org.jetbrains.kotlin.incremental.storage.BasicMapsOwner.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-build-common Show documentation
Kotlin Build Common
There is a newer version: 2.1.0
/*
 * Copyright 2010-2015 JetBrains s.r.o.
 *
 * 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.jetbrains.kotlin.incremental.storage

import org.jetbrains.annotations.TestOnly
import java.io.Closeable
import java.io.File
import java.io.IOException

open class BasicMapsOwner(val cachesDir: File) : Closeable {
    private val maps = arrayListOf>()

    companion object {
        val CACHE_EXTENSION = "tab"
    }

    protected val String.storageFile: File
        get() = File(cachesDir, this + "." + CACHE_EXTENSION)

    @Synchronized
    protected fun > registerMap(map: M): M {
        maps.add(map)
        return map
    }

    fun flush() {
        forEachMapSafe("flush", BasicMap<*, *>::flush)
    }

    open fun deleteStorageFiles() {
        forEachMapSafe("deleteStorageFiles", BasicMap<*, *>::deleteStorageFiles)
    }

    /**
     * Please do not remove or modify this function.
     * It is implementing [org.jetbrains.jps.incremental.storage.StorageOwner] interface and needed for correct JPS compilation.
     */
    override fun close() {
        forEachMapSafe("close", BasicMap<*, *>::close)
    }

    /**
     * Please do not remove or modify this function.
     * It is implementing [org.jetbrains.jps.incremental.storage.StorageOwner] interface and needed for correct JPS compilation.
     */
    fun flush(@Suppress("UNUSED_PARAMETER") memoryCachesOnly: Boolean) {
        flush()
    }

    /**
     * Please do not remove or modify this function.
     * It is implementing [org.jetbrains.jps.incremental.storage.StorageOwner] interface and needed for correct JPS compilation.
     * Calling [org.jetbrains.kotlin.incremental.storage.BasicMapsOwner.close] here is unnecessary and will produce race conditions
     * for JPS build because JPS can modify caches of dependant modules.
     *
     * More context:
     * 1) While compiling module Foo, thread A can open caches of dependent module Bar
     * 2) When we will compile module Bar in thread B we can decide to rebuild the module (e.g. configuration of facet changed)
     * 3) Thread B will call `clean` action on caches of module Bar
     * 4) If `clean` action also call `close` action,
     * it will close opened map and will make it unusable when it tries to add info after recompilation,
     * which will cause a "Storage already closed" exception.
     */
    fun clean() {
        forEachMapSafe("clean", BasicMap<*, *>::clean)
    }

    @Synchronized
    private fun forEachMapSafe(actionName: String, action: (BasicMap<*, *>) -> Unit) {
        val actionExceptions = LinkedHashMap()
        maps.forEach {
            try {
                action(it)
            } catch (e: Exception) {
                actionExceptions[it.storageFile.name] = e
            }
        }
        if (actionExceptions.isNotEmpty()) {
            val desc = "Could not $actionName incremental caches in $cachesDir: ${actionExceptions.keys.joinToString(", ")}"
            val allIOExceptions = actionExceptions.all { it is IOException }
            val ex = if (allIOExceptions) IOException(desc) else Exception(desc)
            actionExceptions.forEach { (_, e) -> ex.addSuppressed(e) }
            throw ex
        }
    }

    @TestOnly
    @Synchronized
    fun dump(): String = maps.joinToString("\n\n") { it.dump() }
}