-
Notifications
You must be signed in to change notification settings - Fork 251
/
KspAATask.kt
540 lines (473 loc) · 22.4 KB
/
KspAATask.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
/*
* Copyright 2023 Google LLC
* Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
*
* 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 com.google.devtools.ksp.gradle
import com.google.devtools.ksp.impl.KotlinSymbolProcessing
import com.google.devtools.ksp.processing.ExitCode
import com.google.devtools.ksp.processing.KSPCommonConfig
import com.google.devtools.ksp.processing.KSPConfig
import com.google.devtools.ksp.processing.KSPJsConfig
import com.google.devtools.ksp.processing.KSPJvmConfig
import com.google.devtools.ksp.processing.KSPNativeConfig
import com.google.devtools.ksp.processing.KspGradleLogger
import org.gradle.api.DefaultTask
import org.gradle.api.artifacts.Configuration
import org.gradle.api.file.ConfigurableFileCollection
import org.gradle.api.logging.LogLevel
import org.gradle.api.provider.MapProperty
import org.gradle.api.provider.Property
import org.gradle.api.provider.SetProperty
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Classpath
import org.gradle.api.tasks.IgnoreEmptyDirectories
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFiles
import org.gradle.api.tasks.Internal
import org.gradle.api.tasks.Nested
import org.gradle.api.tasks.Optional
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import org.gradle.api.tasks.SkipWhenEmpty
import org.gradle.api.tasks.TaskAction
import org.gradle.api.tasks.TaskProvider
import org.gradle.work.ChangeType
import org.gradle.work.Incremental
import org.gradle.work.InputChanges
import org.gradle.workers.WorkAction
import org.gradle.workers.WorkParameters
import org.gradle.workers.WorkerExecutor
import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions
import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation
import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinCommonCompilation
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeCompilation
import org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool
import org.jetbrains.kotlin.gradle.tasks.KotlinNativeCompile
import java.io.ByteArrayOutputStream
import java.io.File
import java.io.ObjectOutputStream
import java.lang.reflect.InvocationTargetException
import java.net.URLClassLoader
import java.util.ServiceLoader
import java.util.concurrent.Callable
import javax.inject.Inject
@CacheableTask
abstract class KspAATask @Inject constructor(
private val workerExecutor: WorkerExecutor,
) : DefaultTask() {
@get:Classpath
abstract val kspClasspath: ConfigurableFileCollection
@get:Nested
abstract val kspConfig: KspGradleConfig
@TaskAction
fun execute(inputChanges: InputChanges) {
// FIXME: Create a class loader with clean classpath instead of shadowing existing ones. It'll require either:
// 1. passing arguments by data structures in stdlib, or
// 2. hoisting and publishing KspGradleConfig into another package.
val modifiedSources: MutableList<File> = mutableListOf()
val removedSources: MutableList<File> = mutableListOf()
if (inputChanges.isIncremental) {
listOf(kspConfig.sourceRoots, kspConfig.javaSourceRoots, kspConfig.commonSourceRoots).forEach {
inputChanges.getFileChanges(it).forEach {
when (it.changeType) {
ChangeType.ADDED, ChangeType.MODIFIED -> modifiedSources.add(it.file)
ChangeType.REMOVED -> removedSources.add(it.file)
}
}
}
}
val changedClasses = if (kspConfig.incremental.get()) {
if (kspConfig.platformType.get() == KotlinPlatformType.jvm) {
getCPChanges(
inputChanges,
listOf(
kspConfig.sourceRoots,
kspConfig.javaSourceRoots,
kspConfig.commonSourceRoots,
kspConfig.libraries
),
kspConfig.cachesDir.get(),
kspConfig.classpathStructure,
kspConfig.libraries,
kspConfig.processorClasspath,
)
} else {
if (
!inputChanges.isIncremental ||
inputChanges.getFileChanges(kspConfig.libraries).iterator().hasNext()
)
kspConfig.cachesDir.get().deleteRecursively()
emptyList()
}
} else {
kspConfig.cachesDir.get().deleteRecursively()
emptyList()
}
val workerQueue = workerExecutor.noIsolation()
workerQueue.submit(KspAAWorkerAction::class.java) {
it.config = kspConfig
it.kspClassPath = kspClasspath
it.modifiedSources = modifiedSources
it.removedSources = removedSources
it.isInputChangeIncremental = inputChanges.isIncremental
it.changedClasses = changedClasses
}
}
companion object {
@Internal
internal fun registerKspAATask(
kotlinCompilation: KotlinCompilation<*>,
kotlinCompileProvider: TaskProvider<AbstractKotlinCompileTool<*>>,
processorClasspath: Configuration,
kspExtension: KspExtension,
): TaskProvider<KspAATask> {
val project = kotlinCompilation.target.project
val target = kotlinCompilation.target.name
val sourceSetName = kotlinCompilation.defaultSourceSet.name
val kspTaskName = kotlinCompileProvider.name.replaceFirst("compile", "ksp")
val kspAADepCfg = project.configurations.detachedConfiguration(
project.dependencies.create("${KspGradleSubplugin.KSP_GROUP_ID}:symbol-processing-api:$KSP_VERSION"),
project.dependencies.create("${KspGradleSubplugin.KSP_GROUP_ID}:symbol-processing-aa:$KSP_VERSION"),
project.dependencies.create(
"${KspGradleSubplugin.KSP_GROUP_ID}:symbol-processing-common-deps:$KSP_VERSION"
),
project.dependencies.create("org.jetbrains.kotlin:kotlin-stdlib:$KSP_KOTLIN_BASE_VERSION"),
).apply {
isTransitive = false
}
val kspTaskProvider = project.tasks.register(kspTaskName, KspAATask::class.java) { kspAATask ->
kspAATask.kspClasspath.from(kspAADepCfg)
kspAATask.kspConfig.let { cfg ->
cfg.processorClasspath.from(processorClasspath)
cfg.moduleName.value(kotlinCompilation.defaultSourceSet.name)
val kotlinOutputDir = KspGradleSubplugin.getKspKotlinOutputDir(project, sourceSetName, target)
val javaOutputDir = KspGradleSubplugin.getKspJavaOutputDir(project, sourceSetName, target)
val filteredTasks =
kspExtension.excludedSources.buildDependencies.getDependencies(null).map { it.name }
kotlinCompilation.allKotlinSourceSetsObservable.forAll { sourceSet ->
val filtered = sourceSet.kotlin.srcDirs.filter {
!kotlinOutputDir.isParentOf(it) && !javaOutputDir.isParentOf(it) &&
it !in kspExtension.excludedSources
}.map {
// @SkipWhenEmpty doesn't work well with File.
project.objects.fileTree().from(it)
}
cfg.sourceRoots.from(filtered)
cfg.javaSourceRoots.from(filtered)
kspAATask.dependsOn(
sourceSet.kotlin.nonSelfDeps(kspTaskName).filter { it.name !in filteredTasks }
)
}
if (kotlinCompilation is KotlinCommonCompilation) {
cfg.commonSourceRoots.from(kotlinCompilation.defaultSourceSet.kotlin)
}
// FIXME: figure out how to filter or set variant attributes correctly.
// cfg.libraries.from(kotlinCompilation.compileDependencyFiles)
val kspOutputDir = KspGradleSubplugin.getKspOutputDir(project, sourceSetName, target)
cfg.libraries.from(
project.files(
Callable {
kotlinCompileProvider.get().libraries.filter {
!kspOutputDir.isParentOf(it) &&
!(it.isDirectory && it.listFiles()?.isEmpty() == true)
}
}
)
)
val compilerOptions = kotlinCompilation.compilerOptions.options
val langVer = compilerOptions.languageVersion.orNull?.version ?: KSP_KOTLIN_BASE_VERSION
val apiVer = compilerOptions.apiVersion.orNull?.version ?: KSP_KOTLIN_BASE_VERSION
cfg.languageVersion.value(langVer.split('.', '-').take(2).joinToString("."))
cfg.apiVersion.value(apiVer.split('.', '-').take(2).joinToString("."))
cfg.projectBaseDir.value(File(project.project.projectDir.canonicalPath))
cfg.cachesDir.value(KspGradleSubplugin.getKspCachesDir(project, sourceSetName, target))
cfg.outputBaseDir.value(KspGradleSubplugin.getKspOutputDir(project, sourceSetName, target))
cfg.kotlinOutputDir.value(kotlinOutputDir)
cfg.javaOutputDir.value(javaOutputDir)
cfg.classOutputDir.value(KspGradleSubplugin.getKspClassOutputDir(project, sourceSetName, target))
cfg.resourceOutputDir.value(
KspGradleSubplugin.getKspResourceOutputDir(
project,
sourceSetName,
target
)
)
val apOptions = mutableMapOf<String, String>()
apOptions.putAll(kspExtension.apOptions)
kspExtension.commandLineArgumentProviders.forEach { provider ->
provider.asArguments().forEach { argument ->
val kv = Regex("(\\S+)=(\\S+)").matchEntire(argument)?.groupValues
if (kv == null || kv.size != 3) {
throw IllegalArgumentException("KSP apoption does not match (\\S+)=(\\S+): $argument")
}
apOptions.put(kv[1], kv[2])
}
}
cfg.processorOptions.value(apOptions)
val logLevel = LogLevel.values().first {
project.logger.isEnabled(it)
}
cfg.logLevel.value(logLevel)
cfg.allWarningsAsErrors.value(kspExtension.allWarningsAsErrors)
cfg.excludedProcessors.value(kspExtension.excludedProcessors)
cfg.incremental.value(project.findProperty("ksp.incremental")?.toString()?.toBoolean() ?: true)
cfg.incrementalLog.value(
project.findProperty("ksp.incremental.log")?.toString()?.toBoolean() ?: false
)
cfg.classpathStructure.from(getClassStructureFiles(project, cfg.libraries))
if (compilerOptions is KotlinJvmCompilerOptions) {
// TODO: set proper jdk home
cfg.jdkHome.value(File(System.getProperty("java.home")))
val jvmDefaultMode = project.provider {
compilerOptions.freeCompilerArgs.get().lastOrNull {
it.startsWith("-Xjvm-default=")
}?.substringAfter("=") ?: "disable"
}
cfg.jvmDefaultMode.value(jvmDefaultMode)
val jvmTarget = project.provider {
(compilerOptions as KotlinJvmCompilerOptions).jvmTarget.get().target
}
cfg.jvmTarget.value(jvmTarget)
}
cfg.platformType.value(kotlinCompilation.platformType)
if (kotlinCompilation is KotlinNativeCompilation) {
val konanTargetName = kotlinCompilation.target.konanTarget.name
cfg.konanTargetName.value(konanTargetName)
cfg.konanHome.value((kotlinCompileProvider.get() as KotlinNativeCompile).konanHome)
}
// TODO: pass targets of common
}
}
return kspTaskProvider
}
}
}
abstract class KspGradleConfig @Inject constructor() {
@get:Classpath
abstract val processorClasspath: ConfigurableFileCollection
@get:Input
abstract val moduleName: Property<String>
@get:InputFiles
@get:SkipWhenEmpty
@get:IgnoreEmptyDirectories
@get:PathSensitive(PathSensitivity.RELATIVE)
abstract val sourceRoots: ConfigurableFileCollection
@get:InputFiles
@get:SkipWhenEmpty
@get:IgnoreEmptyDirectories
@get:PathSensitive(PathSensitivity.RELATIVE)
abstract val commonSourceRoots: ConfigurableFileCollection
@get:InputFiles
@get:SkipWhenEmpty
@get:IgnoreEmptyDirectories
@get:PathSensitive(PathSensitivity.RELATIVE)
abstract val javaSourceRoots: ConfigurableFileCollection
@get:Incremental
@get:Classpath
abstract val libraries: ConfigurableFileCollection
@get:Input
@get:Optional
abstract val jdkHome: Property<File>
@get:Internal
abstract val projectBaseDir: Property<File>
@get:Internal
abstract val outputBaseDir: Property<File>
@get:Internal
abstract val cachesDir: Property<File>
@get:OutputDirectory
abstract val kotlinOutputDir: Property<File>
@get:OutputDirectory
abstract val javaOutputDir: Property<File>
@get:OutputDirectory
abstract val classOutputDir: Property<File>
@get:OutputDirectory
abstract val resourceOutputDir: Property<File>
@get:Input
abstract val languageVersion: Property<String>
@get:Input
abstract val apiVersion: Property<String>
@get:Input
abstract val processorOptions: MapProperty<String, String>
// Unfortunately, passing project.logger over is not possible.
@get:Input
abstract val logLevel: Property<LogLevel>
@get:Input
abstract val allWarningsAsErrors: Property<Boolean>
@get:Input
abstract val excludedProcessors: SetProperty<String>
@get:Input
@get:Optional
abstract val jvmTarget: Property<String>
@get:Input
@get:Optional
abstract val jvmDefaultMode: Property<String>
@get:Input
abstract val incremental: Property<Boolean>
@get:Input
abstract val incrementalLog: Property<Boolean>
@get:Internal
abstract val classpathStructure: ConfigurableFileCollection
@get:Input
abstract val platformType: Property<KotlinPlatformType>
@get:Input
@get:Optional
abstract val konanTargetName: Property<String>
@get:Input
@get:Optional
abstract val konanHome: Property<String>
}
interface KspAAWorkParameter : WorkParameters {
var config: KspGradleConfig
var kspClassPath: ConfigurableFileCollection
var modifiedSources: List<File>
var removedSources: List<File>
var changedClasses: List<String>
var isInputChangeIncremental: Boolean
}
var isolatedClassLoaderCache = mutableMapOf<String, URLClassLoader>()
abstract class KspAAWorkerAction : WorkAction<KspAAWorkParameter> {
override fun execute() {
val gradleCfg = parameters.config
val kspClassPath = parameters.kspClassPath
val key = kspClassPath.files.map { it.toURI().toURL() }.joinToString { it.path }
synchronized(isolatedClassLoaderCache) {
if (isolatedClassLoaderCache[key] == null) {
isolatedClassLoaderCache[key] = URLClassLoader(
kspClassPath.files.map { it.toURI().toURL() }.toTypedArray(),
ClassLoader.getPlatformClassLoader()
)
}
}
val isolatedClassLoader = isolatedClassLoaderCache[key]!!
// Clean stale files for now.
// TODO: support incremental processing.
gradleCfg.outputBaseDir.get().deleteRecursively()
val processorClassloader = URLClassLoader(
gradleCfg.processorClasspath.files.map { it.toURI().toURL() }.toTypedArray(),
isolatedClassLoader
)
val excludedProcessors = gradleCfg.excludedProcessors.get()
val processorProviders = ServiceLoader.load(
processorClassloader.loadClass("com.google.devtools.ksp.processing.SymbolProcessorProvider"),
processorClassloader
).filter {
it.javaClass.name !in excludedProcessors
}.toList()
val kspGradleLogger = KspGradleLogger(gradleCfg.logLevel.get().ordinal)
if (processorProviders.isEmpty()) {
kspGradleLogger.error("No providers found in processor classpath.")
throw Exception("KSP failed with exit code: ${KotlinSymbolProcessing.ExitCode.PROCESSING_ERROR}")
} else {
kspGradleLogger.info(
"loaded provider(s): " +
processorProviders.joinToString(separator = ", ", prefix = "[", postfix = "]") { it.javaClass.name }
)
}
fun KSPConfig.Builder.setupSuper() {
moduleName = gradleCfg.moduleName.get()
sourceRoots = gradleCfg.sourceRoots.files.toList()
commonSourceRoots = gradleCfg.commonSourceRoots.files.toList()
libraries = gradleCfg.libraries.files.toList()
projectBaseDir = gradleCfg.projectBaseDir.get()
outputBaseDir = gradleCfg.outputBaseDir.get()
cachesDir = gradleCfg.cachesDir.get()
kotlinOutputDir = gradleCfg.kotlinOutputDir.get()
classOutputDir = gradleCfg.classOutputDir.get()
resourceOutputDir = gradleCfg.resourceOutputDir.get()
languageVersion = gradleCfg.languageVersion.get()
apiVersion = gradleCfg.apiVersion.get()
processorOptions = gradleCfg.processorOptions.get()
allWarningsAsErrors = gradleCfg.allWarningsAsErrors.get()
incremental = gradleCfg.incremental.get()
incrementalLog = gradleCfg.incrementalLog.get()
modifiedSources = parameters.modifiedSources
removedSources = parameters.removedSources
changedClasses = parameters.changedClasses
}
val platformType = gradleCfg.platformType.get()
val kspConfig = when (platformType) {
KotlinPlatformType.jvm, KotlinPlatformType.androidJvm -> {
KSPJvmConfig.Builder().apply {
this.setupSuper()
javaSourceRoots = gradleCfg.javaSourceRoots.files.toList()
jdkHome = gradleCfg.jdkHome.get()
javaOutputDir = gradleCfg.javaOutputDir.get()
jvmTarget = gradleCfg.jvmTarget.get()
jvmDefaultMode = gradleCfg.jvmDefaultMode.get()
}.build()
}
KotlinPlatformType.js, KotlinPlatformType.wasm -> {
KSPJsConfig.Builder().apply {
this.setupSuper()
backend = if (platformType == KotlinPlatformType.js) "JS" else "Wasm"
}.build()
}
KotlinPlatformType.native -> {
KSPNativeConfig.Builder().apply {
this.setupSuper()
target = gradleCfg.konanTargetName.get()
// Unlike other platforms, K/N sets up stdlib in the compiler, not KGP,
// meaning that KotlinNativeCompile doesn't have stdlib.
// FIXME: find a solution with KGP, K/N and AA owners
val konanHome = File(gradleCfg.konanHome.get())
val klib = File(konanHome, "klib")
val common = File(klib, "common")
val stdlib = File(common, "stdlib")
libraries += stdlib
val platform = File(klib, "platform")
val targetLibDir = File(platform, target)
targetLibDir.listFiles()?.let {
libraries += it
}
}.build()
}
KotlinPlatformType.common -> {
KSPCommonConfig.Builder().apply {
this.setupSuper()
// FIXME: targets
targets = emptyList()
}.build()
}
}
val byteArrayOutputStream = ByteArrayOutputStream()
val objectOutputStream = ObjectOutputStream(byteArrayOutputStream)
objectOutputStream.writeObject(kspConfig)
val exitCode = try {
val kspLoaderClass = isolatedClassLoader.loadClass("com.google.devtools.ksp.impl.KSPLoader")
val runMethod = kspLoaderClass.getMethod(
"loadAndRunKSP",
ByteArray::class.java,
List::class.java,
Int::class.java
)
val returnCode = runMethod.invoke(
null,
byteArrayOutputStream.toByteArray(),
processorProviders,
gradleCfg.logLevel.get().ordinal
) as Int
ExitCode.values()[returnCode]
} catch (e: Exception) {
require(e is InvocationTargetException)
kspGradleLogger.exception(e.targetException)
throw e.targetException
}
if (exitCode != ExitCode.OK) {
throw Exception("KSP failed with exit code: $exitCode")
}
}
}