-
Notifications
You must be signed in to change notification settings - Fork 129
Document internals of invalidation and hook profiler #585
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.
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
Merged
eed3si9n
merged 6 commits into
sbt:develop
from
scalacenter:topic/wip-incremental-common
Aug 31, 2018
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
a813eb9
Remove stale `ClassToSourceMapper` functions
jvican 396713b
Reorganise code in `IncrementalCommon` and document it
jvican 3dd4a2f
Add profiling invalidation utils (zprof)
jvican 13c7d4d
Exclude binary compatibility errors in zincCore
jvican 90b56cd
Add some docs to clarify design
jvican 11092ad
Remove secondary string table
jvican File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package sbt.internal.inc; | ||
|
|
||
| /////////////////////////////////////////////////////////////////////////////////////////////// | ||
| ///////////////////////////////////////// ZINC PROF /////////////////////////////////////////// | ||
| /////////////////////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| // This protobuf scheme is inspired by https://github.com/google/pprof/blob/master/proto/profile.proto | ||
| // As pprof, it uses a string table and all the supposed strings in the format are represented as an | ||
| // index (int32) of that string table. This is done to minimize overhead in memory and disk. | ||
|
|
||
| message Profile { | ||
| repeated ZincRun runs = 1; | ||
| repeated string string_table = 2; | ||
| } | ||
|
|
||
| message ZincRun { | ||
| InitialChanges initial = 1; | ||
| repeated CycleInvalidation cycles = 3; | ||
| } | ||
|
|
||
| message CycleInvalidation { | ||
| repeated int32 invalidated = 1; | ||
| repeated int32 invalidatedByPackageObjects = 2; | ||
| repeated int32 initialSources = 3; | ||
| repeated int32 invalidatedSources = 4; | ||
| repeated int32 recompiledClasses = 5; | ||
|
|
||
| int64 startTimeNanos = 6; // Start time of compilation (UTC) as nanoseconds past the epoch | ||
| int64 compilationDurationNanos = 7; // Duration of the compilation profile in nanoseconds | ||
| repeated ApiChange changesAfterRecompilation = 8; | ||
|
|
||
| repeated InvalidationEvent events = 9; | ||
| repeated int32 nextInvalidations = 10; | ||
| bool shouldCompileIncrementally = 11; | ||
| } | ||
|
|
||
| message InvalidationEvent { | ||
| string kind = 1; | ||
| repeated int32 inputs = 2; | ||
| repeated int32 outputs = 3; | ||
| string reason = 4; | ||
| } | ||
|
|
||
| message Changes { | ||
| repeated int32 added = 1; | ||
| repeated int32 removed = 2; | ||
| repeated int32 modified = 3; | ||
| } | ||
|
|
||
| message ApiChange { | ||
| int32 modifiedClass = 1; | ||
| string reason = 2; | ||
| repeated UsedName usedNames = 3; // Can be empty if the change is not related to names | ||
| } | ||
|
|
||
| message InitialChanges { | ||
| Changes changes = 1; | ||
| repeated int32 removedProducts = 2; | ||
| repeated int32 binaryDependencies = 3; | ||
| repeated ApiChange externalChanges = 4; | ||
| } | ||
|
|
||
| message UsedName { | ||
| int32 name = 1; | ||
| repeated Scope scopes = 2; | ||
| } | ||
|
|
||
| message Scope { | ||
| int32 kind = 1; | ||
| } | ||
90 changes: 0 additions & 90 deletions
90
internal/zinc-core/src/main/scala/sbt/internal/inc/ClassToSourceMapper.scala
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to add more documentation on the messages and the
zprof.protoproto file 😃Especially answering questions like