Add ignored hidden_api.split_packages/package_prefixes properties

Allow modules upstream to make use of these properties despite
sc-mainline-prod not supporting them.

Bug: 194063708
Test: m nothing
Merged-In: If2f90cfc41b6fff9fa4ac8b9d4973110938b9392
Change-Id: I85c13c115ffafc797566ced6c3672a9b0dca59b1
This commit is contained in:
Paul Duffin
2022-03-10 18:15:42 +00:00
parent 9b4eab604d
commit 9345773428

View File

@@ -139,6 +139,74 @@ type bootclasspathFragmentProperties struct {
BootclasspathFragmentsDepsProperties
}
type SourceOnlyBootclasspathProperties struct {
Hidden_api struct {
// Contains prefixes of a package hierarchy that is provided solely by this
// bootclasspath_fragment.
//
// This affects the signature patterns file that is used to select the subset of monolithic
// hidden API flags. See split_packages property for more details.
Package_prefixes []string
// The list of split packages provided by this bootclasspath_fragment.
//
// A split package is one that contains classes which are provided by multiple
// bootclasspath_fragment modules.
//
// This defaults to "*" - which treats all packages as being split. A module that has no split
// packages must specify an empty list.
//
// This affects the signature patterns file that is generated by a bootclasspath_fragment and
// used to select the subset of monolithic hidden API flags against which the flags generated
// by the bootclasspath_fragment are compared.
//
// The signature patterns file selects the subset of monolithic hidden API flags using a number
// of patterns, i.e.:
// * The qualified name (including package) of an outermost class, e.g. java/lang/Character.
// This selects all the flags for all the members of this class and any nested classes.
// * A package wildcard, e.g. java/lang/*. This selects all the flags for all the members of all
// the classes in this package (but not in sub-packages).
// * A recursive package wildcard, e.g. java/**. This selects all the flags for all the members
// of all the classes in this package and sub-packages.
//
// The signature patterns file is constructed as follows:
// * All the signatures are retrieved from the all-flags.csv file.
// * The member and inner class names are removed.
// * If a class is in a split package then that is kept, otherwise the class part is removed
// and replaced with a wildcard, i.e. *.
// * If a package matches a package prefix then the package is removed.
// * All the package prefixes are added with a recursive wildcard appended to each, i.e. **.
// * The resulting patterns are sorted.
//
// So, by default (i.e. without specifying any package_prefixes or split_packages) the signature
// patterns is a list of class names, because there are no package packages and all packages are
// assumed to be split.
//
// If any split packages are specified then only those packages are treated as split and all
// other packages are treated as belonging solely to the bootclasspath_fragment and so they use
// wildcard package patterns.
//
// So, if an empty list of split packages is specified then the signature patterns file just
// includes a wildcard package pattern for every package provided by the bootclasspath_fragment.
//
// If split_packages are specified and a package that is split is not listed then it could lead
// to build failures as it will select monolithic flags that are generated by another
// bootclasspath_fragment to compare against the flags provided by this fragment. The latter
// will obviously not contain those flags and that can cause the comparison and build to fail.
//
// If any package prefixes are specified then any matching packages are removed from the
// signature patterns and replaced with a single recursive package pattern.
//
// It is not strictly necessary to specify either package_prefixes or split_packages as the
// defaults will produce a valid set of signature patterns. However, those patterns may include
// implementation details, e.g. names of implementation classes or packages, which will be
// exported to the sdk snapshot in the signature patterns file. That is something that should be
// avoided where possible. Specifying package_prefixes and split_packages allows those
// implementation details to be excluded from the snapshot.
Split_packages []string
}
}
type BootclasspathFragmentModule struct {
android.ModuleBase
android.ApexModuleBase
@@ -146,6 +214,8 @@ type BootclasspathFragmentModule struct {
ClasspathFragmentBase
properties bootclasspathFragmentProperties
sourceOnlyProperties SourceOnlyBootclasspathProperties
}
// commonBootclasspathFragment defines the methods that are implemented by both source and prebuilt
@@ -177,7 +247,7 @@ type bootImageFilesByArch map[android.ArchType]android.Paths
func bootclasspathFragmentFactory() android.Module {
m := &BootclasspathFragmentModule{}
m.AddProperties(&m.properties)
m.AddProperties(&m.properties, &m.sourceOnlyProperties)
android.InitApexModule(m)
android.InitSdkAwareModule(m)
initClasspathFragment(m, BOOTCLASSPATH)