org.gradle.configurationcache.models.ProjectStateStore.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gradle.configurationcache.models

import org.gradle.cache.internal.streams.BlockAddress
import org.gradle.cache.internal.streams.ValueStore
import org.gradle.configurationcache.CheckedFingerprint
import org.gradle.configurationcache.ConfigurationCacheStateStore
import org.gradle.configurationcache.StateType
import org.gradle.internal.concurrent.CompositeStoppable
import org.gradle.internal.serialize.Decoder
import org.gradle.internal.serialize.Encoder
import org.gradle.util.Path
import java.io.Closeable
import java.util.Collections
import java.util.HashSet
import java.util.concurrent.ConcurrentHashMap
import java.util.function.Consumer


/**
 * Responsible for loading and storing intermediate models used during tooling API build action execution.
 */
internal
abstract class ProjectStateStore(
    private val store: ConfigurationCacheStateStore,
    private val stateType: StateType
) : Closeable {
    private
    val valuesStore by lazy {
        val writer = ValueStore.Writer { encoder, value ->
            write(encoder, value)
        }
        val reader = ValueStore.Reader { decoder ->
            read(decoder)
        }
        store.createValueStore(stateType, writer, reader)
    }

    private
    val previousValues = ConcurrentHashMap()

    private
    val currentValues = ConcurrentHashMap()

    protected
    abstract fun projectPathForKey(key: K): Path?

    protected
    abstract fun write(encoder: Encoder, value: V)

    protected
    abstract fun read(decoder: Decoder): V

    /**
     * All values used during execution.
     */
    val values: Map
        get() = Collections.unmodifiableMap(currentValues)

    fun restoreFromCacheEntry(entryDetails: Map, checkedFingerprint: CheckedFingerprint.ProjectsInvalid) {
        for (entry in entryDetails) {
            val identityPath = projectPathForKey(entry.key)
            if (identityPath == null || !checkedFingerprint.invalidProjects.contains(identityPath)) {
                // Can reuse the value
                previousValues[entry.key] = entry.value
            }
        }
    }

    fun visitProjects(reusedProjects: Consumer, updatedProjects: Consumer) {
        val currentProjects = currentValues.keys.mapNotNull { projectPathForKey(it) }
        val previousProjects = HashSet()
        for (key in previousValues.keys) {
            val path = projectPathForKey(key)
            if (path != null) {
                previousProjects.add(path)
            }
        }
        for (path in currentProjects) {
            if (previousProjects.contains(path)) {
                reusedProjects.accept(path)
            } else {
                updatedProjects.accept(path)
            }
        }
    }

    fun loadOrCreateValue(key: K, creator: () -> V): V {
        val addressOfCached = locateCachedValue(key)
        if (addressOfCached != null) {
            try {
                return valuesStore.read(addressOfCached)
            } catch (e: Exception) {
                throw RuntimeException("Could not load entry for $key", e)
            }
        }
        // TODO - should protect from concurrent creation
        val value = creator()
        val address = valuesStore.write(value)
        currentValues[key] = address
        return value
    }

    private
    fun locateCachedValue(key: K): BlockAddress? {
        val cachedInCurrent = currentValues[key]
        if (cachedInCurrent != null) {
            return cachedInCurrent
        }
        val cachedInPrevious = previousValues[key]
        if (cachedInPrevious != null) {
            currentValues[key] = cachedInPrevious
        }
        return cachedInPrevious
    }

    override fun close() {
        CompositeStoppable.stoppable(valuesStore).stop()
    }
}