blob: 7fc39b6da340edb841e3bdd8e9240cd970262647 [file] [log] [blame]
Colin Crossfabb6082018-02-20 17:22:23 -08001// Copyright 2018 Google Inc. All rights reserved.
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 (
Colin Crossa592e3e2019-02-19 16:59:53 -080018 "fmt"
Jaewoong Jung5b425e22019-06-17 17:40:56 -070019 "path/filepath"
Colin Cross312634e2023-11-21 15:13:56 -080020 "slices"
Colin Crossc20dc852020-11-10 12:27:45 -080021 "strconv"
Colin Crossa97c5d32018-03-28 14:58:31 -070022 "strings"
Colin Crossfabb6082018-02-20 17:22:23 -080023
Jaewoong Jung9befb0c2020-01-18 10:33:43 -080024 "android/soong/android"
Ulya Trafimovich31e444e2020-08-14 17:32:16 +010025 "android/soong/dexpreopt"
Colin Crossfabb6082018-02-20 17:22:23 -080026 "github.com/google/blueprint"
Colin Crossa97c5d32018-03-28 14:58:31 -070027 "github.com/google/blueprint/proptools"
Colin Crossfabb6082018-02-20 17:22:23 -080028)
29
Colin Crossa97c5d32018-03-28 14:58:31 -070030type AndroidLibraryDependency interface {
Colin Crossa97c5d32018-03-28 14:58:31 -070031 ExportPackage() android.Path
Colin Crossab8d1382023-07-14 17:23:41 +000032 ResourcesNodeDepSet() *android.DepSet[*resourcesNode]
33 RRODirsDepSet() *android.DepSet[rroDir]
34 ManifestsDepSet() *android.DepSet[android.Path]
Jaewoong Jungc779cd42020-10-06 18:56:10 -070035 SetRROEnforcedForDependent(enforce bool)
36 IsRROEnforced(ctx android.BaseModuleContext) bool
Colin Crossa97c5d32018-03-28 14:58:31 -070037}
38
39func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000040 RegisterAARBuildComponents(android.InitRegistrationContext)
41}
42
43func RegisterAARBuildComponents(ctx android.RegistrationContext) {
44 ctx.RegisterModuleType("android_library_import", AARImportFactory)
45 ctx.RegisterModuleType("android_library", AndroidLibraryFactory)
Paul Duffin04ba70d2021-03-22 13:56:43 +000046 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
47 ctx.TopDown("propagate_rro_enforcement", propagateRROEnforcementMutator).Parallel()
48 })
Colin Crossa97c5d32018-03-28 14:58:31 -070049}
50
51//
52// AAR (android library)
53//
54
55type androidLibraryProperties struct {
56 BuildAAR bool `blueprint:"mutated"`
57}
58
59type aaptProperties struct {
60 // flags passed to aapt when creating the apk
61 Aaptflags []string
62
Dan Willemsen72be5902018-10-24 20:24:57 -070063 // include all resource configurations, not just the product-configured
64 // ones.
65 Aapt_include_all_resources *bool
66
Jiakai Zhangba82e282023-10-13 18:08:59 +010067 // list of files to use as assets.
68 Assets []string `android:"path"`
69
Colin Crossa97c5d32018-03-28 14:58:31 -070070 // list of directories relative to the Blueprints file containing assets.
Colin Cross0ddae7f2019-02-07 15:30:01 -080071 // Defaults to ["assets"] if a directory called assets exists. Set to []
72 // to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070073 Asset_dirs []string
74
75 // list of directories relative to the Blueprints file containing
Colin Cross0ddae7f2019-02-07 15:30:01 -080076 // Android resources. Defaults to ["res"] if a directory called res exists.
77 // Set to [] to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070078 Resource_dirs []string
79
Colin Crossa592e3e2019-02-19 16:59:53 -080080 // list of zip files containing Android resources.
Colin Cross27b922f2019-03-04 22:35:41 -080081 Resource_zips []string `android:"path"`
Colin Crossa592e3e2019-02-19 16:59:53 -080082
Colin Crossa97c5d32018-03-28 14:58:31 -070083 // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml".
Colin Cross27b922f2019-03-04 22:35:41 -080084 Manifest *string `android:"path"`
changho.shinb5432b72019-08-08 18:37:17 +090085
86 // paths to additional manifest files to merge with main manifest.
87 Additional_manifests []string `android:"path"`
Sasha Smundak541056c2019-10-28 15:50:06 -070088
89 // do not include AndroidManifest from dependent libraries
90 Dont_merge_manifests *bool
Jaewoong Jungc779cd42020-10-06 18:56:10 -070091
Colin Cross4eae06d2023-06-20 22:40:02 -070092 // If use_resource_processor is set, use Bazel's resource processor instead of aapt2 to generate R.class files.
93 // The resource processor produces more optimal R.class files that only list resources in the package of the
94 // library that provided them, as opposed to aapt2 which produces R.java files for every package containing
95 // every resource. Using the resource processor can provide significant build time speedups, but requires
96 // fixing the module to use the correct package to reference each resource, and to avoid having any other
97 // libraries in the tree that use the same package name. Defaults to false, but will default to true in the
98 // future.
99 Use_resource_processor *bool
100
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700101 // true if RRO is enforced for any of the dependent modules
102 RROEnforcedForDependent bool `blueprint:"mutated"`
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900103
104 // Filter only specified product and ignore other products
105 Filter_product *string `blueprint:"mutated"`
Colin Crossa97c5d32018-03-28 14:58:31 -0700106}
107
108type aapt struct {
Colin Cross312634e2023-11-21 15:13:56 -0800109 aaptSrcJar android.Path
110 transitiveAaptRJars android.Paths
111 transitiveAaptResourcePackagesFile android.Path
112 exportPackage android.Path
113 manifestPath android.Path
114 proguardOptionsFile android.Path
115 rTxt android.Path
116 rJar android.Path
117 extraAaptPackagesFile android.Path
118 mergedManifestFile android.Path
119 noticeFile android.OptionalPath
120 assetPackage android.OptionalPath
121 isLibrary bool
122 defaultManifestVersion string
123 useEmbeddedNativeLibs bool
124 useEmbeddedDex bool
125 usesNonSdkApis bool
126 hasNoCode bool
127 LoggingParent string
128 resourceFiles android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700129
Colin Crosse560c4a2019-03-19 16:03:11 -0700130 splitNames []string
131 splits []split
132
Colin Crossa97c5d32018-03-28 14:58:31 -0700133 aaptProperties aaptProperties
Colin Crossab8d1382023-07-14 17:23:41 +0000134
135 resourcesNodesDepSet *android.DepSet[*resourcesNode]
136 rroDirsDepSet *android.DepSet[rroDir]
137 manifestsDepSet *android.DepSet[android.Path]
Alix96ea88452023-08-31 15:48:23 +0000138
139 manifestValues struct {
140 applicationId string
141 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700142}
143
Colin Crosse560c4a2019-03-19 16:03:11 -0700144type split struct {
145 name string
146 suffix string
147 path android.Path
148}
149
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700150// Propagate RRO enforcement flag to static lib dependencies transitively.
151func propagateRROEnforcementMutator(ctx android.TopDownMutatorContext) {
152 m := ctx.Module()
153 if d, ok := m.(AndroidLibraryDependency); ok && d.IsRROEnforced(ctx) {
154 ctx.VisitDirectDepsWithTag(staticLibTag, func(d android.Module) {
155 if a, ok := d.(AndroidLibraryDependency); ok {
156 a.SetRROEnforcedForDependent(true)
157 }
158 })
159 }
160}
161
Colin Cross4eae06d2023-06-20 22:40:02 -0700162func (a *aapt) useResourceProcessorBusyBox() bool {
163 return BoolDefault(a.aaptProperties.Use_resource_processor, false)
164}
165
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900166func (a *aapt) filterProduct() string {
167 return String(a.aaptProperties.Filter_product)
168}
169
Colin Crossa97c5d32018-03-28 14:58:31 -0700170func (a *aapt) ExportPackage() android.Path {
171 return a.exportPackage
172}
Colin Crossab8d1382023-07-14 17:23:41 +0000173func (a *aapt) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
174 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800175}
176
Colin Crossab8d1382023-07-14 17:23:41 +0000177func (a *aapt) RRODirsDepSet() *android.DepSet[rroDir] {
178 return a.rroDirsDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800179}
180
Colin Crossab8d1382023-07-14 17:23:41 +0000181func (a *aapt) ManifestsDepSet() *android.DepSet[android.Path] {
182 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800183}
184
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700185func (a *aapt) SetRROEnforcedForDependent(enforce bool) {
186 a.aaptProperties.RROEnforcedForDependent = enforce
187}
188
189func (a *aapt) IsRROEnforced(ctx android.BaseModuleContext) bool {
190 // True if RRO is enforced for this module or...
191 return ctx.Config().EnforceRROForModule(ctx.ModuleName()) ||
Jeongik Chacee5ba92021-02-19 12:11:51 +0900192 // if RRO is enforced for any of its dependents.
193 a.aaptProperties.RROEnforcedForDependent
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700194}
195
Jiyong Parkf1691d22021-03-29 20:11:58 +0900196func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext android.SdkContext,
Colin Crossa0ba2f52019-06-22 12:59:27 -0700197 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
198 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700199
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800200 hasVersionCode := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-code")
201 hasVersionName := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-name")
Colin Crossa97c5d32018-03-28 14:58:31 -0700202
Colin Crossa97c5d32018-03-28 14:58:31 -0700203 // Flags specified in Android.bp
204 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
205
Colin Crossa97c5d32018-03-28 14:58:31 -0700206 // Find implicit or explicit asset and resource dirs
Jiakai Zhangba82e282023-10-13 18:08:59 +0100207 assets := android.PathsRelativeToModuleSourceDir(android.SourceInput{
208 Context: ctx,
209 Paths: a.aaptProperties.Assets,
210 IncludeDirs: false,
211 })
Colin Crossa97c5d32018-03-28 14:58:31 -0700212 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
213 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800214 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700215
Colin Crossa97c5d32018-03-28 14:58:31 -0700216 // Glob directories into lists of paths
217 for _, dir := range resourceDirs {
218 resDirs = append(resDirs, globbedResourceDir{
219 dir: dir,
220 files: androidResourceGlob(ctx, dir),
221 })
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700222 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, a, dir)
Colin Crossa97c5d32018-03-28 14:58:31 -0700223 overlayDirs = append(overlayDirs, resOverlayDirs...)
224 rroDirs = append(rroDirs, resRRODirs...)
225 }
226
Colin Crossc20dc852020-11-10 12:27:45 -0800227 var assetDeps android.Paths
228 for i, dir := range assetDirs {
229 // Add a dependency on every file in the asset directory. This ensures the aapt2
230 // rule will be rerun if one of the files in the asset directory is modified.
231 assetDeps = append(assetDeps, androidResourceGlob(ctx, dir)...)
232
233 // Add a dependency on a file that contains a list of all the files in the asset directory.
234 // This ensures the aapt2 rule will be run if a file is removed from the asset directory,
235 // or a file is added whose timestamp is older than the output of aapt2.
236 assetFileListFile := android.PathForModuleOut(ctx, "asset_dir_globs", strconv.Itoa(i)+".glob")
237 androidResourceGlobList(ctx, dir, assetFileListFile)
238 assetDeps = append(assetDeps, assetFileListFile)
Colin Crossa97c5d32018-03-28 14:58:31 -0700239 }
240
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700241 assetDirStrings := assetDirs.Strings()
242 if a.noticeFile.Valid() {
243 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
Colin Crossc20dc852020-11-10 12:27:45 -0800244 assetDeps = append(assetDeps, a.noticeFile.Path())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700245 }
Jiakai Zhangba82e282023-10-13 18:08:59 +0100246 if len(assets) > 0 {
247 // aapt2 doesn't support adding individual asset files. Create a temp directory to hold asset
248 // files and pass it to aapt2.
249 tmpAssetDir := android.PathForModuleOut(ctx, "tmp_asset_dir")
250
251 rule := android.NewRuleBuilder(pctx, ctx)
252 rule.Command().
253 Text("rm -rf").Text(tmpAssetDir.String()).
254 Text("&&").
255 Text("mkdir -p").Text(tmpAssetDir.String())
256
257 for _, asset := range assets {
258 output := tmpAssetDir.Join(ctx, asset.Rel())
259 assetDeps = append(assetDeps, output)
260 rule.Command().Text("mkdir -p").Text(filepath.Dir(output.String()))
261 rule.Command().Text("cp").Input(asset).Output(output)
262 }
263
264 rule.Build("tmp_asset_dir", "tmp_asset_dir")
265
266 assetDirStrings = append(assetDirStrings, tmpAssetDir.String())
267 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700268
Colin Crossa97c5d32018-03-28 14:58:31 -0700269 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
270 linkDeps = append(linkDeps, manifestPath)
271
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700272 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossc20dc852020-11-10 12:27:45 -0800273 linkDeps = append(linkDeps, assetDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700274
Spandan Das50885c02023-02-23 21:31:33 +0000275 // Returns the effective version for {min|target}_sdk_version
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000276 effectiveVersionString := func(sdkVersion android.SdkSpec, minSdkVersion android.ApiLevel) string {
Spandan Das50885c02023-02-23 21:31:33 +0000277 // If {min|target}_sdk_version is current, use sdk_version to determine the effective level
278 // This is necessary for vendor modules.
279 // The effective version does not _only_ depend on {min|target}_sdk_version(level),
280 // but also on the sdk_version (kind+level)
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000281 if minSdkVersion.IsCurrent() {
Spandan Das50885c02023-02-23 21:31:33 +0000282 ret, err := sdkVersion.EffectiveVersionString(ctx)
283 if err != nil {
284 ctx.ModuleErrorf("invalid sdk_version: %s", err)
285 }
286 return ret
287 }
288 ret, err := minSdkVersion.EffectiveVersionString(ctx)
289 if err != nil {
290 ctx.ModuleErrorf("invalid min_sdk_version: %s", err)
291 }
292 return ret
Jiyong Park6a927c42020-01-21 02:03:43 +0900293 }
Spandan Das50885c02023-02-23 21:31:33 +0000294 // SDK version flags
295 sdkVersion := sdkContext.SdkVersion(ctx)
296 minSdkVersion := effectiveVersionString(sdkVersion, sdkContext.MinSdkVersion(ctx))
Colin Crossa97c5d32018-03-28 14:58:31 -0700297
Colin Cross83bb3162018-06-25 15:48:06 -0700298 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
Spandan Das6450b552023-02-23 19:27:07 +0000299 // Use minSdkVersion for target-sdk-version, even if `target_sdk_version` is set
300 // This behavior has been copied from Make.
Colin Cross83bb3162018-06-25 15:48:06 -0700301 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700302
Colin Crossa97c5d32018-03-28 14:58:31 -0700303 // Version code
304 if !hasVersionCode {
Dan Albert4f378d72020-07-23 17:32:15 -0700305 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion().String())
Colin Crossa97c5d32018-03-28 14:58:31 -0700306 }
307
308 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700309 var versionName string
310 if ctx.ModuleName() == "framework-res" {
311 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
312 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700313 // if it contains the build number. Use the PlatformVersionName instead.
314 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700315 } else {
316 versionName = ctx.Config().AppsDefaultVersionName()
317 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800318 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700319 linkFlags = append(linkFlags, "--version-name ", versionName)
320 }
321
Colin Crossa0ba2f52019-06-22 12:59:27 -0700322 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
323
324 // Always set --pseudo-localize, it will be stripped out later for release
325 // builds that don't want it.
326 compileFlags = append(compileFlags, "--pseudo-localize")
327
328 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700329}
330
Paul Duffin250e6192019-06-07 10:44:37 +0100331func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800332 if sdkDep.frameworkResModule != "" {
333 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700334 }
335}
336
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800337var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
338 blueprint.RuleParams{
339 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
340 CommandDeps: []string{"${config.Zip2ZipCmd}"},
341 })
342
Alixf7a10272023-09-27 16:47:56 +0000343type aaptBuildActionOptions struct {
344 sdkContext android.SdkContext
345 classLoaderContexts dexpreopt.ClassLoaderContextMap
346 excludedLibs []string
347 enforceDefaultTargetSdkVersion bool
348 extraLinkFlags []string
Jihoon Kang84b25892023-12-01 22:01:06 +0000349 aconfigTextFiles android.Paths
Alixf7a10272023-09-27 16:47:56 +0000350}
351
352func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700353
Colin Cross8676c8c2023-10-12 15:58:57 -0700354 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Alixf7a10272023-09-27 16:47:56 +0000355 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100356
Paul Duffin06530572022-02-03 17:54:15 +0000357 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000358 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000359
Colin Cross31656952018-05-24 16:11:20 -0700360 // App manifest file
361 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
362 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
363
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000364 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000365 SdkContext: opts.sdkContext,
366 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000367 IsLibrary: a.isLibrary,
368 DefaultManifestVersion: a.defaultManifestVersion,
369 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
370 UsesNonSdkApis: a.usesNonSdkApis,
371 UseEmbeddedDex: a.useEmbeddedDex,
372 HasNoCode: a.hasNoCode,
373 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000374 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000375 })
Colin Cross90c25c62019-04-19 16:22:57 -0700376
Colin Crossab8d1382023-07-14 17:23:41 +0000377 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700378 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000379
Luca Stefanifd898822019-09-10 22:13:31 +0200380 // Add additional manifest files to transitive manifests.
381 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000382 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
383 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
384 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
385 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
386 // android_library_import modules. If this is fixed, staticManifestsDepSet can be dropped completely in favor of
387 // staticResourcesNodesDepSet.manifests()
388 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700389
Colin Crossab8d1382023-07-14 17:23:41 +0000390 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000391 manifestMergerParams := ManifestMergerParams{
392 staticLibManifests: transitiveManifestPaths[1:],
Alix96ea88452023-08-31 15:48:23 +0000393 isLibrary: a.isLibrary,
394 packageName: a.manifestValues.applicationId,
395 }
Alixf7a10272023-09-27 16:47:56 +0000396 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700397 if !a.isLibrary {
398 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
399 // will be propagated to the final application and merged there. The merged manifest for libraries is
400 // only passed to Make, which can't handle transitive dependencies.
401 manifestPath = a.mergedManifestFile
402 }
403 } else {
404 a.mergedManifestFile = manifestPath
405 }
Colin Cross31656952018-05-24 16:11:20 -0700406
Alixf7a10272023-09-27 16:47:56 +0000407 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700408
409 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700410 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000411 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000412 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700413 if a.isLibrary {
414 linkFlags = append(linkFlags, "--static-lib")
415 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700416
Colin Cross4eae06d2023-06-20 22:40:02 -0700417 if a.isLibrary && a.useResourceProcessorBusyBox() {
418 // When building an android_library using ResourceProcessorBusyBox the resources are merged into
419 // package-res.apk with --merge-only, but --no-static-lib-packages is not used so that R.txt only
420 // contains resources from this library.
421 linkFlags = append(linkFlags, "--merge-only")
422 } else {
423 // When building and app or when building an android_library without ResourceProcessorBusyBox
424 // --no-static-lib-packages is used to put all the resources into the app. If ResourceProcessorBusyBox
425 // is used then the app's R.txt will be post-processed along with the R.txt files from dependencies to
426 // sort resources into the right packages in R.class.
427 linkFlags = append(linkFlags, "--no-static-lib-packages")
428 }
429
Colin Crossa97c5d32018-03-28 14:58:31 -0700430 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700431 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
432 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700433 // This file isn't used by Soong, but is generated for exporting
434 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700435 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700436 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700437
Colin Cross4aaa84a2018-08-21 15:14:37 -0700438 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700439 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700440 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900441 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700442 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700443
Colin Crossa592e3e2019-02-19 16:59:53 -0800444 for i, zip := range resZips {
445 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700446 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800447 compiledResDirs = append(compiledResDirs, android.Paths{flata})
448 }
449
Colin Cross4aaa84a2018-08-21 15:14:37 -0700450 var compiledRes, compiledOverlay android.Paths
451
Colin Crossab8d1382023-07-14 17:23:41 +0000452 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
453 // of transitiveStaticLibs.
454 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
455
Colin Cross4eae06d2023-06-20 22:40:02 -0700456 if a.isLibrary && a.useResourceProcessorBusyBox() {
457 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
458 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
459 // instead modules depending on this module will reference package-res.apk from all transitive static
460 // dependencies.
461 for _, staticDep := range staticDeps {
462 linkDeps = append(linkDeps, staticDep.resPackage)
463 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
464 if staticDep.usedResourceProcessor {
465 transitiveRJars = append(transitiveRJars, staticDep.rJar)
466 }
467 }
Colin Cross8676c8c2023-10-12 15:58:57 -0700468 for _, sharedDep := range sharedDeps {
469 if sharedDep.usedResourceProcessor {
470 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
471 }
472 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700473 } else {
474 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
475 // dependencies are compiled into this module's package-res.apk as overlays.
476 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
477 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700478
Colin Crossbec85302019-02-13 13:15:46 -0800479 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700480 // If we are using static android libraries, every source file becomes an overlay.
481 // This is to emulate old AAPT behavior which simulated library support.
482 for _, compiledResDir := range compiledResDirs {
483 compiledOverlay = append(compiledOverlay, compiledResDir...)
484 }
Colin Crossbec85302019-02-13 13:15:46 -0800485 } else if a.isLibrary {
486 // Otherwise, for a static library we treat all the resources equally with no overlay.
487 for _, compiledResDir := range compiledResDirs {
488 compiledRes = append(compiledRes, compiledResDir...)
489 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700490 } else if len(compiledResDirs) > 0 {
491 // Without static libraries, the first directory is our directory, which can then be
492 // overlaid by the rest.
493 compiledRes = append(compiledRes, compiledResDirs[0]...)
494 for _, compiledResDir := range compiledResDirs[1:] {
495 compiledOverlay = append(compiledOverlay, compiledResDir...)
496 }
497 }
498
Colin Crossa97c5d32018-03-28 14:58:31 -0700499 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900500 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700501 }
502
Colin Crosse560c4a2019-03-19 16:03:11 -0700503 var splitPackages android.WritablePaths
504 var splits []split
505
506 for _, s := range a.splitNames {
507 suffix := strings.Replace(s, ",", "_", -1)
508 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
509 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
510 splitPackages = append(splitPackages, path)
511 splits = append(splits, split{
512 name: s,
513 suffix: suffix,
514 path: path,
515 })
516 }
517
Colin Crossf3b7bad2023-08-02 15:49:00 -0700518 if !a.useResourceProcessorBusyBox() {
519 // the subdir "android" is required to be filtered by package names
520 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
521 }
522
Colin Crossab8d1382023-07-14 17:23:41 +0000523 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
524 // provided to the final app aapt2Link step.
525 var transitiveAssets android.Paths
526 if !a.isLibrary {
527 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
528 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700529 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000530 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
531 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800532 // Extract assets from the resource package output so that they can be used later in aapt2link
533 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000534 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800535 assets := android.PathForModuleOut(ctx, "assets.zip")
536 ctx.Build(pctx, android.BuildParams{
537 Rule: extractAssetsRule,
538 Input: packageRes,
539 Output: assets,
540 Description: "extract assets from built resource file",
541 })
542 a.assetPackage = android.OptionalPathForPath(assets)
543 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700544
Colin Cross4eae06d2023-06-20 22:40:02 -0700545 if a.useResourceProcessorBusyBox() {
546 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800547 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700548 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700549 transitiveRJars = append(transitiveRJars, rJar)
550 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700551 } else {
552 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700553 }
554
Colin Cross312634e2023-11-21 15:13:56 -0800555 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
556 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
557 return p == packageRes.String()
558 })
559 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
560 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
561
Colin Crossa97c5d32018-03-28 14:58:31 -0700562 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700563 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800564 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700565 a.exportPackage = packageRes
566 a.manifestPath = manifestPath
567 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700568 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700569 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700570 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000571 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
572 Direct(&resourcesNode{
573 resPackage: a.exportPackage,
574 manifest: a.manifestPath,
575 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700576 rTxt: a.rTxt,
577 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000578 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700579
580 usedResourceProcessor: a.useResourceProcessorBusyBox(),
Colin Crossab8d1382023-07-14 17:23:41 +0000581 }).
582 Transitive(staticResourcesNodesDepSet).Build()
583 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
584 Direct(rroDirs...).
585 Transitive(staticRRODirsDepSet).Build()
586 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
587 Direct(a.manifestPath).
588 DirectSlice(additionalManifests).
589 Transitive(staticManifestsDepSet).Build()
590}
591
Colin Cross4eae06d2023-06-20 22:40:02 -0700592var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
593 blueprint.RuleParams{
594 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
595 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
596 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
597 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
598 Rspfile: "${out}.args",
599 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
600 Restat: true,
601 }, "rTxt", "manifest", "args")
602
603// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
604// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
605// supports producing classes for static dependencies that only include resources from that dependency.
606func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800607 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700608
609 var args []string
610 var deps android.Paths
611
612 if !isLibrary {
613 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
614 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
615 // package.
616 args, deps = transitiveDeps.resourceProcessorDeps()
617 } else {
618 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
619 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
620 // inlined into the library before the final IDs are assigned during app compilation.
621 args = append(args, "--finalFields=false")
622 }
623
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800624 for i, arg := range aaptFlags {
625 const AAPT_CUSTOM_PACKAGE = "--custom-package"
626 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
627 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
628 if pkg == "" && i+1 < len(aaptFlags) {
629 pkg = aaptFlags[i+1]
630 }
631 args = append(args, "--packageForR "+pkg)
632 }
633 }
634
Colin Cross4eae06d2023-06-20 22:40:02 -0700635 deps = append(deps, rTxt, manifest)
636
637 ctx.Build(pctx, android.BuildParams{
638 Rule: resourceProcessorBusyBox,
639 Output: rJar,
640 Implicits: deps,
641 Description: "ResourceProcessorBusyBox",
642 Args: map[string]string{
643 "rTxt": rTxt.String(),
644 "manifest": manifest.String(),
645 "args": strings.Join(args, " "),
646 },
647 })
648}
649
Colin Crossab8d1382023-07-14 17:23:41 +0000650type resourcesNode struct {
651 resPackage android.Path
652 manifest android.Path
653 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700654 rTxt android.Path
655 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000656 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700657
658 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000659}
660
661type transitiveAarDeps []*resourcesNode
662
663func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700664 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000665 for _, dep := range t {
666 paths = append(paths, dep.resPackage)
667 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700668 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000669}
670
671func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700672 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000673 for _, dep := range t {
674 paths = append(paths, dep.manifest)
675 paths = append(paths, dep.additionalManifests...)
676 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700677 return paths
678}
679
680func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
681 for _, dep := range t {
682 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
683 deps = append(deps, dep.rTxt, dep.manifest)
684 }
685 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000686}
687
688func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700689 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000690 for _, dep := range t {
691 if dep.assets.Valid() {
692 paths = append(paths, dep.assets.Path())
693 }
694 }
695 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700696}
697
698// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900699func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700700 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000701 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700702
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100703 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000704 // Not all callers need to compute class loader context, those who don't just pass nil.
705 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100706 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000707 }
708
Colin Cross83bb3162018-06-25 15:48:06 -0700709 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700710 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700711 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700712 }
713
Colin Cross8676c8c2023-10-12 15:58:57 -0700714 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
715 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000716 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
717 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
718
Colin Crossa97c5d32018-03-28 14:58:31 -0700719 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000720 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000721
Colin Crossa97c5d32018-03-28 14:58:31 -0700722 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700723 aarDep, _ := module.(AndroidLibraryDependency)
724 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700725 exportPackage = aarDep.ExportPackage()
726 }
727
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000728 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700729 case instrumentationForTag:
730 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400731 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700732 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700733 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700734 sharedLibs = append(sharedLibs, exportPackage)
735 }
Colin Cross5446e882019-05-22 10:46:27 -0700736 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700737 if exportPackage != nil {
738 sharedLibs = append(sharedLibs, exportPackage)
739 }
740 case staticLibTag:
741 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700742 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000743 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
744 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700745 }
746 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000747
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000748 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700749 })
750
Colin Crossab8d1382023-07-14 17:23:41 +0000751 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
752 // Reverse the dependency order now going into the depset so that it comes out in order after the second
753 // reverse later.
754 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
755 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
756 // dependency has to be listed last.
757 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700758 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
759 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
760 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700761
Colin Crossab8d1382023-07-14 17:23:41 +0000762 staticRRODirs = rroDirsDepSetBuilder.Build()
763 staticManifests = manifestsDepSetBuilder.Build()
764
765 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700766 flags = append(flags, "--auto-add-overlay")
767 }
768
769 for _, sharedLib := range sharedLibs {
770 flags = append(flags, "-I "+sharedLib.String())
771 }
772
Colin Cross8676c8c2023-10-12 15:58:57 -0700773 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700774}
775
776type AndroidLibrary struct {
777 Library
778 aapt
779
780 androidLibraryProperties androidLibraryProperties
781
782 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700783}
784
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000785var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
786
787// For OutputFileProducer interface
788func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
789 switch tag {
790 case ".aar":
791 return []android.Path{a.aarFile}, nil
792 default:
793 return a.Library.OutputFiles(tag)
794 }
795}
796
Colin Crossa97c5d32018-03-28 14:58:31 -0700797var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
798
799func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
800 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900801 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100802 if sdkDep.hasFrameworkLibs() {
803 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700804 }
Colin Cross4a80a152022-12-21 21:51:52 -0800805 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700806}
807
808func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800809 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100810 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Alixf7a10272023-09-27 16:47:56 +0000811 a.aapt.buildActions(ctx,
812 aaptBuildActionOptions{
813 sdkContext: android.SdkContext(a),
814 classLoaderContexts: a.classLoaderContexts,
815 enforceDefaultTargetSdkVersion: false,
816 },
817 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700818
Colin Crossff694a82023-12-13 15:54:49 -0800819 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
820 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700821
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000822 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
823
Colin Cross4eae06d2023-06-20 22:40:02 -0700824 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
825 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross4eae06d2023-06-20 22:40:02 -0700826 if a.useResourceProcessorBusyBox() {
827 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700828 } else {
829 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700830 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700831
832 // apps manifests are handled by aapt, don't let Module see them
833 a.properties.Manifest = nil
834
Colin Cross014489c2020-06-02 20:09:13 -0700835 a.linter.mergedManifest = a.aapt.mergedManifestFile
836 a.linter.manifest = a.aapt.manifestPath
837 a.linter.resources = a.aapt.resourceFiles
838
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000839 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800840 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800841 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
842 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
843 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
844
845 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
846 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
847 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700848
Colin Cross4eae06d2023-06-20 22:40:02 -0700849 var extraSrcJars android.Paths
850 var extraCombinedJars android.Paths
851 var extraClasspathJars android.Paths
852 if a.useResourceProcessorBusyBox() {
853 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
854 // library and each of the transitive static android_library dependencies has already created an
855 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
856 extraClasspathJars = a.transitiveAaptRJars
857 } else {
858 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
859 // R.java files for the library's package and the packages from all transitive static android_library
860 // dependencies. Compile the srcjar alongside the rest of the sources.
861 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
862 }
863
864 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700865
Colin Crossf57c5782019-01-25 13:20:38 -0800866 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700867 var res android.Paths
868 if a.androidLibraryProperties.BuildAAR {
869 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
870 ctx.CheckbuildFile(a.aarFile)
871 }
Colin Cross89c31582018-04-30 15:55:11 -0700872
Sam Delmerico82602492022-06-10 17:05:42 +0000873 prebuiltJniPackages := android.Paths{}
874 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800875 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000876 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
877 }
878 })
879 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800880 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000881 JniPackages: prebuiltJniPackages,
882 })
883 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700884}
885
Colin Cross95b53b82023-10-17 13:21:02 -0700886func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
887 a.Library.IDEInfo(dpInfo)
888 a.aapt.IDEInfo(dpInfo)
889}
890
891func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
892 if a.useResourceProcessorBusyBox() {
893 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
894 }
895}
896
Colin Cross1b16b0e2019-02-12 14:41:32 -0800897// android_library builds and links sources into a `.jar` file for the device along with Android resources.
898//
899// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000900// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800901// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
902// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700903func AndroidLibraryFactory() android.Module {
904 module := &AndroidLibrary{}
905
Colin Crossce6734e2020-06-15 16:09:53 -0700906 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700907 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700908 &module.aaptProperties,
909 &module.androidLibraryProperties)
910
911 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700912 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700913
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900914 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700915 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700916 return module
917}
918
Colin Crossfabb6082018-02-20 17:22:23 -0800919//
920// AAR (android library) prebuilts
921//
Colin Crossfabb6082018-02-20 17:22:23 -0800922
Vinh Trance0781f2022-04-13 01:30:44 +0000923// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800924type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000925 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800926 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000927 // If not blank, set to the version of the sdk to compile against.
928 // Defaults to private.
929 // Values are of one of the following forms:
930 // 1) numerical API level, "current", "none", or "core_platform"
931 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
932 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
933 // If the SDK kind is empty, it will be set to public
934 Sdk_version *string
935 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
936 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700937 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000938 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700939 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000940 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
941 Libs []string
942 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700943 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000944 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
945 // will be passed transitively through android_libraries to an android_app.
946 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
947 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800948}
949
950type AARImport struct {
951 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700952 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900953 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800954 prebuilt android.Prebuilt
955
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900956 // Functionality common to Module and Import.
957 embeddableInModuleAndImport
958
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500959 providesTransitiveHeaderJars
960
Colin Crossfabb6082018-02-20 17:22:23 -0800961 properties AARImportProperties
962
Colin Cross312634e2023-11-21 15:13:56 -0800963 classpathFile android.WritablePath
964 proguardFlags android.WritablePath
965 exportPackage android.WritablePath
966 transitiveAaptResourcePackagesFile android.Path
967 extraAaptPackagesFile android.WritablePath
968 manifest android.WritablePath
969 assetsPackage android.WritablePath
970 rTxt android.WritablePath
971 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700972
Colin Crossab8d1382023-07-14 17:23:41 +0000973 resourcesNodesDepSet *android.DepSet[*resourcesNode]
974 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700975
976 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000977
Sam Delmerico82602492022-06-10 17:05:42 +0000978 aarPath android.Path
979 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900980
981 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000982 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000983
984 // Single aconfig "cache file" merged from this module and all dependencies.
985 mergedAconfigFiles map[string]android.Paths
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000986}
987
988var _ android.OutputFileProducer = (*AARImport)(nil)
989
990// For OutputFileProducer interface
991func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
992 switch tag {
993 case ".aar":
994 return []android.Path{a.aarPath}, nil
995 case "":
996 return []android.Path{a.classpathFile}, nil
997 default:
998 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
999 }
Colin Crossfabb6082018-02-20 17:22:23 -08001000}
1001
Jiyong Park92315372021-04-02 08:45:46 +09001002func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1003 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07001004}
1005
Jiyong Parkf1691d22021-03-29 20:11:58 +09001006func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001007 return ""
1008}
1009
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001010func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001011 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001012 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001013 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001014 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001015}
1016
Spandan Dasa26eda72023-03-02 00:56:06 +00001017func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1018 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001019}
1020
Spandan Dasca70fc42023-03-01 23:38:49 +00001021func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1022 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001023}
1024
Colin Cross1e743852019-10-28 11:37:20 -07001025func (a *AARImport) javaVersion() string {
1026 return ""
1027}
1028
Colin Crossa97c5d32018-03-28 14:58:31 -07001029var _ AndroidLibraryDependency = (*AARImport)(nil)
1030
1031func (a *AARImport) ExportPackage() android.Path {
1032 return a.exportPackage
1033}
Colin Crossab8d1382023-07-14 17:23:41 +00001034func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1035 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001036}
1037
Colin Crossab8d1382023-07-14 17:23:41 +00001038func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1039 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001040}
1041
Colin Crossab8d1382023-07-14 17:23:41 +00001042func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1043 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001044}
1045
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001046// RRO enforcement is not available on aar_import since its RRO dirs are not
1047// exported.
1048func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1049}
1050
1051// RRO enforcement is not available on aar_import since its RRO dirs are not
1052// exported.
1053func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1054 return false
1055}
1056
Colin Crossfabb6082018-02-20 17:22:23 -08001057func (a *AARImport) Prebuilt() *android.Prebuilt {
1058 return &a.prebuilt
1059}
1060
1061func (a *AARImport) Name() string {
1062 return a.prebuilt.Name(a.ModuleBase.Name())
1063}
1064
Jiyong Park618922e2020-01-08 13:35:43 +09001065func (a *AARImport) JacocoReportClassesFile() android.Path {
1066 return nil
1067}
1068
Colin Crossfabb6082018-02-20 17:22:23 -08001069func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001070 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001071 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001072 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001073 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001074 }
1075 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001076
Colin Cross42d48b72018-08-29 14:10:52 -07001077 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1078 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001079}
1080
Sam Delmerico82602492022-06-10 17:05:42 +00001081type JniPackageInfo struct {
1082 // List of zip files containing JNI libraries
1083 // Zip files should have directory structure jni/<arch>/*.so
1084 JniPackages android.Paths
1085}
1086
Colin Crossbc7d76c2023-12-12 16:39:03 -08001087var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001088
1089// Unzip an AAR and extract the JNI libs for $archString.
1090var extractJNI = pctx.AndroidStaticRule("extractJNI",
1091 blueprint.RuleParams{
1092 Command: `rm -rf $out $outDir && touch $out && ` +
1093 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1094 `jni_files=$$(find $outDir/jni -type f) && ` +
1095 // print error message if there are no JNI libs for this arch
1096 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001097 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001098 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1099 CommandDeps: []string{"${config.SoongZipCmd}"},
1100 },
1101 "outDir", "archString")
1102
Colin Crossfabb6082018-02-20 17:22:23 -08001103// Unzip an AAR into its constituent files and directories. Any files in Outputs that don't exist in the AAR will be
Dan Willemsen304cfec2019-05-28 14:49:06 -07001104// touched to create an empty file. The res directory is not extracted, as it will be extracted in its own rule.
Colin Crossfabb6082018-02-20 17:22:23 -08001105var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1106 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001107 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001108 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001109 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001110 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001111 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001112 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001113 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001114
1115func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1116 if len(a.properties.Aars) != 1 {
1117 ctx.PropertyErrorf("aars", "exactly one aar is required")
1118 return
1119 }
1120
Jiyong Park92315372021-04-02 08:45:46 +09001121 a.sdkVersion = a.SdkVersion(ctx)
1122 a.minSdkVersion = a.MinSdkVersion(ctx)
1123
Colin Crossff694a82023-12-13 15:54:49 -08001124 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1125 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001126
Nan Zhang4c819fb2018-08-27 18:31:46 -07001127 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001128 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1129
Colin Cross1001a792019-03-21 22:21:39 -07001130 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001131 inputFile := a.aarPath
1132 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1133 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001134 }
Colin Crossfabb6082018-02-20 17:22:23 -08001135
1136 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001137 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001138 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Cross4eae06d2023-06-20 22:40:02 -07001139 aarRTxt := extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001140 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001141 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001142 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001143 ProguardFlagsFiles: android.NewDepSet[android.Path](
1144 android.POSTORDER,
1145 android.Paths{a.proguardFlags},
1146 nil,
1147 ),
1148 })
Colin Crossfabb6082018-02-20 17:22:23 -08001149
1150 ctx.Build(pctx, android.BuildParams{
1151 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001152 Input: a.aarPath,
Colin Cross4eae06d2023-06-20 22:40:02 -07001153 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, aarRTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001154 Description: "unzip AAR",
1155 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001156 "outDir": extractedAARDir.String(),
1157 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001158 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001159 },
1160 })
1161
Colin Crossa0ba2f52019-06-22 12:59:27 -07001162 // Always set --pseudo-localize, it will be stripped out later for release
1163 // builds that don't want it.
1164 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001165 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001166 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001167 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001168
1169 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001170 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Cross4eae06d2023-06-20 22:40:02 -07001171 a.rTxt = android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001172 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001173
1174 var linkDeps android.Paths
1175
1176 linkFlags := []string{
1177 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001178 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001179 "--auto-add-overlay",
1180 }
1181
Colin Cross10f7c4a2018-05-23 10:59:28 -07001182 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1183 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001184
Colin Cross8676c8c2023-10-12 15:58:57 -07001185 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001186 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001187
Colin Cross8676c8c2023-10-12 15:58:57 -07001188 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001189 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001190
Colin Crossab8d1382023-07-14 17:23:41 +00001191 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001192
Colin Crossab8d1382023-07-14 17:23:41 +00001193 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001194 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001195 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001196
Colin Cross4eae06d2023-06-20 22:40:02 -07001197 overlayRes := android.Paths{flata}
1198
1199 // Treat static library dependencies of static libraries as imports.
1200 transitiveStaticLibs := staticDeps.resPackages()
1201 linkDeps = append(linkDeps, transitiveStaticLibs...)
1202 for _, staticLib := range transitiveStaticLibs {
1203 linkFlags = append(linkFlags, "-I "+staticLib.String())
1204 }
Colin Crossfabb6082018-02-20 17:22:23 -08001205
Colin Crossab8d1382023-07-14 17:23:41 +00001206 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossf3b7bad2023-08-02 15:49:00 -07001207 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, a.rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001208 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001209
Colin Cross4eae06d2023-06-20 22:40:02 -07001210 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -08001211 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true, nil)
Colin Cross4eae06d2023-06-20 22:40:02 -07001212
Colin Crossf3b7bad2023-08-02 15:49:00 -07001213 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1214
Colin Crossab8d1382023-07-14 17:23:41 +00001215 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1216 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1217 resPackage: a.exportPackage,
1218 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001219 rTxt: a.rTxt,
1220 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001221 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001222
1223 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001224 })
1225 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1226 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1227
1228 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
1229 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
1230 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
1231 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
1232 // android_library_import modules. If this is fixed, AndroidLibraryDependency.ManifestsDepSet can be dropped
1233 // completely in favor of AndroidLibraryDependency.ResourceNodesDepSet.manifest
1234 //manifestDepSetBuilder.Transitive(transitiveStaticDeps.manifests)
1235 _ = staticManifestsDepSet
1236 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001237
Colin Cross312634e2023-11-21 15:13:56 -08001238 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1239 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1240 return p == a.exportPackage.String()
1241 })
1242 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1243 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1244 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001245
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001246 a.collectTransitiveHeaderJars(ctx)
Colin Cross40213022023-12-13 15:19:49 -08001247 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Crossdcf71b22021-02-01 13:59:03 -08001248 HeaderJars: android.PathsIfNonNil(a.classpathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001249 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1250 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08001251 ImplementationAndResourcesJars: android.PathsIfNonNil(a.classpathFile),
1252 ImplementationJars: android.PathsIfNonNil(a.classpathFile),
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001253 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001254 })
Sam Delmerico82602492022-06-10 17:05:42 +00001255
1256 if proptools.Bool(a.properties.Extract_jni) {
1257 for _, t := range ctx.MultiTargets() {
1258 arch := t.Arch.Abi[0]
1259 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1260 a.jniPackages = append(a.jniPackages, path)
1261
1262 outDir := android.PathForModuleOut(ctx, "aarForJni")
1263 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1264 ctx.Build(pctx, android.BuildParams{
1265 Rule: extractJNI,
1266 Input: aarPath,
1267 Outputs: android.WritablePaths{path},
1268 Description: "extract JNI from AAR",
1269 Args: map[string]string{
1270 "outDir": outDir.String(),
1271 "archString": arch,
1272 },
1273 })
1274 }
Sam Delmerico82602492022-06-10 17:05:42 +00001275 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001276
Colin Cross40213022023-12-13 15:19:49 -08001277 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001278 JniPackages: a.jniPackages,
1279 })
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001280 android.CollectDependencyAconfigFiles(ctx, &a.mergedAconfigFiles)
Colin Crossdcf71b22021-02-01 13:59:03 -08001281}
Colin Crossfabb6082018-02-20 17:22:23 -08001282
1283func (a *AARImport) HeaderJars() android.Paths {
1284 return android.Paths{a.classpathFile}
1285}
1286
Colin Cross331a1212018-08-15 20:40:52 -07001287func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
1288 return android.Paths{a.classpathFile}
1289}
1290
Spandan Das59a4a2b2024-01-09 21:35:56 +00001291func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001292 return nil
1293}
1294
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001295func (a *AARImport) DexJarInstallPath() android.Path {
1296 return nil
1297}
1298
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001299func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Jiyong Park1be96912018-05-28 18:02:19 +09001300 return nil
1301}
1302
Jiyong Park45bf82e2020-12-15 22:29:02 +09001303var _ android.ApexModule = (*AARImport)(nil)
1304
1305// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001306func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1307 return a.depIsInSameApex(ctx, dep)
1308}
1309
Jiyong Park45bf82e2020-12-15 22:29:02 +09001310// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07001311func (g *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1312 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001313 return nil
1314}
1315
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001316var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001317
Colin Cross1b16b0e2019-02-12 14:41:32 -08001318// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1319//
1320// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1321// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001322func AARImportFactory() android.Module {
1323 module := &AARImport{}
1324
1325 module.AddProperties(&module.properties)
1326
1327 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001328 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001329 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001330 return module
1331}