Separate creation of signature patterns from overlap checking am: 67b9d61ac2 am: 0623c3e8f9 (b32b624d) · Commits · e / os / android_build_soong

apex/platform_bootclasspath_test.go

+3 −2

Original line number	Diff line number	Diff line
		@@ -159,11 +159,12 @@ func TestPlatformBootclasspath_Fragments(t *testing.T) {
		android.AssertPathsRelativeToTopEquals(t, message, expected, info.FlagsFilesByCategory[category])
		}

		android.AssertPathsRelativeToTopEquals(t, "stub flags", []string{"out/soong/.intermediates/bar-fragment/android_common_apex10000/modular-hiddenapi/stub-flags.csv"}, info.StubFlagsPaths)
		android.AssertPathsRelativeToTopEquals(t, "annotation flags", []string{"out/soong/.intermediates/bar-fragment/android_common_apex10000/modular-hiddenapi/annotation-flags.csv"}, info.AnnotationFlagsPaths)
		android.AssertPathsRelativeToTopEquals(t, "metadata flags", []string{"out/soong/.intermediates/bar-fragment/android_common_apex10000/modular-hiddenapi/metadata.csv"}, info.MetadataPaths)
		android.AssertPathsRelativeToTopEquals(t, "index flags", []string{"out/soong/.intermediates/bar-fragment/android_common_apex10000/modular-hiddenapi/index.csv"}, info.IndexPaths)
		android.AssertPathsRelativeToTopEquals(t, "all flags", []string{"out/soong/.intermediates/bar-fragment/android_common_apex10000/modular-hiddenapi/all-flags.csv"}, info.AllFlagsPaths)

		android.AssertArrayString(t, "stub flags", []string{"out/soong/.intermediates/bar-fragment/android_common_apex10000/modular-hiddenapi/stub-flags.csv:out/soong/.intermediates/bar-fragment/android_common_apex10000/modular-hiddenapi/signature-patterns.csv"}, info.StubFlagSubsets.RelativeToTop())
		android.AssertArrayString(t, "all flags", []string{"out/soong/.intermediates/bar-fragment/android_common_apex10000/modular-hiddenapi/all-flags.csv:out/soong/.intermediates/bar-fragment/android_common_apex10000/modular-hiddenapi/signature-patterns.csv"}, info.FlagSubsets.RelativeToTop())
		}

		func TestPlatformBootclasspathDependencies(t *testing.T) {

java/bootclasspath_fragment.go

+17 −8

Original line number	Diff line number	Diff line
		@@ -579,6 +579,14 @@ func (b *BootclasspathFragmentModule) generateHiddenAPIBuildActions(ctx android.
		common := ctx.Module().(commonBootclasspathFragment)
		output := common.produceHiddenAPIOutput(ctx, contents, input)

		// If the source or prebuilts module does not provide a signature patterns file then generate one
		// from the flags.
		// TODO(b/192868581): Remove once the source and prebuilts provide a signature patterns file of
		// their own.
		if output.SignaturePatternsPath == nil {
		output.SignaturePatternsPath = buildRuleSignaturePatternsFile(ctx, output.AllFlagsPath)
		}

		// Initialize a HiddenAPIInfo structure.
		hiddenAPIInfo := HiddenAPIInfo{
		// The monolithic hidden API processing needs access to the flag files that override the default
		@@ -744,9 +752,6 @@ type bootclasspathFragmentSdkMemberProperties struct {
		// Flag files by *hiddenAPIFlagFileCategory
		Flag_files_by_category FlagFilesByCategory

		// The path to the generated stub-flags.csv file.
		Stub_flags_path android.OptionalPath

		// The path to the generated annotation-flags.csv file.
		Annotation_flags_path android.OptionalPath

		@@ -756,6 +761,9 @@ type bootclasspathFragmentSdkMemberProperties struct {
		// The path to the generated index.csv file.
		Index_path android.OptionalPath

		// The path to the generated stub-flags.csv file.
		Stub_flags_path android.OptionalPath

		// The path to the generated all-flags.csv file.
		All_flags_path android.OptionalPath
		}
		@@ -772,10 +780,11 @@ func (b *bootclasspathFragmentSdkMemberProperties) PopulateFromVariant(ctx andro
		b.Flag_files_by_category = hiddenAPIInfo.FlagFilesByCategory

		// Copy all the generated file paths.
		b.Stub_flags_path = android.OptionalPathForPath(hiddenAPIInfo.StubFlagsPath)
		b.Annotation_flags_path = android.OptionalPathForPath(hiddenAPIInfo.AnnotationFlagsPath)
		b.Metadata_path = android.OptionalPathForPath(hiddenAPIInfo.MetadataPath)
		b.Index_path = android.OptionalPathForPath(hiddenAPIInfo.IndexPath)

		b.Stub_flags_path = android.OptionalPathForPath(hiddenAPIInfo.StubFlagsPath)
		b.All_flags_path = android.OptionalPathForPath(hiddenAPIInfo.AllFlagsPath)

		// Copy stub_libs properties.
		@@ -839,10 +848,10 @@ func (b *bootclasspathFragmentSdkMemberProperties) AddToPropertySet(ctx android.
		}

		// Copy all the generated files, if available.
		copyOptionalPath(b.Stub_flags_path, "stub_flags")
		copyOptionalPath(b.Annotation_flags_path, "annotation_flags")
		copyOptionalPath(b.Metadata_path, "metadata")
		copyOptionalPath(b.Index_path, "index")
		copyOptionalPath(b.Stub_flags_path, "stub_flags")
		copyOptionalPath(b.All_flags_path, "all_flags")
		}

		@@ -852,9 +861,6 @@ var _ android.SdkMemberType = (*bootclasspathFragmentMemberType)(nil)
		// specific properties.
		type prebuiltBootclasspathFragmentProperties struct {
		Hidden_api struct {
		// The path to the stub-flags.csv file created by the bootclasspath_fragment.
		Stub_flags *string `android:"path"`

		// The path to the annotation-flags.csv file created by the bootclasspath_fragment.
		Annotation_flags *string `android:"path"`

		@@ -864,6 +870,9 @@ type prebuiltBootclasspathFragmentProperties struct {
		// The path to the index.csv file created by the bootclasspath_fragment.
		Index *string `android:"path"`

		// The path to the stub-flags.csv file created by the bootclasspath_fragment.
		Stub_flags *string `android:"path"`

		// The path to the all-flags.csv file created by the bootclasspath_fragment.
		All_flags *string `android:"path"`
		}

java/hiddenapi_modular.go

+77 −13

Original line number	Diff line number	Diff line
		@@ -297,7 +297,7 @@ func hiddenAPIRetrieveDexJarBuildPath(ctx android.ModuleContext, module android.
		//
		// The rule is initialized but not built so that the caller can modify it and select an appropriate
		// name.
		func buildRuleToGenerateHiddenAPIStubFlagsFile(ctx android.BuilderContext, name, desc string, outputPath android.WritablePath, bootDexJars android.Paths, input HiddenAPIFlagInput, moduleStubFlagsPaths android.Paths) {
		func buildRuleToGenerateHiddenAPIStubFlagsFile(ctx android.BuilderContext, name, desc string, outputPath android.WritablePath, bootDexJars android.Paths, input HiddenAPIFlagInput, stubFlagSubsets SignatureCsvSubsets) {
		// Singleton rule which applies hiddenapi on all boot class path dex files.
		rule := android.NewRuleBuilder(pctx, ctx)

		@@ -317,7 +317,7 @@ func buildRuleToGenerateHiddenAPIStubFlagsFile(ctx android.BuilderContext, name,

		// If no module stub flags paths are provided then this must be being called for a
		// bootclasspath_fragment and not the whole platform_bootclasspath.
		if moduleStubFlagsPaths == nil {
		if stubFlagSubsets == nil {
		// This is being run on a fragment of the bootclasspath.
		command.Flag("--fragment")
		}
		@@ -342,8 +342,8 @@ func buildRuleToGenerateHiddenAPIStubFlagsFile(ctx android.BuilderContext, name,

		// If there are stub flag files that have been generated by fragments on which this depends then
		// use them to validate the stub flag file generated by the rules created by this method.
		if len(moduleStubFlagsPaths) > 0 {
		validFile := buildRuleValidateOverlappingCsvFiles(ctx, name, desc, outputPath, moduleStubFlagsPaths)
		if len(stubFlagSubsets) > 0 {
		validFile := buildRuleValidateOverlappingCsvFiles(ctx, name, desc, outputPath, stubFlagSubsets)

		// Add the file that indicates that the file generated by this is valid.
		//
		@@ -546,6 +546,20 @@ func (i *HiddenAPIInfo) mergeFromFragmentDeps(ctx android.ModuleContext, fragmen
		}
		}

		// StubFlagSubset returns a SignatureCsvSubset that contains a path to a stub-flags.csv file and a
		// path to a signature-patterns.csv file that defines a subset of the monolithic stub flags file,
		// i.e. out/soong/hiddenapi/hiddenapi-stub-flags.txt, against which it will be compared.
		func (i *HiddenAPIInfo) StubFlagSubset() SignatureCsvSubset {
		return SignatureCsvSubset{i.StubFlagsPath, i.SignaturePatternsPath}
		}

		// FlagSubset returns a SignatureCsvSubset that contains a path to an all-flags.csv file and a
		// path to a signature-patterns.csv file that defines a subset of the monolithic flags file, i.e.
		// out/soong/hiddenapi/hiddenapi-flags.csv, against which it will be compared.
		func (i *HiddenAPIInfo) FlagSubset() SignatureCsvSubset {
		return SignatureCsvSubset{i.AllFlagsPath, i.SignaturePatternsPath}
		}

		var HiddenAPIInfoProvider = blueprint.NewProvider(HiddenAPIInfo{})

		// ModuleStubDexJars contains the stub dex jars provided by a single module.
		@@ -782,6 +796,10 @@ type HiddenAPIFlagOutput struct {

		// The path to the generated all-flags.csv file.
		AllFlagsPath android.Path

		// The path to the generated signature-patterns.txt file which defines the subset of the
		// monolithic hidden API files provided in this.
		SignaturePatternsPath android.Path
		}

		// bootDexJarByModule is a map from base module name (without prebuilt_ prefix) to the boot dex
		@@ -848,7 +866,7 @@ func pathForValidation(ctx android.PathContext, path android.WritablePath) andro
		// the annotationFlags.
		func buildRuleToGenerateHiddenApiFlags(ctx android.BuilderContext, name, desc string,
		outputPath android.WritablePath, baseFlagsPath android.Path, annotationFlagPaths android.Paths,
		flagFilesByCategory FlagFilesByCategory, allFlagsPaths android.Paths, generatedRemovedDexSignatures android.OptionalPath) {
		flagFilesByCategory FlagFilesByCategory, flagSubsets SignatureCsvSubsets, generatedRemovedDexSignatures android.OptionalPath) {

		// Create the rule that will generate the flag files.
		tempPath := tempPathForRestat(ctx, outputPath)
		@@ -877,8 +895,8 @@ func buildRuleToGenerateHiddenApiFlags(ctx android.BuilderContext, name, desc st

		// If there are flag files that have been generated by fragments on which this depends then use
		// them to validate the flag file generated by the rules created by this method.
		if len(allFlagsPaths) > 0 {
		validFile := buildRuleValidateOverlappingCsvFiles(ctx, name, desc, outputPath, allFlagsPaths)
		if len(flagSubsets) > 0 {
		validFile := buildRuleValidateOverlappingCsvFiles(ctx, name, desc, outputPath, flagSubsets)

		// Add the file that indicates that the file generated by this is valid.
		//
		@@ -890,20 +908,66 @@ func buildRuleToGenerateHiddenApiFlags(ctx android.BuilderContext, name, desc st
		rule.Build(name, desc)
		}

		// SignatureCsvSubset describes a subset of a monolithic flags file, i.e. either
		// out/soong/hiddenapi/hiddenapi-stub-flags.txt or out/soong/hiddenapi/hiddenapi-flags.csv
		type SignatureCsvSubset struct {
		// The path to the CSV file containing hidden API flags.
		//
		// It has the dex member signature as the first column, with flags, one per column, in the
		// subsequent columns.
		CsvFile android.Path

		// The path to the CSV file containing the signature patterns.
		//
		// It is a single column CSV file with the column containing a signature pattern.
		SignaturePatternsFile android.Path
		}

		type SignatureCsvSubsets []SignatureCsvSubset

		func (s SignatureCsvSubsets) RelativeToTop() []string {
		result := []string{}
		for _, subset := range s {
		result = append(result, fmt.Sprintf("%s:%s", subset.CsvFile.RelativeToTop(), subset.SignaturePatternsFile.RelativeToTop()))
		}
		return result
		}

		// buildRuleSignaturePatternsFile creates a rule to generate a file containing the set of signature
		// patterns that will select a subset of the monolithic flags.
		func buildRuleSignaturePatternsFile(ctx android.ModuleContext, flagsPath android.Path) android.Path {
		patternsFile := android.PathForModuleOut(ctx, "modular-hiddenapi", "signature-patterns.csv")
		// Create a rule to validate the output from the following rule.
		rule := android.NewRuleBuilder(pctx, ctx)
		rule.Command().
		BuiltTool("signature_patterns").
		FlagWithInput("--flags ", flagsPath).
		FlagWithOutput("--output ", patternsFile)
		rule.Build("hiddenAPISignaturePatterns", "hidden API signature patterns")

		return patternsFile
		}

		// buildRuleValidateOverlappingCsvFiles checks that the modular CSV files, i.e. the files generated
		// by the individual bootclasspath_fragment modules are subsets of the monolithic CSV file.
		func buildRuleValidateOverlappingCsvFiles(ctx android.BuilderContext, name string, desc string, monolithicFilePath android.WritablePath, modularFilePaths android.Paths) android.WritablePath {
		func buildRuleValidateOverlappingCsvFiles(ctx android.BuilderContext, name string, desc string, monolithicFilePath android.WritablePath, csvSubsets SignatureCsvSubsets) android.WritablePath {
		// The file which is used to record that the flags file is valid.
		validFile := pathForValidation(ctx, monolithicFilePath)

		// Create a rule to validate the output from the following rule.
		rule := android.NewRuleBuilder(pctx, ctx)
		rule.Command().
		command := rule.Command().
		BuiltTool("verify_overlaps").
		Input(monolithicFilePath).
		Inputs(modularFilePaths).
		Input(monolithicFilePath)

		for _, subset := range csvSubsets {
		command.
		Textf("%s:%s", subset.CsvFile, subset.SignaturePatternsFile).
		Implicit(subset.CsvFile).Implicit(subset.SignaturePatternsFile)
		}

		// If validation passes then update the file that records that.
		Text("&& touch").Output(validFile)
		command.Text("&& touch").Output(validFile)
		rule.Build(name+"Validation", desc+" validation")

		return validFile

java/hiddenapi_monolithic.go

+10 −7

Original line number	Diff line number	Diff line
		@@ -29,9 +29,6 @@ type MonolithicHiddenAPIInfo struct {
		// that category.
		FlagsFilesByCategory FlagFilesByCategory

		// The paths to the generated stub-flags.csv files.
		StubFlagsPaths android.Paths

		// The paths to the generated annotation-flags.csv files.
		AnnotationFlagsPaths android.Paths

		@@ -41,8 +38,13 @@ type MonolithicHiddenAPIInfo struct {
		// The paths to the generated index.csv files.
		IndexPaths android.Paths

		// The paths to the generated all-flags.csv files.
		AllFlagsPaths android.Paths
		// The subsets of the monolithic hiddenapi-stubs-flags.txt file that are provided by each
		// bootclasspath_fragment modules.
		StubFlagSubsets SignatureCsvSubsets

		// The subsets of the monolithic hiddenapi-flags.csv file that are provided by each
		// bootclasspath_fragment modules.
		FlagSubsets SignatureCsvSubsets

		// The classes jars from the libraries on the platform bootclasspath.
		ClassesJars android.Paths
		@@ -80,11 +82,12 @@ func newMonolithicHiddenAPIInfo(ctx android.ModuleContext, flagFilesByCategory F
		// append appends all the files from the supplied info to the corresponding files in this struct.
		func (i MonolithicHiddenAPIInfo) append(other HiddenAPIInfo) {
		i.FlagsFilesByCategory.append(other.FlagFilesByCategory)
		i.StubFlagsPaths = append(i.StubFlagsPaths, other.StubFlagsPath)
		i.AnnotationFlagsPaths = append(i.AnnotationFlagsPaths, other.AnnotationFlagsPath)
		i.MetadataPaths = append(i.MetadataPaths, other.MetadataPath)
		i.IndexPaths = append(i.IndexPaths, other.IndexPath)
		i.AllFlagsPaths = append(i.AllFlagsPaths, other.AllFlagsPath)

		i.StubFlagSubsets = append(i.StubFlagSubsets, other.StubFlagSubset())
		i.FlagSubsets = append(i.FlagSubsets, other.FlagSubset())
		}

		var MonolithicHiddenAPIInfoProvider = blueprint.NewProvider(MonolithicHiddenAPIInfo{})

java/platform_bootclasspath.go

+2 −2

Original line number	Diff line number	Diff line
		@@ -316,7 +316,7 @@ func (b *platformBootclasspathModule) generateHiddenAPIBuildActions(ctx android.

		// Generate the monolithic stub-flags.csv file.
		stubFlags := hiddenAPISingletonPaths(ctx).stubFlags
		buildRuleToGenerateHiddenAPIStubFlagsFile(ctx, "platform-bootclasspath-monolithic-hiddenapi-stub-flags", "monolithic hidden API stub flags", stubFlags, bootDexJarByModule.bootDexJars(), input, monolithicInfo.StubFlagsPaths)
		buildRuleToGenerateHiddenAPIStubFlagsFile(ctx, "platform-bootclasspath-monolithic-hiddenapi-stub-flags", "monolithic hidden API stub flags", stubFlags, bootDexJarByModule.bootDexJars(), input, monolithicInfo.StubFlagSubsets)

		// Generate the annotation-flags.csv file from all the module annotations.
		annotationFlags := android.PathForModuleOut(ctx, "hiddenapi-monolithic", "annotation-flags-from-classes.csv")
		@@ -329,7 +329,7 @@ func (b *platformBootclasspathModule) generateHiddenAPIBuildActions(ctx android.
		allAnnotationFlagFiles := android.Paths{annotationFlags}
		allAnnotationFlagFiles = append(allAnnotationFlagFiles, monolithicInfo.AnnotationFlagsPaths...)
		allFlags := hiddenAPISingletonPaths(ctx).flags
		buildRuleToGenerateHiddenApiFlags(ctx, "hiddenAPIFlagsFile", "monolithic hidden API flags", allFlags, stubFlags, allAnnotationFlagFiles, monolithicInfo.FlagsFilesByCategory, monolithicInfo.AllFlagsPaths, android.OptionalPath{})
		buildRuleToGenerateHiddenApiFlags(ctx, "hiddenAPIFlagsFile", "monolithic hidden API flags", allFlags, stubFlags, allAnnotationFlagFiles, monolithicInfo.FlagsFilesByCategory, monolithicInfo.FlagSubsets, android.OptionalPath{})

		// Generate an intermediate monolithic hiddenapi-metadata.csv file directly from the annotations
		// in the source code.