Never prune seed packages from build #295
Merged
Conversation
This file contains 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
In a split build, three rounds of dependency resolution occur: 1. Master set (all packages in the build) 2. Loader set 3. App set Each round produces new ResolvePackage objects. Conceptually, this is wrong, since the loader set and app set are meant to share packages, not duplicate them. This was causing a problem during API resolution: the Resolution object maps API names to *ResolvePackage, with the package pointers coming from the master set. During rounds 2 and 3, lookups in this map yield packages that don't exist in the current working set, resulting in this error: ``` Error: Unexpected unsatisfied API: foo; required by: bar ```
This is a fix for split images.
During dependency resolution, newt executes a phase called "imposter
pruning." A package is an imposter if it is in the dependency graph by
virtue of its own syscfg defines and overrides. For example, say we
have a package `foo`:
```
pkg.name: foo
syscfg.defs:
FOO_SETTING:
value: 1
```
Then we have a BSP package:
```
pkg.name: my_bsp
pkg.deps.FOO_SETTING:
- foo
```
If this is the only dependency on `foo`, then `foo` is an imposter. It
should be removed from the graph, and its syscfg defines and overrides
should be deleted.
This commit changes this procedure slightly. Now, only
*non-seed-packages* are subject to imposter pruning. This change is
necessary due to the way newt builds split images. A split image
consits of two parts: 1) loader, and 2) application. The loader is
self-contained, whereas the application is allowed to depend on packages
in the loader. When newt builds the application, it considers all the
packages in the loader to be seed packages for the application. Since
all these packages are guaranteed to be present (they are already built
in to the loader), they must not be pruned.
The fix is to never prune seed packages. While this fix specifically
addresses split images, conceptually it makes sense to never prune seed
packages for non-split builds as well. If the `project.yml` file points
to a package, that package should be included, even if newt thinks it is
not needed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
NOTE: This PR includes #293 (another split image fix). That one should be merged before this.
This is a fix for split images.
During dependency resolution, newt executes a phase called "imposter pruning." A package is an imposter if it is in the dependency graph by virtue of its own syscfg defines and overrides. For example, say we have a package
foo:Then we have a BSP package:
If this is the only dependency on
foo, thenfoois an imposter. It should be removed from the graph, and its syscfg defines and overrides should be deleted.This commit changes this procedure slightly. Now, only non-seed-packages are subject to imposter pruning. This change is necessary due to the way newt builds split images. A split image consits of two parts: 1) loader, and 2) application. The loader is self-contained, whereas the application is allowed to depend on packages in the loader. When newt builds the application, it considers all the packages in the loader to be seed packages for the application. Since all these packages are guaranteed to be present (they are already built in to the loader), they must not be pruned.
The fix is to never prune seed packages. While this fix specifically addresses split images, conceptually it makes sense to never prune seed packages for non-split builds as well. If the
project.ymlfile points to a package, that package should be included, even if newt thinks it is not needed.