xref: /aosp_15_r20/build/soong/java/bootclasspath_fragment.go (revision 333d2b3687b3a337dbcca9d65000bca186795e39)
1*333d2b36SAndroid Build Coastguard Worker// Copyright (C) 2021 The Android Open Source Project
2*333d2b36SAndroid Build Coastguard Worker//
3*333d2b36SAndroid Build Coastguard Worker// Licensed under the Apache License, Version 2.0 (the "License");
4*333d2b36SAndroid Build Coastguard Worker// you may not use this file except in compliance with the License.
5*333d2b36SAndroid Build Coastguard Worker// You may obtain a copy of the License at
6*333d2b36SAndroid Build Coastguard Worker//
7*333d2b36SAndroid Build Coastguard Worker//     http://www.apache.org/licenses/LICENSE-2.0
8*333d2b36SAndroid Build Coastguard Worker//
9*333d2b36SAndroid Build Coastguard Worker// Unless required by applicable law or agreed to in writing, software
10*333d2b36SAndroid Build Coastguard Worker// distributed under the License is distributed on an "AS IS" BASIS,
11*333d2b36SAndroid Build Coastguard Worker// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*333d2b36SAndroid Build Coastguard Worker// See the License for the specific language governing permissions and
13*333d2b36SAndroid Build Coastguard Worker// limitations under the License.
14*333d2b36SAndroid Build Coastguard Worker
15*333d2b36SAndroid Build Coastguard Workerpackage java
16*333d2b36SAndroid Build Coastguard Worker
17*333d2b36SAndroid Build Coastguard Workerimport (
18*333d2b36SAndroid Build Coastguard Worker	"fmt"
19*333d2b36SAndroid Build Coastguard Worker	"io"
20*333d2b36SAndroid Build Coastguard Worker	"path/filepath"
21*333d2b36SAndroid Build Coastguard Worker	"reflect"
22*333d2b36SAndroid Build Coastguard Worker	"strings"
23*333d2b36SAndroid Build Coastguard Worker
24*333d2b36SAndroid Build Coastguard Worker	"android/soong/android"
25*333d2b36SAndroid Build Coastguard Worker	"android/soong/dexpreopt"
26*333d2b36SAndroid Build Coastguard Worker
27*333d2b36SAndroid Build Coastguard Worker	"github.com/google/blueprint/proptools"
28*333d2b36SAndroid Build Coastguard Worker
29*333d2b36SAndroid Build Coastguard Worker	"github.com/google/blueprint"
30*333d2b36SAndroid Build Coastguard Worker)
31*333d2b36SAndroid Build Coastguard Worker
32*333d2b36SAndroid Build Coastguard Workerfunc init() {
33*333d2b36SAndroid Build Coastguard Worker	registerBootclasspathFragmentBuildComponents(android.InitRegistrationContext)
34*333d2b36SAndroid Build Coastguard Worker
35*333d2b36SAndroid Build Coastguard Worker	android.RegisterSdkMemberType(BootclasspathFragmentSdkMemberType)
36*333d2b36SAndroid Build Coastguard Worker}
37*333d2b36SAndroid Build Coastguard Worker
38*333d2b36SAndroid Build Coastguard Workerfunc registerBootclasspathFragmentBuildComponents(ctx android.RegistrationContext) {
39*333d2b36SAndroid Build Coastguard Worker	ctx.RegisterModuleType("bootclasspath_fragment", bootclasspathFragmentFactory)
40*333d2b36SAndroid Build Coastguard Worker	ctx.RegisterModuleType("bootclasspath_fragment_test", testBootclasspathFragmentFactory)
41*333d2b36SAndroid Build Coastguard Worker	ctx.RegisterModuleType("prebuilt_bootclasspath_fragment", prebuiltBootclasspathFragmentFactory)
42*333d2b36SAndroid Build Coastguard Worker}
43*333d2b36SAndroid Build Coastguard Worker
44*333d2b36SAndroid Build Coastguard Worker// BootclasspathFragmentSdkMemberType is the member type used to add bootclasspath_fragments to
45*333d2b36SAndroid Build Coastguard Worker// the SDK snapshot. It is exported for use by apex.
46*333d2b36SAndroid Build Coastguard Workervar BootclasspathFragmentSdkMemberType = &bootclasspathFragmentMemberType{
47*333d2b36SAndroid Build Coastguard Worker	SdkMemberTypeBase: android.SdkMemberTypeBase{
48*333d2b36SAndroid Build Coastguard Worker		PropertyName: "bootclasspath_fragments",
49*333d2b36SAndroid Build Coastguard Worker		SupportsSdk:  true,
50*333d2b36SAndroid Build Coastguard Worker	},
51*333d2b36SAndroid Build Coastguard Worker}
52*333d2b36SAndroid Build Coastguard Worker
53*333d2b36SAndroid Build Coastguard Workertype bootclasspathFragmentContentDependencyTag struct {
54*333d2b36SAndroid Build Coastguard Worker	blueprint.BaseDependencyTag
55*333d2b36SAndroid Build Coastguard Worker}
56*333d2b36SAndroid Build Coastguard Worker
57*333d2b36SAndroid Build Coastguard Worker// Avoid having to make bootclasspath_fragment content visible to the bootclasspath_fragment.
58*333d2b36SAndroid Build Coastguard Worker//
59*333d2b36SAndroid Build Coastguard Worker// This is a temporary workaround to make it easier to migrate to bootclasspath_fragment modules
60*333d2b36SAndroid Build Coastguard Worker// with proper dependencies.
61*333d2b36SAndroid Build Coastguard Worker// TODO(b/177892522): Remove this and add needed visibility.
62*333d2b36SAndroid Build Coastguard Workerfunc (b bootclasspathFragmentContentDependencyTag) ExcludeFromVisibilityEnforcement() {
63*333d2b36SAndroid Build Coastguard Worker}
64*333d2b36SAndroid Build Coastguard Worker
65*333d2b36SAndroid Build Coastguard Worker// The bootclasspath_fragment contents must never depend on prebuilts.
66*333d2b36SAndroid Build Coastguard Workerfunc (b bootclasspathFragmentContentDependencyTag) ReplaceSourceWithPrebuilt() bool {
67*333d2b36SAndroid Build Coastguard Worker	return false
68*333d2b36SAndroid Build Coastguard Worker}
69*333d2b36SAndroid Build Coastguard Worker
70*333d2b36SAndroid Build Coastguard Worker// SdkMemberType causes dependencies added with this tag to be automatically added to the sdk as if
71*333d2b36SAndroid Build Coastguard Worker// they were specified using java_boot_libs or java_sdk_libs.
72*333d2b36SAndroid Build Coastguard Workerfunc (b bootclasspathFragmentContentDependencyTag) SdkMemberType(child android.Module) android.SdkMemberType {
73*333d2b36SAndroid Build Coastguard Worker	// If the module is a java_sdk_library then treat it as if it was specified in the java_sdk_libs
74*333d2b36SAndroid Build Coastguard Worker	// property, otherwise treat if it was specified in the java_boot_libs property.
75*333d2b36SAndroid Build Coastguard Worker	if javaSdkLibrarySdkMemberType.IsInstance(child) {
76*333d2b36SAndroid Build Coastguard Worker		return javaSdkLibrarySdkMemberType
77*333d2b36SAndroid Build Coastguard Worker	}
78*333d2b36SAndroid Build Coastguard Worker
79*333d2b36SAndroid Build Coastguard Worker	return JavaBootLibsSdkMemberType
80*333d2b36SAndroid Build Coastguard Worker}
81*333d2b36SAndroid Build Coastguard Worker
82*333d2b36SAndroid Build Coastguard Workerfunc (b bootclasspathFragmentContentDependencyTag) ExportMember() bool {
83*333d2b36SAndroid Build Coastguard Worker	return true
84*333d2b36SAndroid Build Coastguard Worker}
85*333d2b36SAndroid Build Coastguard Worker
86*333d2b36SAndroid Build Coastguard Worker// Contents of bootclasspath fragments require files from prebuilt apex files.
87*333d2b36SAndroid Build Coastguard Workerfunc (b bootclasspathFragmentContentDependencyTag) RequiresFilesFromPrebuiltApex() {}
88*333d2b36SAndroid Build Coastguard Worker
89*333d2b36SAndroid Build Coastguard Worker// The tag used for the dependency between the bootclasspath_fragment module and its contents.
90*333d2b36SAndroid Build Coastguard Workervar bootclasspathFragmentContentDepTag = bootclasspathFragmentContentDependencyTag{}
91*333d2b36SAndroid Build Coastguard Worker
92*333d2b36SAndroid Build Coastguard Workervar _ android.ExcludeFromVisibilityEnforcementTag = bootclasspathFragmentContentDepTag
93*333d2b36SAndroid Build Coastguard Workervar _ android.ReplaceSourceWithPrebuilt = bootclasspathFragmentContentDepTag
94*333d2b36SAndroid Build Coastguard Workervar _ android.SdkMemberDependencyTag = bootclasspathFragmentContentDepTag
95*333d2b36SAndroid Build Coastguard Workervar _ android.RequiresFilesFromPrebuiltApexTag = bootclasspathFragmentContentDepTag
96*333d2b36SAndroid Build Coastguard Worker
97*333d2b36SAndroid Build Coastguard Workerfunc IsBootclasspathFragmentContentDepTag(tag blueprint.DependencyTag) bool {
98*333d2b36SAndroid Build Coastguard Worker	return tag == bootclasspathFragmentContentDepTag
99*333d2b36SAndroid Build Coastguard Worker}
100*333d2b36SAndroid Build Coastguard Worker
101*333d2b36SAndroid Build Coastguard Worker// Properties that can be different when coverage is enabled.
102*333d2b36SAndroid Build Coastguard Workertype BootclasspathFragmentCoverageAffectedProperties struct {
103*333d2b36SAndroid Build Coastguard Worker	// The contents of this bootclasspath_fragment, could be either java_library, or java_sdk_library.
104*333d2b36SAndroid Build Coastguard Worker	//
105*333d2b36SAndroid Build Coastguard Worker	// A java_sdk_library specified here will also be treated as if it was specified on the stub_libs
106*333d2b36SAndroid Build Coastguard Worker	// property.
107*333d2b36SAndroid Build Coastguard Worker	//
108*333d2b36SAndroid Build Coastguard Worker	// The order of this list matters as it is the order that is used in the bootclasspath.
109*333d2b36SAndroid Build Coastguard Worker	Contents proptools.Configurable[[]string] `android:"arch_variant"`
110*333d2b36SAndroid Build Coastguard Worker
111*333d2b36SAndroid Build Coastguard Worker	// The properties for specifying the API stubs provided by this fragment.
112*333d2b36SAndroid Build Coastguard Worker	BootclasspathAPIProperties
113*333d2b36SAndroid Build Coastguard Worker}
114*333d2b36SAndroid Build Coastguard Worker
115*333d2b36SAndroid Build Coastguard Workertype bootclasspathFragmentProperties struct {
116*333d2b36SAndroid Build Coastguard Worker	// The name of the image this represents.
117*333d2b36SAndroid Build Coastguard Worker	//
118*333d2b36SAndroid Build Coastguard Worker	// If specified then it must be one of "art" or "boot".
119*333d2b36SAndroid Build Coastguard Worker	Image_name *string
120*333d2b36SAndroid Build Coastguard Worker
121*333d2b36SAndroid Build Coastguard Worker	// Properties whose values need to differ with and without coverage.
122*333d2b36SAndroid Build Coastguard Worker	BootclasspathFragmentCoverageAffectedProperties
123*333d2b36SAndroid Build Coastguard Worker	Coverage BootclasspathFragmentCoverageAffectedProperties
124*333d2b36SAndroid Build Coastguard Worker
125*333d2b36SAndroid Build Coastguard Worker	// Hidden API related properties.
126*333d2b36SAndroid Build Coastguard Worker	HiddenAPIFlagFileProperties
127*333d2b36SAndroid Build Coastguard Worker
128*333d2b36SAndroid Build Coastguard Worker	// The list of additional stub libraries which this fragment's contents use but which are not
129*333d2b36SAndroid Build Coastguard Worker	// provided by another bootclasspath_fragment.
130*333d2b36SAndroid Build Coastguard Worker	//
131*333d2b36SAndroid Build Coastguard Worker	// Note, "android-non-updatable" is treated specially. While no such module exists it is treated
132*333d2b36SAndroid Build Coastguard Worker	// as if it was a java_sdk_library. So, when public API stubs are needed then it will be replaced
133*333d2b36SAndroid Build Coastguard Worker	// with "android-non-updatable.stubs", with "androidn-non-updatable.system.stubs" when the system
134*333d2b36SAndroid Build Coastguard Worker	// stubs are needed and so on.
135*333d2b36SAndroid Build Coastguard Worker	Additional_stubs []string
136*333d2b36SAndroid Build Coastguard Worker
137*333d2b36SAndroid Build Coastguard Worker	// Properties that allow a fragment to depend on other fragments. This is needed for hidden API
138*333d2b36SAndroid Build Coastguard Worker	// processing as it needs access to all the classes used by a fragment including those provided
139*333d2b36SAndroid Build Coastguard Worker	// by other fragments.
140*333d2b36SAndroid Build Coastguard Worker	BootclasspathFragmentsDepsProperties
141*333d2b36SAndroid Build Coastguard Worker}
142*333d2b36SAndroid Build Coastguard Worker
143*333d2b36SAndroid Build Coastguard Workertype HiddenAPIPackageProperties struct {
144*333d2b36SAndroid Build Coastguard Worker	Hidden_api struct {
145*333d2b36SAndroid Build Coastguard Worker		// Contains prefixes of a package hierarchy that is provided solely by this
146*333d2b36SAndroid Build Coastguard Worker		// bootclasspath_fragment.
147*333d2b36SAndroid Build Coastguard Worker		//
148*333d2b36SAndroid Build Coastguard Worker		// This affects the signature patterns file that is used to select the subset of monolithic
149*333d2b36SAndroid Build Coastguard Worker		// hidden API flags. See split_packages property for more details.
150*333d2b36SAndroid Build Coastguard Worker		Package_prefixes []string
151*333d2b36SAndroid Build Coastguard Worker
152*333d2b36SAndroid Build Coastguard Worker		// A list of individual packages that are provided solely by this
153*333d2b36SAndroid Build Coastguard Worker		// bootclasspath_fragment but which cannot be listed in package_prefixes
154*333d2b36SAndroid Build Coastguard Worker		// because there are sub-packages which are provided by other modules.
155*333d2b36SAndroid Build Coastguard Worker		//
156*333d2b36SAndroid Build Coastguard Worker		// This should only be used for legacy packages. New packages should be
157*333d2b36SAndroid Build Coastguard Worker		// covered by a package prefix.
158*333d2b36SAndroid Build Coastguard Worker		Single_packages []string
159*333d2b36SAndroid Build Coastguard Worker
160*333d2b36SAndroid Build Coastguard Worker		// The list of split packages provided by this bootclasspath_fragment.
161*333d2b36SAndroid Build Coastguard Worker		//
162*333d2b36SAndroid Build Coastguard Worker		// A split package is one that contains classes which are provided by multiple
163*333d2b36SAndroid Build Coastguard Worker		// bootclasspath_fragment modules.
164*333d2b36SAndroid Build Coastguard Worker		//
165*333d2b36SAndroid Build Coastguard Worker		// This defaults to "*" - which treats all packages as being split. A module that has no split
166*333d2b36SAndroid Build Coastguard Worker		// packages must specify an empty list.
167*333d2b36SAndroid Build Coastguard Worker		//
168*333d2b36SAndroid Build Coastguard Worker		// This affects the signature patterns file that is generated by a bootclasspath_fragment and
169*333d2b36SAndroid Build Coastguard Worker		// used to select the subset of monolithic hidden API flags against which the flags generated
170*333d2b36SAndroid Build Coastguard Worker		// by the bootclasspath_fragment are compared.
171*333d2b36SAndroid Build Coastguard Worker		//
172*333d2b36SAndroid Build Coastguard Worker		// The signature patterns file selects the subset of monolithic hidden API flags using a number
173*333d2b36SAndroid Build Coastguard Worker		// of patterns, i.e.:
174*333d2b36SAndroid Build Coastguard Worker		// * The qualified name (including package) of an outermost class, e.g. java/lang/Character.
175*333d2b36SAndroid Build Coastguard Worker		//   This selects all the flags for all the members of this class and any nested classes.
176*333d2b36SAndroid Build Coastguard Worker		// * A package wildcard, e.g. java/lang/*. This selects all the flags for all the members of all
177*333d2b36SAndroid Build Coastguard Worker		//   the classes in this package (but not in sub-packages).
178*333d2b36SAndroid Build Coastguard Worker		// * A recursive package wildcard, e.g. java/**. This selects all the flags for all the members
179*333d2b36SAndroid Build Coastguard Worker		//   of all the classes in this package and sub-packages.
180*333d2b36SAndroid Build Coastguard Worker		//
181*333d2b36SAndroid Build Coastguard Worker		// The signature patterns file is constructed as follows:
182*333d2b36SAndroid Build Coastguard Worker		// * All the signatures are retrieved from the all-flags.csv file.
183*333d2b36SAndroid Build Coastguard Worker		// * The member and inner class names are removed.
184*333d2b36SAndroid Build Coastguard Worker		// * If a class is in a split package then that is kept, otherwise the class part is removed
185*333d2b36SAndroid Build Coastguard Worker		//   and replaced with a wildcard, i.e. *.
186*333d2b36SAndroid Build Coastguard Worker		// * If a package matches a package prefix then the package is removed.
187*333d2b36SAndroid Build Coastguard Worker		// * All the package prefixes are added with a recursive wildcard appended to each, i.e. **.
188*333d2b36SAndroid Build Coastguard Worker		// * The resulting patterns are sorted.
189*333d2b36SAndroid Build Coastguard Worker		//
190*333d2b36SAndroid Build Coastguard Worker		// So, by default (i.e. without specifying any package_prefixes or split_packages) the signature
191*333d2b36SAndroid Build Coastguard Worker		// patterns is a list of class names, because there are no package packages and all packages are
192*333d2b36SAndroid Build Coastguard Worker		// assumed to be split.
193*333d2b36SAndroid Build Coastguard Worker		//
194*333d2b36SAndroid Build Coastguard Worker		// If any split packages are specified then only those packages are treated as split and all
195*333d2b36SAndroid Build Coastguard Worker		// other packages are treated as belonging solely to the bootclasspath_fragment and so they use
196*333d2b36SAndroid Build Coastguard Worker		// wildcard package patterns.
197*333d2b36SAndroid Build Coastguard Worker		//
198*333d2b36SAndroid Build Coastguard Worker		// So, if an empty list of split packages is specified then the signature patterns file just
199*333d2b36SAndroid Build Coastguard Worker		// includes a wildcard package pattern for every package provided by the bootclasspath_fragment.
200*333d2b36SAndroid Build Coastguard Worker		//
201*333d2b36SAndroid Build Coastguard Worker		// If split_packages are specified and a package that is split is not listed then it could lead
202*333d2b36SAndroid Build Coastguard Worker		// to build failures as it will select monolithic flags that are generated by another
203*333d2b36SAndroid Build Coastguard Worker		// bootclasspath_fragment to compare against the flags provided by this fragment. The latter
204*333d2b36SAndroid Build Coastguard Worker		// will obviously not contain those flags and that can cause the comparison and build to fail.
205*333d2b36SAndroid Build Coastguard Worker		//
206*333d2b36SAndroid Build Coastguard Worker		// If any package prefixes are specified then any matching packages are removed from the
207*333d2b36SAndroid Build Coastguard Worker		// signature patterns and replaced with a single recursive package pattern.
208*333d2b36SAndroid Build Coastguard Worker		//
209*333d2b36SAndroid Build Coastguard Worker		// It is not strictly necessary to specify either package_prefixes or split_packages as the
210*333d2b36SAndroid Build Coastguard Worker		// defaults will produce a valid set of signature patterns. However, those patterns may include
211*333d2b36SAndroid Build Coastguard Worker		// implementation details, e.g. names of implementation classes or packages, which will be
212*333d2b36SAndroid Build Coastguard Worker		// exported to the sdk snapshot in the signature patterns file. That is something that should be
213*333d2b36SAndroid Build Coastguard Worker		// avoided where possible. Specifying package_prefixes and split_packages allows those
214*333d2b36SAndroid Build Coastguard Worker		// implementation details to be excluded from the snapshot.
215*333d2b36SAndroid Build Coastguard Worker		Split_packages []string
216*333d2b36SAndroid Build Coastguard Worker	}
217*333d2b36SAndroid Build Coastguard Worker}
218*333d2b36SAndroid Build Coastguard Worker
219*333d2b36SAndroid Build Coastguard Workertype SourceOnlyBootclasspathProperties struct {
220*333d2b36SAndroid Build Coastguard Worker	HiddenAPIPackageProperties
221*333d2b36SAndroid Build Coastguard Worker	Coverage HiddenAPIPackageProperties
222*333d2b36SAndroid Build Coastguard Worker}
223*333d2b36SAndroid Build Coastguard Worker
224*333d2b36SAndroid Build Coastguard Workertype BootclasspathFragmentModule struct {
225*333d2b36SAndroid Build Coastguard Worker	android.ModuleBase
226*333d2b36SAndroid Build Coastguard Worker	android.DefaultableModuleBase
227*333d2b36SAndroid Build Coastguard Worker	android.ApexModuleBase
228*333d2b36SAndroid Build Coastguard Worker	ClasspathFragmentBase
229*333d2b36SAndroid Build Coastguard Worker
230*333d2b36SAndroid Build Coastguard Worker	// True if this fragment is for testing purposes.
231*333d2b36SAndroid Build Coastguard Worker	testFragment bool
232*333d2b36SAndroid Build Coastguard Worker
233*333d2b36SAndroid Build Coastguard Worker	properties bootclasspathFragmentProperties
234*333d2b36SAndroid Build Coastguard Worker
235*333d2b36SAndroid Build Coastguard Worker	sourceOnlyProperties SourceOnlyBootclasspathProperties
236*333d2b36SAndroid Build Coastguard Worker
237*333d2b36SAndroid Build Coastguard Worker	// Path to the boot image profile.
238*333d2b36SAndroid Build Coastguard Worker	profilePath    android.WritablePath
239*333d2b36SAndroid Build Coastguard Worker	profilePathErr error
240*333d2b36SAndroid Build Coastguard Worker}
241*333d2b36SAndroid Build Coastguard Worker
242*333d2b36SAndroid Build Coastguard Worker// commonBootclasspathFragment defines the methods that are implemented by both source and prebuilt
243*333d2b36SAndroid Build Coastguard Worker// bootclasspath fragment modules.
244*333d2b36SAndroid Build Coastguard Workertype commonBootclasspathFragment interface {
245*333d2b36SAndroid Build Coastguard Worker	// produceHiddenAPIOutput produces the all-flags.csv and intermediate files and encodes the flags
246*333d2b36SAndroid Build Coastguard Worker	// into dex files.
247*333d2b36SAndroid Build Coastguard Worker	//
248*333d2b36SAndroid Build Coastguard Worker	// Returns a *HiddenAPIOutput containing the paths for the generated files. Returns nil if the
249*333d2b36SAndroid Build Coastguard Worker	// module cannot contribute to hidden API processing, e.g. because it is a prebuilt module in a
250*333d2b36SAndroid Build Coastguard Worker	// versioned sdk.
251*333d2b36SAndroid Build Coastguard Worker	produceHiddenAPIOutput(ctx android.ModuleContext, contents []android.Module, fragments []android.Module, input HiddenAPIFlagInput) *HiddenAPIOutput
252*333d2b36SAndroid Build Coastguard Worker
253*333d2b36SAndroid Build Coastguard Worker	// getProfilePath returns the path to the boot image profile.
254*333d2b36SAndroid Build Coastguard Worker	getProfilePath() android.Path
255*333d2b36SAndroid Build Coastguard Worker}
256*333d2b36SAndroid Build Coastguard Worker
257*333d2b36SAndroid Build Coastguard Workervar _ commonBootclasspathFragment = (*BootclasspathFragmentModule)(nil)
258*333d2b36SAndroid Build Coastguard Worker
259*333d2b36SAndroid Build Coastguard Workerfunc bootclasspathFragmentFactory() android.Module {
260*333d2b36SAndroid Build Coastguard Worker	m := &BootclasspathFragmentModule{}
261*333d2b36SAndroid Build Coastguard Worker	m.AddProperties(&m.properties, &m.sourceOnlyProperties)
262*333d2b36SAndroid Build Coastguard Worker	android.InitApexModule(m)
263*333d2b36SAndroid Build Coastguard Worker	initClasspathFragment(m, BOOTCLASSPATH)
264*333d2b36SAndroid Build Coastguard Worker	android.InitAndroidArchModule(m, android.DeviceSupported, android.MultilibCommon)
265*333d2b36SAndroid Build Coastguard Worker	android.InitDefaultableModule(m)
266*333d2b36SAndroid Build Coastguard Worker
267*333d2b36SAndroid Build Coastguard Worker	android.AddLoadHook(m, func(ctx android.LoadHookContext) {
268*333d2b36SAndroid Build Coastguard Worker		// If code coverage has been enabled for the framework then append the properties with
269*333d2b36SAndroid Build Coastguard Worker		// coverage specific properties.
270*333d2b36SAndroid Build Coastguard Worker		if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
271*333d2b36SAndroid Build Coastguard Worker			err := proptools.AppendProperties(&m.properties.BootclasspathFragmentCoverageAffectedProperties, &m.properties.Coverage, nil)
272*333d2b36SAndroid Build Coastguard Worker			if err != nil {
273*333d2b36SAndroid Build Coastguard Worker				ctx.PropertyErrorf("coverage", "error trying to append coverage specific properties: %s", err)
274*333d2b36SAndroid Build Coastguard Worker				return
275*333d2b36SAndroid Build Coastguard Worker			}
276*333d2b36SAndroid Build Coastguard Worker
277*333d2b36SAndroid Build Coastguard Worker			err = proptools.AppendProperties(&m.sourceOnlyProperties.HiddenAPIPackageProperties, &m.sourceOnlyProperties.Coverage, nil)
278*333d2b36SAndroid Build Coastguard Worker			if err != nil {
279*333d2b36SAndroid Build Coastguard Worker				ctx.PropertyErrorf("coverage", "error trying to append hidden api coverage specific properties: %s", err)
280*333d2b36SAndroid Build Coastguard Worker				return
281*333d2b36SAndroid Build Coastguard Worker			}
282*333d2b36SAndroid Build Coastguard Worker		}
283*333d2b36SAndroid Build Coastguard Worker	})
284*333d2b36SAndroid Build Coastguard Worker	return m
285*333d2b36SAndroid Build Coastguard Worker}
286*333d2b36SAndroid Build Coastguard Worker
287*333d2b36SAndroid Build Coastguard Workerfunc testBootclasspathFragmentFactory() android.Module {
288*333d2b36SAndroid Build Coastguard Worker	m := bootclasspathFragmentFactory().(*BootclasspathFragmentModule)
289*333d2b36SAndroid Build Coastguard Worker	m.testFragment = true
290*333d2b36SAndroid Build Coastguard Worker	return m
291*333d2b36SAndroid Build Coastguard Worker}
292*333d2b36SAndroid Build Coastguard Worker
293*333d2b36SAndroid Build Coastguard Workerfunc (m *BootclasspathFragmentModule) bootclasspathFragmentPropertyCheck(ctx android.ModuleContext) {
294*333d2b36SAndroid Build Coastguard Worker	contents := m.properties.Contents.GetOrDefault(ctx, nil)
295*333d2b36SAndroid Build Coastguard Worker	if len(contents) == 0 {
296*333d2b36SAndroid Build Coastguard Worker		ctx.PropertyErrorf("contents", "required property is missing")
297*333d2b36SAndroid Build Coastguard Worker		return
298*333d2b36SAndroid Build Coastguard Worker	}
299*333d2b36SAndroid Build Coastguard Worker
300*333d2b36SAndroid Build Coastguard Worker	if m.properties.Image_name == nil {
301*333d2b36SAndroid Build Coastguard Worker		// Nothing to do.
302*333d2b36SAndroid Build Coastguard Worker		return
303*333d2b36SAndroid Build Coastguard Worker	}
304*333d2b36SAndroid Build Coastguard Worker
305*333d2b36SAndroid Build Coastguard Worker	imageName := proptools.String(m.properties.Image_name)
306*333d2b36SAndroid Build Coastguard Worker	if imageName != "art" {
307*333d2b36SAndroid Build Coastguard Worker		ctx.PropertyErrorf("image_name", `unknown image name %q, expected "art"`, imageName)
308*333d2b36SAndroid Build Coastguard Worker		return
309*333d2b36SAndroid Build Coastguard Worker	}
310*333d2b36SAndroid Build Coastguard Worker
311*333d2b36SAndroid Build Coastguard Worker	// Get the configuration for the art apex jars. Do not use getImageConfig(ctx) here as this is
312*333d2b36SAndroid Build Coastguard Worker	// too early in the Soong processing for that to work.
313*333d2b36SAndroid Build Coastguard Worker	global := dexpreopt.GetGlobalConfig(ctx)
314*333d2b36SAndroid Build Coastguard Worker	modules := global.ArtApexJars
315*333d2b36SAndroid Build Coastguard Worker	configuredJars := modules.CopyOfJars()
316*333d2b36SAndroid Build Coastguard Worker
317*333d2b36SAndroid Build Coastguard Worker	// Skip the check if the configured jars list is empty as that is a common configuration when
318*333d2b36SAndroid Build Coastguard Worker	// building targets that do not result in a system image.
319*333d2b36SAndroid Build Coastguard Worker	if len(configuredJars) == 0 {
320*333d2b36SAndroid Build Coastguard Worker		return
321*333d2b36SAndroid Build Coastguard Worker	}
322*333d2b36SAndroid Build Coastguard Worker
323*333d2b36SAndroid Build Coastguard Worker	if !reflect.DeepEqual(configuredJars, contents) {
324*333d2b36SAndroid Build Coastguard Worker		ctx.ModuleErrorf("inconsistency in specification of contents. ArtApexJars configuration specifies %#v, contents property specifies %#v",
325*333d2b36SAndroid Build Coastguard Worker			configuredJars, contents)
326*333d2b36SAndroid Build Coastguard Worker	}
327*333d2b36SAndroid Build Coastguard Worker
328*333d2b36SAndroid Build Coastguard Worker	// Make sure that the apex specified in the configuration is consistent and is one for which
329*333d2b36SAndroid Build Coastguard Worker	// this boot image is available.
330*333d2b36SAndroid Build Coastguard Worker	commonApex := ""
331*333d2b36SAndroid Build Coastguard Worker	for i := 0; i < modules.Len(); i++ {
332*333d2b36SAndroid Build Coastguard Worker		apex := modules.Apex(i)
333*333d2b36SAndroid Build Coastguard Worker		jar := modules.Jar(i)
334*333d2b36SAndroid Build Coastguard Worker		if apex == "platform" {
335*333d2b36SAndroid Build Coastguard Worker			ctx.ModuleErrorf("ArtApexJars is invalid as it requests a platform variant of %q", jar)
336*333d2b36SAndroid Build Coastguard Worker			continue
337*333d2b36SAndroid Build Coastguard Worker		}
338*333d2b36SAndroid Build Coastguard Worker		if !m.AvailableFor(apex) {
339*333d2b36SAndroid Build Coastguard Worker			ctx.ModuleErrorf("ArtApexJars configuration incompatible with this module, ArtApexJars expects this to be in apex %q but this is only in apexes %q",
340*333d2b36SAndroid Build Coastguard Worker				apex, m.ApexAvailable())
341*333d2b36SAndroid Build Coastguard Worker			continue
342*333d2b36SAndroid Build Coastguard Worker		}
343*333d2b36SAndroid Build Coastguard Worker		if commonApex == "" {
344*333d2b36SAndroid Build Coastguard Worker			commonApex = apex
345*333d2b36SAndroid Build Coastguard Worker		} else if commonApex != apex {
346*333d2b36SAndroid Build Coastguard Worker			ctx.ModuleErrorf("ArtApexJars configuration is inconsistent, expected all jars to be in the same apex but it specifies apex %q and %q",
347*333d2b36SAndroid Build Coastguard Worker				commonApex, apex)
348*333d2b36SAndroid Build Coastguard Worker		}
349*333d2b36SAndroid Build Coastguard Worker	}
350*333d2b36SAndroid Build Coastguard Worker}
351*333d2b36SAndroid Build Coastguard Worker
352*333d2b36SAndroid Build Coastguard Workervar BootclasspathFragmentApexContentInfoProvider = blueprint.NewProvider[BootclasspathFragmentApexContentInfo]()
353*333d2b36SAndroid Build Coastguard Worker
354*333d2b36SAndroid Build Coastguard Worker// BootclasspathFragmentApexContentInfo contains the bootclasspath_fragments contributions to the
355*333d2b36SAndroid Build Coastguard Worker// apex contents.
356*333d2b36SAndroid Build Coastguard Workertype BootclasspathFragmentApexContentInfo struct {
357*333d2b36SAndroid Build Coastguard Worker	// Map from the base module name (without prebuilt_ prefix) of a fragment's contents module to the
358*333d2b36SAndroid Build Coastguard Worker	// hidden API encoded dex jar path.
359*333d2b36SAndroid Build Coastguard Worker	contentModuleDexJarPaths bootDexJarByModule
360*333d2b36SAndroid Build Coastguard Worker
361*333d2b36SAndroid Build Coastguard Worker	// Path to the image profile file on host (or empty, if profile is not generated).
362*333d2b36SAndroid Build Coastguard Worker	profilePathOnHost android.Path
363*333d2b36SAndroid Build Coastguard Worker
364*333d2b36SAndroid Build Coastguard Worker	// Install path of the boot image profile if it needs to be installed in the APEX, or empty if not
365*333d2b36SAndroid Build Coastguard Worker	// needed.
366*333d2b36SAndroid Build Coastguard Worker	profileInstallPathInApex string
367*333d2b36SAndroid Build Coastguard Worker}
368*333d2b36SAndroid Build Coastguard Worker
369*333d2b36SAndroid Build Coastguard Worker// DexBootJarPathForContentModule returns the path to the dex boot jar for specified module.
370*333d2b36SAndroid Build Coastguard Worker//
371*333d2b36SAndroid Build Coastguard Worker// The dex boot jar is one which has had hidden API encoding performed on it.
372*333d2b36SAndroid Build Coastguard Workerfunc (i BootclasspathFragmentApexContentInfo) DexBootJarPathForContentModule(module android.Module) (android.Path, error) {
373*333d2b36SAndroid Build Coastguard Worker	// A bootclasspath_fragment cannot use a prebuilt library so Name() will return the base name
374*333d2b36SAndroid Build Coastguard Worker	// without a prebuilt_ prefix so is safe to use as the key for the contentModuleDexJarPaths.
375*333d2b36SAndroid Build Coastguard Worker	name := module.Name()
376*333d2b36SAndroid Build Coastguard Worker	if dexJar, ok := i.contentModuleDexJarPaths[name]; ok {
377*333d2b36SAndroid Build Coastguard Worker		return dexJar, nil
378*333d2b36SAndroid Build Coastguard Worker	} else {
379*333d2b36SAndroid Build Coastguard Worker		return nil, fmt.Errorf("unknown bootclasspath_fragment content module %s, expected one of %s",
380*333d2b36SAndroid Build Coastguard Worker			name, strings.Join(android.SortedKeys(i.contentModuleDexJarPaths), ", "))
381*333d2b36SAndroid Build Coastguard Worker	}
382*333d2b36SAndroid Build Coastguard Worker}
383*333d2b36SAndroid Build Coastguard Worker
384*333d2b36SAndroid Build Coastguard Workerfunc (i BootclasspathFragmentApexContentInfo) DexBootJarPathMap() bootDexJarByModule {
385*333d2b36SAndroid Build Coastguard Worker	return i.contentModuleDexJarPaths
386*333d2b36SAndroid Build Coastguard Worker}
387*333d2b36SAndroid Build Coastguard Worker
388*333d2b36SAndroid Build Coastguard Workerfunc (i BootclasspathFragmentApexContentInfo) ProfilePathOnHost() android.Path {
389*333d2b36SAndroid Build Coastguard Worker	return i.profilePathOnHost
390*333d2b36SAndroid Build Coastguard Worker}
391*333d2b36SAndroid Build Coastguard Worker
392*333d2b36SAndroid Build Coastguard Workerfunc (i BootclasspathFragmentApexContentInfo) ProfileInstallPathInApex() string {
393*333d2b36SAndroid Build Coastguard Worker	return i.profileInstallPathInApex
394*333d2b36SAndroid Build Coastguard Worker}
395*333d2b36SAndroid Build Coastguard Worker
396*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
397*333d2b36SAndroid Build Coastguard Worker	tag := ctx.OtherModuleDependencyTag(dep)
398*333d2b36SAndroid Build Coastguard Worker
399*333d2b36SAndroid Build Coastguard Worker	// If the module is a default module, do not check the tag
400*333d2b36SAndroid Build Coastguard Worker	if _, ok := dep.(*Defaults); ok {
401*333d2b36SAndroid Build Coastguard Worker		return true
402*333d2b36SAndroid Build Coastguard Worker	}
403*333d2b36SAndroid Build Coastguard Worker	if IsBootclasspathFragmentContentDepTag(tag) {
404*333d2b36SAndroid Build Coastguard Worker		// Boot image contents are automatically added to apex.
405*333d2b36SAndroid Build Coastguard Worker		return true
406*333d2b36SAndroid Build Coastguard Worker	}
407*333d2b36SAndroid Build Coastguard Worker	if android.IsMetaDependencyTag(tag) {
408*333d2b36SAndroid Build Coastguard Worker		// Cross-cutting metadata dependencies are metadata.
409*333d2b36SAndroid Build Coastguard Worker		return false
410*333d2b36SAndroid Build Coastguard Worker	}
411*333d2b36SAndroid Build Coastguard Worker	// Dependency to the bootclasspath fragment of another apex
412*333d2b36SAndroid Build Coastguard Worker	// e.g. concsrypt-bootclasspath-fragment --> art-bootclasspath-fragment
413*333d2b36SAndroid Build Coastguard Worker	if tag == bootclasspathFragmentDepTag {
414*333d2b36SAndroid Build Coastguard Worker		return false
415*333d2b36SAndroid Build Coastguard Worker
416*333d2b36SAndroid Build Coastguard Worker	}
417*333d2b36SAndroid Build Coastguard Worker	panic(fmt.Errorf("boot_image module %q should not have a dependency on %q via tag %s", b, dep, android.PrettyPrintTag(tag)))
418*333d2b36SAndroid Build Coastguard Worker}
419*333d2b36SAndroid Build Coastguard Worker
420*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
421*333d2b36SAndroid Build Coastguard Worker	return nil
422*333d2b36SAndroid Build Coastguard Worker}
423*333d2b36SAndroid Build Coastguard Worker
424*333d2b36SAndroid Build Coastguard Worker// ComponentDepsMutator adds dependencies onto modules before any prebuilt modules without a
425*333d2b36SAndroid Build Coastguard Worker// corresponding source module are renamed. This means that adding a dependency using a name without
426*333d2b36SAndroid Build Coastguard Worker// a prebuilt_ prefix will always resolve to a source module and when using a name with that prefix
427*333d2b36SAndroid Build Coastguard Worker// it will always resolve to a prebuilt module.
428*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) ComponentDepsMutator(ctx android.BottomUpMutatorContext) {
429*333d2b36SAndroid Build Coastguard Worker	module := ctx.Module()
430*333d2b36SAndroid Build Coastguard Worker	_, isSourceModule := module.(*BootclasspathFragmentModule)
431*333d2b36SAndroid Build Coastguard Worker
432*333d2b36SAndroid Build Coastguard Worker	for _, name := range b.properties.Contents.GetOrDefault(ctx, nil) {
433*333d2b36SAndroid Build Coastguard Worker		// A bootclasspath_fragment must depend only on other source modules, while the
434*333d2b36SAndroid Build Coastguard Worker		// prebuilt_bootclasspath_fragment must only depend on other prebuilt modules.
435*333d2b36SAndroid Build Coastguard Worker		//
436*333d2b36SAndroid Build Coastguard Worker		// TODO(b/177892522) - avoid special handling of jacocoagent.
437*333d2b36SAndroid Build Coastguard Worker		if !isSourceModule && name != "jacocoagent" {
438*333d2b36SAndroid Build Coastguard Worker			name = android.PrebuiltNameFromSource(name)
439*333d2b36SAndroid Build Coastguard Worker		}
440*333d2b36SAndroid Build Coastguard Worker		ctx.AddDependency(module, bootclasspathFragmentContentDepTag, name)
441*333d2b36SAndroid Build Coastguard Worker	}
442*333d2b36SAndroid Build Coastguard Worker
443*333d2b36SAndroid Build Coastguard Worker}
444*333d2b36SAndroid Build Coastguard Worker
445*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) DepsMutator(ctx android.BottomUpMutatorContext) {
446*333d2b36SAndroid Build Coastguard Worker	// Add dependencies onto all the modules that provide the API stubs for classes on this
447*333d2b36SAndroid Build Coastguard Worker	// bootclasspath fragment.
448*333d2b36SAndroid Build Coastguard Worker	hiddenAPIAddStubLibDependencies(ctx, b.properties.apiScopeToStubLibs(ctx))
449*333d2b36SAndroid Build Coastguard Worker
450*333d2b36SAndroid Build Coastguard Worker	for _, additionalStubModule := range b.properties.Additional_stubs {
451*333d2b36SAndroid Build Coastguard Worker		for _, apiScope := range hiddenAPISdkLibrarySupportedScopes {
452*333d2b36SAndroid Build Coastguard Worker			// Add a dependency onto a possibly scope specific stub library.
453*333d2b36SAndroid Build Coastguard Worker			scopeSpecificDependency := apiScope.scopeSpecificStubModule(ctx, additionalStubModule)
454*333d2b36SAndroid Build Coastguard Worker			tag := hiddenAPIStubsDependencyTag{apiScope: apiScope, fromAdditionalDependency: true}
455*333d2b36SAndroid Build Coastguard Worker			ctx.AddVariationDependencies(nil, tag, scopeSpecificDependency)
456*333d2b36SAndroid Build Coastguard Worker		}
457*333d2b36SAndroid Build Coastguard Worker	}
458*333d2b36SAndroid Build Coastguard Worker
459*333d2b36SAndroid Build Coastguard Worker	if !dexpreopt.IsDex2oatNeeded(ctx) {
460*333d2b36SAndroid Build Coastguard Worker		return
461*333d2b36SAndroid Build Coastguard Worker	}
462*333d2b36SAndroid Build Coastguard Worker
463*333d2b36SAndroid Build Coastguard Worker	// Add a dependency onto the dex2oat tool which is needed for creating the boot image. The
464*333d2b36SAndroid Build Coastguard Worker	// path is retrieved from the dependency by GetGlobalSoongConfig(ctx).
465*333d2b36SAndroid Build Coastguard Worker	dexpreopt.RegisterToolDeps(ctx)
466*333d2b36SAndroid Build Coastguard Worker
467*333d2b36SAndroid Build Coastguard Worker	// Add a dependency to `all_apex_contributions` to determine if prebuilts are active.
468*333d2b36SAndroid Build Coastguard Worker	// If prebuilts are active, `contents` validation on the source bootclasspath fragment should be disabled.
469*333d2b36SAndroid Build Coastguard Worker	if _, isPrebuiltModule := ctx.Module().(*PrebuiltBootclasspathFragmentModule); !isPrebuiltModule {
470*333d2b36SAndroid Build Coastguard Worker		ctx.AddDependency(b, android.AcDepTag, "all_apex_contributions")
471*333d2b36SAndroid Build Coastguard Worker	}
472*333d2b36SAndroid Build Coastguard Worker}
473*333d2b36SAndroid Build Coastguard Worker
474*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) BootclasspathDepsMutator(ctx android.BottomUpMutatorContext) {
475*333d2b36SAndroid Build Coastguard Worker	// Add dependencies on all the fragments.
476*333d2b36SAndroid Build Coastguard Worker	b.properties.BootclasspathFragmentsDepsProperties.addDependenciesOntoFragments(ctx)
477*333d2b36SAndroid Build Coastguard Worker}
478*333d2b36SAndroid Build Coastguard Worker
479*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
480*333d2b36SAndroid Build Coastguard Worker	// Only perform a consistency check if this module is the active module. That will prevent an
481*333d2b36SAndroid Build Coastguard Worker	// unused prebuilt that was created without instrumentation from breaking an instrumentation
482*333d2b36SAndroid Build Coastguard Worker	// build.
483*333d2b36SAndroid Build Coastguard Worker	if isActiveModule(ctx, ctx.Module()) {
484*333d2b36SAndroid Build Coastguard Worker		b.bootclasspathFragmentPropertyCheck(ctx)
485*333d2b36SAndroid Build Coastguard Worker	}
486*333d2b36SAndroid Build Coastguard Worker
487*333d2b36SAndroid Build Coastguard Worker	// Generate classpaths.proto config
488*333d2b36SAndroid Build Coastguard Worker	b.generateClasspathProtoBuildActions(ctx)
489*333d2b36SAndroid Build Coastguard Worker
490*333d2b36SAndroid Build Coastguard Worker	// Gather the bootclasspath fragment's contents.
491*333d2b36SAndroid Build Coastguard Worker	var contents []android.Module
492*333d2b36SAndroid Build Coastguard Worker	ctx.VisitDirectDeps(func(module android.Module) {
493*333d2b36SAndroid Build Coastguard Worker		tag := ctx.OtherModuleDependencyTag(module)
494*333d2b36SAndroid Build Coastguard Worker		if IsBootclasspathFragmentContentDepTag(tag) {
495*333d2b36SAndroid Build Coastguard Worker			contents = append(contents, module)
496*333d2b36SAndroid Build Coastguard Worker		}
497*333d2b36SAndroid Build Coastguard Worker	})
498*333d2b36SAndroid Build Coastguard Worker
499*333d2b36SAndroid Build Coastguard Worker	fragments := gatherApexModulePairDepsWithTag(ctx, bootclasspathFragmentDepTag)
500*333d2b36SAndroid Build Coastguard Worker
501*333d2b36SAndroid Build Coastguard Worker	// Perform hidden API processing.
502*333d2b36SAndroid Build Coastguard Worker	hiddenAPIOutput := b.generateHiddenAPIBuildActions(ctx, contents, fragments)
503*333d2b36SAndroid Build Coastguard Worker
504*333d2b36SAndroid Build Coastguard Worker	if android.IsModulePrebuilt(ctx.Module()) {
505*333d2b36SAndroid Build Coastguard Worker		b.profilePath = ctx.Module().(*PrebuiltBootclasspathFragmentModule).produceBootImageProfile(ctx)
506*333d2b36SAndroid Build Coastguard Worker	} else {
507*333d2b36SAndroid Build Coastguard Worker		b.profilePath = b.produceBootImageProfileFromSource(ctx, contents, hiddenAPIOutput.EncodedBootDexFilesByModule)
508*333d2b36SAndroid Build Coastguard Worker		// Provide the apex content info. A prebuilt fragment cannot contribute to an apex.
509*333d2b36SAndroid Build Coastguard Worker		b.provideApexContentInfo(ctx, hiddenAPIOutput, b.profilePath)
510*333d2b36SAndroid Build Coastguard Worker	}
511*333d2b36SAndroid Build Coastguard Worker
512*333d2b36SAndroid Build Coastguard Worker	// In order for information about bootclasspath_fragment modules to be added to module-info.json
513*333d2b36SAndroid Build Coastguard Worker	// it is necessary to output an entry to Make. As bootclasspath_fragment modules are part of an
514*333d2b36SAndroid Build Coastguard Worker	// APEX there can be multiple variants, including the default/platform variant and only one can
515*333d2b36SAndroid Build Coastguard Worker	// be output to Make but it does not really matter which variant is output. The default/platform
516*333d2b36SAndroid Build Coastguard Worker	// variant is the first (ctx.PrimaryModule()) and is usually hidden from make so this just picks
517*333d2b36SAndroid Build Coastguard Worker	// the last variant (ctx.FinalModule()).
518*333d2b36SAndroid Build Coastguard Worker	if !ctx.IsFinalModule(ctx.Module()) {
519*333d2b36SAndroid Build Coastguard Worker		b.HideFromMake()
520*333d2b36SAndroid Build Coastguard Worker	}
521*333d2b36SAndroid Build Coastguard Worker}
522*333d2b36SAndroid Build Coastguard Worker
523*333d2b36SAndroid Build Coastguard Worker// getProfileProviderApex returns the name of the apex that provides a boot image profile, or an
524*333d2b36SAndroid Build Coastguard Worker// empty string if this module should not provide a boot image profile.
525*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) getProfileProviderApex(ctx android.BaseModuleContext) string {
526*333d2b36SAndroid Build Coastguard Worker	// Only use the profile from the module that is preferred.
527*333d2b36SAndroid Build Coastguard Worker	if !isActiveModule(ctx, ctx.Module()) {
528*333d2b36SAndroid Build Coastguard Worker		return ""
529*333d2b36SAndroid Build Coastguard Worker	}
530*333d2b36SAndroid Build Coastguard Worker
531*333d2b36SAndroid Build Coastguard Worker	// Bootclasspath fragment modules that are for the platform do not produce boot related files.
532*333d2b36SAndroid Build Coastguard Worker	apexInfos, _ := android.ModuleProvider(ctx, android.AllApexInfoProvider)
533*333d2b36SAndroid Build Coastguard Worker	if apexInfos == nil {
534*333d2b36SAndroid Build Coastguard Worker		return ""
535*333d2b36SAndroid Build Coastguard Worker	}
536*333d2b36SAndroid Build Coastguard Worker
537*333d2b36SAndroid Build Coastguard Worker	for _, apexInfo := range apexInfos.ApexInfos {
538*333d2b36SAndroid Build Coastguard Worker		for _, apex := range apexInfo.InApexVariants {
539*333d2b36SAndroid Build Coastguard Worker			if isProfileProviderApex(ctx, apex) {
540*333d2b36SAndroid Build Coastguard Worker				return apex
541*333d2b36SAndroid Build Coastguard Worker			}
542*333d2b36SAndroid Build Coastguard Worker		}
543*333d2b36SAndroid Build Coastguard Worker	}
544*333d2b36SAndroid Build Coastguard Worker
545*333d2b36SAndroid Build Coastguard Worker	return ""
546*333d2b36SAndroid Build Coastguard Worker}
547*333d2b36SAndroid Build Coastguard Worker
548*333d2b36SAndroid Build Coastguard Worker// provideApexContentInfo creates, initializes and stores the apex content info for use by other
549*333d2b36SAndroid Build Coastguard Worker// modules.
550*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) provideApexContentInfo(ctx android.ModuleContext, hiddenAPIOutput *HiddenAPIOutput, profile android.WritablePath) {
551*333d2b36SAndroid Build Coastguard Worker	// Construct the apex content info from the config.
552*333d2b36SAndroid Build Coastguard Worker	info := BootclasspathFragmentApexContentInfo{
553*333d2b36SAndroid Build Coastguard Worker		// Populate the apex content info with paths to the dex jars.
554*333d2b36SAndroid Build Coastguard Worker		contentModuleDexJarPaths: hiddenAPIOutput.EncodedBootDexFilesByModule,
555*333d2b36SAndroid Build Coastguard Worker	}
556*333d2b36SAndroid Build Coastguard Worker
557*333d2b36SAndroid Build Coastguard Worker	if profile != nil {
558*333d2b36SAndroid Build Coastguard Worker		info.profilePathOnHost = profile
559*333d2b36SAndroid Build Coastguard Worker		info.profileInstallPathInApex = ProfileInstallPathInApex
560*333d2b36SAndroid Build Coastguard Worker	}
561*333d2b36SAndroid Build Coastguard Worker
562*333d2b36SAndroid Build Coastguard Worker	// Make the apex content info available for other modules.
563*333d2b36SAndroid Build Coastguard Worker	android.SetProvider(ctx, BootclasspathFragmentApexContentInfoProvider, info)
564*333d2b36SAndroid Build Coastguard Worker}
565*333d2b36SAndroid Build Coastguard Worker
566*333d2b36SAndroid Build Coastguard Worker// generateClasspathProtoBuildActions generates all required build actions for classpath.proto config
567*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) generateClasspathProtoBuildActions(ctx android.ModuleContext) {
568*333d2b36SAndroid Build Coastguard Worker	var classpathJars []classpathJar
569*333d2b36SAndroid Build Coastguard Worker	configuredJars := b.configuredJars(ctx)
570*333d2b36SAndroid Build Coastguard Worker	if "art" == proptools.String(b.properties.Image_name) {
571*333d2b36SAndroid Build Coastguard Worker		// ART and platform boot jars must have a corresponding entry in DEX2OATBOOTCLASSPATH
572*333d2b36SAndroid Build Coastguard Worker		classpathJars = configuredJarListToClasspathJars(ctx, configuredJars, BOOTCLASSPATH, DEX2OATBOOTCLASSPATH)
573*333d2b36SAndroid Build Coastguard Worker	} else {
574*333d2b36SAndroid Build Coastguard Worker		classpathJars = configuredJarListToClasspathJars(ctx, configuredJars, b.classpathType)
575*333d2b36SAndroid Build Coastguard Worker	}
576*333d2b36SAndroid Build Coastguard Worker	b.classpathFragmentBase().generateClasspathProtoBuildActions(ctx, configuredJars, classpathJars)
577*333d2b36SAndroid Build Coastguard Worker}
578*333d2b36SAndroid Build Coastguard Worker
579*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) configuredJars(ctx android.ModuleContext) android.ConfiguredJarList {
580*333d2b36SAndroid Build Coastguard Worker	global := dexpreopt.GetGlobalConfig(ctx)
581*333d2b36SAndroid Build Coastguard Worker
582*333d2b36SAndroid Build Coastguard Worker	if "art" == proptools.String(b.properties.Image_name) {
583*333d2b36SAndroid Build Coastguard Worker		return global.ArtApexJars
584*333d2b36SAndroid Build Coastguard Worker	}
585*333d2b36SAndroid Build Coastguard Worker
586*333d2b36SAndroid Build Coastguard Worker	possibleUpdatableModules := gatherPossibleApexModuleNamesAndStems(ctx, b.properties.Contents.GetOrDefault(ctx, nil), bootclasspathFragmentContentDepTag)
587*333d2b36SAndroid Build Coastguard Worker	jars, unknown := global.ApexBootJars.Filter(possibleUpdatableModules)
588*333d2b36SAndroid Build Coastguard Worker
589*333d2b36SAndroid Build Coastguard Worker	// TODO(satayev): for apex_test we want to include all contents unconditionally to classpaths
590*333d2b36SAndroid Build Coastguard Worker	// config. However, any test specific jars would not be present in ApexBootJars. Instead,
591*333d2b36SAndroid Build Coastguard Worker	// we should check if we are creating a config for apex_test via ApexInfo and amend the values.
592*333d2b36SAndroid Build Coastguard Worker	// This is an exception to support end-to-end test for SdkExtensions, until such support exists.
593*333d2b36SAndroid Build Coastguard Worker	if android.InList("test_framework-sdkextensions", possibleUpdatableModules) {
594*333d2b36SAndroid Build Coastguard Worker		jars = jars.Append("com.android.sdkext", "test_framework-sdkextensions")
595*333d2b36SAndroid Build Coastguard Worker	} else if android.InList("test_framework-apexd", possibleUpdatableModules) {
596*333d2b36SAndroid Build Coastguard Worker		jars = jars.Append("com.android.apex.test_package", "test_framework-apexd")
597*333d2b36SAndroid Build Coastguard Worker	} else if global.ApexBootJars.Len() != 0 {
598*333d2b36SAndroid Build Coastguard Worker		unknown = android.RemoveListFromList(unknown, b.properties.Coverage.Contents.GetOrDefault(ctx, nil))
599*333d2b36SAndroid Build Coastguard Worker		_, unknown = android.RemoveFromList("core-icu4j", unknown)
600*333d2b36SAndroid Build Coastguard Worker		// This module only exists in car products.
601*333d2b36SAndroid Build Coastguard Worker		// So ignore it even if it is not in PRODUCT_APEX_BOOT_JARS.
602*333d2b36SAndroid Build Coastguard Worker		// TODO(b/202896428): Add better way to handle this.
603*333d2b36SAndroid Build Coastguard Worker		_, unknown = android.RemoveFromList("android.car-module", unknown)
604*333d2b36SAndroid Build Coastguard Worker		if isApexVariant(ctx) && len(unknown) > 0 {
605*333d2b36SAndroid Build Coastguard Worker			if android.IsModulePrebuilt(ctx.Module()) {
606*333d2b36SAndroid Build Coastguard Worker				// prebuilt bcpf. the validation of this will be done at the top-level apex
607*333d2b36SAndroid Build Coastguard Worker				providerClasspathFragmentValidationInfoProvider(ctx, unknown)
608*333d2b36SAndroid Build Coastguard Worker			} else if !disableSourceApexVariant(ctx) {
609*333d2b36SAndroid Build Coastguard Worker				// source bcpf, and prebuilt apex are not selected.
610*333d2b36SAndroid Build Coastguard Worker				ctx.ModuleErrorf("%s in contents must also be declared in PRODUCT_APEX_BOOT_JARS", unknown)
611*333d2b36SAndroid Build Coastguard Worker			}
612*333d2b36SAndroid Build Coastguard Worker		}
613*333d2b36SAndroid Build Coastguard Worker	}
614*333d2b36SAndroid Build Coastguard Worker	return jars
615*333d2b36SAndroid Build Coastguard Worker}
616*333d2b36SAndroid Build Coastguard Worker
617*333d2b36SAndroid Build Coastguard Workervar ClasspathFragmentValidationInfoProvider = blueprint.NewProvider[ClasspathFragmentValidationInfo]()
618*333d2b36SAndroid Build Coastguard Worker
619*333d2b36SAndroid Build Coastguard Workertype ClasspathFragmentValidationInfo struct {
620*333d2b36SAndroid Build Coastguard Worker	ClasspathFragmentModuleName string
621*333d2b36SAndroid Build Coastguard Worker	UnknownJars                 []string
622*333d2b36SAndroid Build Coastguard Worker}
623*333d2b36SAndroid Build Coastguard Worker
624*333d2b36SAndroid Build Coastguard Worker// Set a provider with the list of jars that have not been added to PRODUCT_APEX_BOOT_JARS
625*333d2b36SAndroid Build Coastguard Worker// The validation will be done in the ctx of the top-level _selected_ apex
626*333d2b36SAndroid Build Coastguard Workerfunc providerClasspathFragmentValidationInfoProvider(ctx android.ModuleContext, unknown []string) {
627*333d2b36SAndroid Build Coastguard Worker	info := ClasspathFragmentValidationInfo{
628*333d2b36SAndroid Build Coastguard Worker		ClasspathFragmentModuleName: ctx.ModuleName(),
629*333d2b36SAndroid Build Coastguard Worker		UnknownJars:                 unknown,
630*333d2b36SAndroid Build Coastguard Worker	}
631*333d2b36SAndroid Build Coastguard Worker	android.SetProvider(ctx, ClasspathFragmentValidationInfoProvider, info)
632*333d2b36SAndroid Build Coastguard Worker}
633*333d2b36SAndroid Build Coastguard Worker
634*333d2b36SAndroid Build Coastguard Worker// generateHiddenAPIBuildActions generates all the hidden API related build rules.
635*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) generateHiddenAPIBuildActions(ctx android.ModuleContext, contents []android.Module, fragments []android.Module) *HiddenAPIOutput {
636*333d2b36SAndroid Build Coastguard Worker
637*333d2b36SAndroid Build Coastguard Worker	// Create hidden API input structure.
638*333d2b36SAndroid Build Coastguard Worker	input := b.createHiddenAPIFlagInput(ctx, contents, fragments)
639*333d2b36SAndroid Build Coastguard Worker
640*333d2b36SAndroid Build Coastguard Worker	// Delegate the production of the hidden API all-flags.csv file to a module type specific method.
641*333d2b36SAndroid Build Coastguard Worker	common := ctx.Module().(commonBootclasspathFragment)
642*333d2b36SAndroid Build Coastguard Worker	output := common.produceHiddenAPIOutput(ctx, contents, fragments, input)
643*333d2b36SAndroid Build Coastguard Worker
644*333d2b36SAndroid Build Coastguard Worker	// If the source or prebuilts module does not provide a signature patterns file then generate one
645*333d2b36SAndroid Build Coastguard Worker	// from the flags.
646*333d2b36SAndroid Build Coastguard Worker	// TODO(b/192868581): Remove once the source and prebuilts provide a signature patterns file of
647*333d2b36SAndroid Build Coastguard Worker	//  their own.
648*333d2b36SAndroid Build Coastguard Worker	if output.SignaturePatternsPath == nil {
649*333d2b36SAndroid Build Coastguard Worker		output.SignaturePatternsPath = buildRuleSignaturePatternsFile(
650*333d2b36SAndroid Build Coastguard Worker			ctx, output.AllFlagsPath, []string{"*"}, nil, nil, "")
651*333d2b36SAndroid Build Coastguard Worker	}
652*333d2b36SAndroid Build Coastguard Worker
653*333d2b36SAndroid Build Coastguard Worker	// Initialize a HiddenAPIInfo structure.
654*333d2b36SAndroid Build Coastguard Worker	hiddenAPIInfo := HiddenAPIInfo{
655*333d2b36SAndroid Build Coastguard Worker		// The monolithic hidden API processing needs access to the flag files that override the default
656*333d2b36SAndroid Build Coastguard Worker		// flags from all the fragments whether or not they actually perform their own hidden API flag
657*333d2b36SAndroid Build Coastguard Worker		// generation. That is because the monolithic hidden API processing uses those flag files to
658*333d2b36SAndroid Build Coastguard Worker		// perform its own flag generation.
659*333d2b36SAndroid Build Coastguard Worker		FlagFilesByCategory: input.FlagFilesByCategory,
660*333d2b36SAndroid Build Coastguard Worker
661*333d2b36SAndroid Build Coastguard Worker		// Other bootclasspath_fragments that depend on this need the transitive set of stub dex jars
662*333d2b36SAndroid Build Coastguard Worker		// from this to resolve any references from their code to classes provided by this fragment
663*333d2b36SAndroid Build Coastguard Worker		// and the fragments this depends upon.
664*333d2b36SAndroid Build Coastguard Worker		TransitiveStubDexJarsByScope: input.transitiveStubDexJarsByScope(),
665*333d2b36SAndroid Build Coastguard Worker	}
666*333d2b36SAndroid Build Coastguard Worker
667*333d2b36SAndroid Build Coastguard Worker	// The monolithic hidden API processing also needs access to all the output files produced by
668*333d2b36SAndroid Build Coastguard Worker	// hidden API processing of this fragment.
669*333d2b36SAndroid Build Coastguard Worker	hiddenAPIInfo.HiddenAPIFlagOutput = output.HiddenAPIFlagOutput
670*333d2b36SAndroid Build Coastguard Worker
671*333d2b36SAndroid Build Coastguard Worker	//  Provide it for use by other modules.
672*333d2b36SAndroid Build Coastguard Worker	android.SetProvider(ctx, HiddenAPIInfoProvider, hiddenAPIInfo)
673*333d2b36SAndroid Build Coastguard Worker
674*333d2b36SAndroid Build Coastguard Worker	return output
675*333d2b36SAndroid Build Coastguard Worker}
676*333d2b36SAndroid Build Coastguard Worker
677*333d2b36SAndroid Build Coastguard Worker// createHiddenAPIFlagInput creates a HiddenAPIFlagInput struct and initializes it with information derived
678*333d2b36SAndroid Build Coastguard Worker// from the properties on this module and its dependencies.
679*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) createHiddenAPIFlagInput(ctx android.ModuleContext, contents []android.Module, fragments []android.Module) HiddenAPIFlagInput {
680*333d2b36SAndroid Build Coastguard Worker	// Merge the HiddenAPIInfo from all the fragment dependencies.
681*333d2b36SAndroid Build Coastguard Worker	dependencyHiddenApiInfo := newHiddenAPIInfo()
682*333d2b36SAndroid Build Coastguard Worker	dependencyHiddenApiInfo.mergeFromFragmentDeps(ctx, fragments)
683*333d2b36SAndroid Build Coastguard Worker
684*333d2b36SAndroid Build Coastguard Worker	// Create hidden API flag input structure.
685*333d2b36SAndroid Build Coastguard Worker	input := newHiddenAPIFlagInput()
686*333d2b36SAndroid Build Coastguard Worker
687*333d2b36SAndroid Build Coastguard Worker	// Update the input structure with information obtained from the stub libraries.
688*333d2b36SAndroid Build Coastguard Worker	input.gatherStubLibInfo(ctx, contents)
689*333d2b36SAndroid Build Coastguard Worker
690*333d2b36SAndroid Build Coastguard Worker	// Populate with flag file paths from the properties.
691*333d2b36SAndroid Build Coastguard Worker	input.extractFlagFilesFromProperties(ctx, &b.properties.HiddenAPIFlagFileProperties)
692*333d2b36SAndroid Build Coastguard Worker
693*333d2b36SAndroid Build Coastguard Worker	// Populate with package rules from the properties.
694*333d2b36SAndroid Build Coastguard Worker	input.extractPackageRulesFromProperties(&b.sourceOnlyProperties.HiddenAPIPackageProperties)
695*333d2b36SAndroid Build Coastguard Worker
696*333d2b36SAndroid Build Coastguard Worker	input.gatherPropertyInfo(ctx, contents)
697*333d2b36SAndroid Build Coastguard Worker
698*333d2b36SAndroid Build Coastguard Worker	// Add the stub dex jars from this module's fragment dependencies.
699*333d2b36SAndroid Build Coastguard Worker	input.DependencyStubDexJarsByScope.addStubDexJarsByModule(dependencyHiddenApiInfo.TransitiveStubDexJarsByScope)
700*333d2b36SAndroid Build Coastguard Worker
701*333d2b36SAndroid Build Coastguard Worker	return input
702*333d2b36SAndroid Build Coastguard Worker}
703*333d2b36SAndroid Build Coastguard Worker
704*333d2b36SAndroid Build Coastguard Worker// isTestFragment returns true if the current module is a test bootclasspath_fragment.
705*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) isTestFragment() bool {
706*333d2b36SAndroid Build Coastguard Worker	return b.testFragment
707*333d2b36SAndroid Build Coastguard Worker}
708*333d2b36SAndroid Build Coastguard Worker
709*333d2b36SAndroid Build Coastguard Worker// generateHiddenApiFlagRules generates rules to generate hidden API flags and compute the signature
710*333d2b36SAndroid Build Coastguard Worker// patterns file.
711*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) generateHiddenApiFlagRules(ctx android.ModuleContext, contents []android.Module, input HiddenAPIFlagInput, bootDexInfoByModule bootDexInfoByModule, suffix string) HiddenAPIFlagOutput {
712*333d2b36SAndroid Build Coastguard Worker	// Generate the rules to create the hidden API flags and update the supplied hiddenAPIInfo with the
713*333d2b36SAndroid Build Coastguard Worker	// paths to the created files.
714*333d2b36SAndroid Build Coastguard Worker	flagOutput := hiddenAPIFlagRulesForBootclasspathFragment(ctx, bootDexInfoByModule, contents, input, suffix)
715*333d2b36SAndroid Build Coastguard Worker
716*333d2b36SAndroid Build Coastguard Worker	// If the module specifies split_packages or package_prefixes then use those to generate the
717*333d2b36SAndroid Build Coastguard Worker	// signature patterns.
718*333d2b36SAndroid Build Coastguard Worker	splitPackages := input.SplitPackages
719*333d2b36SAndroid Build Coastguard Worker	packagePrefixes := input.PackagePrefixes
720*333d2b36SAndroid Build Coastguard Worker	singlePackages := input.SinglePackages
721*333d2b36SAndroid Build Coastguard Worker	if splitPackages != nil || packagePrefixes != nil || singlePackages != nil {
722*333d2b36SAndroid Build Coastguard Worker		flagOutput.SignaturePatternsPath = buildRuleSignaturePatternsFile(
723*333d2b36SAndroid Build Coastguard Worker			ctx, flagOutput.AllFlagsPath, splitPackages, packagePrefixes, singlePackages, suffix)
724*333d2b36SAndroid Build Coastguard Worker	} else if !b.isTestFragment() {
725*333d2b36SAndroid Build Coastguard Worker		ctx.ModuleErrorf(`Must specify at least one of the split_packages, package_prefixes and single_packages properties
726*333d2b36SAndroid Build Coastguard Worker  If this is a new bootclasspath_fragment or you are unsure what to do add the
727*333d2b36SAndroid Build Coastguard Worker  the following to the bootclasspath_fragment:
728*333d2b36SAndroid Build Coastguard Worker      hidden_api: {split_packages: ["*"]},
729*333d2b36SAndroid Build Coastguard Worker  and then run the following:
730*333d2b36SAndroid Build Coastguard Worker      m analyze_bcpf && analyze_bcpf --bcpf %q
731*333d2b36SAndroid Build Coastguard Worker  it will analyze the bootclasspath_fragment and provide hints as to what you
732*333d2b36SAndroid Build Coastguard Worker  should specify here. If you are happy with its suggestions then you can add
733*333d2b36SAndroid Build Coastguard Worker  the --fix option and it will fix them for you.`, b.BaseModuleName())
734*333d2b36SAndroid Build Coastguard Worker	}
735*333d2b36SAndroid Build Coastguard Worker	return flagOutput
736*333d2b36SAndroid Build Coastguard Worker}
737*333d2b36SAndroid Build Coastguard Worker
738*333d2b36SAndroid Build Coastguard Worker// produceHiddenAPIOutput produces the hidden API all-flags.csv file (and supporting files)
739*333d2b36SAndroid Build Coastguard Worker// for the fragment as well as encoding the flags in the boot dex jars.
740*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) produceHiddenAPIOutput(ctx android.ModuleContext, contents []android.Module, fragments []android.Module, input HiddenAPIFlagInput) *HiddenAPIOutput {
741*333d2b36SAndroid Build Coastguard Worker	// Gather information about the boot dex files for the boot libraries provided by this fragment.
742*333d2b36SAndroid Build Coastguard Worker	bootDexInfoByModule := extractBootDexInfoFromModules(ctx, contents)
743*333d2b36SAndroid Build Coastguard Worker
744*333d2b36SAndroid Build Coastguard Worker	// Generate the flag file needed to encode into the dex files.
745*333d2b36SAndroid Build Coastguard Worker	flagOutput := b.generateHiddenApiFlagRules(ctx, contents, input, bootDexInfoByModule, "")
746*333d2b36SAndroid Build Coastguard Worker
747*333d2b36SAndroid Build Coastguard Worker	// Encode those flags into the dex files of the contents of this fragment.
748*333d2b36SAndroid Build Coastguard Worker	encodedBootDexFilesByModule := hiddenAPIEncodeRulesForBootclasspathFragment(ctx, bootDexInfoByModule, flagOutput.AllFlagsPath)
749*333d2b36SAndroid Build Coastguard Worker
750*333d2b36SAndroid Build Coastguard Worker	// Store that information for return for use by other rules.
751*333d2b36SAndroid Build Coastguard Worker	output := &HiddenAPIOutput{
752*333d2b36SAndroid Build Coastguard Worker		HiddenAPIFlagOutput:         flagOutput,
753*333d2b36SAndroid Build Coastguard Worker		EncodedBootDexFilesByModule: encodedBootDexFilesByModule,
754*333d2b36SAndroid Build Coastguard Worker	}
755*333d2b36SAndroid Build Coastguard Worker
756*333d2b36SAndroid Build Coastguard Worker	// Get the ApiLevel associated with SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE, defaulting to current
757*333d2b36SAndroid Build Coastguard Worker	// if not set.
758*333d2b36SAndroid Build Coastguard Worker	config := ctx.Config()
759*333d2b36SAndroid Build Coastguard Worker	targetApiLevel := android.ApiLevelOrPanic(ctx,
760*333d2b36SAndroid Build Coastguard Worker		config.GetenvWithDefault("SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE", "current"))
761*333d2b36SAndroid Build Coastguard Worker
762*333d2b36SAndroid Build Coastguard Worker	// Filter the contents list to remove any modules that do not support the target build release.
763*333d2b36SAndroid Build Coastguard Worker	// The current build release supports all the modules.
764*333d2b36SAndroid Build Coastguard Worker	contentsForSdkSnapshot := []android.Module{}
765*333d2b36SAndroid Build Coastguard Worker	for _, module := range contents {
766*333d2b36SAndroid Build Coastguard Worker		// If the module has a min_sdk_version that is higher than the target build release then it will
767*333d2b36SAndroid Build Coastguard Worker		// not work on the target build release and so must not be included in the sdk snapshot.
768*333d2b36SAndroid Build Coastguard Worker		minApiLevel := android.MinApiLevelForSdkSnapshot(ctx, module)
769*333d2b36SAndroid Build Coastguard Worker		if minApiLevel.GreaterThan(targetApiLevel) {
770*333d2b36SAndroid Build Coastguard Worker			continue
771*333d2b36SAndroid Build Coastguard Worker		}
772*333d2b36SAndroid Build Coastguard Worker
773*333d2b36SAndroid Build Coastguard Worker		contentsForSdkSnapshot = append(contentsForSdkSnapshot, module)
774*333d2b36SAndroid Build Coastguard Worker	}
775*333d2b36SAndroid Build Coastguard Worker
776*333d2b36SAndroid Build Coastguard Worker	var flagFilesByCategory FlagFilesByCategory
777*333d2b36SAndroid Build Coastguard Worker	if len(contentsForSdkSnapshot) != len(contents) {
778*333d2b36SAndroid Build Coastguard Worker		// The sdk snapshot has different contents to the runtime fragment so it is not possible to
779*333d2b36SAndroid Build Coastguard Worker		// reuse the hidden API information generated for the fragment. So, recompute that information
780*333d2b36SAndroid Build Coastguard Worker		// for the sdk snapshot.
781*333d2b36SAndroid Build Coastguard Worker		filteredInput := b.createHiddenAPIFlagInput(ctx, contentsForSdkSnapshot, fragments)
782*333d2b36SAndroid Build Coastguard Worker
783*333d2b36SAndroid Build Coastguard Worker		// Gather information about the boot dex files for the boot libraries provided by this fragment.
784*333d2b36SAndroid Build Coastguard Worker		filteredBootDexInfoByModule := extractBootDexInfoFromModules(ctx, contentsForSdkSnapshot)
785*333d2b36SAndroid Build Coastguard Worker		flagOutput = b.generateHiddenApiFlagRules(ctx, contentsForSdkSnapshot, filteredInput, filteredBootDexInfoByModule, "-for-sdk-snapshot")
786*333d2b36SAndroid Build Coastguard Worker		flagFilesByCategory = filteredInput.FlagFilesByCategory
787*333d2b36SAndroid Build Coastguard Worker	} else {
788*333d2b36SAndroid Build Coastguard Worker		// The sdk snapshot has the same contents as the runtime fragment so reuse that information.
789*333d2b36SAndroid Build Coastguard Worker		flagFilesByCategory = input.FlagFilesByCategory
790*333d2b36SAndroid Build Coastguard Worker	}
791*333d2b36SAndroid Build Coastguard Worker
792*333d2b36SAndroid Build Coastguard Worker	// Make the information available for the sdk snapshot.
793*333d2b36SAndroid Build Coastguard Worker	android.SetProvider(ctx, HiddenAPIInfoForSdkProvider, HiddenAPIInfoForSdk{
794*333d2b36SAndroid Build Coastguard Worker		FlagFilesByCategory: flagFilesByCategory,
795*333d2b36SAndroid Build Coastguard Worker		HiddenAPIFlagOutput: flagOutput,
796*333d2b36SAndroid Build Coastguard Worker	})
797*333d2b36SAndroid Build Coastguard Worker
798*333d2b36SAndroid Build Coastguard Worker	return output
799*333d2b36SAndroid Build Coastguard Worker}
800*333d2b36SAndroid Build Coastguard Worker
801*333d2b36SAndroid Build Coastguard Worker// produceBootImageProfileFromSource builds the boot image profile from the source if it is required.
802*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) produceBootImageProfileFromSource(ctx android.ModuleContext, contents []android.Module, modules bootDexJarByModule) android.WritablePath {
803*333d2b36SAndroid Build Coastguard Worker	apex := b.getProfileProviderApex(ctx)
804*333d2b36SAndroid Build Coastguard Worker	if apex == "" {
805*333d2b36SAndroid Build Coastguard Worker		return nil
806*333d2b36SAndroid Build Coastguard Worker	}
807*333d2b36SAndroid Build Coastguard Worker
808*333d2b36SAndroid Build Coastguard Worker	dexPaths := make(android.Paths, 0, len(contents))
809*333d2b36SAndroid Build Coastguard Worker	dexLocations := make([]string, 0, len(contents))
810*333d2b36SAndroid Build Coastguard Worker	for _, module := range contents {
811*333d2b36SAndroid Build Coastguard Worker		dexPaths = append(dexPaths, modules[module.Name()])
812*333d2b36SAndroid Build Coastguard Worker		dexLocations = append(dexLocations, filepath.Join("/", "apex", apex, "javalib", module.Name()+".jar"))
813*333d2b36SAndroid Build Coastguard Worker	}
814*333d2b36SAndroid Build Coastguard Worker
815*333d2b36SAndroid Build Coastguard Worker	// Build a profile for the modules in this fragment.
816*333d2b36SAndroid Build Coastguard Worker	return bootImageProfileRuleCommon(ctx, b.Name(), dexPaths, dexLocations)
817*333d2b36SAndroid Build Coastguard Worker}
818*333d2b36SAndroid Build Coastguard Worker
819*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) AndroidMkEntries() []android.AndroidMkEntries {
820*333d2b36SAndroid Build Coastguard Worker	// Use the generated classpath proto as the output.
821*333d2b36SAndroid Build Coastguard Worker	outputFile := b.outputFilepath
822*333d2b36SAndroid Build Coastguard Worker	// Create a fake entry that will cause this to be added to the module-info.json file.
823*333d2b36SAndroid Build Coastguard Worker	entriesList := []android.AndroidMkEntries{{
824*333d2b36SAndroid Build Coastguard Worker		Class:      "FAKE",
825*333d2b36SAndroid Build Coastguard Worker		OutputFile: android.OptionalPathForPath(outputFile),
826*333d2b36SAndroid Build Coastguard Worker		Include:    "$(BUILD_PHONY_PACKAGE)",
827*333d2b36SAndroid Build Coastguard Worker		ExtraFooters: []android.AndroidMkExtraFootersFunc{
828*333d2b36SAndroid Build Coastguard Worker			func(w io.Writer, name, prefix, moduleDir string) {
829*333d2b36SAndroid Build Coastguard Worker				// Allow the bootclasspath_fragment to be built by simply passing its name on the command
830*333d2b36SAndroid Build Coastguard Worker				// line.
831*333d2b36SAndroid Build Coastguard Worker				fmt.Fprintln(w, ".PHONY:", b.Name())
832*333d2b36SAndroid Build Coastguard Worker				fmt.Fprintln(w, b.Name()+":", outputFile.String())
833*333d2b36SAndroid Build Coastguard Worker			},
834*333d2b36SAndroid Build Coastguard Worker		},
835*333d2b36SAndroid Build Coastguard Worker	}}
836*333d2b36SAndroid Build Coastguard Worker	return entriesList
837*333d2b36SAndroid Build Coastguard Worker}
838*333d2b36SAndroid Build Coastguard Worker
839*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) getProfilePath() android.Path {
840*333d2b36SAndroid Build Coastguard Worker	return b.profilePath
841*333d2b36SAndroid Build Coastguard Worker}
842*333d2b36SAndroid Build Coastguard Worker
843*333d2b36SAndroid Build Coastguard Worker// Collect information for opening IDE project files in java/jdeps.go.
844*333d2b36SAndroid Build Coastguard Workerfunc (b *BootclasspathFragmentModule) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
845*333d2b36SAndroid Build Coastguard Worker	dpInfo.Deps = append(dpInfo.Deps, b.properties.Contents.GetOrDefault(ctx, nil)...)
846*333d2b36SAndroid Build Coastguard Worker}
847*333d2b36SAndroid Build Coastguard Worker
848*333d2b36SAndroid Build Coastguard Workertype bootclasspathFragmentMemberType struct {
849*333d2b36SAndroid Build Coastguard Worker	android.SdkMemberTypeBase
850*333d2b36SAndroid Build Coastguard Worker}
851*333d2b36SAndroid Build Coastguard Worker
852*333d2b36SAndroid Build Coastguard Workerfunc (b *bootclasspathFragmentMemberType) AddDependencies(ctx android.SdkDependencyContext, dependencyTag blueprint.DependencyTag, names []string) {
853*333d2b36SAndroid Build Coastguard Worker	ctx.AddVariationDependencies(nil, dependencyTag, names...)
854*333d2b36SAndroid Build Coastguard Worker}
855*333d2b36SAndroid Build Coastguard Worker
856*333d2b36SAndroid Build Coastguard Workerfunc (b *bootclasspathFragmentMemberType) IsInstance(module android.Module) bool {
857*333d2b36SAndroid Build Coastguard Worker	_, ok := module.(*BootclasspathFragmentModule)
858*333d2b36SAndroid Build Coastguard Worker	return ok
859*333d2b36SAndroid Build Coastguard Worker}
860*333d2b36SAndroid Build Coastguard Worker
861*333d2b36SAndroid Build Coastguard Workerfunc (b *bootclasspathFragmentMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
862*333d2b36SAndroid Build Coastguard Worker	if b.PropertyName == "boot_images" {
863*333d2b36SAndroid Build Coastguard Worker		return ctx.SnapshotBuilder().AddPrebuiltModule(member, "prebuilt_boot_image")
864*333d2b36SAndroid Build Coastguard Worker	} else {
865*333d2b36SAndroid Build Coastguard Worker		return ctx.SnapshotBuilder().AddPrebuiltModule(member, "prebuilt_bootclasspath_fragment")
866*333d2b36SAndroid Build Coastguard Worker	}
867*333d2b36SAndroid Build Coastguard Worker}
868*333d2b36SAndroid Build Coastguard Worker
869*333d2b36SAndroid Build Coastguard Workerfunc (b *bootclasspathFragmentMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
870*333d2b36SAndroid Build Coastguard Worker	return &bootclasspathFragmentSdkMemberProperties{}
871*333d2b36SAndroid Build Coastguard Worker}
872*333d2b36SAndroid Build Coastguard Worker
873*333d2b36SAndroid Build Coastguard Workertype bootclasspathFragmentSdkMemberProperties struct {
874*333d2b36SAndroid Build Coastguard Worker	android.SdkMemberPropertiesBase
875*333d2b36SAndroid Build Coastguard Worker
876*333d2b36SAndroid Build Coastguard Worker	// The image name
877*333d2b36SAndroid Build Coastguard Worker	Image_name *string
878*333d2b36SAndroid Build Coastguard Worker
879*333d2b36SAndroid Build Coastguard Worker	// Contents of the bootclasspath fragment
880*333d2b36SAndroid Build Coastguard Worker	Contents []string
881*333d2b36SAndroid Build Coastguard Worker
882*333d2b36SAndroid Build Coastguard Worker	// Stub_libs properties.
883*333d2b36SAndroid Build Coastguard Worker	Stub_libs               []string
884*333d2b36SAndroid Build Coastguard Worker	Core_platform_stub_libs []string
885*333d2b36SAndroid Build Coastguard Worker
886*333d2b36SAndroid Build Coastguard Worker	// Fragment properties
887*333d2b36SAndroid Build Coastguard Worker	Fragments []ApexVariantReference
888*333d2b36SAndroid Build Coastguard Worker
889*333d2b36SAndroid Build Coastguard Worker	// Flag files by *hiddenAPIFlagFileCategory
890*333d2b36SAndroid Build Coastguard Worker	Flag_files_by_category FlagFilesByCategory
891*333d2b36SAndroid Build Coastguard Worker
892*333d2b36SAndroid Build Coastguard Worker	// The path to the generated annotation-flags.csv file.
893*333d2b36SAndroid Build Coastguard Worker	Annotation_flags_path android.OptionalPath
894*333d2b36SAndroid Build Coastguard Worker
895*333d2b36SAndroid Build Coastguard Worker	// The path to the generated metadata.csv file.
896*333d2b36SAndroid Build Coastguard Worker	Metadata_path android.OptionalPath
897*333d2b36SAndroid Build Coastguard Worker
898*333d2b36SAndroid Build Coastguard Worker	// The path to the generated index.csv file.
899*333d2b36SAndroid Build Coastguard Worker	Index_path android.OptionalPath
900*333d2b36SAndroid Build Coastguard Worker
901*333d2b36SAndroid Build Coastguard Worker	// The path to the generated stub-flags.csv file.
902*333d2b36SAndroid Build Coastguard Worker	Stub_flags_path android.OptionalPath `supported_build_releases:"S"`
903*333d2b36SAndroid Build Coastguard Worker
904*333d2b36SAndroid Build Coastguard Worker	// The path to the generated all-flags.csv file.
905*333d2b36SAndroid Build Coastguard Worker	All_flags_path android.OptionalPath `supported_build_releases:"S"`
906*333d2b36SAndroid Build Coastguard Worker
907*333d2b36SAndroid Build Coastguard Worker	// The path to the generated signature-patterns.csv file.
908*333d2b36SAndroid Build Coastguard Worker	Signature_patterns_path android.OptionalPath `supported_build_releases:"Tiramisu+"`
909*333d2b36SAndroid Build Coastguard Worker
910*333d2b36SAndroid Build Coastguard Worker	// The path to the generated filtered-stub-flags.csv file.
911*333d2b36SAndroid Build Coastguard Worker	Filtered_stub_flags_path android.OptionalPath `supported_build_releases:"Tiramisu+"`
912*333d2b36SAndroid Build Coastguard Worker
913*333d2b36SAndroid Build Coastguard Worker	// The path to the generated filtered-flags.csv file.
914*333d2b36SAndroid Build Coastguard Worker	Filtered_flags_path android.OptionalPath `supported_build_releases:"Tiramisu+"`
915*333d2b36SAndroid Build Coastguard Worker}
916*333d2b36SAndroid Build Coastguard Worker
917*333d2b36SAndroid Build Coastguard Workerfunc (b *bootclasspathFragmentSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
918*333d2b36SAndroid Build Coastguard Worker	module := variant.(*BootclasspathFragmentModule)
919*333d2b36SAndroid Build Coastguard Worker
920*333d2b36SAndroid Build Coastguard Worker	b.Image_name = module.properties.Image_name
921*333d2b36SAndroid Build Coastguard Worker	b.Contents = module.properties.Contents.GetOrDefault(ctx.SdkModuleContext(), nil)
922*333d2b36SAndroid Build Coastguard Worker
923*333d2b36SAndroid Build Coastguard Worker	// Get the hidden API information from the module.
924*333d2b36SAndroid Build Coastguard Worker	mctx := ctx.SdkModuleContext()
925*333d2b36SAndroid Build Coastguard Worker	hiddenAPIInfo, _ := android.OtherModuleProvider(mctx, module, HiddenAPIInfoForSdkProvider)
926*333d2b36SAndroid Build Coastguard Worker	b.Flag_files_by_category = hiddenAPIInfo.FlagFilesByCategory
927*333d2b36SAndroid Build Coastguard Worker
928*333d2b36SAndroid Build Coastguard Worker	// Copy all the generated file paths.
929*333d2b36SAndroid Build Coastguard Worker	b.Annotation_flags_path = android.OptionalPathForPath(hiddenAPIInfo.AnnotationFlagsPath)
930*333d2b36SAndroid Build Coastguard Worker	b.Metadata_path = android.OptionalPathForPath(hiddenAPIInfo.MetadataPath)
931*333d2b36SAndroid Build Coastguard Worker	b.Index_path = android.OptionalPathForPath(hiddenAPIInfo.IndexPath)
932*333d2b36SAndroid Build Coastguard Worker
933*333d2b36SAndroid Build Coastguard Worker	b.Stub_flags_path = android.OptionalPathForPath(hiddenAPIInfo.StubFlagsPath)
934*333d2b36SAndroid Build Coastguard Worker	b.All_flags_path = android.OptionalPathForPath(hiddenAPIInfo.AllFlagsPath)
935*333d2b36SAndroid Build Coastguard Worker
936*333d2b36SAndroid Build Coastguard Worker	b.Signature_patterns_path = android.OptionalPathForPath(hiddenAPIInfo.SignaturePatternsPath)
937*333d2b36SAndroid Build Coastguard Worker	b.Filtered_stub_flags_path = android.OptionalPathForPath(hiddenAPIInfo.FilteredStubFlagsPath)
938*333d2b36SAndroid Build Coastguard Worker	b.Filtered_flags_path = android.OptionalPathForPath(hiddenAPIInfo.FilteredFlagsPath)
939*333d2b36SAndroid Build Coastguard Worker
940*333d2b36SAndroid Build Coastguard Worker	// Copy stub_libs properties.
941*333d2b36SAndroid Build Coastguard Worker	b.Stub_libs = module.properties.Api.Stub_libs.GetOrDefault(mctx, nil)
942*333d2b36SAndroid Build Coastguard Worker	b.Core_platform_stub_libs = module.properties.Core_platform_api.Stub_libs.GetOrDefault(mctx, nil)
943*333d2b36SAndroid Build Coastguard Worker
944*333d2b36SAndroid Build Coastguard Worker	// Copy fragment properties.
945*333d2b36SAndroid Build Coastguard Worker	b.Fragments = module.properties.Fragments
946*333d2b36SAndroid Build Coastguard Worker}
947*333d2b36SAndroid Build Coastguard Worker
948*333d2b36SAndroid Build Coastguard Workerfunc (b *bootclasspathFragmentSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
949*333d2b36SAndroid Build Coastguard Worker	if b.Image_name != nil {
950*333d2b36SAndroid Build Coastguard Worker		propertySet.AddProperty("image_name", *b.Image_name)
951*333d2b36SAndroid Build Coastguard Worker	}
952*333d2b36SAndroid Build Coastguard Worker
953*333d2b36SAndroid Build Coastguard Worker	builder := ctx.SnapshotBuilder()
954*333d2b36SAndroid Build Coastguard Worker	requiredMemberDependency := builder.SdkMemberReferencePropertyTag(true)
955*333d2b36SAndroid Build Coastguard Worker
956*333d2b36SAndroid Build Coastguard Worker	if len(b.Contents) > 0 {
957*333d2b36SAndroid Build Coastguard Worker		propertySet.AddPropertyWithTag("contents", b.Contents, requiredMemberDependency)
958*333d2b36SAndroid Build Coastguard Worker	}
959*333d2b36SAndroid Build Coastguard Worker
960*333d2b36SAndroid Build Coastguard Worker	if len(b.Stub_libs) > 0 {
961*333d2b36SAndroid Build Coastguard Worker		apiPropertySet := propertySet.AddPropertySet("api")
962*333d2b36SAndroid Build Coastguard Worker		apiPropertySet.AddPropertyWithTag("stub_libs", b.Stub_libs, requiredMemberDependency)
963*333d2b36SAndroid Build Coastguard Worker	}
964*333d2b36SAndroid Build Coastguard Worker	if len(b.Core_platform_stub_libs) > 0 {
965*333d2b36SAndroid Build Coastguard Worker		corePlatformApiPropertySet := propertySet.AddPropertySet("core_platform_api")
966*333d2b36SAndroid Build Coastguard Worker		corePlatformApiPropertySet.AddPropertyWithTag("stub_libs", b.Core_platform_stub_libs, requiredMemberDependency)
967*333d2b36SAndroid Build Coastguard Worker	}
968*333d2b36SAndroid Build Coastguard Worker	if len(b.Fragments) > 0 {
969*333d2b36SAndroid Build Coastguard Worker		propertySet.AddProperty("fragments", b.Fragments)
970*333d2b36SAndroid Build Coastguard Worker	}
971*333d2b36SAndroid Build Coastguard Worker
972*333d2b36SAndroid Build Coastguard Worker	hiddenAPISet := propertySet.AddPropertySet("hidden_api")
973*333d2b36SAndroid Build Coastguard Worker	hiddenAPIDir := "hiddenapi"
974*333d2b36SAndroid Build Coastguard Worker
975*333d2b36SAndroid Build Coastguard Worker	// Copy manually curated flag files specified on the bootclasspath_fragment.
976*333d2b36SAndroid Build Coastguard Worker	if b.Flag_files_by_category != nil {
977*333d2b36SAndroid Build Coastguard Worker		for _, category := range HiddenAPIFlagFileCategories {
978*333d2b36SAndroid Build Coastguard Worker			paths := b.Flag_files_by_category[category]
979*333d2b36SAndroid Build Coastguard Worker			if len(paths) > 0 {
980*333d2b36SAndroid Build Coastguard Worker				dests := []string{}
981*333d2b36SAndroid Build Coastguard Worker				for _, p := range paths {
982*333d2b36SAndroid Build Coastguard Worker					dest := filepath.Join(hiddenAPIDir, p.Base())
983*333d2b36SAndroid Build Coastguard Worker					builder.CopyToSnapshot(p, dest)
984*333d2b36SAndroid Build Coastguard Worker					dests = append(dests, dest)
985*333d2b36SAndroid Build Coastguard Worker				}
986*333d2b36SAndroid Build Coastguard Worker				hiddenAPISet.AddProperty(category.PropertyName(), dests)
987*333d2b36SAndroid Build Coastguard Worker			}
988*333d2b36SAndroid Build Coastguard Worker		}
989*333d2b36SAndroid Build Coastguard Worker	}
990*333d2b36SAndroid Build Coastguard Worker
991*333d2b36SAndroid Build Coastguard Worker	copyOptionalPath := func(path android.OptionalPath, property string) {
992*333d2b36SAndroid Build Coastguard Worker		if path.Valid() {
993*333d2b36SAndroid Build Coastguard Worker			p := path.Path()
994*333d2b36SAndroid Build Coastguard Worker			dest := filepath.Join(hiddenAPIDir, p.Base())
995*333d2b36SAndroid Build Coastguard Worker			builder.CopyToSnapshot(p, dest)
996*333d2b36SAndroid Build Coastguard Worker			hiddenAPISet.AddProperty(property, dest)
997*333d2b36SAndroid Build Coastguard Worker		}
998*333d2b36SAndroid Build Coastguard Worker	}
999*333d2b36SAndroid Build Coastguard Worker
1000*333d2b36SAndroid Build Coastguard Worker	// Copy all the generated files, if available.
1001*333d2b36SAndroid Build Coastguard Worker	copyOptionalPath(b.Annotation_flags_path, "annotation_flags")
1002*333d2b36SAndroid Build Coastguard Worker	copyOptionalPath(b.Metadata_path, "metadata")
1003*333d2b36SAndroid Build Coastguard Worker	copyOptionalPath(b.Index_path, "index")
1004*333d2b36SAndroid Build Coastguard Worker
1005*333d2b36SAndroid Build Coastguard Worker	copyOptionalPath(b.Stub_flags_path, "stub_flags")
1006*333d2b36SAndroid Build Coastguard Worker	copyOptionalPath(b.All_flags_path, "all_flags")
1007*333d2b36SAndroid Build Coastguard Worker
1008*333d2b36SAndroid Build Coastguard Worker	copyOptionalPath(b.Signature_patterns_path, "signature_patterns")
1009*333d2b36SAndroid Build Coastguard Worker	copyOptionalPath(b.Filtered_stub_flags_path, "filtered_stub_flags")
1010*333d2b36SAndroid Build Coastguard Worker	copyOptionalPath(b.Filtered_flags_path, "filtered_flags")
1011*333d2b36SAndroid Build Coastguard Worker}
1012*333d2b36SAndroid Build Coastguard Worker
1013*333d2b36SAndroid Build Coastguard Workervar _ android.SdkMemberType = (*bootclasspathFragmentMemberType)(nil)
1014*333d2b36SAndroid Build Coastguard Worker
1015*333d2b36SAndroid Build Coastguard Worker// prebuiltBootclasspathFragmentProperties contains additional prebuilt_bootclasspath_fragment
1016*333d2b36SAndroid Build Coastguard Worker// specific properties.
1017*333d2b36SAndroid Build Coastguard Workertype prebuiltBootclasspathFragmentProperties struct {
1018*333d2b36SAndroid Build Coastguard Worker	Hidden_api struct {
1019*333d2b36SAndroid Build Coastguard Worker		// The path to the annotation-flags.csv file created by the bootclasspath_fragment.
1020*333d2b36SAndroid Build Coastguard Worker		Annotation_flags *string `android:"path"`
1021*333d2b36SAndroid Build Coastguard Worker
1022*333d2b36SAndroid Build Coastguard Worker		// The path to the metadata.csv file created by the bootclasspath_fragment.
1023*333d2b36SAndroid Build Coastguard Worker		Metadata *string `android:"path"`
1024*333d2b36SAndroid Build Coastguard Worker
1025*333d2b36SAndroid Build Coastguard Worker		// The path to the index.csv file created by the bootclasspath_fragment.
1026*333d2b36SAndroid Build Coastguard Worker		Index *string `android:"path"`
1027*333d2b36SAndroid Build Coastguard Worker
1028*333d2b36SAndroid Build Coastguard Worker		// The path to the signature-patterns.csv file created by the bootclasspath_fragment.
1029*333d2b36SAndroid Build Coastguard Worker		Signature_patterns *string `android:"path"`
1030*333d2b36SAndroid Build Coastguard Worker
1031*333d2b36SAndroid Build Coastguard Worker		// The path to the stub-flags.csv file created by the bootclasspath_fragment.
1032*333d2b36SAndroid Build Coastguard Worker		Stub_flags *string `android:"path"`
1033*333d2b36SAndroid Build Coastguard Worker
1034*333d2b36SAndroid Build Coastguard Worker		// The path to the all-flags.csv file created by the bootclasspath_fragment.
1035*333d2b36SAndroid Build Coastguard Worker		All_flags *string `android:"path"`
1036*333d2b36SAndroid Build Coastguard Worker
1037*333d2b36SAndroid Build Coastguard Worker		// The path to the filtered-stub-flags.csv file created by the bootclasspath_fragment.
1038*333d2b36SAndroid Build Coastguard Worker		Filtered_stub_flags *string `android:"path"`
1039*333d2b36SAndroid Build Coastguard Worker
1040*333d2b36SAndroid Build Coastguard Worker		// The path to the filtered-flags.csv file created by the bootclasspath_fragment.
1041*333d2b36SAndroid Build Coastguard Worker		Filtered_flags *string `android:"path"`
1042*333d2b36SAndroid Build Coastguard Worker	}
1043*333d2b36SAndroid Build Coastguard Worker}
1044*333d2b36SAndroid Build Coastguard Worker
1045*333d2b36SAndroid Build Coastguard Worker// A prebuilt version of the bootclasspath_fragment module.
1046*333d2b36SAndroid Build Coastguard Worker//
1047*333d2b36SAndroid Build Coastguard Worker// At the moment this is basically just a bootclasspath_fragment module that can be used as a
1048*333d2b36SAndroid Build Coastguard Worker// prebuilt. Eventually as more functionality is migrated into the bootclasspath_fragment module
1049*333d2b36SAndroid Build Coastguard Worker// type from the various singletons then this will diverge.
1050*333d2b36SAndroid Build Coastguard Workertype PrebuiltBootclasspathFragmentModule struct {
1051*333d2b36SAndroid Build Coastguard Worker	BootclasspathFragmentModule
1052*333d2b36SAndroid Build Coastguard Worker	prebuilt android.Prebuilt
1053*333d2b36SAndroid Build Coastguard Worker
1054*333d2b36SAndroid Build Coastguard Worker	// Additional prebuilt specific properties.
1055*333d2b36SAndroid Build Coastguard Worker	prebuiltProperties prebuiltBootclasspathFragmentProperties
1056*333d2b36SAndroid Build Coastguard Worker}
1057*333d2b36SAndroid Build Coastguard Worker
1058*333d2b36SAndroid Build Coastguard Workerfunc (module *PrebuiltBootclasspathFragmentModule) Prebuilt() *android.Prebuilt {
1059*333d2b36SAndroid Build Coastguard Worker	return &module.prebuilt
1060*333d2b36SAndroid Build Coastguard Worker}
1061*333d2b36SAndroid Build Coastguard Worker
1062*333d2b36SAndroid Build Coastguard Workerfunc (module *PrebuiltBootclasspathFragmentModule) Name() string {
1063*333d2b36SAndroid Build Coastguard Worker	return module.prebuilt.Name(module.ModuleBase.Name())
1064*333d2b36SAndroid Build Coastguard Worker}
1065*333d2b36SAndroid Build Coastguard Worker
1066*333d2b36SAndroid Build Coastguard Worker// produceHiddenAPIOutput returns a path to the prebuilt all-flags.csv or nil if none is specified.
1067*333d2b36SAndroid Build Coastguard Workerfunc (module *PrebuiltBootclasspathFragmentModule) produceHiddenAPIOutput(ctx android.ModuleContext, contents []android.Module, fragments []android.Module, input HiddenAPIFlagInput) *HiddenAPIOutput {
1068*333d2b36SAndroid Build Coastguard Worker	pathForOptionalSrc := func(src *string, defaultPath android.Path) android.Path {
1069*333d2b36SAndroid Build Coastguard Worker		if src == nil {
1070*333d2b36SAndroid Build Coastguard Worker			return defaultPath
1071*333d2b36SAndroid Build Coastguard Worker		}
1072*333d2b36SAndroid Build Coastguard Worker		return android.PathForModuleSrc(ctx, *src)
1073*333d2b36SAndroid Build Coastguard Worker	}
1074*333d2b36SAndroid Build Coastguard Worker	pathForSrc := func(property string, src *string) android.Path {
1075*333d2b36SAndroid Build Coastguard Worker		if src == nil {
1076*333d2b36SAndroid Build Coastguard Worker			ctx.PropertyErrorf(property, "is required but was not specified")
1077*333d2b36SAndroid Build Coastguard Worker			return android.PathForModuleSrc(ctx, "missing", property)
1078*333d2b36SAndroid Build Coastguard Worker		}
1079*333d2b36SAndroid Build Coastguard Worker		return android.PathForModuleSrc(ctx, *src)
1080*333d2b36SAndroid Build Coastguard Worker	}
1081*333d2b36SAndroid Build Coastguard Worker
1082*333d2b36SAndroid Build Coastguard Worker	output := HiddenAPIOutput{
1083*333d2b36SAndroid Build Coastguard Worker		HiddenAPIFlagOutput: HiddenAPIFlagOutput{
1084*333d2b36SAndroid Build Coastguard Worker			AnnotationFlagsPath:   pathForSrc("hidden_api.annotation_flags", module.prebuiltProperties.Hidden_api.Annotation_flags),
1085*333d2b36SAndroid Build Coastguard Worker			MetadataPath:          pathForSrc("hidden_api.metadata", module.prebuiltProperties.Hidden_api.Metadata),
1086*333d2b36SAndroid Build Coastguard Worker			IndexPath:             pathForSrc("hidden_api.index", module.prebuiltProperties.Hidden_api.Index),
1087*333d2b36SAndroid Build Coastguard Worker			SignaturePatternsPath: pathForOptionalSrc(module.prebuiltProperties.Hidden_api.Signature_patterns, nil),
1088*333d2b36SAndroid Build Coastguard Worker			// TODO: Temporarily handle stub_flags/all_flags properties until prebuilts have been updated.
1089*333d2b36SAndroid Build Coastguard Worker			StubFlagsPath: pathForOptionalSrc(module.prebuiltProperties.Hidden_api.Stub_flags, nil),
1090*333d2b36SAndroid Build Coastguard Worker			AllFlagsPath:  pathForOptionalSrc(module.prebuiltProperties.Hidden_api.All_flags, nil),
1091*333d2b36SAndroid Build Coastguard Worker		},
1092*333d2b36SAndroid Build Coastguard Worker	}
1093*333d2b36SAndroid Build Coastguard Worker
1094*333d2b36SAndroid Build Coastguard Worker	// TODO: Temporarily fallback to stub_flags/all_flags properties until prebuilts have been updated.
1095*333d2b36SAndroid Build Coastguard Worker	output.FilteredStubFlagsPath = pathForOptionalSrc(module.prebuiltProperties.Hidden_api.Filtered_stub_flags, output.StubFlagsPath)
1096*333d2b36SAndroid Build Coastguard Worker	output.FilteredFlagsPath = pathForOptionalSrc(module.prebuiltProperties.Hidden_api.Filtered_flags, output.AllFlagsPath)
1097*333d2b36SAndroid Build Coastguard Worker
1098*333d2b36SAndroid Build Coastguard Worker	return &output
1099*333d2b36SAndroid Build Coastguard Worker}
1100*333d2b36SAndroid Build Coastguard Worker
1101*333d2b36SAndroid Build Coastguard Worker// DEPRECATED: this information is now generated in the context of the top level prebuilt apex.
1102*333d2b36SAndroid Build Coastguard Worker// produceBootImageProfile extracts the boot image profile from the APEX if available.
1103*333d2b36SAndroid Build Coastguard Workerfunc (module *PrebuiltBootclasspathFragmentModule) produceBootImageProfile(ctx android.ModuleContext) android.WritablePath {
1104*333d2b36SAndroid Build Coastguard Worker	return android.PathForModuleInstall(ctx, "intentionally_no_longer_supported")
1105*333d2b36SAndroid Build Coastguard Worker}
1106*333d2b36SAndroid Build Coastguard Worker
1107*333d2b36SAndroid Build Coastguard Workerfunc (b *PrebuiltBootclasspathFragmentModule) getProfilePath() android.Path {
1108*333d2b36SAndroid Build Coastguard Worker	if b.profilePathErr != nil {
1109*333d2b36SAndroid Build Coastguard Worker		panic(b.profilePathErr.Error())
1110*333d2b36SAndroid Build Coastguard Worker	}
1111*333d2b36SAndroid Build Coastguard Worker	return b.profilePath
1112*333d2b36SAndroid Build Coastguard Worker}
1113*333d2b36SAndroid Build Coastguard Worker
1114*333d2b36SAndroid Build Coastguard Workervar _ commonBootclasspathFragment = (*PrebuiltBootclasspathFragmentModule)(nil)
1115*333d2b36SAndroid Build Coastguard Worker
1116*333d2b36SAndroid Build Coastguard Worker// RequiredFilesFromPrebuiltApex returns the list of all files the prebuilt_bootclasspath_fragment
1117*333d2b36SAndroid Build Coastguard Worker// requires from a prebuilt .apex file.
1118*333d2b36SAndroid Build Coastguard Worker//
1119*333d2b36SAndroid Build Coastguard Worker// If there is no image config associated with this fragment then it returns nil. Otherwise, it
1120*333d2b36SAndroid Build Coastguard Worker// returns the files that are listed in the image config.
1121*333d2b36SAndroid Build Coastguard Workerfunc (module *PrebuiltBootclasspathFragmentModule) RequiredFilesFromPrebuiltApex(ctx android.BaseModuleContext) []string {
1122*333d2b36SAndroid Build Coastguard Worker	for _, apex := range module.ApexProperties.Apex_available {
1123*333d2b36SAndroid Build Coastguard Worker		if isProfileProviderApex(ctx, apex) {
1124*333d2b36SAndroid Build Coastguard Worker			return []string{ProfileInstallPathInApex}
1125*333d2b36SAndroid Build Coastguard Worker		}
1126*333d2b36SAndroid Build Coastguard Worker	}
1127*333d2b36SAndroid Build Coastguard Worker	return nil
1128*333d2b36SAndroid Build Coastguard Worker}
1129*333d2b36SAndroid Build Coastguard Worker
1130*333d2b36SAndroid Build Coastguard Workerfunc (module *PrebuiltBootclasspathFragmentModule) UseProfileGuidedDexpreopt() bool {
1131*333d2b36SAndroid Build Coastguard Worker	return false
1132*333d2b36SAndroid Build Coastguard Worker}
1133*333d2b36SAndroid Build Coastguard Worker
1134*333d2b36SAndroid Build Coastguard Workervar _ android.RequiredFilesFromPrebuiltApex = (*PrebuiltBootclasspathFragmentModule)(nil)
1135*333d2b36SAndroid Build Coastguard Worker
1136*333d2b36SAndroid Build Coastguard Workerfunc prebuiltBootclasspathFragmentFactory() android.Module {
1137*333d2b36SAndroid Build Coastguard Worker	m := &PrebuiltBootclasspathFragmentModule{}
1138*333d2b36SAndroid Build Coastguard Worker	m.AddProperties(&m.properties, &m.prebuiltProperties)
1139*333d2b36SAndroid Build Coastguard Worker	// This doesn't actually have any prebuilt files of its own so pass a placeholder for the srcs
1140*333d2b36SAndroid Build Coastguard Worker	// array.
1141*333d2b36SAndroid Build Coastguard Worker	android.InitPrebuiltModule(m, &[]string{"placeholder"})
1142*333d2b36SAndroid Build Coastguard Worker	android.InitApexModule(m)
1143*333d2b36SAndroid Build Coastguard Worker	android.InitAndroidArchModule(m, android.HostAndDeviceSupported, android.MultilibCommon)
1144*333d2b36SAndroid Build Coastguard Worker
1145*333d2b36SAndroid Build Coastguard Worker	return m
1146*333d2b36SAndroid Build Coastguard Worker}
1147