Skip to content

Commit f29b419

Browse files
aviroop-123aviroop-123
committed
Create a compiler argument to adjust the klib zip file cache.
^KT-79675
1 parent 5360a8d commit f29b419

File tree

13 files changed

+124
-43
lines changed

13 files changed

+124
-43
lines changed

‎compiler/arguments/resources/kotlin-compiler-arguments.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6292,6 +6292,37 @@
62926292
"deprecatedVersion": null,
62936293
"removedVersion": null
62946294
}
6295+
},
6296+
{
6297+
"name": "Xklib-zip-file-accessor-cache-limit",
6298+
"shortName": null,
6299+
"deprecatedName": null,
6300+
"description": {
6301+
"current": "Maximum number of klibs that can be cached during compilation. Default is 64.",
6302+
"valueInVersions": []
6303+
},
6304+
"delimiter": null,
6305+
"valueType": {
6306+
"type": "org.jetbrains.kotlin.arguments.dsl.types.IntType",
6307+
"isNullable": {
6308+
"current": false,
6309+
"valueInVersions": []
6310+
},
6311+
"defaultValue": {
6312+
"current": 64,
6313+
"valueInVersions": []
6314+
}
6315+
},
6316+
"valueDescription": {
6317+
"current": null,
6318+
"valueInVersions": []
6319+
},
6320+
"releaseVersionsMetadata": {
6321+
"introducedVersion": "2.3.0",
6322+
"stabilizedVersion": null,
6323+
"deprecatedVersion": null,
6324+
"removedVersion": null
6325+
}
62956326
}
62966327
],
62976328
"nestedLevels": [

‎compiler/arguments/src/org/jetbrains/kotlin/arguments/description/CommonKlibBasedCompilerArguments.kt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import org.jetbrains.kotlin.arguments.dsl.defaultFalse
1010
import org.jetbrains.kotlin.arguments.dsl.defaultNull
1111
import org.jetbrains.kotlin.arguments.dsl.defaultTrue
1212
import org.jetbrains.kotlin.arguments.dsl.types.BooleanType
13+
import org.jetbrains.kotlin.arguments.dsl.types.IntType
1314
import org.jetbrains.kotlin.arguments.dsl.types.StringArrayType
1415
import org.jetbrains.kotlin.arguments.dsl.types.StringType
1516

@@ -107,4 +108,16 @@ The only observable effect is that a custom ABI version is written to KLIB manif
107108
introducedVersion = KotlinReleaseVersion.v2_2_0,
108109
)
109110
}
111+
112+
compilerArgument {
113+
name = "Xklib-zip-file-accessor-cache-limit"
114+
description = "Maximum number of klibs that can be cached during compilation. Default is 64.".asReleaseDependent()
115+
valueType = IntType(
116+
defaultValue = 64.asReleaseDependent()
117+
)
118+
119+
lifecycle(
120+
introducedVersion = KotlinReleaseVersion.v2_3_0
121+
)
122+
}
110123
}

