Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't calculate incremental info when incremental processing is disabled #227

Merged
merged 1 commit into from
Jan 6, 2021
Merged

Don't calculate incremental info when incremental processing is disabled #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 36 additions & 18 deletions compiler-plugin/src/main/kotlin/com/google/devtools/ksp/Incremental.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,24 +124,24 @@ class FileToFilesMap(storageFile: File) : BasicMap<File, Collection<File>>(stora
}

object symbolCollector : KSDefaultVisitor<(LookupSymbol) -> Unit, Unit>() {
override fun defaultHandler(node: KSNode, collect: (LookupSymbol) -> Unit) = Unit
override fun defaultHandler(node: KSNode, data: (LookupSymbol) -> Unit) = Unit

override fun visitDeclaration(declaration: KSDeclaration, collect: (LookupSymbol) -> Unit) {
override fun visitDeclaration(declaration: KSDeclaration, data: (LookupSymbol) -> Unit) {
if (declaration.isPrivate())
return

val name = declaration.simpleName.asString()
val scope = declaration.qualifiedName?.asString()?.let { it.substring(0, Math.max(it.length - name.length - 1, 0))} ?: return
collect(LookupSymbol(name, scope))
data(LookupSymbol(name, scope))
}

override fun visitDeclarationContainer(declarationContainer: KSDeclarationContainer, collect: (LookupSymbol) -> Unit) {
override fun visitDeclarationContainer(declarationContainer: KSDeclarationContainer, data: (LookupSymbol) -> Unit) {
// Local declarations aren't visible to other files / classes.
if (declarationContainer is KSFunctionDeclaration)
return

declarationContainer.declarations.forEach {
it.accept(this, collect)
it.accept(this, data)
}
}
}
Expand All @@ -155,15 +155,20 @@ class IncrementalContext(
private val options: KspOptions,
private val ksFiles: List<KSFile>,
private val componentProvider: ComponentProvider,
private val anyChangesWildcard: File,
private val isIncremental: Boolean
private val anyChangesWildcard: File
) {
// Symbols defined in changed files. This is used to update symbolsMap in the end.
private val updatedSymbols = MultiMap.createSet<File, LookupSymbol>()

// Symbols defined in each file. This is
// Symbols defined in each file. This is saved across processing.
private val symbolsMap = FileToSymbolsMap(File(options.cachesDir, "symbols"))

private val cachesUpToDateFile = File(options.cachesDir, "caches.uptodate")
private val isIncremental = options.incremental
private var rebuild = !isIncremental || !cachesUpToDateFile.exists()
|| (options.knownModified.isEmpty() && options.knownRemoved.isEmpty())
|| (options.knownModified + options.knownRemoved).any { !it.isKotlinFile(listOf("kt")) && !it.isJavaFile() }

private val baseDir = options.projectBaseDir

private val logsDir = File(baseDir, "build").apply { mkdir() }
Expand Down Expand Up @@ -195,7 +200,7 @@ class IncrementalContext(
}
}

fun updateLookupCache(dirtyFiles: Collection<File>) {
private fun updateLookupCache(dirtyFiles: Collection<File>) {
if (lookupTracker is LookupTrackerImpl) {
lookupCache.update(lookupTracker, dirtyFiles, options.knownRemoved)
lookupCache.flush(false)
Expand Down Expand Up @@ -261,7 +266,7 @@ class IncrementalContext(
return visited
}

fun logDirtyFilesByDeps(dirtyFiles: Collection<File>) {
private fun logDirtyFilesByDeps(dirtyFiles: Collection<File>) {
if (!options.incrementalLog)
return

Expand All @@ -276,7 +281,7 @@ class IncrementalContext(
logFile.appendText("\n")
}

fun logDirtyFilesByOutputs(dirtyFiles: Collection<File>) {
private fun logDirtyFilesByOutputs(dirtyFiles: Collection<File>) {
if (!options.incrementalLog)
return

Expand All @@ -299,7 +304,7 @@ class IncrementalContext(
logFile.appendText("\n")
}

fun logSourceToOutputs() {
private fun logSourceToOutputs() {
if (!options.incrementalLog)
return

Expand All @@ -315,7 +320,7 @@ class IncrementalContext(
logFile.appendText("\n")
}

fun logDirtyFiles(files: List<KSFile>) {
private fun logDirtyFiles(files: List<KSFile>) {
if (!options.incrementalLog)
return

Expand All @@ -333,7 +338,12 @@ class IncrementalContext(

// Beware: no side-effects here; Caches should only be touched in updateCaches.
fun calcDirtyFiles(): Collection<KSFile> {
if (isIncremental) {
if (!isIncremental) {
cleanIncrementalCache()
return ksFiles
}

if (!rebuild) {
val dirtyFilesByDeps = calcDirtySetByDeps()

logDirtyFilesByDeps(dirtyFilesByDeps)
Expand All @@ -357,7 +367,7 @@ class IncrementalContext(
}
}

fun updateSourceToOutputs(dirtyFiles: Collection<File>, outputs: Set<File>, sourceToOutputs: Map<File, Set<File>>) {
private fun updateSourceToOutputs(dirtyFiles: Collection<File>, outputs: Set<File>, sourceToOutputs: Map<File, Set<File>>) {
// Prune deleted sources in source-to-outputs map.
removed.forEach {
sourceToOutputsMap.remove(it)
Expand All @@ -375,7 +385,7 @@ class IncrementalContext(
}

// TODO: Recover if processing failed.
fun updateOutputs(outputs: Set<File>, cleanOutputs: Collection<File>) {
private fun updateOutputs(outputs: Set<File>, cleanOutputs: Collection<File>) {
val outRoot = options.kspOutputDir
val bakRoot = File(options.cachesDir, "backups")

Expand Down Expand Up @@ -406,12 +416,12 @@ class IncrementalContext(
}

// TODO: Don't do anything if processing failed.
fun updateCaches(dirtyFiles: Collection<File>, outputs: Set<File>, sourceToOutputs: Map<File, Set<File>>) {
private fun updateCaches(dirtyFiles: Collection<File>, outputs: Set<File>, sourceToOutputs: Map<File, Set<File>>) {
updateSourceToOutputs(dirtyFiles, outputs, sourceToOutputs)
updateLookupCache(dirtyFiles)

// Update symbolsMap
if (isIncremental) {
if (!rebuild) {
// Update symbol caches from modified files.
options.knownModified.forEach {
symbolsMap.set(it, updatedSymbols[it].toSet())
Expand All @@ -432,6 +442,12 @@ class IncrementalContext(
}

fun updateCachesAndOutputs(dirtyFiles: Collection<KSFile>, outputs: Set<File>, sourceToOutputs: Map<File, Set<File>>) {
if (!isIncremental)
return

cachesUpToDateFile.delete()
assert(!cachesUpToDateFile.exists())

val cleanOutputs = mutableSetOf<File>()
val dirtyFilePaths = dirtyFiles.map { it.relativeFile }
sourceToOutputsMap.keys.forEach { source ->
Expand All @@ -442,6 +458,8 @@ class IncrementalContext(
updateCaches(dirtyFilePaths, outputs, sourceToOutputs)
updateOutputs(outputs, cleanOutputs)

cachesUpToDateFile.createNewFile()
assert(cachesUpToDateFile.exists())
}

// Insert Java file -> names lookup records.
Expand Down
5 changes: 1 addition & 4 deletions compiler-plugin/src/main/kotlin/com/google/devtools/ksp/KotlinSymbolProcessingExtension.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,9 @@ abstract class AbstractKotlinSymbolProcessingExtension(val options: KspOptions,

val anyChangesWildcard = AnyChanges(options.projectBaseDir)
val ksFiles = files.map { KSFileImpl.getCached(it) } + javaFiles.map { KSFileJavaImpl.getCached(it) }
val isIncremental = options.incremental && (options.knownModified.isNotEmpty() || options.knownRemoved.isNotEmpty()) &&
(options.knownModified + options.knownRemoved).all { it.isKotlinFile(listOf("kt")) || it.isJavaFile() }
val incrementalContext = IncrementalContext(
options, ksFiles, componentProvider,
File(anyChangesWildcard.filePath).relativeTo(options.projectBaseDir),
isIncremental
File(anyChangesWildcard.filePath).relativeTo(options.projectBaseDir)
)
val dirtyFiles = incrementalContext.calcDirtyFiles()

Expand Down