Merge changes from topics "dist-for-goals", "soong-dist", "tests-PathForSource" (1adc63ec) · Commits · e / os / android_build_soong

android/Android.bp

+1 −0

Original line number	Diff line number	Diff line
		@@ -36,6 +36,7 @@ bootstrap_go_package {
		"package_ctx.go",
		"path_properties.go",
		"paths.go",
		"phony.go",
		"prebuilt.go",
		"proto.go",
		"register.go",

android/config.go

+8 −0

Original line number	Diff line number	Diff line
		@@ -111,6 +111,10 @@ type config struct {
		fs pathtools.FileSystem
		mockBpList string

		// If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
		// in tests when a path doesn't exist.
		testAllowNonExistentPaths bool

		OncePer
		}

		@@ -230,6 +234,10 @@ func TestConfig(buildDir string, env map[string]string, bp string, fs map[string
		buildDir: buildDir,
		captureBuild: true,
		env: envCopy,

		// Set testAllowNonExistentPaths so that test contexts don't need to specify every path
		// passed to PathForSource or PathForModuleSrc.
		testAllowNonExistentPaths: true,
		}
		config.deviceConfig = &deviceConfig{
		config: config,

android/makevars.go

+111 −13

Original line number	Diff line number	Diff line
		@@ -17,12 +17,11 @@ package android
		import (
		"bytes"
		"fmt"
		"io/ioutil"
		"os"
		"strconv"
		"strings"

		"github.com/google/blueprint"
		"github.com/google/blueprint/pathtools"
		"github.com/google/blueprint/proptools"
		)

		@@ -84,6 +83,29 @@ type MakeVarsContext interface {
		// builder whenever a file matching the pattern as added or removed, without rerunning if a
		// file that does not match the pattern is added to a searched directory.
		GlobWithDeps(pattern string, excludes []string) ([]string, error)

		// Phony creates a phony rule in Make, which will allow additional DistForGoal
		// dependencies to be added to it. Phony can be called on the same name multiple
		// times to add additional dependencies.
		Phony(names string, deps ...Path)

		// DistForGoal creates a rule to copy one or more Paths to the artifacts
		// directory on the build server when the specified goal is built.
		DistForGoal(goal string, paths ...Path)

		// DistForGoalWithFilename creates a rule to copy a Path to the artifacts
		// directory on the build server with the given filename when the specified
		// goal is built.
		DistForGoalWithFilename(goal string, path Path, filename string)

		// DistForGoals creates a rule to copy one or more Paths to the artifacts
		// directory on the build server when any of the specified goals are built.
		DistForGoals(goals []string, paths ...Path)

		// DistForGoalsWithFilename creates a rule to copy a Path to the artifacts
		// directory on the build server with the given filename when any of the
		// specified goals are built.
		DistForGoalsWithFilename(goals []string, path Path, filename string)
		}

		var _ PathContext = MakeVarsContext(nil)
		@@ -133,6 +155,8 @@ type makeVarsContext struct {
		config Config
		pctx PackageContext
		vars []makeVarsVariable
		phonies []phony
		dists []dist
		}

		var _ MakeVarsContext = &makeVarsContext{}
		@@ -144,6 +168,16 @@ type makeVarsVariable struct {
		strict bool
		}

		type phony struct {
		name string
		deps []string
		}

		type dist struct {
		goals []string
		paths []string
		}

		func (s *makeVarsSingleton) GenerateBuildActions(ctx SingletonContext) {
		if !ctx.Config().EmbeddedInMake() {
		return
		@@ -152,11 +186,16 @@ func (s *makeVarsSingleton) GenerateBuildActions(ctx SingletonContext) {
		outFile := absolutePath(PathForOutput(ctx,
		"make_vars"+proptools.String(ctx.Config().productVariables.Make_suffix)+".mk").String())

		lateOutFile := absolutePath(PathForOutput(ctx,
		"late"+proptools.String(ctx.Config().productVariables.Make_suffix)+".mk").String())

		if ctx.Failed() {
		return
		}

		vars := []makeVarsVariable{}
		var vars []makeVarsVariable
		var dists []dist
		var phonies []phony
		for _, provider := range makeVarsProviders {
		mctx := &makeVarsContext{
		SingletonContext: ctx,
		@@ -166,6 +205,8 @@ func (s *makeVarsSingleton) GenerateBuildActions(ctx SingletonContext) {
		provider.call(mctx)

		vars = append(vars, mctx.vars...)
		phonies = append(phonies, mctx.phonies...)
		dists = append(dists, mctx.dists...)
		}

		if ctx.Failed() {
		@@ -174,17 +215,16 @@ func (s *makeVarsSingleton) GenerateBuildActions(ctx SingletonContext) {

		outBytes := s.writeVars(vars)

		if _, err := os.Stat(absolutePath(outFile)); err == nil {
		if data, err := ioutil.ReadFile(absolutePath(outFile)); err == nil {
		if bytes.Equal(data, outBytes) {
		return
		}
		}
		if err := pathtools.WriteFileIfChanged(outFile, outBytes, 0666); err != nil {
		ctx.Errorf(err.Error())
		}

		if err := ioutil.WriteFile(absolutePath(outFile), outBytes, 0666); err != nil {
		lateOutBytes := s.writeLate(phonies, dists)

		if err := pathtools.WriteFileIfChanged(lateOutFile, lateOutBytes, 0666); err != nil {
		ctx.Errorf(err.Error())
		}

		}

		func (s *makeVarsSingleton) writeVars(vars []makeVarsVariable) []byte {
		@@ -263,6 +303,33 @@ my_check_failed :=

		fmt.Fprintln(buf, "\nsoong-compare-var :=")

		fmt.Fprintln(buf)

		return buf.Bytes()
		}

		func (s *makeVarsSingleton) writeLate(phonies []phony, dists []dist) []byte {
		buf := &bytes.Buffer{}

		fmt.Fprint(buf, `# Autogenerated file

		# Values written by Soong read after parsing all Android.mk files.


		`)

		for _, phony := range phonies {
		fmt.Fprintf(buf, ".PHONY: %s\n", phony.name)
		fmt.Fprintf(buf, "%s: %s\n", phony.name, strings.Join(phony.deps, "\\\n "))
		}

		fmt.Fprintln(buf)

		for _, dist := range dists {
		fmt.Fprintf(buf, "$(call dist-for-goals,%s,%s)\n",
		strings.Join(dist.goals, " "), strings.Join(dist.paths, " "))
		}

		return buf.Bytes()
		}

		@@ -299,6 +366,17 @@ func (c *makeVarsContext) addVariable(name, ninjaStr string, strict, sort bool)
		c.addVariableRaw(name, value, strict, sort)
		}

		func (c *makeVarsContext) addPhony(name string, deps []string) {
		c.phonies = append(c.phonies, phony{name, deps})
		}

		func (c *makeVarsContext) addDist(goals []string, paths []string) {
		c.dists = append(c.dists, dist{
		goals: goals,
		paths: paths,
		})
		}

		func (c *makeVarsContext) Strict(name, ninjaStr string) {
		c.addVariable(name, ninjaStr, true, false)
		}
		@@ -318,3 +396,23 @@ func (c *makeVarsContext) CheckSorted(name, ninjaStr string) {
		func (c *makeVarsContext) CheckRaw(name, value string) {
		c.addVariableRaw(name, value, false, false)
		}

		func (c *makeVarsContext) Phony(name string, deps ...Path) {
		c.addPhony(name, Paths(deps).Strings())
		}

		func (c *makeVarsContext) DistForGoal(goal string, paths ...Path) {
		c.DistForGoals([]string{goal}, paths...)
		}

		func (c *makeVarsContext) DistForGoalWithFilename(goal string, path Path, filename string) {
		c.DistForGoalsWithFilename([]string{goal}, path, filename)
		}

		func (c *makeVarsContext) DistForGoals(goals []string, paths ...Path) {
		c.addDist(goals, Paths(paths).Strings())
		}

		func (c *makeVarsContext) DistForGoalsWithFilename(goals []string, path Path, filename string) {
		c.addDist(goals, []string{path.String() + ":" + filename})
		}

android/module.go

+32 −52

Original line number	Diff line number	Diff line
		@@ -207,6 +207,10 @@ type ModuleContext interface {
		// Similar to blueprint.ModuleContext.Build, but takes Paths instead of []string,
		// and performs more verification.
		Build(pctx PackageContext, params BuildParams)
		// Phony creates a Make-style phony rule, a rule with no commands that can depend on other
		// phony rules or real files. Phony can be called on the same name multiple times to add
		// additional dependencies.
		Phony(phony string, deps ...Path)

		PrimaryModule() Module
		FinalModule() Module
		@@ -722,6 +726,7 @@ type ModuleBase struct {
		installFiles InstallPaths
		checkbuildFiles Paths
		noticeFiles Paths
		phonies map[string]Paths

		// Used by buildTargetSingleton to create checkbuild and per-directory build targets
		// Only set on the final variant of each module
		@@ -1093,26 +1098,17 @@ func (m *ModuleBase) generateModuleTarget(ctx ModuleContext) {
		}

		if len(allInstalledFiles) > 0 {
		name := PathForPhony(ctx, namespacePrefix+ctx.ModuleName()+"-install")
		ctx.Build(pctx, BuildParams{
		Rule: blueprint.Phony,
		Output: name,
		Implicits: allInstalledFiles.Paths(),
		Default: !ctx.Config().EmbeddedInMake(),
		})
		deps = append(deps, name)
		m.installTarget = name
		name := namespacePrefix + ctx.ModuleName() + "-install"
		ctx.Phony(name, allInstalledFiles.Paths()...)
		m.installTarget = PathForPhony(ctx, name)
		deps = append(deps, m.installTarget)
		}

		if len(allCheckbuildFiles) > 0 {
		name := PathForPhony(ctx, namespacePrefix+ctx.ModuleName()+"-checkbuild")
		ctx.Build(pctx, BuildParams{
		Rule: blueprint.Phony,
		Output: name,
		Implicits: allCheckbuildFiles,
		})
		deps = append(deps, name)
		m.checkbuildTarget = name
		name := namespacePrefix + ctx.ModuleName() + "-checkbuild"
		ctx.Phony(name, allCheckbuildFiles...)
		m.checkbuildTarget = PathForPhony(ctx, name)
		deps = append(deps, m.checkbuildTarget)
		}

		if len(deps) > 0 {
		@@ -1121,12 +1117,7 @@ func (m *ModuleBase) generateModuleTarget(ctx ModuleContext) {
		suffix = "-soong"
		}

		name := PathForPhony(ctx, namespacePrefix+ctx.ModuleName()+suffix)
		ctx.Build(pctx, BuildParams{
		Rule: blueprint.Phony,
		Outputs: []WritablePath{name},
		Implicits: deps,
		})
		ctx.Phony(namespacePrefix+ctx.ModuleName()+suffix, deps...)

		m.blueprintDir = ctx.ModuleDir()
		}
		@@ -1313,6 +1304,9 @@ func (m *ModuleBase) GenerateBuildActions(blueprintCtx blueprint.ModuleContext)
		m.checkbuildFiles = append(m.checkbuildFiles, ctx.checkbuildFiles...)
		m.initRcPaths = PathsForModuleSrc(ctx, m.commonProperties.Init_rc)
		m.vintfFragmentsPaths = PathsForModuleSrc(ctx, m.commonProperties.Vintf_fragments)
		for k, v := range ctx.phonies {
		m.phonies[k] = append(m.phonies[k], v...)
		}
		} else if ctx.Config().AllowMissingDependencies() {
		// If the module is not enabled it will not create any build rules, nothing will call
		// ctx.GetMissingDependencies(), and blueprint will consider the missing dependencies to be unhandled
		@@ -1460,6 +1454,7 @@ type moduleContext struct {
		installFiles InstallPaths
		checkbuildFiles Paths
		module Module
		phonies map[string]Paths

		// For tests
		buildParams []BuildParams
		@@ -1574,6 +1569,11 @@ func (m *moduleContext) Build(pctx PackageContext, params BuildParams) {

		m.bp.Build(pctx.PackageContext, convertBuildParams(params))
		}

		func (m *moduleContext) Phony(name string, deps ...Path) {
		addPhony(m.config, name, deps...)
		}

		func (m *moduleContext) GetMissingDependencies() []string {
		var missingDeps []string
		missingDeps = append(missingDeps, m.Module().base().commonProperties.MissingDeps...)
		@@ -2233,9 +2233,8 @@ type buildTargetSingleton struct{}
		func (c *buildTargetSingleton) GenerateBuildActions(ctx SingletonContext) {
		var checkbuildDeps Paths

		mmTarget := func(dir string) WritablePath {
		return PathForPhony(ctx,
		"MODULES-IN-"+strings.Replace(filepath.Clean(dir), "/", "-", -1))
		mmTarget := func(dir string) string {
		return "MODULES-IN-" + strings.Replace(filepath.Clean(dir), "/", "-", -1)
		}

		modulesInDir := make(map[string]Paths)
		@@ -2261,11 +2260,7 @@ func (c *buildTargetSingleton) GenerateBuildActions(ctx SingletonContext) {
		}

		// Create a top-level checkbuild target that depends on all modules
		ctx.Build(pctx, BuildParams{
		Rule: blueprint.Phony,
		Output: PathForPhony(ctx, "checkbuild"+suffix),
		Implicits: checkbuildDeps,
		})
		ctx.Phony("checkbuild"+suffix, checkbuildDeps...)

		// Make will generate the MODULES-IN-* targets
		if ctx.Config().EmbeddedInMake() {
		@@ -2289,7 +2284,7 @@ func (c *buildTargetSingleton) GenerateBuildActions(ctx SingletonContext) {
		for _, dir := range dirs {
		p := parentDir(dir)
		if p != "." && p != "/" {
		modulesInDir[p] = append(modulesInDir[p], mmTarget(dir))
		modulesInDir[p] = append(modulesInDir[p], PathForPhony(ctx, mmTarget(dir)))
		}
		}

		@@ -2297,14 +2292,7 @@ func (c *buildTargetSingleton) GenerateBuildActions(ctx SingletonContext) {
		// depends on the MODULES-IN-* targets of all of its subdirectories that contain Android.bp
		// files.
		for _, dir := range dirs {
		ctx.Build(pctx, BuildParams{
		Rule: blueprint.Phony,
		Output: mmTarget(dir),
		Implicits: modulesInDir[dir],
		// HACK: checkbuild should be an optional build, but force it
		// enabled for now in standalone builds
		Default: !ctx.Config().EmbeddedInMake(),
		})
		ctx.Phony(mmTarget(dir), modulesInDir[dir]...)
		}

		// Create (host\|host-cross\|target)-<OS> phony rules to build a reduced checkbuild.
		@@ -2331,23 +2319,15 @@ func (c *buildTargetSingleton) GenerateBuildActions(ctx SingletonContext) {
		continue
		}

		name := PathForPhony(ctx, className+"-"+os.Name)
		osClass[className] = append(osClass[className], name)
		name := className + "-" + os.Name
		osClass[className] = append(osClass[className], PathForPhony(ctx, name))

		ctx.Build(pctx, BuildParams{
		Rule: blueprint.Phony,
		Output: name,
		Implicits: deps,
		})
		ctx.Phony(name, deps...)
		}

		// Wrap those into host\|host-cross\|target phony rules
		for _, class := range SortedStringKeys(osClass) {
		ctx.Build(pctx, BuildParams{
		Rule: blueprint.Phony,
		Output: PathForPhony(ctx, class),
		Implicits: osClass[class],
		})
		ctx.Phony(class, osClass[class]...)
		}
		}

android/paths.go

+2 −2

Original line number	Diff line number	Diff line
		@@ -405,7 +405,7 @@ func expandOneSrcPath(ctx ModuleContext, s string, expandedExcludes []string) (P
		p := pathForModuleSrc(ctx, s)
		if exists, _, err := ctx.Config().fs.Exists(p.String()); err != nil {
		reportPathErrorf(ctx, "%s: %s", p, err.Error())
		} else if !exists {
		} else if !exists && !ctx.Config().testAllowNonExistentPaths {
		reportPathErrorf(ctx, "module source path %q does not exist", p)
		}

		@@ -798,7 +798,7 @@ func PathForSource(ctx PathContext, pathComponents ...string) SourcePath {
		}
		} else if exists, _, err := ctx.Config().fs.Exists(path.String()); err != nil {
		reportPathErrorf(ctx, "%s: %s", path, err.Error())
		} else if !exists {
		} else if !exists && !ctx.Config().testAllowNonExistentPaths {
		reportPathErrorf(ctx, "source path %q does not exist", path)
		}
		return path