blob: 4d3d794d86f2750c895cd9d335941ba2ba0e7574 [file] [log] [blame]
Paul Duffin3451e162021-01-20 15:16:56 +00001// Copyright (C) 2021 The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17import (
Paul Duffina1d60252021-01-21 18:13:43 +000018 "fmt"
Paul Duffinea465fb2022-03-04 18:39:29 +000019 "io"
Paul Duffin7c955552021-04-19 13:23:53 +010020 "path/filepath"
Paul Duffinba6afd02019-11-19 19:44:10 +000021 "reflect"
Paul Duffin3451e162021-01-20 15:16:56 +000022 "strings"
23
24 "android/soong/android"
Paul Duffina1d60252021-01-21 18:13:43 +000025 "android/soong/dexpreopt"
Aditya Choudhary9b593522023-10-06 19:54:58 +000026 "android/soong/testing"
Colin Crossc33e5212021-05-25 18:16:02 -070027
Paul Duffinc7ef9892021-03-23 23:21:59 +000028 "github.com/google/blueprint/proptools"
Martin Stjernholmb79c7f12021-03-17 00:26:25 +000029
Paul Duffin3451e162021-01-20 15:16:56 +000030 "github.com/google/blueprint"
31)
32
33func init() {
Paul Duffin7771eba2021-04-23 14:25:28 +010034 registerBootclasspathFragmentBuildComponents(android.InitRegistrationContext)
Paul Duffinf7f65da2021-03-10 15:00:46 +000035
Paul Duffin4e7d1c42022-05-13 13:12:19 +000036 android.RegisterSdkMemberType(BootclasspathFragmentSdkMemberType)
Paul Duffin3451e162021-01-20 15:16:56 +000037}
38
Paul Duffin7771eba2021-04-23 14:25:28 +010039func registerBootclasspathFragmentBuildComponents(ctx android.RegistrationContext) {
Paul Duffin7771eba2021-04-23 14:25:28 +010040 ctx.RegisterModuleType("bootclasspath_fragment", bootclasspathFragmentFactory)
Paul Duffinc15b9e92022-03-31 15:42:30 +010041 ctx.RegisterModuleType("bootclasspath_fragment_test", testBootclasspathFragmentFactory)
Paul Duffin7771eba2021-04-23 14:25:28 +010042 ctx.RegisterModuleType("prebuilt_bootclasspath_fragment", prebuiltBootclasspathFragmentFactory)
Paul Duffin3451e162021-01-20 15:16:56 +000043}
44
Paul Duffin4e7d1c42022-05-13 13:12:19 +000045// BootclasspathFragmentSdkMemberType is the member type used to add bootclasspath_fragments to
46// the SDK snapshot. It is exported for use by apex.
47var BootclasspathFragmentSdkMemberType = &bootclasspathFragmentMemberType{
48 SdkMemberTypeBase: android.SdkMemberTypeBase{
49 PropertyName: "bootclasspath_fragments",
50 SupportsSdk: true,
51 },
52}
53
Paul Duffin65898052021-04-20 22:47:03 +010054type bootclasspathFragmentContentDependencyTag struct {
Paul Duffinc7ef9892021-03-23 23:21:59 +000055 blueprint.BaseDependencyTag
56}
57
Paul Duffin7771eba2021-04-23 14:25:28 +010058// Avoid having to make bootclasspath_fragment content visible to the bootclasspath_fragment.
Paul Duffinc7ef9892021-03-23 23:21:59 +000059//
Paul Duffin7771eba2021-04-23 14:25:28 +010060// This is a temporary workaround to make it easier to migrate to bootclasspath_fragment modules
61// with proper dependencies.
Paul Duffinc7ef9892021-03-23 23:21:59 +000062// TODO(b/177892522): Remove this and add needed visibility.
Paul Duffin65898052021-04-20 22:47:03 +010063func (b bootclasspathFragmentContentDependencyTag) ExcludeFromVisibilityEnforcement() {
64}
65
66// The bootclasspath_fragment contents must never depend on prebuilts.
67func (b bootclasspathFragmentContentDependencyTag) ReplaceSourceWithPrebuilt() bool {
68 return false
Paul Duffinc7ef9892021-03-23 23:21:59 +000069}
70
Paul Duffine95b53a2021-04-23 20:41:23 +010071// SdkMemberType causes dependencies added with this tag to be automatically added to the sdk as if
Paul Duffina10bd3c2021-05-12 13:46:54 +010072// they were specified using java_boot_libs or java_sdk_libs.
73func (b bootclasspathFragmentContentDependencyTag) SdkMemberType(child android.Module) android.SdkMemberType {
74 // If the module is a java_sdk_library then treat it as if it was specified in the java_sdk_libs
75 // property, otherwise treat if it was specified in the java_boot_libs property.
76 if javaSdkLibrarySdkMemberType.IsInstance(child) {
77 return javaSdkLibrarySdkMemberType
78 }
79
Spandan Das159b2642024-03-20 21:22:47 +000080 return JavaBootLibsSdkMemberType
Paul Duffine95b53a2021-04-23 20:41:23 +010081}
82
83func (b bootclasspathFragmentContentDependencyTag) ExportMember() bool {
84 return true
85}
86
Colin Crossc33e5212021-05-25 18:16:02 -070087// Contents of bootclasspath fragments in an apex are considered to be directly in the apex, as if
88// they were listed in java_libs.
89func (b bootclasspathFragmentContentDependencyTag) CopyDirectlyInAnyApex() {}
90
Paul Duffinfef55002021-06-17 14:56:05 +010091// Contents of bootclasspath fragments require files from prebuilt apex files.
92func (b bootclasspathFragmentContentDependencyTag) RequiresFilesFromPrebuiltApex() {}
93
Paul Duffin7771eba2021-04-23 14:25:28 +010094// The tag used for the dependency between the bootclasspath_fragment module and its contents.
Paul Duffin65898052021-04-20 22:47:03 +010095var bootclasspathFragmentContentDepTag = bootclasspathFragmentContentDependencyTag{}
Paul Duffinc7ef9892021-03-23 23:21:59 +000096
Paul Duffin65898052021-04-20 22:47:03 +010097var _ android.ExcludeFromVisibilityEnforcementTag = bootclasspathFragmentContentDepTag
98var _ android.ReplaceSourceWithPrebuilt = bootclasspathFragmentContentDepTag
Paul Duffinf7b3d0d2021-09-02 14:29:21 +010099var _ android.SdkMemberDependencyTag = bootclasspathFragmentContentDepTag
Colin Crossc33e5212021-05-25 18:16:02 -0700100var _ android.CopyDirectlyInAnyApexTag = bootclasspathFragmentContentDepTag
Paul Duffinfef55002021-06-17 14:56:05 +0100101var _ android.RequiresFilesFromPrebuiltApexTag = bootclasspathFragmentContentDepTag
Paul Duffinc7ef9892021-03-23 23:21:59 +0000102
Paul Duffin65898052021-04-20 22:47:03 +0100103func IsBootclasspathFragmentContentDepTag(tag blueprint.DependencyTag) bool {
104 return tag == bootclasspathFragmentContentDepTag
Paul Duffin4d101b62021-03-24 15:42:20 +0000105}
106
Paul Duffinc7d16442021-04-23 13:55:49 +0100107// Properties that can be different when coverage is enabled.
108type BootclasspathFragmentCoverageAffectedProperties struct {
109 // The contents of this bootclasspath_fragment, could be either java_library, or java_sdk_library.
110 //
Paul Duffin34827d42021-05-13 21:25:05 +0100111 // A java_sdk_library specified here will also be treated as if it was specified on the stub_libs
112 // property.
113 //
Paul Duffinc7d16442021-04-23 13:55:49 +0100114 // The order of this list matters as it is the order that is used in the bootclasspath.
115 Contents []string
Paul Duffin10931582021-04-25 10:13:54 +0100116
117 // The properties for specifying the API stubs provided by this fragment.
118 BootclasspathAPIProperties
Paul Duffinc7d16442021-04-23 13:55:49 +0100119}
120
Paul Duffin7771eba2021-04-23 14:25:28 +0100121type bootclasspathFragmentProperties struct {
Paul Duffin3451e162021-01-20 15:16:56 +0000122 // The name of the image this represents.
123 //
Paul Duffin82886d62021-03-24 01:34:57 +0000124 // If specified then it must be one of "art" or "boot".
Paul Duffin64be7bb2021-03-23 23:06:38 +0000125 Image_name *string
Paul Duffinc7ef9892021-03-23 23:21:59 +0000126
Paul Duffinc7d16442021-04-23 13:55:49 +0100127 // Properties whose values need to differ with and without coverage.
128 BootclasspathFragmentCoverageAffectedProperties
129 Coverage BootclasspathFragmentCoverageAffectedProperties
Paul Duffin9b381ef2021-04-08 23:01:37 +0100130
Paul Duffin31fad802021-06-18 18:14:25 +0100131 // Hidden API related properties.
Paul Duffin9b61abb2022-07-27 16:16:54 +0000132 HiddenAPIFlagFileProperties
Paul Duffin70cfdff2021-05-15 09:10:42 +0100133
Paul Duffin5cca7c42021-05-26 10:16:01 +0100134 // The list of additional stub libraries which this fragment's contents use but which are not
135 // provided by another bootclasspath_fragment.
136 //
137 // Note, "android-non-updatable" is treated specially. While no such module exists it is treated
138 // as if it was a java_sdk_library. So, when public API stubs are needed then it will be replaced
139 // with "android-non-updatable.stubs", with "androidn-non-updatable.system.stubs" when the system
140 // stubs are needed and so on.
141 Additional_stubs []string
142
Paul Duffin70cfdff2021-05-15 09:10:42 +0100143 // Properties that allow a fragment to depend on other fragments. This is needed for hidden API
144 // processing as it needs access to all the classes used by a fragment including those provided
145 // by other fragments.
146 BootclasspathFragmentsDepsProperties
Paul Duffin3451e162021-01-20 15:16:56 +0000147}
148
Paul Duffin1e9e9382022-07-27 15:55:06 +0000149type HiddenAPIPackageProperties struct {
Paul Duffin1e18e982021-08-03 15:42:27 +0100150 Hidden_api struct {
151 // Contains prefixes of a package hierarchy that is provided solely by this
152 // bootclasspath_fragment.
153 //
154 // This affects the signature patterns file that is used to select the subset of monolithic
155 // hidden API flags. See split_packages property for more details.
156 Package_prefixes []string
157
Paul Duffin846beb72022-03-15 17:45:57 +0000158 // A list of individual packages that are provided solely by this
159 // bootclasspath_fragment but which cannot be listed in package_prefixes
160 // because there are sub-packages which are provided by other modules.
161 //
162 // This should only be used for legacy packages. New packages should be
163 // covered by a package prefix.
164 Single_packages []string
165
Paul Duffin1e18e982021-08-03 15:42:27 +0100166 // The list of split packages provided by this bootclasspath_fragment.
167 //
168 // A split package is one that contains classes which are provided by multiple
169 // bootclasspath_fragment modules.
170 //
171 // This defaults to "*" - which treats all packages as being split. A module that has no split
172 // packages must specify an empty list.
173 //
174 // This affects the signature patterns file that is generated by a bootclasspath_fragment and
175 // used to select the subset of monolithic hidden API flags against which the flags generated
176 // by the bootclasspath_fragment are compared.
177 //
178 // The signature patterns file selects the subset of monolithic hidden API flags using a number
179 // of patterns, i.e.:
180 // * The qualified name (including package) of an outermost class, e.g. java/lang/Character.
181 // This selects all the flags for all the members of this class and any nested classes.
182 // * A package wildcard, e.g. java/lang/*. This selects all the flags for all the members of all
183 // the classes in this package (but not in sub-packages).
184 // * A recursive package wildcard, e.g. java/**. This selects all the flags for all the members
185 // of all the classes in this package and sub-packages.
186 //
187 // The signature patterns file is constructed as follows:
188 // * All the signatures are retrieved from the all-flags.csv file.
189 // * The member and inner class names are removed.
190 // * If a class is in a split package then that is kept, otherwise the class part is removed
191 // and replaced with a wildcard, i.e. *.
192 // * If a package matches a package prefix then the package is removed.
193 // * All the package prefixes are added with a recursive wildcard appended to each, i.e. **.
194 // * The resulting patterns are sorted.
195 //
196 // So, by default (i.e. without specifying any package_prefixes or split_packages) the signature
197 // patterns is a list of class names, because there are no package packages and all packages are
198 // assumed to be split.
199 //
200 // If any split packages are specified then only those packages are treated as split and all
201 // other packages are treated as belonging solely to the bootclasspath_fragment and so they use
202 // wildcard package patterns.
203 //
204 // So, if an empty list of split packages is specified then the signature patterns file just
205 // includes a wildcard package pattern for every package provided by the bootclasspath_fragment.
206 //
207 // If split_packages are specified and a package that is split is not listed then it could lead
208 // to build failures as it will select monolithic flags that are generated by another
209 // bootclasspath_fragment to compare against the flags provided by this fragment. The latter
210 // will obviously not contain those flags and that can cause the comparison and build to fail.
211 //
212 // If any package prefixes are specified then any matching packages are removed from the
213 // signature patterns and replaced with a single recursive package pattern.
214 //
215 // It is not strictly necessary to specify either package_prefixes or split_packages as the
216 // defaults will produce a valid set of signature patterns. However, those patterns may include
217 // implementation details, e.g. names of implementation classes or packages, which will be
218 // exported to the sdk snapshot in the signature patterns file. That is something that should be
219 // avoided where possible. Specifying package_prefixes and split_packages allows those
220 // implementation details to be excluded from the snapshot.
221 Split_packages []string
222 }
223}
224
Paul Duffin846beb72022-03-15 17:45:57 +0000225type SourceOnlyBootclasspathProperties struct {
Paul Duffin1e9e9382022-07-27 15:55:06 +0000226 HiddenAPIPackageProperties
227 Coverage HiddenAPIPackageProperties
Paul Duffin846beb72022-03-15 17:45:57 +0000228}
229
Paul Duffin7771eba2021-04-23 14:25:28 +0100230type BootclasspathFragmentModule struct {
Paul Duffin3451e162021-01-20 15:16:56 +0000231 android.ModuleBase
Jihoon Kang9272dcc2024-01-12 00:08:30 +0000232 android.DefaultableModuleBase
Paul Duffina1d60252021-01-21 18:13:43 +0000233 android.ApexModuleBase
satayev3db35472021-05-06 23:59:58 +0100234 ClasspathFragmentBase
235
Paul Duffinc15b9e92022-03-31 15:42:30 +0100236 // True if this fragment is for testing purposes.
237 testFragment bool
238
Paul Duffin7771eba2021-04-23 14:25:28 +0100239 properties bootclasspathFragmentProperties
braleeb0c1f0c2021-06-07 22:49:13 +0800240
Paul Duffin1e18e982021-08-03 15:42:27 +0100241 sourceOnlyProperties SourceOnlyBootclasspathProperties
242
Jiakai Zhangc08c1622023-05-10 18:38:34 +0100243 // Path to the boot image profile.
Spandan Dasfae468e2023-12-12 23:23:53 +0000244 profilePath android.WritablePath
245 profilePathErr error
Paul Duffin3451e162021-01-20 15:16:56 +0000246}
247
Paul Duffin2fef1362021-04-15 13:32:00 +0100248// commonBootclasspathFragment defines the methods that are implemented by both source and prebuilt
249// bootclasspath fragment modules.
250type commonBootclasspathFragment interface {
Paul Duffine5218812021-06-07 13:28:19 +0100251 // produceHiddenAPIOutput produces the all-flags.csv and intermediate files and encodes the flags
252 // into dex files.
Paul Duffin2fef1362021-04-15 13:32:00 +0100253 //
Paul Duffine5218812021-06-07 13:28:19 +0100254 // Returns a *HiddenAPIOutput containing the paths for the generated files. Returns nil if the
255 // module cannot contribute to hidden API processing, e.g. because it is a prebuilt module in a
256 // versioned sdk.
Paul Duffin1938dba2022-07-26 23:53:00 +0000257 produceHiddenAPIOutput(ctx android.ModuleContext, contents []android.Module, fragments []android.Module, input HiddenAPIFlagInput) *HiddenAPIOutput
Paul Duffin5466a362021-06-07 10:25:31 +0100258
Jiakai Zhangc08c1622023-05-10 18:38:34 +0100259 // getProfilePath returns the path to the boot image profile.
260 getProfilePath() android.Path
Paul Duffin2fef1362021-04-15 13:32:00 +0100261}
262
Paul Duffin1e6f5c42021-05-21 16:15:31 +0100263var _ commonBootclasspathFragment = (*BootclasspathFragmentModule)(nil)
264
Paul Duffin7771eba2021-04-23 14:25:28 +0100265func bootclasspathFragmentFactory() android.Module {
266 m := &BootclasspathFragmentModule{}
Paul Duffin1e18e982021-08-03 15:42:27 +0100267 m.AddProperties(&m.properties, &m.sourceOnlyProperties)
Paul Duffina1d60252021-01-21 18:13:43 +0000268 android.InitApexModule(m)
satayev3db35472021-05-06 23:59:58 +0100269 initClasspathFragment(m, BOOTCLASSPATH)
Paul Duffinb2c21732022-05-11 14:29:53 +0000270 android.InitAndroidArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jihoon Kang9272dcc2024-01-12 00:08:30 +0000271 android.InitDefaultableModule(m)
Paul Duffinc7ef9892021-03-23 23:21:59 +0000272
Paul Duffinc7ef9892021-03-23 23:21:59 +0000273 android.AddLoadHook(m, func(ctx android.LoadHookContext) {
Paul Duffinc7d16442021-04-23 13:55:49 +0100274 // If code coverage has been enabled for the framework then append the properties with
275 // coverage specific properties.
276 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
277 err := proptools.AppendProperties(&m.properties.BootclasspathFragmentCoverageAffectedProperties, &m.properties.Coverage, nil)
278 if err != nil {
279 ctx.PropertyErrorf("coverage", "error trying to append coverage specific properties: %s", err)
280 return
281 }
Paul Duffin846beb72022-03-15 17:45:57 +0000282
Paul Duffin1e9e9382022-07-27 15:55:06 +0000283 err = proptools.AppendProperties(&m.sourceOnlyProperties.HiddenAPIPackageProperties, &m.sourceOnlyProperties.Coverage, nil)
Paul Duffin846beb72022-03-15 17:45:57 +0000284 if err != nil {
285 ctx.PropertyErrorf("coverage", "error trying to append hidden api coverage specific properties: %s", err)
286 return
287 }
Paul Duffinc7d16442021-04-23 13:55:49 +0100288 }
Paul Duffinc7ef9892021-03-23 23:21:59 +0000289 })
Paul Duffin3451e162021-01-20 15:16:56 +0000290 return m
291}
292
Paul Duffinc15b9e92022-03-31 15:42:30 +0100293func testBootclasspathFragmentFactory() android.Module {
294 m := bootclasspathFragmentFactory().(*BootclasspathFragmentModule)
295 m.testFragment = true
296 return m
297}
298
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100299func (m *BootclasspathFragmentModule) bootclasspathFragmentPropertyCheck(ctx android.EarlyModuleContext) {
Paul Duffin82886d62021-03-24 01:34:57 +0000300 contents := m.properties.Contents
Paul Duffin8018e502021-05-21 19:28:09 +0100301 if len(contents) == 0 {
302 ctx.PropertyErrorf("contents", "required property is missing")
303 return
304 }
305
306 if m.properties.Image_name == nil {
307 // Nothing to do.
308 return
Paul Duffin82886d62021-03-24 01:34:57 +0000309 }
Paul Duffinba6afd02019-11-19 19:44:10 +0000310
Paul Duffinc7ef9892021-03-23 23:21:59 +0000311 imageName := proptools.String(m.properties.Image_name)
Paul Duffin8018e502021-05-21 19:28:09 +0100312 if imageName != "art" {
313 ctx.PropertyErrorf("image_name", `unknown image name %q, expected "art"`, imageName)
314 return
Paul Duffinba6afd02019-11-19 19:44:10 +0000315 }
Paul Duffin8018e502021-05-21 19:28:09 +0100316
Paul Duffin8018e502021-05-21 19:28:09 +0100317 // Get the configuration for the art apex jars. Do not use getImageConfig(ctx) here as this is
318 // too early in the Soong processing for that to work.
319 global := dexpreopt.GetGlobalConfig(ctx)
320 modules := global.ArtApexJars
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100321 configuredJars := modules.CopyOfJars()
322
323 // Skip the check if the configured jars list is empty as that is a common configuration when
324 // building targets that do not result in a system image.
325 if len(configuredJars) == 0 {
326 return
327 }
328
329 if !reflect.DeepEqual(configuredJars, contents) {
330 ctx.ModuleErrorf("inconsistency in specification of contents. ArtApexJars configuration specifies %#v, contents property specifies %#v",
331 configuredJars, contents)
332 }
Paul Duffin8018e502021-05-21 19:28:09 +0100333
334 // Make sure that the apex specified in the configuration is consistent and is one for which
335 // this boot image is available.
336 commonApex := ""
337 for i := 0; i < modules.Len(); i++ {
338 apex := modules.Apex(i)
339 jar := modules.Jar(i)
340 if apex == "platform" {
341 ctx.ModuleErrorf("ArtApexJars is invalid as it requests a platform variant of %q", jar)
342 continue
343 }
344 if !m.AvailableFor(apex) {
345 ctx.ModuleErrorf("ArtApexJars configuration incompatible with this module, ArtApexJars expects this to be in apex %q but this is only in apexes %q",
346 apex, m.ApexAvailable())
347 continue
348 }
349 if commonApex == "" {
350 commonApex = apex
351 } else if commonApex != apex {
352 ctx.ModuleErrorf("ArtApexJars configuration is inconsistent, expected all jars to be in the same apex but it specifies apex %q and %q",
353 commonApex, apex)
354 }
355 }
Paul Duffinba6afd02019-11-19 19:44:10 +0000356}
357
Colin Crossbc7d76c2023-12-12 16:39:03 -0800358var BootclasspathFragmentApexContentInfoProvider = blueprint.NewProvider[BootclasspathFragmentApexContentInfo]()
Paul Duffin3451e162021-01-20 15:16:56 +0000359
Paul Duffine946b322021-04-25 23:04:00 +0100360// BootclasspathFragmentApexContentInfo contains the bootclasspath_fragments contributions to the
361// apex contents.
362type BootclasspathFragmentApexContentInfo struct {
Paul Duffine5218812021-06-07 13:28:19 +0100363 // Map from the base module name (without prebuilt_ prefix) of a fragment's contents module to the
364 // hidden API encoded dex jar path.
365 contentModuleDexJarPaths bootDexJarByModule
Jiakai Zhang49b1eb62021-11-26 18:09:27 +0000366
367 // Path to the image profile file on host (or empty, if profile is not generated).
368 profilePathOnHost android.Path
369
370 // Install path of the boot image profile if it needs to be installed in the APEX, or empty if not
371 // needed.
372 profileInstallPathInApex string
Paul Duffin3451e162021-01-20 15:16:56 +0000373}
374
Paul Duffin190fdef2021-04-26 10:33:59 +0100375// DexBootJarPathForContentModule returns the path to the dex boot jar for specified module.
376//
377// The dex boot jar is one which has had hidden API encoding performed on it.
Paul Duffin1a8010a2021-05-15 12:39:23 +0100378func (i BootclasspathFragmentApexContentInfo) DexBootJarPathForContentModule(module android.Module) (android.Path, error) {
Paul Duffine5218812021-06-07 13:28:19 +0100379 // A bootclasspath_fragment cannot use a prebuilt library so Name() will return the base name
380 // without a prebuilt_ prefix so is safe to use as the key for the contentModuleDexJarPaths.
Paul Duffin1a8010a2021-05-15 12:39:23 +0100381 name := module.Name()
382 if dexJar, ok := i.contentModuleDexJarPaths[name]; ok {
383 return dexJar, nil
384 } else {
385 return nil, fmt.Errorf("unknown bootclasspath_fragment content module %s, expected one of %s",
Cole Faust18994c72023-02-28 16:02:16 -0800386 name, strings.Join(android.SortedKeys(i.contentModuleDexJarPaths), ", "))
Paul Duffin1a8010a2021-05-15 12:39:23 +0100387 }
Paul Duffin190fdef2021-04-26 10:33:59 +0100388}
389
Spandan Das5be63332023-12-13 00:06:32 +0000390func (i BootclasspathFragmentApexContentInfo) DexBootJarPathMap() bootDexJarByModule {
391 return i.contentModuleDexJarPaths
392}
393
Jiakai Zhang49b1eb62021-11-26 18:09:27 +0000394func (i BootclasspathFragmentApexContentInfo) ProfilePathOnHost() android.Path {
395 return i.profilePathOnHost
396}
397
398func (i BootclasspathFragmentApexContentInfo) ProfileInstallPathInApex() string {
399 return i.profileInstallPathInApex
400}
401
Paul Duffin7771eba2021-04-23 14:25:28 +0100402func (b *BootclasspathFragmentModule) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffina1d60252021-01-21 18:13:43 +0000403 tag := ctx.OtherModuleDependencyTag(dep)
Jihoon Kang9272dcc2024-01-12 00:08:30 +0000404
405 // If the module is a default module, do not check the tag
406 if _, ok := dep.(*Defaults); ok {
407 return true
408 }
Paul Duffin65898052021-04-20 22:47:03 +0100409 if IsBootclasspathFragmentContentDepTag(tag) {
Paul Duffin4d101b62021-03-24 15:42:20 +0000410 // Boot image contents are automatically added to apex.
411 return true
Paul Duffinc7ef9892021-03-23 23:21:59 +0000412 }
Bob Badour07065cd2021-02-05 19:59:11 -0800413 if android.IsMetaDependencyTag(tag) {
414 // Cross-cutting metadata dependencies are metadata.
415 return false
416 }
Paul Duffina1d60252021-01-21 18:13:43 +0000417 panic(fmt.Errorf("boot_image module %q should not have a dependency on %q via tag %s", b, dep, android.PrettyPrintTag(tag)))
418}
419
Paul Duffin7771eba2021-04-23 14:25:28 +0100420func (b *BootclasspathFragmentModule) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Paul Duffina1d60252021-01-21 18:13:43 +0000421 return nil
422}
423
Paul Duffin65898052021-04-20 22:47:03 +0100424// ComponentDepsMutator adds dependencies onto modules before any prebuilt modules without a
425// corresponding source module are renamed. This means that adding a dependency using a name without
426// a prebuilt_ prefix will always resolve to a source module and when using a name with that prefix
427// it will always resolve to a prebuilt module.
Paul Duffin7771eba2021-04-23 14:25:28 +0100428func (b *BootclasspathFragmentModule) ComponentDepsMutator(ctx android.BottomUpMutatorContext) {
Paul Duffin65898052021-04-20 22:47:03 +0100429 module := ctx.Module()
Paul Duffin7771eba2021-04-23 14:25:28 +0100430 _, isSourceModule := module.(*BootclasspathFragmentModule)
Paul Duffin65898052021-04-20 22:47:03 +0100431
432 for _, name := range b.properties.Contents {
433 // A bootclasspath_fragment must depend only on other source modules, while the
434 // prebuilt_bootclasspath_fragment must only depend on other prebuilt modules.
Paul Duffina9dd6fa2021-04-22 17:25:57 +0100435 //
436 // TODO(b/177892522) - avoid special handling of jacocoagent.
437 if !isSourceModule && name != "jacocoagent" {
Paul Duffin65898052021-04-20 22:47:03 +0100438 name = android.PrebuiltNameFromSource(name)
439 }
440 ctx.AddDependency(module, bootclasspathFragmentContentDepTag, name)
441 }
442
443}
444
Paul Duffin7771eba2021-04-23 14:25:28 +0100445func (b *BootclasspathFragmentModule) DepsMutator(ctx android.BottomUpMutatorContext) {
Paul Duffin10931582021-04-25 10:13:54 +0100446 // Add dependencies onto all the modules that provide the API stubs for classes on this
447 // bootclasspath fragment.
Paul Duffin31fad802021-06-18 18:14:25 +0100448 hiddenAPIAddStubLibDependencies(ctx, b.properties.apiScopeToStubLibs())
Paul Duffinc7ef9892021-03-23 23:21:59 +0000449
Paul Duffin5cca7c42021-05-26 10:16:01 +0100450 for _, additionalStubModule := range b.properties.Additional_stubs {
451 for _, apiScope := range hiddenAPISdkLibrarySupportedScopes {
452 // Add a dependency onto a possibly scope specific stub library.
453 scopeSpecificDependency := apiScope.scopeSpecificStubModule(ctx, additionalStubModule)
454 tag := hiddenAPIStubsDependencyTag{apiScope: apiScope, fromAdditionalDependency: true}
455 ctx.AddVariationDependencies(nil, tag, scopeSpecificDependency)
456 }
457 }
458
Jiakai Zhangbc698cd2023-05-08 16:28:38 +0000459 if !dexpreopt.IsDex2oatNeeded(ctx) {
Qiao Yang8d8c6602023-05-05 15:03:24 +0000460 return
461 }
462
Paul Duffina1d60252021-01-21 18:13:43 +0000463 // Add a dependency onto the dex2oat tool which is needed for creating the boot image. The
464 // path is retrieved from the dependency by GetGlobalSoongConfig(ctx).
465 dexpreopt.RegisterToolDeps(ctx)
466}
467
Paul Duffinf1b358c2021-05-17 07:38:47 +0100468func (b *BootclasspathFragmentModule) BootclasspathDepsMutator(ctx android.BottomUpMutatorContext) {
469 // Add dependencies on all the fragments.
470 b.properties.BootclasspathFragmentsDepsProperties.addDependenciesOntoFragments(ctx)
471}
472
Paul Duffin7771eba2021-04-23 14:25:28 +0100473func (b *BootclasspathFragmentModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Paul Duffinba6afd02019-11-19 19:44:10 +0000474 // Only perform a consistency check if this module is the active module. That will prevent an
475 // unused prebuilt that was created without instrumentation from breaking an instrumentation
476 // build.
Cole Fausta963b942024-04-11 17:43:00 -0700477 if isActiveModule(ctx, ctx.Module()) {
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100478 b.bootclasspathFragmentPropertyCheck(ctx)
Paul Duffinba6afd02019-11-19 19:44:10 +0000479 }
480
satayev3db35472021-05-06 23:59:58 +0100481 // Generate classpaths.proto config
482 b.generateClasspathProtoBuildActions(ctx)
483
Paul Duffin7ebebfd2021-04-27 19:36:57 +0100484 // Gather the bootclasspath fragment's contents.
485 var contents []android.Module
486 ctx.VisitDirectDeps(func(module android.Module) {
487 tag := ctx.OtherModuleDependencyTag(module)
488 if IsBootclasspathFragmentContentDepTag(tag) {
Paul Duffin79fd3d72021-05-14 16:14:17 +0100489 contents = append(contents, module)
Paul Duffin7ebebfd2021-04-27 19:36:57 +0100490 }
491 })
492
Paul Duffinf1b358c2021-05-17 07:38:47 +0100493 fragments := gatherApexModulePairDepsWithTag(ctx, bootclasspathFragmentDepTag)
494
Paul Duffin458a15b2022-11-25 12:18:24 +0000495 // Perform hidden API processing.
496 hiddenAPIOutput := b.generateHiddenAPIBuildActions(ctx, contents, fragments)
Paul Duffine5218812021-06-07 13:28:19 +0100497
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100498 if android.IsModulePrebuilt(ctx.Module()) {
499 b.profilePath = ctx.Module().(*PrebuiltBootclasspathFragmentModule).produceBootImageProfile(ctx)
500 } else {
501 b.profilePath = b.produceBootImageProfileFromSource(ctx, contents, hiddenAPIOutput.EncodedBootDexFilesByModule)
502 // Provide the apex content info. A prebuilt fragment cannot contribute to an apex.
503 b.provideApexContentInfo(ctx, hiddenAPIOutput, b.profilePath)
Paul Duffinea465fb2022-03-04 18:39:29 +0000504 }
505
506 // In order for information about bootclasspath_fragment modules to be added to module-info.json
507 // it is necessary to output an entry to Make. As bootclasspath_fragment modules are part of an
508 // APEX there can be multiple variants, including the default/platform variant and only one can
509 // be output to Make but it does not really matter which variant is output. The default/platform
510 // variant is the first (ctx.PrimaryModule()) and is usually hidden from make so this just picks
511 // the last variant (ctx.FinalModule()).
512 if ctx.Module() != ctx.FinalModule() {
513 b.HideFromMake()
Paul Duffin1a8010a2021-05-15 12:39:23 +0100514 }
Colin Cross40213022023-12-13 15:19:49 -0800515 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Paul Duffin1a8010a2021-05-15 12:39:23 +0100516}
517
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100518// getProfileProviderApex returns the name of the apex that provides a boot image profile, or an
519// empty string if this module should not provide a boot image profile.
520func (b *BootclasspathFragmentModule) getProfileProviderApex(ctx android.BaseModuleContext) string {
521 // Only use the profile from the module that is preferred.
Cole Fausta963b942024-04-11 17:43:00 -0700522 if !isActiveModule(ctx, ctx.Module()) {
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100523 return ""
524 }
525
Paul Duffince918b02021-06-07 14:33:47 +0100526 // Bootclasspath fragment modules that are for the platform do not produce boot related files.
Colin Crossff694a82023-12-13 15:54:49 -0800527 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100528 for _, apex := range apexInfo.InApexVariants {
529 if isProfileProviderApex(ctx, apex) {
530 return apex
531 }
Paul Duffince918b02021-06-07 14:33:47 +0100532 }
533
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100534 return ""
Paul Duffince918b02021-06-07 14:33:47 +0100535}
536
Paul Duffin1a8010a2021-05-15 12:39:23 +0100537// provideApexContentInfo creates, initializes and stores the apex content info for use by other
538// modules.
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100539func (b *BootclasspathFragmentModule) provideApexContentInfo(ctx android.ModuleContext, hiddenAPIOutput *HiddenAPIOutput, profile android.WritablePath) {
Paul Duffin1a8010a2021-05-15 12:39:23 +0100540 // Construct the apex content info from the config.
Paul Duffine5218812021-06-07 13:28:19 +0100541 info := BootclasspathFragmentApexContentInfo{
542 // Populate the apex content info with paths to the dex jars.
543 contentModuleDexJarPaths: hiddenAPIOutput.EncodedBootDexFilesByModule,
544 }
Paul Duffin1a8010a2021-05-15 12:39:23 +0100545
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100546 if profile != nil {
547 info.profilePathOnHost = profile
Spandan Dasda739a32023-12-13 00:06:32 +0000548 info.profileInstallPathInApex = ProfileInstallPathInApex
Paul Duffin1a8010a2021-05-15 12:39:23 +0100549 }
Paul Duffin3451e162021-01-20 15:16:56 +0000550
Paul Duffin1a8010a2021-05-15 12:39:23 +0100551 // Make the apex content info available for other modules.
Colin Cross40213022023-12-13 15:19:49 -0800552 android.SetProvider(ctx, BootclasspathFragmentApexContentInfoProvider, info)
Paul Duffin1a8010a2021-05-15 12:39:23 +0100553}
554
satayev3db35472021-05-06 23:59:58 +0100555// generateClasspathProtoBuildActions generates all required build actions for classpath.proto config
556func (b *BootclasspathFragmentModule) generateClasspathProtoBuildActions(ctx android.ModuleContext) {
557 var classpathJars []classpathJar
satayevb3090502021-06-15 17:49:10 +0100558 configuredJars := b.configuredJars(ctx)
satayev3db35472021-05-06 23:59:58 +0100559 if "art" == proptools.String(b.properties.Image_name) {
560 // ART and platform boot jars must have a corresponding entry in DEX2OATBOOTCLASSPATH
satayevb3090502021-06-15 17:49:10 +0100561 classpathJars = configuredJarListToClasspathJars(ctx, configuredJars, BOOTCLASSPATH, DEX2OATBOOTCLASSPATH)
satayev3db35472021-05-06 23:59:58 +0100562 } else {
satayevb3090502021-06-15 17:49:10 +0100563 classpathJars = configuredJarListToClasspathJars(ctx, configuredJars, b.classpathType)
satayev3db35472021-05-06 23:59:58 +0100564 }
satayevb3090502021-06-15 17:49:10 +0100565 b.classpathFragmentBase().generateClasspathProtoBuildActions(ctx, configuredJars, classpathJars)
satayev3db35472021-05-06 23:59:58 +0100566}
567
satayev142ed272021-06-15 16:21:17 +0100568func (b *BootclasspathFragmentModule) configuredJars(ctx android.ModuleContext) android.ConfiguredJarList {
satayev8fab6f82021-05-07 00:10:33 +0100569 global := dexpreopt.GetGlobalConfig(ctx)
570
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100571 if "art" == proptools.String(b.properties.Image_name) {
572 return global.ArtApexJars
573 }
574
satayevd604b212021-07-21 14:23:52 +0100575 possibleUpdatableModules := gatherPossibleApexModuleNamesAndStems(ctx, b.properties.Contents, bootclasspathFragmentContentDepTag)
satayevd34eb0c2021-08-06 13:20:28 +0100576 jars, unknown := global.ApexBootJars.Filter(possibleUpdatableModules)
satayev1b75a3c2021-06-04 18:09:40 +0100577
578 // TODO(satayev): for apex_test we want to include all contents unconditionally to classpaths
satayevd604b212021-07-21 14:23:52 +0100579 // config. However, any test specific jars would not be present in ApexBootJars. Instead,
satayev1b75a3c2021-06-04 18:09:40 +0100580 // we should check if we are creating a config for apex_test via ApexInfo and amend the values.
581 // This is an exception to support end-to-end test for SdkExtensions, until such support exists.
Paul Duffin56c93e82021-06-29 20:04:45 +0100582 if android.InList("test_framework-sdkextensions", possibleUpdatableModules) {
satayev1b75a3c2021-06-04 18:09:40 +0100583 jars = jars.Append("com.android.sdkext", "test_framework-sdkextensions")
Samiul Islam7b385c52021-10-11 22:47:13 +0100584 } else if android.InList("test_framework-apexd", possibleUpdatableModules) {
585 jars = jars.Append("com.android.apex.test_package", "test_framework-apexd")
Paul Duffin458a15b2022-11-25 12:18:24 +0000586 } else if global.ApexBootJars.Len() != 0 {
satayevd34eb0c2021-08-06 13:20:28 +0100587 unknown = android.RemoveListFromList(unknown, b.properties.Coverage.Contents)
588 _, unknown = android.RemoveFromList("core-icu4j", unknown)
Keun young Park59799962021-10-14 15:42:04 -0700589 // This module only exists in car products.
590 // So ignore it even if it is not in PRODUCT_APEX_BOOT_JARS.
591 // TODO(b/202896428): Add better way to handle this.
592 _, unknown = android.RemoveFromList("android.car-module", unknown)
Spandan Das3d0d31a2024-05-03 21:36:48 +0000593 if isApexVariant(ctx) && len(unknown) > 0 {
594 if android.IsModulePrebuilt(ctx.Module()) {
595 // prebuilt bcpf. the validation of this will be done at the top-level apex
596 providerClasspathFragmentValidationInfoProvider(ctx, unknown)
597 } else if !disableSourceApexVariant(ctx) {
598 // source bcpf, and prebuilt apex are not selected.
599 ctx.ModuleErrorf("%s in contents must also be declared in PRODUCT_APEX_BOOT_JARS", unknown)
600 }
satayevd34eb0c2021-08-06 13:20:28 +0100601 }
satayev1b75a3c2021-06-04 18:09:40 +0100602 }
603 return jars
satayev3db35472021-05-06 23:59:58 +0100604}
605
Spandan Das3d0d31a2024-05-03 21:36:48 +0000606var ClasspathFragmentValidationInfoProvider = blueprint.NewProvider[ClasspathFragmentValidationInfo]()
607
608type ClasspathFragmentValidationInfo struct {
609 ClasspathFragmentModuleName string
610 UnknownJars []string
611}
612
613// Set a provider with the list of jars that have not been added to PRODUCT_APEX_BOOT_JARS
614// The validation will be done in the ctx of the top-level _selected_ apex
615func providerClasspathFragmentValidationInfoProvider(ctx android.ModuleContext, unknown []string) {
616 info := ClasspathFragmentValidationInfo{
617 ClasspathFragmentModuleName: ctx.ModuleName(),
618 UnknownJars: unknown,
619 }
620 android.SetProvider(ctx, ClasspathFragmentValidationInfoProvider, info)
621}
622
Paul Duffin9b381ef2021-04-08 23:01:37 +0100623// generateHiddenAPIBuildActions generates all the hidden API related build rules.
Paul Duffine5218812021-06-07 13:28:19 +0100624func (b *BootclasspathFragmentModule) generateHiddenAPIBuildActions(ctx android.ModuleContext, contents []android.Module, fragments []android.Module) *HiddenAPIOutput {
Paul Duffin10931582021-04-25 10:13:54 +0100625
Paul Duffin1352f7c2021-05-21 22:18:49 +0100626 // Create hidden API input structure.
Paul Duffinf1b358c2021-05-17 07:38:47 +0100627 input := b.createHiddenAPIFlagInput(ctx, contents, fragments)
Paul Duffin10931582021-04-25 10:13:54 +0100628
Paul Duffinda286f42021-06-29 11:59:23 +0100629 // Delegate the production of the hidden API all-flags.csv file to a module type specific method.
630 common := ctx.Module().(commonBootclasspathFragment)
Paul Duffin1938dba2022-07-26 23:53:00 +0000631 output := common.produceHiddenAPIOutput(ctx, contents, fragments, input)
Paul Duffin62370922021-05-23 16:55:37 +0100632
Paul Duffin67b9d612021-07-21 17:38:47 +0100633 // If the source or prebuilts module does not provide a signature patterns file then generate one
634 // from the flags.
635 // TODO(b/192868581): Remove once the source and prebuilts provide a signature patterns file of
636 // their own.
637 if output.SignaturePatternsPath == nil {
Paul Duffin846beb72022-03-15 17:45:57 +0000638 output.SignaturePatternsPath = buildRuleSignaturePatternsFile(
Paul Duffin1938dba2022-07-26 23:53:00 +0000639 ctx, output.AllFlagsPath, []string{"*"}, nil, nil, "")
Paul Duffin67b9d612021-07-21 17:38:47 +0100640 }
641
Paul Duffin62370922021-05-23 16:55:37 +0100642 // Initialize a HiddenAPIInfo structure.
Paul Duffinaf99afa2021-05-21 22:18:56 +0100643 hiddenAPIInfo := HiddenAPIInfo{
Paul Duffin62370922021-05-23 16:55:37 +0100644 // The monolithic hidden API processing needs access to the flag files that override the default
645 // flags from all the fragments whether or not they actually perform their own hidden API flag
646 // generation. That is because the monolithic hidden API processing uses those flag files to
647 // perform its own flag generation.
Paul Duffin1352f7c2021-05-21 22:18:49 +0100648 FlagFilesByCategory: input.FlagFilesByCategory,
Paul Duffin18cf1972021-05-21 22:46:59 +0100649
Paul Duffinf1b358c2021-05-17 07:38:47 +0100650 // Other bootclasspath_fragments that depend on this need the transitive set of stub dex jars
651 // from this to resolve any references from their code to classes provided by this fragment
652 // and the fragments this depends upon.
Paul Duffin31fad802021-06-18 18:14:25 +0100653 TransitiveStubDexJarsByScope: input.transitiveStubDexJarsByScope(),
Paul Duffin62370922021-05-23 16:55:37 +0100654 }
Paul Duffin2fef1362021-04-15 13:32:00 +0100655
Paul Duffine5218812021-06-07 13:28:19 +0100656 // The monolithic hidden API processing also needs access to all the output files produced by
657 // hidden API processing of this fragment.
Paul Duffin54e41972021-07-19 13:23:40 +0100658 hiddenAPIInfo.HiddenAPIFlagOutput = output.HiddenAPIFlagOutput
Paul Duffin62370922021-05-23 16:55:37 +0100659
660 // Provide it for use by other modules.
Colin Cross40213022023-12-13 15:19:49 -0800661 android.SetProvider(ctx, HiddenAPIInfoProvider, hiddenAPIInfo)
Paul Duffin54c98f52021-05-15 08:54:30 +0100662
Paul Duffin1e6f5c42021-05-21 16:15:31 +0100663 return output
Paul Duffin2fef1362021-04-15 13:32:00 +0100664}
665
Paul Duffin1352f7c2021-05-21 22:18:49 +0100666// createHiddenAPIFlagInput creates a HiddenAPIFlagInput struct and initializes it with information derived
667// from the properties on this module and its dependencies.
Paul Duffinf1b358c2021-05-17 07:38:47 +0100668func (b *BootclasspathFragmentModule) createHiddenAPIFlagInput(ctx android.ModuleContext, contents []android.Module, fragments []android.Module) HiddenAPIFlagInput {
Paul Duffinf1b358c2021-05-17 07:38:47 +0100669 // Merge the HiddenAPIInfo from all the fragment dependencies.
670 dependencyHiddenApiInfo := newHiddenAPIInfo()
671 dependencyHiddenApiInfo.mergeFromFragmentDeps(ctx, fragments)
672
673 // Create hidden API flag input structure.
Paul Duffin1352f7c2021-05-21 22:18:49 +0100674 input := newHiddenAPIFlagInput()
675
676 // Update the input structure with information obtained from the stub libraries.
677 input.gatherStubLibInfo(ctx, contents)
678
679 // Populate with flag file paths from the properties.
Paul Duffin9b61abb2022-07-27 16:16:54 +0000680 input.extractFlagFilesFromProperties(ctx, &b.properties.HiddenAPIFlagFileProperties)
Paul Duffin1352f7c2021-05-21 22:18:49 +0100681
Paul Duffin1e9e9382022-07-27 15:55:06 +0000682 // Populate with package rules from the properties.
683 input.extractPackageRulesFromProperties(&b.sourceOnlyProperties.HiddenAPIPackageProperties)
684
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000685 input.gatherPropertyInfo(ctx, contents)
686
Paul Duffin5cca7c42021-05-26 10:16:01 +0100687 // Add the stub dex jars from this module's fragment dependencies.
Paul Duffin280a31a2021-06-27 20:28:29 +0100688 input.DependencyStubDexJarsByScope.addStubDexJarsByModule(dependencyHiddenApiInfo.TransitiveStubDexJarsByScope)
Paul Duffinf1b358c2021-05-17 07:38:47 +0100689
Paul Duffin1352f7c2021-05-21 22:18:49 +0100690 return input
691}
692
Paul Duffinc15b9e92022-03-31 15:42:30 +0100693// isTestFragment returns true if the current module is a test bootclasspath_fragment.
694func (b *BootclasspathFragmentModule) isTestFragment() bool {
Paul Duffind0fe1302022-09-14 17:04:51 +0000695 return b.testFragment
Paul Duffinc15b9e92022-03-31 15:42:30 +0100696}
697
Paul Duffinaf705182022-09-14 11:47:34 +0100698// generateHiddenApiFlagRules generates rules to generate hidden API flags and compute the signature
699// patterns file.
700func (b *BootclasspathFragmentModule) generateHiddenApiFlagRules(ctx android.ModuleContext, contents []android.Module, input HiddenAPIFlagInput, bootDexInfoByModule bootDexInfoByModule, suffix string) HiddenAPIFlagOutput {
Paul Duffin1352f7c2021-05-21 22:18:49 +0100701 // Generate the rules to create the hidden API flags and update the supplied hiddenAPIInfo with the
Paul Duffin2fef1362021-04-15 13:32:00 +0100702 // paths to the created files.
Paul Duffin1938dba2022-07-26 23:53:00 +0000703 flagOutput := hiddenAPIFlagRulesForBootclasspathFragment(ctx, bootDexInfoByModule, contents, input, suffix)
Paul Duffin1e18e982021-08-03 15:42:27 +0100704
705 // If the module specifies split_packages or package_prefixes then use those to generate the
706 // signature patterns.
Paul Duffin1e9e9382022-07-27 15:55:06 +0000707 splitPackages := input.SplitPackages
708 packagePrefixes := input.PackagePrefixes
709 singlePackages := input.SinglePackages
Paul Duffin846beb72022-03-15 17:45:57 +0000710 if splitPackages != nil || packagePrefixes != nil || singlePackages != nil {
Paul Duffinaf705182022-09-14 11:47:34 +0100711 flagOutput.SignaturePatternsPath = buildRuleSignaturePatternsFile(
Paul Duffin1938dba2022-07-26 23:53:00 +0000712 ctx, flagOutput.AllFlagsPath, splitPackages, packagePrefixes, singlePackages, suffix)
Paul Duffin9fd56472022-03-31 15:42:30 +0100713 } else if !b.isTestFragment() {
714 ctx.ModuleErrorf(`Must specify at least one of the split_packages, package_prefixes and single_packages properties
715 If this is a new bootclasspath_fragment or you are unsure what to do add the
716 the following to the bootclasspath_fragment:
717 hidden_api: {split_packages: ["*"]},
718 and then run the following:
719 m analyze_bcpf && analyze_bcpf --bcpf %q
720 it will analyze the bootclasspath_fragment and provide hints as to what you
721 should specify here. If you are happy with its suggestions then you can add
722 the --fix option and it will fix them for you.`, b.BaseModuleName())
Paul Duffin1e18e982021-08-03 15:42:27 +0100723 }
Paul Duffinaf705182022-09-14 11:47:34 +0100724 return flagOutput
725}
726
727// produceHiddenAPIOutput produces the hidden API all-flags.csv file (and supporting files)
728// for the fragment as well as encoding the flags in the boot dex jars.
Paul Duffin1938dba2022-07-26 23:53:00 +0000729func (b *BootclasspathFragmentModule) produceHiddenAPIOutput(ctx android.ModuleContext, contents []android.Module, fragments []android.Module, input HiddenAPIFlagInput) *HiddenAPIOutput {
Paul Duffinaf705182022-09-14 11:47:34 +0100730 // Gather information about the boot dex files for the boot libraries provided by this fragment.
731 bootDexInfoByModule := extractBootDexInfoFromModules(ctx, contents)
732
733 // Generate the flag file needed to encode into the dex files.
734 flagOutput := b.generateHiddenApiFlagRules(ctx, contents, input, bootDexInfoByModule, "")
735
736 // Encode those flags into the dex files of the contents of this fragment.
737 encodedBootDexFilesByModule := hiddenAPIEncodeRulesForBootclasspathFragment(ctx, bootDexInfoByModule, flagOutput.AllFlagsPath)
738
739 // Store that information for return for use by other rules.
740 output := &HiddenAPIOutput{
741 HiddenAPIFlagOutput: flagOutput,
742 EncodedBootDexFilesByModule: encodedBootDexFilesByModule,
743 }
Paul Duffin1e18e982021-08-03 15:42:27 +0100744
Paul Duffin1938dba2022-07-26 23:53:00 +0000745 // Get the ApiLevel associated with SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE, defaulting to current
746 // if not set.
747 config := ctx.Config()
748 targetApiLevel := android.ApiLevelOrPanic(ctx,
749 config.GetenvWithDefault("SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE", "current"))
750
751 // Filter the contents list to remove any modules that do not support the target build release.
752 // The current build release supports all the modules.
753 contentsForSdkSnapshot := []android.Module{}
754 for _, module := range contents {
755 // If the module has a min_sdk_version that is higher than the target build release then it will
756 // not work on the target build release and so must not be included in the sdk snapshot.
757 minApiLevel := android.MinApiLevelForSdkSnapshot(ctx, module)
758 if minApiLevel.GreaterThan(targetApiLevel) {
759 continue
760 }
761
762 contentsForSdkSnapshot = append(contentsForSdkSnapshot, module)
763 }
764
765 var flagFilesByCategory FlagFilesByCategory
766 if len(contentsForSdkSnapshot) != len(contents) {
767 // The sdk snapshot has different contents to the runtime fragment so it is not possible to
768 // reuse the hidden API information generated for the fragment. So, recompute that information
769 // for the sdk snapshot.
770 filteredInput := b.createHiddenAPIFlagInput(ctx, contentsForSdkSnapshot, fragments)
771
772 // Gather information about the boot dex files for the boot libraries provided by this fragment.
773 filteredBootDexInfoByModule := extractBootDexInfoFromModules(ctx, contentsForSdkSnapshot)
774 flagOutput = b.generateHiddenApiFlagRules(ctx, contentsForSdkSnapshot, filteredInput, filteredBootDexInfoByModule, "-for-sdk-snapshot")
775 flagFilesByCategory = filteredInput.FlagFilesByCategory
776 } else {
777 // The sdk snapshot has the same contents as the runtime fragment so reuse that information.
778 flagFilesByCategory = input.FlagFilesByCategory
779 }
Paul Duffin887efdd2022-09-14 16:37:12 +0100780
781 // Make the information available for the sdk snapshot.
Colin Cross40213022023-12-13 15:19:49 -0800782 android.SetProvider(ctx, HiddenAPIInfoForSdkProvider, HiddenAPIInfoForSdk{
Paul Duffin887efdd2022-09-14 16:37:12 +0100783 FlagFilesByCategory: flagFilesByCategory,
784 HiddenAPIFlagOutput: flagOutput,
785 })
786
Paul Duffin1e18e982021-08-03 15:42:27 +0100787 return output
Paul Duffin9b381ef2021-04-08 23:01:37 +0100788}
789
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100790// produceBootImageProfileFromSource builds the boot image profile from the source if it is required.
791func (b *BootclasspathFragmentModule) produceBootImageProfileFromSource(ctx android.ModuleContext, contents []android.Module, modules bootDexJarByModule) android.WritablePath {
792 apex := b.getProfileProviderApex(ctx)
793 if apex == "" {
794 return nil
Paul Duffin7ebebfd2021-04-27 19:36:57 +0100795 }
796
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100797 dexPaths := make(android.Paths, 0, len(contents))
798 dexLocations := make([]string, 0, len(contents))
799 for _, module := range contents {
800 dexPaths = append(dexPaths, modules[module.Name()])
Cole Faust06ea5312023-10-18 17:38:40 -0700801 dexLocations = append(dexLocations, filepath.Join("/", "apex", apex, "javalib", module.Name()+".jar"))
Paul Duffin7ebebfd2021-04-27 19:36:57 +0100802 }
803
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100804 // Build a profile for the modules in this fragment.
805 return bootImageProfileRuleCommon(ctx, b.Name(), dexPaths, dexLocations)
Paul Duffin7ebebfd2021-04-27 19:36:57 +0100806}
807
Jiakai Zhang6decef92022-01-12 17:56:19 +0000808func (b *BootclasspathFragmentModule) AndroidMkEntries() []android.AndroidMkEntries {
Paul Duffinea465fb2022-03-04 18:39:29 +0000809 // Use the generated classpath proto as the output.
810 outputFile := b.outputFilepath
811 // Create a fake entry that will cause this to be added to the module-info.json file.
812 entriesList := []android.AndroidMkEntries{{
813 Class: "FAKE",
814 OutputFile: android.OptionalPathForPath(outputFile),
815 Include: "$(BUILD_PHONY_PACKAGE)",
816 ExtraFooters: []android.AndroidMkExtraFootersFunc{
817 func(w io.Writer, name, prefix, moduleDir string) {
818 // Allow the bootclasspath_fragment to be built by simply passing its name on the command
819 // line.
820 fmt.Fprintln(w, ".PHONY:", b.Name())
821 fmt.Fprintln(w, b.Name()+":", outputFile.String())
822 },
823 },
824 }}
Jiakai Zhang6decef92022-01-12 17:56:19 +0000825 return entriesList
826}
827
Jiakai Zhangc08c1622023-05-10 18:38:34 +0100828func (b *BootclasspathFragmentModule) getProfilePath() android.Path {
829 return b.profilePath
830}
831
braleeb0c1f0c2021-06-07 22:49:13 +0800832// Collect information for opening IDE project files in java/jdeps.go.
833func (b *BootclasspathFragmentModule) IDEInfo(dpInfo *android.IdeInfo) {
834 dpInfo.Deps = append(dpInfo.Deps, b.properties.Contents...)
braleeb0c1f0c2021-06-07 22:49:13 +0800835}
836
Paul Duffin7771eba2021-04-23 14:25:28 +0100837type bootclasspathFragmentMemberType struct {
Paul Duffinf7f65da2021-03-10 15:00:46 +0000838 android.SdkMemberTypeBase
839}
840
Paul Duffin296701e2021-07-14 10:29:36 +0100841func (b *bootclasspathFragmentMemberType) AddDependencies(ctx android.SdkDependencyContext, dependencyTag blueprint.DependencyTag, names []string) {
842 ctx.AddVariationDependencies(nil, dependencyTag, names...)
Paul Duffinf7f65da2021-03-10 15:00:46 +0000843}
844
Paul Duffin7771eba2021-04-23 14:25:28 +0100845func (b *bootclasspathFragmentMemberType) IsInstance(module android.Module) bool {
846 _, ok := module.(*BootclasspathFragmentModule)
Paul Duffinf7f65da2021-03-10 15:00:46 +0000847 return ok
848}
849
Paul Duffin7771eba2021-04-23 14:25:28 +0100850func (b *bootclasspathFragmentMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
Paul Duffin4b64ba02021-03-29 11:02:53 +0100851 if b.PropertyName == "boot_images" {
852 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "prebuilt_boot_image")
853 } else {
854 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "prebuilt_bootclasspath_fragment")
855 }
Paul Duffinf7f65da2021-03-10 15:00:46 +0000856}
857
Paul Duffin7771eba2021-04-23 14:25:28 +0100858func (b *bootclasspathFragmentMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
859 return &bootclasspathFragmentSdkMemberProperties{}
Paul Duffinf7f65da2021-03-10 15:00:46 +0000860}
861
Paul Duffin7771eba2021-04-23 14:25:28 +0100862type bootclasspathFragmentSdkMemberProperties struct {
Paul Duffinf7f65da2021-03-10 15:00:46 +0000863 android.SdkMemberPropertiesBase
864
Paul Duffina57835e2021-04-19 13:23:06 +0100865 // The image name
Paul Duffin64be7bb2021-03-23 23:06:38 +0000866 Image_name *string
Paul Duffina57835e2021-04-19 13:23:06 +0100867
868 // Contents of the bootclasspath fragment
869 Contents []string
Paul Duffin7c955552021-04-19 13:23:53 +0100870
Paul Duffin895c7142021-04-25 13:40:15 +0100871 // Stub_libs properties.
872 Stub_libs []string
873 Core_platform_stub_libs []string
874
Paul Duffin51227d82021-05-18 12:54:27 +0100875 // Fragment properties
876 Fragments []ApexVariantReference
877
Paul Duffin7c955552021-04-19 13:23:53 +0100878 // Flag files by *hiddenAPIFlagFileCategory
Paul Duffin438eb572021-05-21 16:58:23 +0100879 Flag_files_by_category FlagFilesByCategory
Paul Duffin2fef1362021-04-15 13:32:00 +0100880
Paul Duffin2fef1362021-04-15 13:32:00 +0100881 // The path to the generated annotation-flags.csv file.
882 Annotation_flags_path android.OptionalPath
883
884 // The path to the generated metadata.csv file.
885 Metadata_path android.OptionalPath
886
887 // The path to the generated index.csv file.
888 Index_path android.OptionalPath
889
Paul Duffin67b9d612021-07-21 17:38:47 +0100890 // The path to the generated stub-flags.csv file.
Paul Duffin191be3a2021-08-10 16:14:16 +0100891 Stub_flags_path android.OptionalPath `supported_build_releases:"S"`
Paul Duffin67b9d612021-07-21 17:38:47 +0100892
Paul Duffin2fef1362021-04-15 13:32:00 +0100893 // The path to the generated all-flags.csv file.
Paul Duffin191be3a2021-08-10 16:14:16 +0100894 All_flags_path android.OptionalPath `supported_build_releases:"S"`
895
896 // The path to the generated signature-patterns.csv file.
Paul Duffine7babdb2022-02-10 13:06:54 +0000897 Signature_patterns_path android.OptionalPath `supported_build_releases:"Tiramisu+"`
Paul Duffin191be3a2021-08-10 16:14:16 +0100898
899 // The path to the generated filtered-stub-flags.csv file.
Paul Duffine7babdb2022-02-10 13:06:54 +0000900 Filtered_stub_flags_path android.OptionalPath `supported_build_releases:"Tiramisu+"`
Paul Duffin191be3a2021-08-10 16:14:16 +0100901
902 // The path to the generated filtered-flags.csv file.
Paul Duffine7babdb2022-02-10 13:06:54 +0000903 Filtered_flags_path android.OptionalPath `supported_build_releases:"Tiramisu+"`
Paul Duffin2fef1362021-04-15 13:32:00 +0100904}
905
Paul Duffin7771eba2021-04-23 14:25:28 +0100906func (b *bootclasspathFragmentSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
907 module := variant.(*BootclasspathFragmentModule)
Paul Duffinf7f65da2021-03-10 15:00:46 +0000908
909 b.Image_name = module.properties.Image_name
Paul Duffin2dc665b2021-04-23 16:58:51 +0100910 b.Contents = module.properties.Contents
Paul Duffin7c955552021-04-19 13:23:53 +0100911
Paul Duffinaf99afa2021-05-21 22:18:56 +0100912 // Get the hidden API information from the module.
Paul Duffin7c955552021-04-19 13:23:53 +0100913 mctx := ctx.SdkModuleContext()
Colin Cross313aa542023-12-13 13:47:44 -0800914 hiddenAPIInfo, _ := android.OtherModuleProvider(mctx, module, HiddenAPIInfoForSdkProvider)
Paul Duffinaf99afa2021-05-21 22:18:56 +0100915 b.Flag_files_by_category = hiddenAPIInfo.FlagFilesByCategory
Paul Duffin895c7142021-04-25 13:40:15 +0100916
Paul Duffin2fef1362021-04-15 13:32:00 +0100917 // Copy all the generated file paths.
Paul Duffinaf99afa2021-05-21 22:18:56 +0100918 b.Annotation_flags_path = android.OptionalPathForPath(hiddenAPIInfo.AnnotationFlagsPath)
919 b.Metadata_path = android.OptionalPathForPath(hiddenAPIInfo.MetadataPath)
920 b.Index_path = android.OptionalPathForPath(hiddenAPIInfo.IndexPath)
Paul Duffin67b9d612021-07-21 17:38:47 +0100921
922 b.Stub_flags_path = android.OptionalPathForPath(hiddenAPIInfo.StubFlagsPath)
Paul Duffinaf99afa2021-05-21 22:18:56 +0100923 b.All_flags_path = android.OptionalPathForPath(hiddenAPIInfo.AllFlagsPath)
Paul Duffin2fef1362021-04-15 13:32:00 +0100924
Paul Duffin191be3a2021-08-10 16:14:16 +0100925 b.Signature_patterns_path = android.OptionalPathForPath(hiddenAPIInfo.SignaturePatternsPath)
926 b.Filtered_stub_flags_path = android.OptionalPathForPath(hiddenAPIInfo.FilteredStubFlagsPath)
927 b.Filtered_flags_path = android.OptionalPathForPath(hiddenAPIInfo.FilteredFlagsPath)
928
Paul Duffin895c7142021-04-25 13:40:15 +0100929 // Copy stub_libs properties.
930 b.Stub_libs = module.properties.Api.Stub_libs
931 b.Core_platform_stub_libs = module.properties.Core_platform_api.Stub_libs
Paul Duffin51227d82021-05-18 12:54:27 +0100932
933 // Copy fragment properties.
934 b.Fragments = module.properties.Fragments
Paul Duffinf7f65da2021-03-10 15:00:46 +0000935}
936
Paul Duffin7771eba2021-04-23 14:25:28 +0100937func (b *bootclasspathFragmentSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffin64be7bb2021-03-23 23:06:38 +0000938 if b.Image_name != nil {
939 propertySet.AddProperty("image_name", *b.Image_name)
Paul Duffinf7f65da2021-03-10 15:00:46 +0000940 }
Paul Duffina57835e2021-04-19 13:23:06 +0100941
Paul Duffin895c7142021-04-25 13:40:15 +0100942 builder := ctx.SnapshotBuilder()
943 requiredMemberDependency := builder.SdkMemberReferencePropertyTag(true)
944
Paul Duffina57835e2021-04-19 13:23:06 +0100945 if len(b.Contents) > 0 {
Paul Duffin895c7142021-04-25 13:40:15 +0100946 propertySet.AddPropertyWithTag("contents", b.Contents, requiredMemberDependency)
Paul Duffina57835e2021-04-19 13:23:06 +0100947 }
Paul Duffin7c955552021-04-19 13:23:53 +0100948
Paul Duffin895c7142021-04-25 13:40:15 +0100949 if len(b.Stub_libs) > 0 {
950 apiPropertySet := propertySet.AddPropertySet("api")
951 apiPropertySet.AddPropertyWithTag("stub_libs", b.Stub_libs, requiredMemberDependency)
952 }
953 if len(b.Core_platform_stub_libs) > 0 {
954 corePlatformApiPropertySet := propertySet.AddPropertySet("core_platform_api")
955 corePlatformApiPropertySet.AddPropertyWithTag("stub_libs", b.Core_platform_stub_libs, requiredMemberDependency)
956 }
Paul Duffin51227d82021-05-18 12:54:27 +0100957 if len(b.Fragments) > 0 {
958 propertySet.AddProperty("fragments", b.Fragments)
959 }
Paul Duffin895c7142021-04-25 13:40:15 +0100960
Paul Duffin2fef1362021-04-15 13:32:00 +0100961 hiddenAPISet := propertySet.AddPropertySet("hidden_api")
962 hiddenAPIDir := "hiddenapi"
963
964 // Copy manually curated flag files specified on the bootclasspath_fragment.
Paul Duffin7c955552021-04-19 13:23:53 +0100965 if b.Flag_files_by_category != nil {
Paul Duffin524c82c2021-06-09 14:39:28 +0100966 for _, category := range HiddenAPIFlagFileCategories {
Paul Duffin7c955552021-04-19 13:23:53 +0100967 paths := b.Flag_files_by_category[category]
968 if len(paths) > 0 {
969 dests := []string{}
970 for _, p := range paths {
Paul Duffin2fef1362021-04-15 13:32:00 +0100971 dest := filepath.Join(hiddenAPIDir, p.Base())
Paul Duffin7c955552021-04-19 13:23:53 +0100972 builder.CopyToSnapshot(p, dest)
973 dests = append(dests, dest)
974 }
Cole Faust22e8abc2024-01-23 17:52:13 -0800975 hiddenAPISet.AddProperty(category.PropertyName(), dests)
Paul Duffin7c955552021-04-19 13:23:53 +0100976 }
977 }
978 }
Paul Duffin2fef1362021-04-15 13:32:00 +0100979
980 copyOptionalPath := func(path android.OptionalPath, property string) {
981 if path.Valid() {
982 p := path.Path()
983 dest := filepath.Join(hiddenAPIDir, p.Base())
984 builder.CopyToSnapshot(p, dest)
985 hiddenAPISet.AddProperty(property, dest)
986 }
987 }
988
989 // Copy all the generated files, if available.
Paul Duffin2fef1362021-04-15 13:32:00 +0100990 copyOptionalPath(b.Annotation_flags_path, "annotation_flags")
991 copyOptionalPath(b.Metadata_path, "metadata")
992 copyOptionalPath(b.Index_path, "index")
Paul Duffin191be3a2021-08-10 16:14:16 +0100993
Paul Duffin67b9d612021-07-21 17:38:47 +0100994 copyOptionalPath(b.Stub_flags_path, "stub_flags")
Paul Duffin2fef1362021-04-15 13:32:00 +0100995 copyOptionalPath(b.All_flags_path, "all_flags")
Paul Duffin191be3a2021-08-10 16:14:16 +0100996
997 copyOptionalPath(b.Signature_patterns_path, "signature_patterns")
998 copyOptionalPath(b.Filtered_stub_flags_path, "filtered_stub_flags")
999 copyOptionalPath(b.Filtered_flags_path, "filtered_flags")
Paul Duffinf7f65da2021-03-10 15:00:46 +00001000}
1001
Paul Duffin7771eba2021-04-23 14:25:28 +01001002var _ android.SdkMemberType = (*bootclasspathFragmentMemberType)(nil)
Paul Duffinf7f65da2021-03-10 15:00:46 +00001003
Paul Duffin2fef1362021-04-15 13:32:00 +01001004// prebuiltBootclasspathFragmentProperties contains additional prebuilt_bootclasspath_fragment
1005// specific properties.
1006type prebuiltBootclasspathFragmentProperties struct {
1007 Hidden_api struct {
Paul Duffin2fef1362021-04-15 13:32:00 +01001008 // The path to the annotation-flags.csv file created by the bootclasspath_fragment.
1009 Annotation_flags *string `android:"path"`
1010
1011 // The path to the metadata.csv file created by the bootclasspath_fragment.
1012 Metadata *string `android:"path"`
1013
1014 // The path to the index.csv file created by the bootclasspath_fragment.
1015 Index *string `android:"path"`
1016
Paul Duffin8d007e92021-07-22 12:00:49 +01001017 // The path to the signature-patterns.csv file created by the bootclasspath_fragment.
1018 Signature_patterns *string `android:"path"`
1019
Paul Duffin67b9d612021-07-21 17:38:47 +01001020 // The path to the stub-flags.csv file created by the bootclasspath_fragment.
1021 Stub_flags *string `android:"path"`
1022
Paul Duffin2fef1362021-04-15 13:32:00 +01001023 // The path to the all-flags.csv file created by the bootclasspath_fragment.
1024 All_flags *string `android:"path"`
Paul Duffin191be3a2021-08-10 16:14:16 +01001025
1026 // The path to the filtered-stub-flags.csv file created by the bootclasspath_fragment.
1027 Filtered_stub_flags *string `android:"path"`
1028
1029 // The path to the filtered-flags.csv file created by the bootclasspath_fragment.
1030 Filtered_flags *string `android:"path"`
Paul Duffin2fef1362021-04-15 13:32:00 +01001031 }
1032}
1033
Paul Duffin7771eba2021-04-23 14:25:28 +01001034// A prebuilt version of the bootclasspath_fragment module.
Paul Duffinf7f65da2021-03-10 15:00:46 +00001035//
Paul Duffin7771eba2021-04-23 14:25:28 +01001036// At the moment this is basically just a bootclasspath_fragment module that can be used as a
1037// prebuilt. Eventually as more functionality is migrated into the bootclasspath_fragment module
1038// type from the various singletons then this will diverge.
Jiakai Zhange6e90db2022-01-28 14:58:56 +00001039type PrebuiltBootclasspathFragmentModule struct {
Paul Duffin7771eba2021-04-23 14:25:28 +01001040 BootclasspathFragmentModule
Paul Duffinf7f65da2021-03-10 15:00:46 +00001041 prebuilt android.Prebuilt
Paul Duffin2fef1362021-04-15 13:32:00 +01001042
1043 // Additional prebuilt specific properties.
1044 prebuiltProperties prebuiltBootclasspathFragmentProperties
Paul Duffinf7f65da2021-03-10 15:00:46 +00001045}
1046
Jiakai Zhange6e90db2022-01-28 14:58:56 +00001047func (module *PrebuiltBootclasspathFragmentModule) Prebuilt() *android.Prebuilt {
Paul Duffinf7f65da2021-03-10 15:00:46 +00001048 return &module.prebuilt
1049}
1050
Jiakai Zhange6e90db2022-01-28 14:58:56 +00001051func (module *PrebuiltBootclasspathFragmentModule) Name() string {
Paul Duffinf7f65da2021-03-10 15:00:46 +00001052 return module.prebuilt.Name(module.ModuleBase.Name())
1053}
1054
Paul Duffine5218812021-06-07 13:28:19 +01001055// produceHiddenAPIOutput returns a path to the prebuilt all-flags.csv or nil if none is specified.
Paul Duffin1938dba2022-07-26 23:53:00 +00001056func (module *PrebuiltBootclasspathFragmentModule) produceHiddenAPIOutput(ctx android.ModuleContext, contents []android.Module, fragments []android.Module, input HiddenAPIFlagInput) *HiddenAPIOutput {
Paul Duffin191be3a2021-08-10 16:14:16 +01001057 pathForOptionalSrc := func(src *string, defaultPath android.Path) android.Path {
Paul Duffin8d007e92021-07-22 12:00:49 +01001058 if src == nil {
Paul Duffin191be3a2021-08-10 16:14:16 +01001059 return defaultPath
Paul Duffin8d007e92021-07-22 12:00:49 +01001060 }
1061 return android.PathForModuleSrc(ctx, *src)
1062 }
Paul Duffin54e41972021-07-19 13:23:40 +01001063 pathForSrc := func(property string, src *string) android.Path {
Paul Duffin2fef1362021-04-15 13:32:00 +01001064 if src == nil {
Paul Duffin54e41972021-07-19 13:23:40 +01001065 ctx.PropertyErrorf(property, "is required but was not specified")
1066 return android.PathForModuleSrc(ctx, "missing", property)
Paul Duffin2fef1362021-04-15 13:32:00 +01001067 }
Paul Duffin1e6f5c42021-05-21 16:15:31 +01001068 return android.PathForModuleSrc(ctx, *src)
Paul Duffin2fef1362021-04-15 13:32:00 +01001069 }
1070
Paul Duffine5218812021-06-07 13:28:19 +01001071 output := HiddenAPIOutput{
1072 HiddenAPIFlagOutput: HiddenAPIFlagOutput{
Paul Duffin8d007e92021-07-22 12:00:49 +01001073 AnnotationFlagsPath: pathForSrc("hidden_api.annotation_flags", module.prebuiltProperties.Hidden_api.Annotation_flags),
1074 MetadataPath: pathForSrc("hidden_api.metadata", module.prebuiltProperties.Hidden_api.Metadata),
1075 IndexPath: pathForSrc("hidden_api.index", module.prebuiltProperties.Hidden_api.Index),
Paul Duffin191be3a2021-08-10 16:14:16 +01001076 SignaturePatternsPath: pathForOptionalSrc(module.prebuiltProperties.Hidden_api.Signature_patterns, nil),
1077 // TODO: Temporarily handle stub_flags/all_flags properties until prebuilts have been updated.
1078 StubFlagsPath: pathForOptionalSrc(module.prebuiltProperties.Hidden_api.Stub_flags, nil),
1079 AllFlagsPath: pathForOptionalSrc(module.prebuiltProperties.Hidden_api.All_flags, nil),
Paul Duffine5218812021-06-07 13:28:19 +01001080 },
Paul Duffin1e6f5c42021-05-21 16:15:31 +01001081 }
1082
Paul Duffin191be3a2021-08-10 16:14:16 +01001083 // TODO: Temporarily fallback to stub_flags/all_flags properties until prebuilts have been updated.
1084 output.FilteredStubFlagsPath = pathForOptionalSrc(module.prebuiltProperties.Hidden_api.Filtered_stub_flags, output.StubFlagsPath)
1085 output.FilteredFlagsPath = pathForOptionalSrc(module.prebuiltProperties.Hidden_api.Filtered_flags, output.AllFlagsPath)
1086
Paul Duffin1e6f5c42021-05-21 16:15:31 +01001087 return &output
Paul Duffin2fef1362021-04-15 13:32:00 +01001088}
1089
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +01001090// produceBootImageProfile extracts the boot image profile from the APEX if available.
1091func (module *PrebuiltBootclasspathFragmentModule) produceBootImageProfile(ctx android.ModuleContext) android.WritablePath {
1092 // This module does not provide a boot image profile.
1093 if module.getProfileProviderApex(ctx) == "" {
1094 return nil
Paul Duffin5466a362021-06-07 10:25:31 +01001095 }
1096
Spandan Dasfae468e2023-12-12 23:23:53 +00001097 di, err := android.FindDeapexerProviderForModule(ctx)
1098 if err != nil {
1099 // An error was found, possibly due to multiple apexes in the tree that export this library
1100 // Defer the error till a client tries to call getProfilePath
1101 module.profilePathErr = err
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +01001102 return nil // An error has been reported by FindDeapexerProviderForModule.
Paul Duffin5466a362021-06-07 10:25:31 +01001103 }
1104
Spandan Dasda739a32023-12-13 00:06:32 +00001105 return di.PrebuiltExportPath(ProfileInstallPathInApex)
Jiakai Zhangc08c1622023-05-10 18:38:34 +01001106}
1107
1108func (b *PrebuiltBootclasspathFragmentModule) getProfilePath() android.Path {
Spandan Dasfae468e2023-12-12 23:23:53 +00001109 if b.profilePathErr != nil {
1110 panic(b.profilePathErr.Error())
1111 }
Jiakai Zhangc08c1622023-05-10 18:38:34 +01001112 return b.profilePath
1113}
1114
Jiakai Zhange6e90db2022-01-28 14:58:56 +00001115var _ commonBootclasspathFragment = (*PrebuiltBootclasspathFragmentModule)(nil)
Paul Duffin2fef1362021-04-15 13:32:00 +01001116
Paul Duffin5466a362021-06-07 10:25:31 +01001117// RequiredFilesFromPrebuiltApex returns the list of all files the prebuilt_bootclasspath_fragment
1118// requires from a prebuilt .apex file.
1119//
1120// If there is no image config associated with this fragment then it returns nil. Otherwise, it
1121// returns the files that are listed in the image config.
Jiakai Zhange6e90db2022-01-28 14:58:56 +00001122func (module *PrebuiltBootclasspathFragmentModule) RequiredFilesFromPrebuiltApex(ctx android.BaseModuleContext) []string {
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +01001123 for _, apex := range module.ApexProperties.Apex_available {
1124 if isProfileProviderApex(ctx, apex) {
Spandan Dasda739a32023-12-13 00:06:32 +00001125 return []string{ProfileInstallPathInApex}
Jiakai Zhange6e90db2022-01-28 14:58:56 +00001126 }
Paul Duffin5466a362021-06-07 10:25:31 +01001127 }
1128 return nil
1129}
1130
Spandan Das2ea84dd2024-01-25 22:12:50 +00001131func (module *PrebuiltBootclasspathFragmentModule) UseProfileGuidedDexpreopt() bool {
1132 return false
1133}
1134
Jiakai Zhange6e90db2022-01-28 14:58:56 +00001135var _ android.RequiredFilesFromPrebuiltApex = (*PrebuiltBootclasspathFragmentModule)(nil)
Paul Duffin5466a362021-06-07 10:25:31 +01001136
Paul Duffin7771eba2021-04-23 14:25:28 +01001137func prebuiltBootclasspathFragmentFactory() android.Module {
Jiakai Zhange6e90db2022-01-28 14:58:56 +00001138 m := &PrebuiltBootclasspathFragmentModule{}
Paul Duffin2fef1362021-04-15 13:32:00 +01001139 m.AddProperties(&m.properties, &m.prebuiltProperties)
Paul Duffinf7f65da2021-03-10 15:00:46 +00001140 // This doesn't actually have any prebuilt files of its own so pass a placeholder for the srcs
1141 // array.
1142 android.InitPrebuiltModule(m, &[]string{"placeholder"})
1143 android.InitApexModule(m)
Martin Stjernholmb79c7f12021-03-17 00:26:25 +00001144 android.InitAndroidArchModule(m, android.HostAndDeviceSupported, android.MultilibCommon)
Paul Duffinc7ef9892021-03-23 23:21:59 +00001145
Paul Duffinf7f65da2021-03-10 15:00:46 +00001146 return m
1147}