‎compiler/arguments/src/org/jetbrains/kotlin/arguments/description/NativeCompilerArguments.kt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1069,7 +1069,8 @@ The default value is 1.""".asReleaseDependent()
10691069

10701070
compilerArgument {
10711071
name = "Xmanifest-native-targets"
1072-
description = "Comma-separated list that will be written as the value of 'native_targets' property in the .klib manifest. Unknown values are discarded.".asReleaseDependent()
1072+
description =
1073+
"Comma-separated list that will be written as the value of 'native_targets' property in the .klib manifest. Unknown values are discarded.".asReleaseDependent()
10731074
valueType = StringArrayType.defaultNull
10741075

10751076
lifecycle(

‎compiler/build-tools/kotlin-build-tools-api/gen/org/jetbrains/kotlin/buildtools/api/arguments/CommonKlibBasedArguments.kt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ package org.jetbrains.kotlin.buildtools.api.arguments
55

66
import kotlin.Array
77
import kotlin.Boolean
8+
import kotlin.Int
89
import kotlin.String
910
import kotlin.jvm.JvmField
1011

@@ -118,5 +119,15 @@ public interface CommonKlibBasedArguments : CommonCompilerArguments {
118119
@ExperimentalCompilerArgument
119120
public val X_KLIB_ABI_VERSION: CommonKlibBasedArgument<String?> =
120121
CommonKlibBasedArgument("X_KLIB_ABI_VERSION")
122+
123+
/**
124+
* Maximum number of klibs that can be cached during compilation. Default is 64.
125+
*
126+
* WARNING: this option is EXPERIMENTAL and it may be changed in the future without notice or may be removed entirely.
127+
*/
128+
@JvmField
129+
@ExperimentalCompilerArgument
130+
public val X_KLIB_ZIP_FILE_ACCESSOR_CACHE_LIMIT: CommonKlibBasedArgument<Int> =
131+
CommonKlibBasedArgument("X_KLIB_ZIP_FILE_ACCESSOR_CACHE_LIMIT")
121132
}
122133
}

‎compiler/cli/cli-common/gen/org/jetbrains/kotlin/cli/common/arguments/CommonKlibBasedCompilerArguments.kt‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,14 @@ The only observable effect is that a custom ABI version is written to KLIB manif
9595
field = if (value.isNullOrEmpty()) null else value
9696
}
9797

98+
@Argument(
99+
value = "-Xklib-zip-file-accessor-cache-limit",
100+
description = "Maximum number of klibs that can be cached during compilation. Default is 64.",
101+
)
102+
var klibZipFileAccessorCacheLimit: String = "64"
103+
set(value) {
104+
checkFrozen()
105+
field = value
106+
}
107+
98108
}

‎compiler/cli/cli-js/src/org/jetbrains/kotlin/cli/js/Helpers.kt‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
package org.jetbrains.kotlin.cli.js
77

8-
import com.intellij.openapi.Disposable
98
import com.intellij.util.ExceptionUtil
109
import org.jetbrains.kotlin.backend.js.JsGenerationGranularity
1110
import org.jetbrains.kotlin.backend.js.TsCompilationStrategy
@@ -23,8 +22,6 @@ import org.jetbrains.kotlin.js.config.EcmaVersion
2322
import org.jetbrains.kotlin.js.config.SourceMapNamesPolicy
2423
import org.jetbrains.kotlin.js.config.SourceMapSourceEmbedding
2524
import org.jetbrains.kotlin.js.config.wasmCompilation
26-
import org.jetbrains.kotlin.konan.file.ZipFileSystemAccessor
27-
import org.jetbrains.kotlin.konan.file.ZipFileSystemCacheableAccessor
2825
import org.jetbrains.kotlin.library.loader.KlibPlatformChecker
2926
import org.jetbrains.kotlin.psi.KtFile
3027
import org.jetbrains.kotlin.serialization.js.ModuleKind
@@ -60,16 +57,6 @@ val K2JSCompilerArguments.dtsStrategy: TsCompilationStrategy
6057
else -> TsCompilationStrategy.MERGED
6158
}
6259

63-
internal class DisposableZipFileSystemAccessor private constructor(
64-
private val zipAccessor: ZipFileSystemCacheableAccessor,
65-
) : Disposable, ZipFileSystemAccessor by zipAccessor {
66-
constructor(cacheLimit: Int) : this(ZipFileSystemCacheableAccessor(cacheLimit))
67-
68-
override fun dispose() {
69-
zipAccessor.reset()
70-
}
71-
}
72-
7360
internal val sourceMapContentEmbeddingMap: Map<String, SourceMapSourceEmbedding> = mapOf(
7461
K2JsArgumentConstants.SOURCE_MAP_SOURCE_CONTENT_ALWAYS to SourceMapSourceEmbedding.ALWAYS,
7562
K2JsArgumentConstants.SOURCE_MAP_SOURCE_CONTENT_NEVER to SourceMapSourceEmbedding.NEVER,

‎compiler/cli/cli-js/src/org/jetbrains/kotlin/cli/js/K2JSCompiler.kt‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
package org.jetbrains.kotlin.cli.js
77

88
import com.intellij.openapi.Disposable
9-
import com.intellij.openapi.util.Disposer
109
import org.jetbrains.kotlin.analyzer.CompilationErrorException
1110
import org.jetbrains.kotlin.backend.common.LoadedKlibs
1211
import org.jetbrains.kotlin.cli.common.CLICompiler
@@ -29,7 +28,6 @@ import org.jetbrains.kotlin.cli.pipeline.web.CommonWebConfigurationUpdater
2928
import org.jetbrains.kotlin.cli.pipeline.web.WebCliPipeline
3029
import org.jetbrains.kotlin.config.CommonConfigurationKeys
3130
import org.jetbrains.kotlin.config.CompilerConfiguration
32-
import org.jetbrains.kotlin.config.KlibConfigurationKeys
3331
import org.jetbrains.kotlin.config.Services
3432
import org.jetbrains.kotlin.diagnostics.DiagnosticReporterFactory
3533
import org.jetbrains.kotlin.ir.backend.js.*
@@ -119,14 +117,10 @@ class K2JSCompiler : CLICompiler<K2JSCompilerArguments>() {
119117
val pluginLoadResult = loadPlugins(paths, arguments, configuration, rootDisposable)
120118
if (pluginLoadResult != OK) return pluginLoadResult
121119

122-
CommonWebConfigurationUpdater.initializeCommonConfiguration(compilerImpl.configuration, arguments)
120+
CommonWebConfigurationUpdater.initializeCommonConfiguration(compilerImpl.configuration, arguments, rootDisposable)
123121

124122
val targetEnvironment = compilerImpl.tryInitializeCompiler(rootDisposable) ?: return COMPILATION_ERROR
125123

126-
val zipAccessor = DisposableZipFileSystemAccessor(64)
127-
Disposer.register(rootDisposable, zipAccessor)
128-
targetEnvironment.configuration.put(KlibConfigurationKeys.ZIP_FILE_SYSTEM_ACCESSOR, zipAccessor)
129-
130124
val sourcesFiles = targetEnvironment.getSourceFiles()
131125

132126
if (!checkKotlinPackageUsageForPsi(targetEnvironment.configuration, sourcesFiles)) return COMPILATION_ERROR

‎compiler/cli/cli-js/src/org/jetbrains/kotlin/cli/pipeline/web/WebConfigurationPhase.kt‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
package org.jetbrains.kotlin.cli.pipeline.web
77

8-
import com.intellij.openapi.util.Disposer
8+
import com.intellij.openapi.Disposable
99
import com.intellij.openapi.util.text.StringUtil
1010
import org.jetbrains.kotlin.backend.common.linkage.partial.setupPartialLinkageConfig
1111
import org.jetbrains.kotlin.cli.common.allowKotlinPackage
@@ -59,7 +59,7 @@ object CommonWebConfigurationUpdater : ConfigurationUpdater<K2JSCompilerArgument
5959
) {
6060
val (arguments, services, rootDisposable, _, _) = input
6161
setupPlatformSpecificArgumentsAndServices(configuration, arguments, services)
62-
initializeCommonConfiguration(configuration, arguments)
62+
initializeCommonConfiguration(configuration, arguments, rootDisposable)
6363
configuration.jsIncrementalCompilationEnabled = incrementalCompilationIsEnabledForJs(arguments)
6464

6565
val messageCollector = configuration.messageCollector
@@ -84,9 +84,6 @@ object CommonWebConfigurationUpdater : ConfigurationUpdater<K2JSCompilerArgument
8484
arguments.main?.let { configuration.callMainMode = it }
8585
configuration.dce = arguments.irDce
8686

87-
val zipAccessor = DisposableZipFileSystemAccessor(64)
88-
Disposer.register(rootDisposable, zipAccessor)
89-
configuration.zipFileSystemAccessor = zipAccessor
9087
configuration.perModuleOutputName = arguments.irPerModuleOutputName
9188
configuration.icCacheDirectory = arguments.cacheDirectory
9289
configuration.icCacheReadOnly = arguments.icCacheReadonly
@@ -227,8 +224,8 @@ object CommonWebConfigurationUpdater : ConfigurationUpdater<K2JSCompilerArgument
227224
)
228225
}
229226

230-
internal fun initializeCommonConfiguration(configuration: CompilerConfiguration, arguments: K2JSCompilerArguments) {
231-
configuration.setupCommonKlibArguments(arguments, canBeMetadataKlibCompilation = false)
227+
internal fun initializeCommonConfiguration(configuration: CompilerConfiguration, arguments: K2JSCompilerArguments, rootDisposable: Disposable) {
228+
configuration.setupCommonKlibArguments(arguments, canBeMetadataKlibCompilation = false, rootDisposable = rootDisposable)
232229

233230
val libraries: List<String> = configureLibraries(arguments.libraries) + listOfNotNull(arguments.includes)
234231
val friendLibraries: List<String> = configureLibraries(arguments.friendModules)

‎compiler/cli/src/org/jetbrains/kotlin/cli/common/klibArguments.kt‎

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,16 @@
55

66
package org.jetbrains.kotlin.cli.common
77

8+
import com.intellij.openapi.Disposable
9+
import com.intellij.openapi.util.Disposer
810
import org.jetbrains.kotlin.cli.common.arguments.CommonKlibBasedCompilerArguments
911
import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
1012
import org.jetbrains.kotlin.cli.common.messages.MessageCollector
13+
import org.jetbrains.kotlin.config.*
1114
import org.jetbrains.kotlin.config.CommonConfigurationKeys.LANGUAGE_VERSION_SETTINGS
12-
import org.jetbrains.kotlin.config.CompilerConfiguration
13-
import org.jetbrains.kotlin.config.DuplicatedUniqueNameStrategy
14-
import org.jetbrains.kotlin.config.KlibAbiCompatibilityLevel
15-
import org.jetbrains.kotlin.config.LanguageFeature
16-
import org.jetbrains.kotlin.config.LanguageVersion
17-
import org.jetbrains.kotlin.config.customKlibAbiVersion
18-
import org.jetbrains.kotlin.config.duplicatedUniqueNameStrategy
19-
import org.jetbrains.kotlin.config.klibAbiCompatibilityLevel
20-
import org.jetbrains.kotlin.config.klibNormalizeAbsolutePath
21-
import org.jetbrains.kotlin.config.klibRelativePathBases
22-
import org.jetbrains.kotlin.config.messageCollector
23-
import org.jetbrains.kotlin.config.produceKlibSignaturesClashChecks
15+
import org.jetbrains.kotlin.konan.file.ZipFileSystemAccessor
16+
import org.jetbrains.kotlin.konan.file.ZipFileSystemCacheableAccessor
17+
import org.jetbrains.kotlin.konan.file.ZipFileSystemInPlaceAccessor
2418
import org.jetbrains.kotlin.library.KotlinAbiVersion
2519
import java.util.EnumMap
2620
import kotlin.collections.plus
@@ -31,7 +25,8 @@ import kotlin.collections.plus
3125
*/
3226
fun CompilerConfiguration.setupCommonKlibArguments(
3327
arguments: CommonKlibBasedCompilerArguments,
34-
canBeMetadataKlibCompilation: Boolean
28+
canBeMetadataKlibCompilation: Boolean,
29+
rootDisposable: Disposable
3530
) {
3631
val isKlibMetadataCompilation = canBeMetadataKlibCompilation && arguments.metadataKlib
3732

@@ -55,6 +50,9 @@ fun CompilerConfiguration.setupCommonKlibArguments(
5550
if (!isKlibMetadataCompilation) {
5651
setupKlibAbiCompatibilityLevel()
5752
}
53+
54+
zipFileSystemAccessor = getZipFileSystemAccessor(arguments, messageCollector)
55+
(zipFileSystemAccessor as? Disposable)?.let { Disposer.register(rootDisposable, it) }
5856
}
5957

6058
/**
@@ -76,6 +74,8 @@ fun CompilerConfiguration.copyCommonKlibArgumentsFrom(source: CompilerConfigurat
7674

7775
// ABI compatibility level (the one that actually affects the KLIB serialization).
7876
klibAbiCompatibilityLevel = source.klibAbiCompatibilityLevel
77+
78+
zipFileSystemAccessor = source.zipFileSystemAccessor
7979
}
8080

8181
private fun parseCustomKotlinAbiVersion(customKlibAbiVersion: String?, collector: MessageCollector): KotlinAbiVersion? {
@@ -99,6 +99,35 @@ private fun parseCustomKotlinAbiVersion(customKlibAbiVersion: String?, collector
9999
return KotlinAbiVersion(version[0], version[1], version[2])
100100
}
101101

102+
private fun getZipFileSystemAccessor(arguments: CommonKlibBasedCompilerArguments, collector: MessageCollector): ZipFileSystemAccessor? {
103+
val cacheLimit = arguments.klibZipFileAccessorCacheLimit.toIntOrNull()
104+
if (cacheLimit == null || cacheLimit < 0) {
105+
collector.report(
106+
CompilerMessageSeverity.ERROR,
107+
buildString {
108+
append("Cannot parse -Xklib-zip-file-accessor-cache-limit value: \"${arguments.klibZipFileAccessorCacheLimit}\". ")
109+
append("It must be an integer >= 0.")
110+
}
111+
)
112+
return null
113+
}
114+
if (cacheLimit > 0) {
115+
return DisposableZipFileSystemAccessor(cacheLimit)
116+
} else {
117+
return ZipFileSystemInPlaceAccessor
118+
}
119+
}
120+
121+
private class DisposableZipFileSystemAccessor(
122+
private val zipAccessor: ZipFileSystemCacheableAccessor
123+
) : Disposable, ZipFileSystemAccessor by zipAccessor {
124+
constructor(cacheLimit: Int) : this(ZipFileSystemCacheableAccessor(cacheLimit))
125+
126+
override fun dispose() {
127+
zipAccessor.reset()
128+
}
129+
}
130+
102131
private fun CompilerConfiguration.setupKlibAbiCompatibilityLevel() {
103132
val languageVersionSettings = this[LANGUAGE_VERSION_SETTINGS]
104133
?: error("Language version settings should be already set up")

‎compiler/ir/serialization.common/src/org/jetbrains/kotlin/backend/common/loadMetadataKlibs.kt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
package org.jetbrains.kotlin.backend.common
77

88
import org.jetbrains.kotlin.config.CompilerConfiguration
9+
import org.jetbrains.kotlin.config.zipFileSystemAccessor
910
import org.jetbrains.kotlin.library.loader.KlibLoader
1011

1112
/**
@@ -17,6 +18,7 @@ import org.jetbrains.kotlin.library.loader.KlibLoader
1718
fun loadMetadataKlibs(libraryPaths: List<String>, configuration: CompilerConfiguration): LoadedKlibs {
1819
val result = KlibLoader {
1920
libraryPaths(libraryPaths)
21+
configuration.zipFileSystemAccessor?.let { zipFileSystemAccessor(it)}
2022
// IMPORTANT: Do not set any ABI version requirements - metadata libraries are not supposed to have any ABI.
2123
}.load()
2224
result.reportLoadingProblemsIfAny(configuration)

0 commit comments

Comments
 (0)