diff options
author | Justin Yun <justinyun@google.com> | 2023-04-11 18:20:07 +0900 |
---|---|---|
committer | Justin Yun <justinyun@google.com> | 2023-04-26 11:27:34 +0900 |
commit | 2b6b7af8f4c760860331352fedd10029b3a79928 (patch) | |
tree | 3533419cc315b8c96365def39c502d534de3ba82 | |
parent | 07d931980b4607ada6462c3794e90476f09dd81c (diff) | |
download | soong-2b6b7af8f4c760860331352fedd10029b3a79928.tar.gz |
Include license information for vendor and host snapshots
In addition to the license text files, include license kinds
information to json file. Also, use the original paths of license
text files that are copied to NOTICE_FILES directory.
This will be used when generating snapshots from the snapshot build.
Bug: 271539873
Test: m vendor-snapshot
Merged-In: I0c0427bb66f2c1fca322d5554aa66220a3b62fb3
Change-Id: I0c0427bb66f2c1fca322d5554aa66220a3b62fb3
(cherry picked from commit 1db9748805147a69792b2a1a556689253c5b82f6)
-rw-r--r-- | cc/util.go | 11 | ||||
-rw-r--r-- | cc/vendor_snapshot.go | 19 | ||||
-rw-r--r-- | etc/prebuilt_etc.go | 27 | ||||
-rw-r--r-- | snapshot/host_snapshot.go | 18 | ||||
-rw-r--r-- | snapshot/snapshot.go | 28 | ||||
-rw-r--r-- | snapshot/snapshot_base.go | 15 | ||||
-rw-r--r-- | snapshot/util.go | 16 |
7 files changed, 80 insertions, 54 deletions
diff --git a/cc/util.go b/cc/util.go index aa0f6b5d6..6d8ac435f 100644 --- a/cc/util.go +++ b/cc/util.go @@ -100,17 +100,6 @@ func makeSymlinkCmd(linkDirOnDevice string, linkName string, target string) stri "ln -sf " + target + " " + filepath.Join(dir, linkName) } -func combineNoticesRule(ctx android.SingletonContext, paths android.Paths, out string) android.OutputPath { - outPath := android.PathForOutput(ctx, out) - ctx.Build(pctx, android.BuildParams{ - Rule: android.Cat, - Inputs: paths, - Output: outPath, - Description: "combine notices for " + out, - }) - return outPath -} - // Dump a map to a list file as: // // {key1} {value1} diff --git a/cc/vendor_snapshot.go b/cc/vendor_snapshot.go index aed37753a..e6e566025 100644 --- a/cc/vendor_snapshot.go +++ b/cc/vendor_snapshot.go @@ -160,7 +160,7 @@ type snapshotJsonFlags struct { MinSdkVersion string `json:",omitempty"` } -var ccSnapshotAction snapshot.GenerateSnapshotAction = func(s snapshot.SnapshotSingleton, ctx android.SingletonContext, snapshotArchDir string) android.Paths { +var ccSnapshotAction snapshot.GenerateSnapshotAction = func(s snapshot.SnapshotSingleton, ctx android.SingletonContext, snapshotArchDir string) snapshot.SnapshotPaths { /* Vendor snapshot zipped artifacts directory structure for cc modules: {SNAPSHOT_ARCH}/ @@ -195,10 +195,10 @@ var ccSnapshotAction snapshot.GenerateSnapshotAction = func(s snapshot.SnapshotS */ var snapshotOutputs android.Paths + var snapshotNotices android.Paths includeDir := filepath.Join(snapshotArchDir, "include") configsDir := filepath.Join(snapshotArchDir, "configs") - noticeDir := filepath.Join(snapshotArchDir, "NOTICE_FILES") installedNotices := make(map[string]bool) installedConfigs := make(map[string]bool) @@ -228,7 +228,7 @@ var ccSnapshotAction snapshot.GenerateSnapshotAction = func(s snapshot.SnapshotS prop := snapshotJsonFlags{} // Common properties among snapshots. - prop.ModuleName = ctx.ModuleName(m) + prop.InitBaseSnapshotPropsWithName(m, ctx.ModuleName(m)) if supportsVndkExt(s.Image) && m.IsVndkExt() { // vndk exts are installed to /vendor/lib(64)?/vndk(-sp)? if m.IsVndkSp() { @@ -406,13 +406,10 @@ var ccSnapshotAction snapshot.GenerateSnapshotAction = func(s snapshot.SnapshotS headers = append(headers, m.SnapshotHeaders()...) } - if len(m.EffectiveLicenseFiles()) > 0 { - noticeName := ctx.ModuleName(m) + ".txt" - noticeOut := filepath.Join(noticeDir, noticeName) - // skip already copied notice file - if !installedNotices[noticeOut] { - installedNotices[noticeOut] = true - snapshotOutputs = append(snapshotOutputs, combineNoticesRule(ctx, m.EffectiveLicenseFiles(), noticeOut)) + for _, notice := range m.EffectiveLicenseFiles() { + if _, ok := installedNotices[notice.String()]; !ok { + installedNotices[notice.String()] = true + snapshotNotices = append(snapshotNotices, notice) } } }) @@ -422,7 +419,7 @@ var ccSnapshotAction snapshot.GenerateSnapshotAction = func(s snapshot.SnapshotS snapshotOutputs = append(snapshotOutputs, copyFile(ctx, header, filepath.Join(includeDir, header.String()), s.Fake)) } - return snapshotOutputs + return snapshot.SnapshotPaths{OutputFiles: snapshotOutputs, NoticeFiles: snapshotNotices} } func init() { diff --git a/etc/prebuilt_etc.go b/etc/prebuilt_etc.go index dcd7fdcb9..6817dcef0 100644 --- a/etc/prebuilt_etc.go +++ b/etc/prebuilt_etc.go @@ -617,7 +617,7 @@ func isSnapshotAware(ctx android.SingletonContext, m *PrebuiltEtc, image snapsho return true } -func generatePrebuiltSnapshot(s snapshot.SnapshotSingleton, ctx android.SingletonContext, snapshotArchDir string) android.Paths { +func generatePrebuiltSnapshot(s snapshot.SnapshotSingleton, ctx android.SingletonContext, snapshotArchDir string) snapshot.SnapshotPaths { /* Snapshot zipped artifacts directory structure for etc modules: {SNAPSHOT_ARCH}/ @@ -631,7 +631,7 @@ func generatePrebuiltSnapshot(s snapshot.SnapshotSingleton, ctx android.Singleto (notice files) */ var snapshotOutputs android.Paths - noticeDir := filepath.Join(snapshotArchDir, "NOTICE_FILES") + var snapshotNotices android.Paths installedNotices := make(map[string]bool) ctx.VisitAllModules(func(module android.Module) { @@ -651,7 +651,7 @@ func generatePrebuiltSnapshot(s snapshot.SnapshotSingleton, ctx android.Singleto prop := snapshot.SnapshotJsonFlags{} propOut := snapshotLibOut + ".json" - prop.ModuleName = m.BaseModuleName() + prop.InitBaseSnapshotProps(m) if m.subdirProperties.Relative_install_path != nil { prop.RelativeInstallPath = *m.subdirProperties.Relative_install_path } @@ -667,27 +667,16 @@ func generatePrebuiltSnapshot(s snapshot.SnapshotSingleton, ctx android.Singleto } snapshotOutputs = append(snapshotOutputs, snapshot.WriteStringToFileRule(ctx, string(j), propOut)) - if len(m.EffectiveLicenseFiles()) > 0 { - noticeName := ctx.ModuleName(m) + ".txt" - noticeOut := filepath.Join(noticeDir, noticeName) - // skip already copied notice file - if !installedNotices[noticeOut] { - installedNotices[noticeOut] = true - - noticeOutPath := android.PathForOutput(ctx, noticeOut) - ctx.Build(pctx, android.BuildParams{ - Rule: android.Cat, - Inputs: m.EffectiveLicenseFiles(), - Output: noticeOutPath, - Description: "combine notices for " + noticeOut, - }) - snapshotOutputs = append(snapshotOutputs, noticeOutPath) + for _, notice := range m.EffectiveLicenseFiles() { + if _, ok := installedNotices[notice.String()]; !ok { + installedNotices[notice.String()] = true + snapshotNotices = append(snapshotNotices, notice) } } }) - return snapshotOutputs + return snapshot.SnapshotPaths{OutputFiles: snapshotOutputs, NoticeFiles: snapshotNotices} } // For Bazel / bp2build diff --git a/snapshot/host_snapshot.go b/snapshot/host_snapshot.go index 9793218a3..edcc16348 100644 --- a/snapshot/host_snapshot.go +++ b/snapshot/host_snapshot.go @@ -96,6 +96,7 @@ func (f *hostSnapshot) CreateMetaData(ctx android.ModuleContext, fileName string var jsonData []SnapshotJsonFlags var metaPaths android.Paths + installedNotices := make(map[string]bool) metaZipFile := android.PathForModuleOut(ctx, fileName).OutputPath // Create JSON file based on the direct dependencies @@ -104,12 +105,14 @@ func (f *hostSnapshot) CreateMetaData(ctx android.ModuleContext, fileName string if desc != nil { jsonData = append(jsonData, *desc) } - if len(dep.EffectiveLicenseFiles()) > 0 { - noticeFile := android.PathForModuleOut(ctx, "NOTICE_FILES", dep.Name()+".txt").OutputPath - android.CatFileRule(ctx, dep.EffectiveLicenseFiles(), noticeFile) - metaPaths = append(metaPaths, noticeFile) + for _, notice := range dep.EffectiveLicenseFiles() { + if _, ok := installedNotices[notice.String()]; !ok { + installedNotices[notice.String()] = true + noticeOut := android.PathForModuleOut(ctx, "NOTICE_FILES", notice.String()).OutputPath + CopyFileToOutputPathRule(pctx, ctx, notice, noticeOut) + metaPaths = append(metaPaths, noticeOut) + } } - }) // Sort notice paths and json data for repeatble build sort.Slice(jsonData, func(i, j int) bool { @@ -220,8 +223,7 @@ func hostJsonDesc(m android.Module) *SnapshotJsonFlags { } if path.Valid() && path.String() != "" { - return &SnapshotJsonFlags{ - ModuleName: m.Name(), + props := &SnapshotJsonFlags{ ModuleStemName: moduleStem, Filename: path.String(), Required: append(m.HostRequiredModuleNames(), m.RequiredModuleNames()...), @@ -229,6 +231,8 @@ func hostJsonDesc(m android.Module) *SnapshotJsonFlags { RustProcMacro: procMacro, CrateName: crateName, } + props.InitBaseSnapshotProps(m) + return props } return nil } diff --git a/snapshot/snapshot.go b/snapshot/snapshot.go index 206ecc947..c95a53774 100644 --- a/snapshot/snapshot.go +++ b/snapshot/snapshot.go @@ -26,6 +26,10 @@ import ( var pctx = android.NewPackageContext("android/soong/snapshot") +func init() { + pctx.Import("android/soong/android") +} + type SnapshotSingleton struct { // Name, e.g., "vendor", "recovery", "ramdisk". name string @@ -48,8 +52,18 @@ type SnapshotSingleton struct { Fake bool } +// The output files to be included in the snapshot. +type SnapshotPaths struct { + // All files to be included in the snapshot + OutputFiles android.Paths + + // Notice files of the snapshot output files + NoticeFiles android.Paths +} + // Interface of function to capture snapshot from each module -type GenerateSnapshotAction func(snapshot SnapshotSingleton, ctx android.SingletonContext, snapshotArchDir string) android.Paths +// Returns snapshot ouputs and notice files. +type GenerateSnapshotAction func(snapshot SnapshotSingleton, ctx android.SingletonContext, snapshotArchDir string) SnapshotPaths var snapshotActionList []GenerateSnapshotAction @@ -74,9 +88,19 @@ func (c *SnapshotSingleton) GenerateBuildActions(ctx android.SingletonContext) { snapshotDir = filepath.Join("fake", snapshotDir) } snapshotArchDir := filepath.Join(snapshotDir, ctx.DeviceConfig().DeviceArch()) + noticeDir := filepath.Join(snapshotArchDir, "NOTICE_FILES") + installedNotices := make(map[string]bool) for _, f := range snapshotActionList { - snapshotOutputs = append(snapshotOutputs, f(*c, ctx, snapshotArchDir)...) + snapshotPaths := f(*c, ctx, snapshotArchDir) + snapshotOutputs = append(snapshotOutputs, snapshotPaths.OutputFiles...) + for _, notice := range snapshotPaths.NoticeFiles { + if _, ok := installedNotices[notice.String()]; !ok { + installedNotices[notice.String()] = true + snapshotOutputs = append(snapshotOutputs, CopyFileRule( + pctx, ctx, notice, filepath.Join(noticeDir, notice.String()))) + } + } } // All artifacts are ready. Sort them to normalize ninja and then zip. diff --git a/snapshot/snapshot_base.go b/snapshot/snapshot_base.go index 809ca3d11..fb4ee0c83 100644 --- a/snapshot/snapshot_base.go +++ b/snapshot/snapshot_base.go @@ -120,4 +120,19 @@ type SnapshotJsonFlags struct { // dependencies Required []string `json:",omitempty"` Overrides []string `json:",omitempty"` + + // license information + LicenseKinds []string `json:",omitempty"` + LicenseTexts []string `json:",omitempty"` +} + +func (prop *SnapshotJsonFlags) InitBaseSnapshotPropsWithName(m android.Module, name string) { + prop.ModuleName = name + + prop.LicenseKinds = m.EffectiveLicenseKinds() + prop.LicenseTexts = m.EffectiveLicenseFiles().Strings() +} + +func (prop *SnapshotJsonFlags) InitBaseSnapshotProps(m android.Module) { + prop.InitBaseSnapshotPropsWithName(m, m.Name()) } diff --git a/snapshot/util.go b/snapshot/util.go index 806ac90fa..c87c508e6 100644 --- a/snapshot/util.go +++ b/snapshot/util.go @@ -21,17 +21,25 @@ func WriteStringToFileRule(ctx android.SingletonContext, content, out string) an return outPath } -func CopyFileRule(pctx android.PackageContext, ctx android.SingletonContext, path android.Path, out string) android.OutputPath { - outPath := android.PathForOutput(ctx, out) +type buildContext interface { + Build(pctx android.PackageContext, params android.BuildParams) +} + +func CopyFileToOutputPathRule(pctx android.PackageContext, ctx buildContext, path android.Path, outPath android.OutputPath) { ctx.Build(pctx, android.BuildParams{ Rule: android.Cp, Input: path, Output: outPath, - Description: "copy " + path.String() + " -> " + out, + Description: "copy " + path.String() + " -> " + outPath.String(), Args: map[string]string{ - "cpFlags": "-f -L", + "cpFlags": "-L", }, }) +} + +func CopyFileRule(pctx android.PackageContext, ctx android.SingletonContext, path android.Path, out string) android.OutputPath { + outPath := android.PathForOutput(ctx, out) + CopyFileToOutputPathRule(pctx, ctx, path, outPath) return outPath } |