Merge changes from topic "sdk_repo_license" (97cffec5) · Commits · e / os / android_build_soong

android/license_metadata.go

+38 −15

Original line number	Diff line number	Diff line
		@@ -34,7 +34,7 @@ var (
		}, "args")
		)

		func buildLicenseMetadata(ctx ModuleContext) {
		func buildLicenseMetadata(ctx ModuleContext, licenseMetadataFile WritablePath) {
		base := ctx.Module().base()

		if !base.Enabled() {
		@@ -45,9 +45,18 @@ func buildLicenseMetadata(ctx ModuleContext) {
		return
		}

		var outputFiles Paths
		if outputFileProducer, ok := ctx.Module().(OutputFileProducer); ok {
		outputFiles, _ = outputFileProducer.OutputFiles("")
		outputFiles = PathsIfNonNil(outputFiles...)
		}

		isContainer := isContainerFromFileExtensions(base.installFiles, outputFiles)

		var allDepMetadataFiles Paths
		var allDepMetadataArgs []string
		var allDepOutputFiles Paths
		var allDepMetadataDepSets []*PathsDepSet

		ctx.VisitDirectDepsBlueprint(func(bpdep blueprint.Module) {
		dep, _ := bpdep.(Module)
		@@ -61,6 +70,9 @@ func buildLicenseMetadata(ctx ModuleContext) {
		if ctx.OtherModuleHasProvider(dep, LicenseMetadataProvider) {
		info := ctx.OtherModuleProvider(dep, LicenseMetadataProvider).(*LicenseMetadataInfo)
		allDepMetadataFiles = append(allDepMetadataFiles, info.LicenseMetadataPath)
		if isContainer \|\| IsInstallDepNeeded(ctx.OtherModuleDependencyTag(dep)) {
		allDepMetadataDepSets = append(allDepMetadataDepSets, info.LicenseMetadataDepSet)
		}

		depAnnotations := licenseAnnotationsFromTag(ctx.OtherModuleDependencyTag(dep))

		@@ -105,9 +117,16 @@ func buildLicenseMetadata(ctx ModuleContext) {
		args = append(args,
		JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(base.commonProperties.Effective_license_text.Strings()), "-n "))

		if isContainer {
		transitiveDeps := newPathsDepSet(nil, allDepMetadataDepSets).ToList()
		args = append(args,
		JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(transitiveDeps.Strings()), "-d "))
		orderOnlyDeps = append(orderOnlyDeps, transitiveDeps...)
		} else {
		args = append(args,
		JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(allDepMetadataArgs), "-d "))
		orderOnlyDeps = append(orderOnlyDeps, allDepMetadataFiles...)
		}

		args = append(args,
		JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(allDepOutputFiles.Strings()), "-s "))
		@@ -117,12 +136,6 @@ func buildLicenseMetadata(ctx ModuleContext) {
		JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(base.licenseInstallMap), "-m "))

		// Built files
		var outputFiles Paths
		if outputFileProducer, ok := ctx.Module().(OutputFileProducer); ok {
		outputFiles, _ = outputFileProducer.OutputFiles("")
		outputFiles = PathsIfNonNil(outputFiles...)
		}

		if len(outputFiles) > 0 {
		args = append(args,
		JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(outputFiles.Strings()), "-t "))
		@@ -134,13 +147,10 @@ func buildLicenseMetadata(ctx ModuleContext) {
		args = append(args,
		JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(base.installFiles.Strings()), "-i "))

		isContainer := isContainerFromFileExtensions(base.installFiles, outputFiles)
		if isContainer {
		args = append(args, "--is_container")
		}

		licenseMetadataFile := PathForModuleOut(ctx, "meta_lic")

		ctx.Build(pctx, BuildParams{
		Rule: licenseMetadataRule,
		Output: licenseMetadataFile,
		@@ -153,6 +163,7 @@ func buildLicenseMetadata(ctx ModuleContext) {

		ctx.SetProvider(LicenseMetadataProvider, &LicenseMetadataInfo{
		LicenseMetadataPath: licenseMetadataFile,
		LicenseMetadataDepSet: newPathsDepSet(Paths{licenseMetadataFile}, allDepMetadataDepSets),
		})
		}

		@@ -180,6 +191,7 @@ var LicenseMetadataProvider = blueprint.NewProvider(&LicenseMetadataInfo{})
		// LicenseMetadataInfo stores the license metadata path for a module.
		type LicenseMetadataInfo struct {
		LicenseMetadataPath Path
		LicenseMetadataDepSet *PathsDepSet
		}

		// licenseAnnotationsFromTag returns the LicenseAnnotations for a tag (if any) converted into
		@@ -212,6 +224,9 @@ const (
		// LicenseAnnotationSharedDependency should be returned by LicenseAnnotations implementations
		// of dependency tags when the usage of the dependency is dynamic, for example a shared library
		// linkage for native modules or as a classpath library for java modules.
		//
		// Dependency tags that need to always return LicenseAnnotationSharedDependency
		// can embed LicenseAnnotationSharedDependencyTag to implement LicenseAnnotations.
		LicenseAnnotationSharedDependency LicenseAnnotation = "dynamic"

		// LicenseAnnotationToolchain should be returned by LicenseAnnotations implementations of
		@@ -222,6 +237,14 @@ const (
		LicenseAnnotationToolchain LicenseAnnotation = "toolchain"
		)

		// LicenseAnnotationSharedDependencyTag can be embedded in a dependency tag to implement
		// LicenseAnnotations that always returns LicenseAnnotationSharedDependency.
		type LicenseAnnotationSharedDependencyTag struct{}

		func (LicenseAnnotationSharedDependencyTag) LicenseAnnotations() []LicenseAnnotation {
		return []LicenseAnnotation{LicenseAnnotationSharedDependency}
		}

		// LicenseAnnotationToolchainDependencyTag can be embedded in a dependency tag to implement
		// LicenseAnnotations that always returns LicenseAnnotationToolchain.
		type LicenseAnnotationToolchainDependencyTag struct{}

android/module.go

+6 −1

Original line number	Diff line number	Diff line
		@@ -1321,6 +1321,9 @@ type ModuleBase struct {
		// set of dependency module:location mappings used to populate the license metadata for
		// apex containers.
		licenseInstallMap []string

		// The path to the generated license metadata file for the module.
		licenseMetadataFile WritablePath
		}

		// A struct containing all relevant information about a Bazel target converted via bp2build.
		@@ -2076,6 +2079,8 @@ func (m *ModuleBase) GenerateBuildActions(blueprintCtx blueprint.ModuleContext)
		variables: make(map[string]string),
		}

		m.licenseMetadataFile = PathForModuleOut(ctx, "meta_lic")

		dependencyInstallFiles, dependencyPackagingSpecs := m.computeInstallDeps(ctx)
		// set m.installFilesDepSet to only the transitive dependencies to be used as the dependencies
		// of installed files of this module. It will be replaced by a depset including the installed
		@@ -2207,7 +2212,7 @@ func (m *ModuleBase) GenerateBuildActions(blueprintCtx blueprint.ModuleContext)
		m.installFilesDepSet = newInstallPathsDepSet(m.installFiles, dependencyInstallFiles)
		m.packagingSpecsDepSet = newPackagingSpecsDepSet(m.packagingSpecs, dependencyPackagingSpecs)

		buildLicenseMetadata(ctx)
		buildLicenseMetadata(ctx, m.licenseMetadataFile)

		m.buildParams = ctx.buildParams
		m.ruleParams = ctx.ruleParams

android/notices.go

+12 −51

Original line number	Diff line number	Diff line
		@@ -16,6 +16,7 @@ package android

		import (
		"path/filepath"
		"strings"

		"github.com/google/blueprint"
		)
		@@ -101,55 +102,15 @@ func BuildNoticeOutput(ctx ModuleContext, installPath InstallPath, installFilena
		}
		}

		// BuildNotices merges the supplied NOTICE files into a single file that lists notices
		// for every key in noticeMap (which would normally be installed files).
		func BuildNotices(ctx ModuleContext, noticeMap map[string]Paths) NoticeOutputs {
		// TODO(jungjw): We should just produce a well-formatted NOTICE.html file in a single pass.
		//
		// generate-notice-files.py, which processes the merged NOTICE file, has somewhat strict rules
		// about input NOTICE file paths.
		// 1. Their relative paths to the src root become their NOTICE index titles. We want to use
		// on-device paths as titles, and so output the merged NOTICE file the corresponding location.
		// 2. They must end with .txt extension. Otherwise, they're ignored.

		mergeTool := PathForSource(ctx, "build/soong/scripts/mergenotice.py")
		generateNoticeTool := PathForSource(ctx, "build/soong/scripts/generate-notice-files.py")

		outputDir := PathForModuleOut(ctx, "notices")
		builder := NewRuleBuilder(pctx, ctx).
		Sbox(outputDir, PathForModuleOut(ctx, "notices.sbox.textproto"))
		for _, installPath := range SortedStringKeys(noticeMap) {
		noticePath := outputDir.Join(ctx, installPath+".txt")
		// It would be nice if sbox created directories for temporaries, but until then
		// this is simple enough.
		builder.Command().
		Text("(cd").OutputDir().Text("&&").
		Text("mkdir -p").Text(filepath.Dir(installPath)).Text(")")
		builder.Temporary(noticePath)
		builder.Command().
		Tool(mergeTool).
		Flag("--output").Output(noticePath).
		Inputs(noticeMap[installPath])
		}

		// Transform the merged NOTICE file into a gzipped HTML file.
		txtOutput := outputDir.Join(ctx, "NOTICE.txt")
		htmlOutput := outputDir.Join(ctx, "NOTICE.html")
		htmlGzOutput := outputDir.Join(ctx, "NOTICE.html.gz")
		title := "\"Notices for " + ctx.ModuleName() + "\""
		builder.Command().Tool(generateNoticeTool).
		FlagWithOutput("--text-output ", txtOutput).
		FlagWithOutput("--html-output ", htmlOutput).
		FlagWithArg("-t ", title).
		Flag("-s").OutputDir()
		builder.Command().BuiltTool("minigzip").
		FlagWithInput("-c ", htmlOutput).
		FlagWithOutput("> ", htmlGzOutput)
		builder.Build("build_notices", "generate notice output")

		return NoticeOutputs{
		TxtOutput: OptionalPathForPath(txtOutput),
		HtmlOutput: OptionalPathForPath(htmlOutput),
		HtmlGzOutput: OptionalPathForPath(htmlGzOutput),
		}
		// BuildNoticeTextOutputFromLicenseMetadata writes out a notice text file based on the module's
		// generated license metadata file.
		func BuildNoticeTextOutputFromLicenseMetadata(ctx ModuleContext, outputFile WritablePath) {
		depsFile := outputFile.ReplaceExtension(ctx, strings.TrimPrefix(outputFile.Ext()+".d", "."))
		rule := NewRuleBuilder(pctx, ctx)
		rule.Command().
		BuiltTool("textnotice").
		FlagWithOutput("-o ", outputFile).
		FlagWithDepFile("-d ", depsFile).
		Input(ctx.Module().base().licenseMetadataFile)
		rule.Build("container_notice", "container notice file")
		}

android/paths.go

+20 −0

Original line number	Diff line number	Diff line
		@@ -2149,3 +2149,23 @@ func IsThirdPartyPath(path string) bool {
		}
		return false
		}

		// PathsDepSet is a thin type-safe wrapper around the generic depSet. It always uses
		// topological order.
		type PathsDepSet struct {
		depSet
		}

		// newPathsDepSet returns an immutable PathsDepSet with the given direct and
		// transitive contents.
		func newPathsDepSet(direct Paths, transitive []PathsDepSet) PathsDepSet {
		return &PathsDepSet{*newDepSet(TOPOLOGICAL, direct, transitive)}
		}

		// ToList returns the PathsDepSet flattened to a list in topological order.
		func (d *PathsDepSet) ToList() Paths {
		if d == nil {
		return nil
		}
		return d.depSet.ToList().(Paths)
		}

android_sdk/sdk_repo_host.go

+3 −10

Original line number	Diff line number	Diff line
		@@ -122,17 +122,10 @@ func (s *sdkRepoHost) GenerateAndroidBuildActions(ctx android.ModuleContext) {

		s.CopySpecsToDir(ctx, builder, packageSpecs, dir)

		// Collect licenses to write into NOTICE.txt
		noticeMap := map[string]android.Paths{}
		for path, pkgSpec := range packageSpecs {
		licenseFiles := pkgSpec.EffectiveLicenseFiles()
		if len(licenseFiles) > 0 {
		noticeMap[path] = pkgSpec.EffectiveLicenseFiles()
		}
		}
		notices := android.BuildNotices(ctx, noticeMap)
		noticeFile := android.PathForModuleOut(ctx, "NOTICES.txt")
		android.BuildNoticeTextOutputFromLicenseMetadata(ctx, noticeFile)
		builder.Command().Text("cp").
		Input(notices.TxtOutput.Path()).
		Input(noticeFile).
		Text(filepath.Join(dir.String(), "NOTICE.txt"))

		// Handle `merge_zips` by extracting their contents into our tmpdir