blob: 54fca819aaf3de7d829fe7976a6eb87613771d8c [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"
Jihoon Kangfe914ed2024-02-12 22:49:21 +000026
Colin Crossfabb6082018-02-20 17:22:23 -080027 "github.com/google/blueprint"
Colin Crossa97c5d32018-03-28 14:58:31 -070028 "github.com/google/blueprint/proptools"
Colin Crossfabb6082018-02-20 17:22:23 -080029)
30
Colin Crossa97c5d32018-03-28 14:58:31 -070031type AndroidLibraryDependency interface {
Colin Crossa97c5d32018-03-28 14:58:31 -070032 ExportPackage() android.Path
Colin Crossab8d1382023-07-14 17:23:41 +000033 ResourcesNodeDepSet() *android.DepSet[*resourcesNode]
34 RRODirsDepSet() *android.DepSet[rroDir]
35 ManifestsDepSet() *android.DepSet[android.Path]
Jaewoong Jungc779cd42020-10-06 18:56:10 -070036 SetRROEnforcedForDependent(enforce bool)
37 IsRROEnforced(ctx android.BaseModuleContext) bool
Colin Crossa97c5d32018-03-28 14:58:31 -070038}
39
40func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000041 RegisterAARBuildComponents(android.InitRegistrationContext)
42}
43
44func RegisterAARBuildComponents(ctx android.RegistrationContext) {
45 ctx.RegisterModuleType("android_library_import", AARImportFactory)
46 ctx.RegisterModuleType("android_library", AndroidLibraryFactory)
Paul Duffin04ba70d2021-03-22 13:56:43 +000047 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Cross7e6a9012024-01-17 14:58:38 -080048 ctx.TopDown("propagate_rro_enforcement", propagateRROEnforcementMutator)
Paul Duffin04ba70d2021-03-22 13:56:43 +000049 })
Colin Crossa97c5d32018-03-28 14:58:31 -070050}
51
52//
53// AAR (android library)
54//
55
56type androidLibraryProperties struct {
57 BuildAAR bool `blueprint:"mutated"`
58}
59
60type aaptProperties struct {
61 // flags passed to aapt when creating the apk
62 Aaptflags []string
63
Dan Willemsen72be5902018-10-24 20:24:57 -070064 // include all resource configurations, not just the product-configured
65 // ones.
66 Aapt_include_all_resources *bool
67
Jiakai Zhangba82e282023-10-13 18:08:59 +010068 // list of files to use as assets.
69 Assets []string `android:"path"`
70
Colin Crossa97c5d32018-03-28 14:58:31 -070071 // list of directories relative to the Blueprints file containing assets.
Colin Cross0ddae7f2019-02-07 15:30:01 -080072 // Defaults to ["assets"] if a directory called assets exists. Set to []
73 // to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070074 Asset_dirs []string
75
76 // list of directories relative to the Blueprints file containing
Colin Cross0ddae7f2019-02-07 15:30:01 -080077 // Android resources. Defaults to ["res"] if a directory called res exists.
78 // Set to [] to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070079 Resource_dirs []string
80
Colin Crossa592e3e2019-02-19 16:59:53 -080081 // list of zip files containing Android resources.
Colin Cross27b922f2019-03-04 22:35:41 -080082 Resource_zips []string `android:"path"`
Colin Crossa592e3e2019-02-19 16:59:53 -080083
Colin Crossa97c5d32018-03-28 14:58:31 -070084 // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml".
Colin Cross27b922f2019-03-04 22:35:41 -080085 Manifest *string `android:"path"`
changho.shinb5432b72019-08-08 18:37:17 +090086
87 // paths to additional manifest files to merge with main manifest.
88 Additional_manifests []string `android:"path"`
Sasha Smundak541056c2019-10-28 15:50:06 -070089
90 // do not include AndroidManifest from dependent libraries
91 Dont_merge_manifests *bool
Jaewoong Jungc779cd42020-10-06 18:56:10 -070092
Colin Cross4eae06d2023-06-20 22:40:02 -070093 // If use_resource_processor is set, use Bazel's resource processor instead of aapt2 to generate R.class files.
94 // The resource processor produces more optimal R.class files that only list resources in the package of the
95 // library that provided them, as opposed to aapt2 which produces R.java files for every package containing
96 // every resource. Using the resource processor can provide significant build time speedups, but requires
97 // fixing the module to use the correct package to reference each resource, and to avoid having any other
98 // libraries in the tree that use the same package name. Defaults to false, but will default to true in the
99 // future.
100 Use_resource_processor *bool
101
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700102 // true if RRO is enforced for any of the dependent modules
103 RROEnforcedForDependent bool `blueprint:"mutated"`
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900104
105 // Filter only specified product and ignore other products
106 Filter_product *string `blueprint:"mutated"`
Colin Crossa97c5d32018-03-28 14:58:31 -0700107}
108
109type aapt struct {
Colin Cross312634e2023-11-21 15:13:56 -0800110 aaptSrcJar android.Path
111 transitiveAaptRJars android.Paths
112 transitiveAaptResourcePackagesFile android.Path
113 exportPackage android.Path
114 manifestPath android.Path
115 proguardOptionsFile android.Path
116 rTxt android.Path
117 rJar android.Path
118 extraAaptPackagesFile android.Path
119 mergedManifestFile android.Path
120 noticeFile android.OptionalPath
121 assetPackage android.OptionalPath
122 isLibrary bool
123 defaultManifestVersion string
124 useEmbeddedNativeLibs bool
125 useEmbeddedDex bool
126 usesNonSdkApis bool
127 hasNoCode bool
128 LoggingParent string
129 resourceFiles android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700130
Colin Crosse560c4a2019-03-19 16:03:11 -0700131 splitNames []string
132 splits []split
133
Colin Crossa97c5d32018-03-28 14:58:31 -0700134 aaptProperties aaptProperties
Colin Crossab8d1382023-07-14 17:23:41 +0000135
136 resourcesNodesDepSet *android.DepSet[*resourcesNode]
137 rroDirsDepSet *android.DepSet[rroDir]
138 manifestsDepSet *android.DepSet[android.Path]
Alix96ea88452023-08-31 15:48:23 +0000139
140 manifestValues struct {
141 applicationId string
142 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700143}
144
Colin Crosse560c4a2019-03-19 16:03:11 -0700145type split struct {
146 name string
147 suffix string
148 path android.Path
149}
150
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700151// Propagate RRO enforcement flag to static lib dependencies transitively.
152func propagateRROEnforcementMutator(ctx android.TopDownMutatorContext) {
153 m := ctx.Module()
154 if d, ok := m.(AndroidLibraryDependency); ok && d.IsRROEnforced(ctx) {
155 ctx.VisitDirectDepsWithTag(staticLibTag, func(d android.Module) {
156 if a, ok := d.(AndroidLibraryDependency); ok {
157 a.SetRROEnforcedForDependent(true)
158 }
159 })
160 }
161}
162
Colin Cross8f1b0332024-01-25 13:39:06 -0800163func (a *aapt) useResourceProcessorBusyBox(ctx android.BaseModuleContext) bool {
164 return BoolDefault(a.aaptProperties.Use_resource_processor, ctx.Config().UseResourceProcessorByDefault())
Colin Cross4eae06d2023-06-20 22:40:02 -0700165}
166
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900167func (a *aapt) filterProduct() string {
168 return String(a.aaptProperties.Filter_product)
169}
170
Colin Crossa97c5d32018-03-28 14:58:31 -0700171func (a *aapt) ExportPackage() android.Path {
172 return a.exportPackage
173}
Colin Crossab8d1382023-07-14 17:23:41 +0000174func (a *aapt) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
175 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800176}
177
Colin Crossab8d1382023-07-14 17:23:41 +0000178func (a *aapt) RRODirsDepSet() *android.DepSet[rroDir] {
179 return a.rroDirsDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800180}
181
Colin Crossab8d1382023-07-14 17:23:41 +0000182func (a *aapt) ManifestsDepSet() *android.DepSet[android.Path] {
183 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800184}
185
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700186func (a *aapt) SetRROEnforcedForDependent(enforce bool) {
187 a.aaptProperties.RROEnforcedForDependent = enforce
188}
189
190func (a *aapt) IsRROEnforced(ctx android.BaseModuleContext) bool {
191 // True if RRO is enforced for this module or...
192 return ctx.Config().EnforceRROForModule(ctx.ModuleName()) ||
Jeongik Chacee5ba92021-02-19 12:11:51 +0900193 // if RRO is enforced for any of its dependents.
194 a.aaptProperties.RROEnforcedForDependent
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700195}
196
Jiyong Parkf1691d22021-03-29 20:11:58 +0900197func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext android.SdkContext,
Colin Crossa0ba2f52019-06-22 12:59:27 -0700198 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
199 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700200
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800201 hasVersionCode := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-code")
202 hasVersionName := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-name")
Colin Crossa97c5d32018-03-28 14:58:31 -0700203
Colin Crossa97c5d32018-03-28 14:58:31 -0700204 // Flags specified in Android.bp
205 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
206
Colin Crossa97c5d32018-03-28 14:58:31 -0700207 // Find implicit or explicit asset and resource dirs
Jiakai Zhangba82e282023-10-13 18:08:59 +0100208 assets := android.PathsRelativeToModuleSourceDir(android.SourceInput{
209 Context: ctx,
210 Paths: a.aaptProperties.Assets,
211 IncludeDirs: false,
212 })
Colin Crossa97c5d32018-03-28 14:58:31 -0700213 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
214 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800215 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700216
Colin Crossa97c5d32018-03-28 14:58:31 -0700217 // Glob directories into lists of paths
218 for _, dir := range resourceDirs {
219 resDirs = append(resDirs, globbedResourceDir{
220 dir: dir,
221 files: androidResourceGlob(ctx, dir),
222 })
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700223 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, a, dir)
Colin Crossa97c5d32018-03-28 14:58:31 -0700224 overlayDirs = append(overlayDirs, resOverlayDirs...)
225 rroDirs = append(rroDirs, resRRODirs...)
226 }
227
Colin Crossc20dc852020-11-10 12:27:45 -0800228 var assetDeps android.Paths
229 for i, dir := range assetDirs {
230 // Add a dependency on every file in the asset directory. This ensures the aapt2
231 // rule will be rerun if one of the files in the asset directory is modified.
232 assetDeps = append(assetDeps, androidResourceGlob(ctx, dir)...)
233
234 // Add a dependency on a file that contains a list of all the files in the asset directory.
235 // This ensures the aapt2 rule will be run if a file is removed from the asset directory,
236 // or a file is added whose timestamp is older than the output of aapt2.
237 assetFileListFile := android.PathForModuleOut(ctx, "asset_dir_globs", strconv.Itoa(i)+".glob")
238 androidResourceGlobList(ctx, dir, assetFileListFile)
239 assetDeps = append(assetDeps, assetFileListFile)
Colin Crossa97c5d32018-03-28 14:58:31 -0700240 }
241
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700242 assetDirStrings := assetDirs.Strings()
243 if a.noticeFile.Valid() {
244 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
Colin Crossc20dc852020-11-10 12:27:45 -0800245 assetDeps = append(assetDeps, a.noticeFile.Path())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700246 }
Jiakai Zhangba82e282023-10-13 18:08:59 +0100247 if len(assets) > 0 {
248 // aapt2 doesn't support adding individual asset files. Create a temp directory to hold asset
249 // files and pass it to aapt2.
250 tmpAssetDir := android.PathForModuleOut(ctx, "tmp_asset_dir")
251
252 rule := android.NewRuleBuilder(pctx, ctx)
253 rule.Command().
254 Text("rm -rf").Text(tmpAssetDir.String()).
255 Text("&&").
256 Text("mkdir -p").Text(tmpAssetDir.String())
257
258 for _, asset := range assets {
259 output := tmpAssetDir.Join(ctx, asset.Rel())
260 assetDeps = append(assetDeps, output)
261 rule.Command().Text("mkdir -p").Text(filepath.Dir(output.String()))
262 rule.Command().Text("cp").Input(asset).Output(output)
263 }
264
265 rule.Build("tmp_asset_dir", "tmp_asset_dir")
266
267 assetDirStrings = append(assetDirStrings, tmpAssetDir.String())
268 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700269
Colin Crossa97c5d32018-03-28 14:58:31 -0700270 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
271 linkDeps = append(linkDeps, manifestPath)
272
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700273 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossc20dc852020-11-10 12:27:45 -0800274 linkDeps = append(linkDeps, assetDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700275
Spandan Das50885c02023-02-23 21:31:33 +0000276 // Returns the effective version for {min|target}_sdk_version
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000277 effectiveVersionString := func(sdkVersion android.SdkSpec, minSdkVersion android.ApiLevel) string {
Spandan Das50885c02023-02-23 21:31:33 +0000278 // If {min|target}_sdk_version is current, use sdk_version to determine the effective level
279 // This is necessary for vendor modules.
280 // The effective version does not _only_ depend on {min|target}_sdk_version(level),
281 // but also on the sdk_version (kind+level)
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000282 if minSdkVersion.IsCurrent() {
Spandan Das50885c02023-02-23 21:31:33 +0000283 ret, err := sdkVersion.EffectiveVersionString(ctx)
284 if err != nil {
285 ctx.ModuleErrorf("invalid sdk_version: %s", err)
286 }
287 return ret
288 }
289 ret, err := minSdkVersion.EffectiveVersionString(ctx)
290 if err != nil {
291 ctx.ModuleErrorf("invalid min_sdk_version: %s", err)
292 }
293 return ret
Jiyong Park6a927c42020-01-21 02:03:43 +0900294 }
Spandan Das50885c02023-02-23 21:31:33 +0000295 // SDK version flags
296 sdkVersion := sdkContext.SdkVersion(ctx)
297 minSdkVersion := effectiveVersionString(sdkVersion, sdkContext.MinSdkVersion(ctx))
Colin Crossa97c5d32018-03-28 14:58:31 -0700298
Colin Cross83bb3162018-06-25 15:48:06 -0700299 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
Spandan Das6450b552023-02-23 19:27:07 +0000300 // Use minSdkVersion for target-sdk-version, even if `target_sdk_version` is set
301 // This behavior has been copied from Make.
Colin Cross83bb3162018-06-25 15:48:06 -0700302 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700303
Colin Crossa97c5d32018-03-28 14:58:31 -0700304 // Version code
305 if !hasVersionCode {
Dan Albert4f378d72020-07-23 17:32:15 -0700306 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion().String())
Colin Crossa97c5d32018-03-28 14:58:31 -0700307 }
308
309 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700310 var versionName string
311 if ctx.ModuleName() == "framework-res" {
312 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
313 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700314 // if it contains the build number. Use the PlatformVersionName instead.
315 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700316 } else {
317 versionName = ctx.Config().AppsDefaultVersionName()
318 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800319 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700320 linkFlags = append(linkFlags, "--version-name ", versionName)
321 }
322
Colin Crossa0ba2f52019-06-22 12:59:27 -0700323 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
324
325 // Always set --pseudo-localize, it will be stripped out later for release
326 // builds that don't want it.
327 compileFlags = append(compileFlags, "--pseudo-localize")
328
329 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700330}
331
Paul Duffin250e6192019-06-07 10:44:37 +0100332func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800333 if sdkDep.frameworkResModule != "" {
334 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700335 }
336}
337
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800338var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
339 blueprint.RuleParams{
340 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
341 CommandDeps: []string{"${config.Zip2ZipCmd}"},
342 })
343
Alixf7a10272023-09-27 16:47:56 +0000344type aaptBuildActionOptions struct {
345 sdkContext android.SdkContext
346 classLoaderContexts dexpreopt.ClassLoaderContextMap
347 excludedLibs []string
348 enforceDefaultTargetSdkVersion bool
349 extraLinkFlags []string
Jihoon Kang84b25892023-12-01 22:01:06 +0000350 aconfigTextFiles android.Paths
Alixf7a10272023-09-27 16:47:56 +0000351}
352
353func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700354
Colin Cross8676c8c2023-10-12 15:58:57 -0700355 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Alixf7a10272023-09-27 16:47:56 +0000356 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100357
Paul Duffin06530572022-02-03 17:54:15 +0000358 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000359 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000360
Colin Cross31656952018-05-24 16:11:20 -0700361 // App manifest file
362 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
363 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
364
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000365 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000366 SdkContext: opts.sdkContext,
367 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000368 IsLibrary: a.isLibrary,
369 DefaultManifestVersion: a.defaultManifestVersion,
370 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
371 UsesNonSdkApis: a.usesNonSdkApis,
372 UseEmbeddedDex: a.useEmbeddedDex,
373 HasNoCode: a.hasNoCode,
374 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000375 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000376 })
Colin Cross90c25c62019-04-19 16:22:57 -0700377
Colin Crossab8d1382023-07-14 17:23:41 +0000378 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700379 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000380
Luca Stefanifd898822019-09-10 22:13:31 +0200381 // Add additional manifest files to transitive manifests.
382 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000383 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
384 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
385 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
386 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
387 // android_library_import modules. If this is fixed, staticManifestsDepSet can be dropped completely in favor of
388 // staticResourcesNodesDepSet.manifests()
389 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700390
Colin Crossab8d1382023-07-14 17:23:41 +0000391 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000392 manifestMergerParams := ManifestMergerParams{
393 staticLibManifests: transitiveManifestPaths[1:],
Alix96ea88452023-08-31 15:48:23 +0000394 isLibrary: a.isLibrary,
395 packageName: a.manifestValues.applicationId,
396 }
Alixf7a10272023-09-27 16:47:56 +0000397 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700398 if !a.isLibrary {
399 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
400 // will be propagated to the final application and merged there. The merged manifest for libraries is
401 // only passed to Make, which can't handle transitive dependencies.
402 manifestPath = a.mergedManifestFile
403 }
404 } else {
405 a.mergedManifestFile = manifestPath
406 }
Colin Cross31656952018-05-24 16:11:20 -0700407
Alixf7a10272023-09-27 16:47:56 +0000408 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700409
410 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700411 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000412 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000413 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700414 if a.isLibrary {
415 linkFlags = append(linkFlags, "--static-lib")
416 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700417
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800418 linkFlags = append(linkFlags, "--no-static-lib-packages")
Colin Cross8f1b0332024-01-25 13:39:06 -0800419 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800420 // When building an android_library using ResourceProcessorBusyBox pass --merge-only to skip resource
421 // references validation until the final app link step when all static libraries are present.
Colin Cross4eae06d2023-06-20 22:40:02 -0700422 linkFlags = append(linkFlags, "--merge-only")
Colin Cross4eae06d2023-06-20 22:40:02 -0700423 }
424
Colin Crossa97c5d32018-03-28 14:58:31 -0700425 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700426 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
427 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700428 // This file isn't used by Soong, but is generated for exporting
429 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700430 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700431 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700432
Colin Cross4aaa84a2018-08-21 15:14:37 -0700433 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700434 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700435 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900436 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700437 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700438
Colin Crossa592e3e2019-02-19 16:59:53 -0800439 for i, zip := range resZips {
440 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700441 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800442 compiledResDirs = append(compiledResDirs, android.Paths{flata})
443 }
444
Colin Cross4aaa84a2018-08-21 15:14:37 -0700445 var compiledRes, compiledOverlay android.Paths
446
Colin Crossab8d1382023-07-14 17:23:41 +0000447 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
448 // of transitiveStaticLibs.
449 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
450
Colin Cross8f1b0332024-01-25 13:39:06 -0800451 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700452 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
453 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
454 // instead modules depending on this module will reference package-res.apk from all transitive static
455 // dependencies.
Colin Cross1d3f5902024-03-05 11:51:54 -0800456 for _, sharedDep := range sharedDeps {
457 if sharedDep.usedResourceProcessor {
458 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
459 }
460 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700461 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 }
468 } else {
469 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
470 // dependencies are compiled into this module's package-res.apk as overlays.
471 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
472 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700473
Colin Crossbec85302019-02-13 13:15:46 -0800474 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700475 // If we are using static android libraries, every source file becomes an overlay.
476 // This is to emulate old AAPT behavior which simulated library support.
477 for _, compiledResDir := range compiledResDirs {
478 compiledOverlay = append(compiledOverlay, compiledResDir...)
479 }
Colin Crossbec85302019-02-13 13:15:46 -0800480 } else if a.isLibrary {
481 // Otherwise, for a static library we treat all the resources equally with no overlay.
482 for _, compiledResDir := range compiledResDirs {
483 compiledRes = append(compiledRes, compiledResDir...)
484 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700485 } else if len(compiledResDirs) > 0 {
486 // Without static libraries, the first directory is our directory, which can then be
487 // overlaid by the rest.
488 compiledRes = append(compiledRes, compiledResDirs[0]...)
489 for _, compiledResDir := range compiledResDirs[1:] {
490 compiledOverlay = append(compiledOverlay, compiledResDir...)
491 }
492 }
493
Colin Crossa97c5d32018-03-28 14:58:31 -0700494 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900495 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700496 }
497
Colin Crosse560c4a2019-03-19 16:03:11 -0700498 var splitPackages android.WritablePaths
499 var splits []split
500
501 for _, s := range a.splitNames {
502 suffix := strings.Replace(s, ",", "_", -1)
503 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
504 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
505 splitPackages = append(splitPackages, path)
506 splits = append(splits, split{
507 name: s,
508 suffix: suffix,
509 path: path,
510 })
511 }
512
Colin Cross8f1b0332024-01-25 13:39:06 -0800513 if !a.useResourceProcessorBusyBox(ctx) {
Colin Crossf3b7bad2023-08-02 15:49:00 -0700514 // the subdir "android" is required to be filtered by package names
515 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
516 }
517
Colin Crossab8d1382023-07-14 17:23:41 +0000518 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
519 // provided to the final app aapt2Link step.
520 var transitiveAssets android.Paths
521 if !a.isLibrary {
522 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
523 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700524 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000525 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
526 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800527 // Extract assets from the resource package output so that they can be used later in aapt2link
528 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000529 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800530 assets := android.PathForModuleOut(ctx, "assets.zip")
531 ctx.Build(pctx, android.BuildParams{
532 Rule: extractAssetsRule,
533 Input: packageRes,
534 Output: assets,
535 Description: "extract assets from built resource file",
536 })
537 a.assetPackage = android.OptionalPathForPath(assets)
538 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700539
Colin Cross8f1b0332024-01-25 13:39:06 -0800540 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700541 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800542 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700543 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700544 transitiveRJars = append(transitiveRJars, rJar)
545 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700546 } else {
547 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700548 }
549
Colin Cross312634e2023-11-21 15:13:56 -0800550 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
551 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
552 return p == packageRes.String()
553 })
554 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
555 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
556
Colin Cross1d3f5902024-03-05 11:51:54 -0800557 // Reverse the list of R.jar files so that the current module comes first, and direct dependencies come before
558 // transitive dependencies.
559 transitiveRJars = android.ReversePaths(transitiveRJars)
560
Colin Crossa97c5d32018-03-28 14:58:31 -0700561 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700562 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800563 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700564 a.exportPackage = packageRes
565 a.manifestPath = manifestPath
566 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700567 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700568 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700569 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000570 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
571 Direct(&resourcesNode{
572 resPackage: a.exportPackage,
573 manifest: a.manifestPath,
574 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700575 rTxt: a.rTxt,
576 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000577 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700578
Colin Cross8f1b0332024-01-25 13:39:06 -0800579 usedResourceProcessor: a.useResourceProcessorBusyBox(ctx),
Colin Crossab8d1382023-07-14 17:23:41 +0000580 }).
581 Transitive(staticResourcesNodesDepSet).Build()
582 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
583 Direct(rroDirs...).
584 Transitive(staticRRODirsDepSet).Build()
585 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
586 Direct(a.manifestPath).
587 DirectSlice(additionalManifests).
588 Transitive(staticManifestsDepSet).Build()
589}
590
Colin Cross4eae06d2023-06-20 22:40:02 -0700591var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
592 blueprint.RuleParams{
593 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
594 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
595 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
596 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
597 Rspfile: "${out}.args",
598 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
599 Restat: true,
600 }, "rTxt", "manifest", "args")
601
602// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
603// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
604// supports producing classes for static dependencies that only include resources from that dependency.
605func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800606 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700607
608 var args []string
609 var deps android.Paths
610
611 if !isLibrary {
612 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
613 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
614 // package.
615 args, deps = transitiveDeps.resourceProcessorDeps()
616 } else {
617 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
618 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
619 // inlined into the library before the final IDs are assigned during app compilation.
620 args = append(args, "--finalFields=false")
621 }
622
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800623 for i, arg := range aaptFlags {
624 const AAPT_CUSTOM_PACKAGE = "--custom-package"
625 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
626 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
627 if pkg == "" && i+1 < len(aaptFlags) {
628 pkg = aaptFlags[i+1]
629 }
630 args = append(args, "--packageForR "+pkg)
631 }
632 }
633
Colin Cross4eae06d2023-06-20 22:40:02 -0700634 deps = append(deps, rTxt, manifest)
635
636 ctx.Build(pctx, android.BuildParams{
637 Rule: resourceProcessorBusyBox,
638 Output: rJar,
639 Implicits: deps,
640 Description: "ResourceProcessorBusyBox",
641 Args: map[string]string{
642 "rTxt": rTxt.String(),
643 "manifest": manifest.String(),
644 "args": strings.Join(args, " "),
645 },
646 })
647}
648
Colin Crossab8d1382023-07-14 17:23:41 +0000649type resourcesNode struct {
650 resPackage android.Path
651 manifest android.Path
652 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700653 rTxt android.Path
654 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000655 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700656
657 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000658}
659
660type transitiveAarDeps []*resourcesNode
661
662func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700663 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000664 for _, dep := range t {
665 paths = append(paths, dep.resPackage)
666 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700667 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000668}
669
670func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700671 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000672 for _, dep := range t {
673 paths = append(paths, dep.manifest)
674 paths = append(paths, dep.additionalManifests...)
675 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700676 return paths
677}
678
679func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
680 for _, dep := range t {
681 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
682 deps = append(deps, dep.rTxt, dep.manifest)
683 }
684 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000685}
686
687func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700688 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000689 for _, dep := range t {
690 if dep.assets.Valid() {
691 paths = append(paths, dep.assets.Path())
692 }
693 }
694 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700695}
696
697// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900698func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700699 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000700 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700701
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100702 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000703 // Not all callers need to compute class loader context, those who don't just pass nil.
704 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100705 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000706 }
707
Colin Cross83bb3162018-06-25 15:48:06 -0700708 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700709 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700710 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700711 }
712
Colin Cross8676c8c2023-10-12 15:58:57 -0700713 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
714 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000715 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
716 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
717
Colin Crossa97c5d32018-03-28 14:58:31 -0700718 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000719 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000720
Colin Crossa97c5d32018-03-28 14:58:31 -0700721 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700722 aarDep, _ := module.(AndroidLibraryDependency)
723 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700724 exportPackage = aarDep.ExportPackage()
725 }
726
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000727 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700728 case instrumentationForTag:
729 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400730 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700731 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700732 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700733 sharedLibs = append(sharedLibs, exportPackage)
734 }
Colin Cross5446e882019-05-22 10:46:27 -0700735 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700736 if exportPackage != nil {
737 sharedLibs = append(sharedLibs, exportPackage)
738 }
739 case staticLibTag:
740 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700741 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000742 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
743 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700744 }
745 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000746
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000747 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700748 })
749
Colin Crossab8d1382023-07-14 17:23:41 +0000750 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
751 // Reverse the dependency order now going into the depset so that it comes out in order after the second
752 // reverse later.
753 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
754 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
755 // dependency has to be listed last.
756 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700757 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
758 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
759 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700760
Colin Crossab8d1382023-07-14 17:23:41 +0000761 staticRRODirs = rroDirsDepSetBuilder.Build()
762 staticManifests = manifestsDepSetBuilder.Build()
763
764 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700765 flags = append(flags, "--auto-add-overlay")
766 }
767
768 for _, sharedLib := range sharedLibs {
769 flags = append(flags, "-I "+sharedLib.String())
770 }
771
Colin Cross8676c8c2023-10-12 15:58:57 -0700772 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700773}
774
775type AndroidLibrary struct {
776 Library
777 aapt
778
779 androidLibraryProperties androidLibraryProperties
780
781 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700782}
783
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000784var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
785
786// For OutputFileProducer interface
787func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
788 switch tag {
789 case ".aar":
790 return []android.Path{a.aarFile}, nil
791 default:
792 return a.Library.OutputFiles(tag)
793 }
794}
795
Colin Crossa97c5d32018-03-28 14:58:31 -0700796var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
797
798func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
799 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900800 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100801 if sdkDep.hasFrameworkLibs() {
802 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700803 }
Colin Cross4a80a152022-12-21 21:51:52 -0800804 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700805}
806
807func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800808 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100809 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000810 if a.usesLibrary.shouldDisableDexpreopt {
811 a.dexpreopter.disableDexpreopt()
812 }
Alixf7a10272023-09-27 16:47:56 +0000813 a.aapt.buildActions(ctx,
814 aaptBuildActionOptions{
815 sdkContext: android.SdkContext(a),
816 classLoaderContexts: a.classLoaderContexts,
817 enforceDefaultTargetSdkVersion: false,
818 },
819 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700820
Colin Crossff694a82023-12-13 15:54:49 -0800821 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
822 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700823
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000824 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
825
Colin Cross4eae06d2023-06-20 22:40:02 -0700826 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
827 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800828 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700829 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700830 } else {
831 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700832 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700833
834 // apps manifests are handled by aapt, don't let Module see them
835 a.properties.Manifest = nil
836
Colin Cross014489c2020-06-02 20:09:13 -0700837 a.linter.mergedManifest = a.aapt.mergedManifestFile
838 a.linter.manifest = a.aapt.manifestPath
839 a.linter.resources = a.aapt.resourceFiles
840
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000841 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800842 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800843 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
844 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
845 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
846
847 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
848 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
849 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700850
Colin Cross4eae06d2023-06-20 22:40:02 -0700851 var extraSrcJars android.Paths
852 var extraCombinedJars android.Paths
853 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800854 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700855 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
856 // library and each of the transitive static android_library dependencies has already created an
857 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
858 extraClasspathJars = a.transitiveAaptRJars
859 } else {
860 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
861 // R.java files for the library's package and the packages from all transitive static android_library
862 // dependencies. Compile the srcjar alongside the rest of the sources.
863 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
864 }
865
866 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700867
Colin Crossf57c5782019-01-25 13:20:38 -0800868 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700869 var res android.Paths
870 if a.androidLibraryProperties.BuildAAR {
871 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
872 ctx.CheckbuildFile(a.aarFile)
873 }
Colin Cross89c31582018-04-30 15:55:11 -0700874
Sam Delmerico82602492022-06-10 17:05:42 +0000875 prebuiltJniPackages := android.Paths{}
876 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800877 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000878 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
879 }
880 })
881 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800882 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000883 JniPackages: prebuiltJniPackages,
884 })
885 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700886}
887
Colin Cross95b53b82023-10-17 13:21:02 -0700888func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
889 a.Library.IDEInfo(dpInfo)
890 a.aapt.IDEInfo(dpInfo)
891}
892
893func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800894 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700895 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
896 }
897}
898
Colin Cross1b16b0e2019-02-12 14:41:32 -0800899// android_library builds and links sources into a `.jar` file for the device along with Android resources.
900//
901// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000902// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800903// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
904// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700905func AndroidLibraryFactory() android.Module {
906 module := &AndroidLibrary{}
907
Colin Crossce6734e2020-06-15 16:09:53 -0700908 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700909 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700910 &module.aaptProperties,
911 &module.androidLibraryProperties)
912
913 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700914 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700915
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900916 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700917 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700918 return module
919}
920
Colin Crossfabb6082018-02-20 17:22:23 -0800921//
922// AAR (android library) prebuilts
923//
Colin Crossfabb6082018-02-20 17:22:23 -0800924
Vinh Trance0781f2022-04-13 01:30:44 +0000925// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800926type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000927 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800928 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000929 // If not blank, set to the version of the sdk to compile against.
930 // Defaults to private.
931 // Values are of one of the following forms:
932 // 1) numerical API level, "current", "none", or "core_platform"
933 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
934 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
935 // If the SDK kind is empty, it will be set to public
936 Sdk_version *string
937 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
938 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700939 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000940 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700941 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000942 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
943 Libs []string
944 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700945 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000946 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
947 // will be passed transitively through android_libraries to an android_app.
948 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
949 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800950}
951
952type AARImport struct {
953 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700954 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900955 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800956 prebuilt android.Prebuilt
957
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900958 // Functionality common to Module and Import.
959 embeddableInModuleAndImport
960
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500961 providesTransitiveHeaderJars
962
Colin Crossfabb6082018-02-20 17:22:23 -0800963 properties AARImportProperties
964
Colin Cross312634e2023-11-21 15:13:56 -0800965 classpathFile android.WritablePath
966 proguardFlags android.WritablePath
967 exportPackage android.WritablePath
968 transitiveAaptResourcePackagesFile android.Path
969 extraAaptPackagesFile android.WritablePath
970 manifest android.WritablePath
971 assetsPackage android.WritablePath
972 rTxt android.WritablePath
973 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700974
Colin Crossab8d1382023-07-14 17:23:41 +0000975 resourcesNodesDepSet *android.DepSet[*resourcesNode]
976 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700977
978 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000979
Sam Delmerico82602492022-06-10 17:05:42 +0000980 aarPath android.Path
981 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900982
983 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000984 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000985
986 // Single aconfig "cache file" merged from this module and all dependencies.
987 mergedAconfigFiles map[string]android.Paths
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000988}
989
990var _ android.OutputFileProducer = (*AARImport)(nil)
991
992// For OutputFileProducer interface
993func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
994 switch tag {
995 case ".aar":
996 return []android.Path{a.aarPath}, nil
997 case "":
998 return []android.Path{a.classpathFile}, nil
999 default:
1000 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
1001 }
Colin Crossfabb6082018-02-20 17:22:23 -08001002}
1003
Jiyong Park92315372021-04-02 08:45:46 +09001004func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1005 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07001006}
1007
Jiyong Parkf1691d22021-03-29 20:11:58 +09001008func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001009 return ""
1010}
1011
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001012func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001013 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001014 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001015 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001016 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001017}
1018
Spandan Dasa26eda72023-03-02 00:56:06 +00001019func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1020 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001021}
1022
Spandan Dasca70fc42023-03-01 23:38:49 +00001023func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1024 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001025}
1026
Colin Cross1e743852019-10-28 11:37:20 -07001027func (a *AARImport) javaVersion() string {
1028 return ""
1029}
1030
Colin Crossa97c5d32018-03-28 14:58:31 -07001031var _ AndroidLibraryDependency = (*AARImport)(nil)
1032
1033func (a *AARImport) ExportPackage() android.Path {
1034 return a.exportPackage
1035}
Colin Crossab8d1382023-07-14 17:23:41 +00001036func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1037 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001038}
1039
Colin Crossab8d1382023-07-14 17:23:41 +00001040func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1041 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001042}
1043
Colin Crossab8d1382023-07-14 17:23:41 +00001044func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1045 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001046}
1047
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001048// RRO enforcement is not available on aar_import since its RRO dirs are not
1049// exported.
1050func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1051}
1052
1053// RRO enforcement is not available on aar_import since its RRO dirs are not
1054// exported.
1055func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1056 return false
1057}
1058
Colin Crossfabb6082018-02-20 17:22:23 -08001059func (a *AARImport) Prebuilt() *android.Prebuilt {
1060 return &a.prebuilt
1061}
1062
1063func (a *AARImport) Name() string {
1064 return a.prebuilt.Name(a.ModuleBase.Name())
1065}
1066
Jiyong Park618922e2020-01-08 13:35:43 +09001067func (a *AARImport) JacocoReportClassesFile() android.Path {
1068 return nil
1069}
1070
Colin Crossfabb6082018-02-20 17:22:23 -08001071func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001072 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001073 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001074 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001075 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001076 }
1077 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001078
Colin Cross42d48b72018-08-29 14:10:52 -07001079 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1080 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001081}
1082
Sam Delmerico82602492022-06-10 17:05:42 +00001083type JniPackageInfo struct {
1084 // List of zip files containing JNI libraries
1085 // Zip files should have directory structure jni/<arch>/*.so
1086 JniPackages android.Paths
1087}
1088
Colin Crossbc7d76c2023-12-12 16:39:03 -08001089var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001090
1091// Unzip an AAR and extract the JNI libs for $archString.
1092var extractJNI = pctx.AndroidStaticRule("extractJNI",
1093 blueprint.RuleParams{
1094 Command: `rm -rf $out $outDir && touch $out && ` +
1095 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1096 `jni_files=$$(find $outDir/jni -type f) && ` +
1097 // print error message if there are no JNI libs for this arch
1098 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001099 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001100 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1101 CommandDeps: []string{"${config.SoongZipCmd}"},
1102 },
1103 "outDir", "archString")
1104
Colin Crossfabb6082018-02-20 17:22:23 -08001105// 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 -07001106// 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 -08001107var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1108 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001109 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001110 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001111 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001112 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001113 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001114 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001115 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001116
1117func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1118 if len(a.properties.Aars) != 1 {
1119 ctx.PropertyErrorf("aars", "exactly one aar is required")
1120 return
1121 }
1122
Jiyong Park92315372021-04-02 08:45:46 +09001123 a.sdkVersion = a.SdkVersion(ctx)
1124 a.minSdkVersion = a.MinSdkVersion(ctx)
1125
Colin Crossff694a82023-12-13 15:54:49 -08001126 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1127 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001128
Nan Zhang4c819fb2018-08-27 18:31:46 -07001129 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001130 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1131
Colin Cross1001a792019-03-21 22:21:39 -07001132 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001133 inputFile := a.aarPath
1134 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1135 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001136 }
Colin Crossfabb6082018-02-20 17:22:23 -08001137
1138 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001139 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001140 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001141 a.rTxt = extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001142 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001143 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001144 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001145 ProguardFlagsFiles: android.NewDepSet[android.Path](
1146 android.POSTORDER,
1147 android.Paths{a.proguardFlags},
1148 nil,
1149 ),
1150 })
Colin Crossfabb6082018-02-20 17:22:23 -08001151
1152 ctx.Build(pctx, android.BuildParams{
1153 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001154 Input: a.aarPath,
Colin Crossbb77d8e2024-02-15 14:43:47 -08001155 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, a.rTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001156 Description: "unzip AAR",
1157 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001158 "outDir": extractedAARDir.String(),
1159 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001160 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001161 },
1162 })
1163
Colin Crossa0ba2f52019-06-22 12:59:27 -07001164 // Always set --pseudo-localize, it will be stripped out later for release
1165 // builds that don't want it.
1166 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001167 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001168 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001169 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001170
1171 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001172 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001173 aaptRTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001174 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001175
1176 var linkDeps android.Paths
1177
1178 linkFlags := []string{
1179 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001180 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001181 "--auto-add-overlay",
Colin Cross7c4dc5d2024-02-13 14:29:45 -08001182 "--no-static-lib-packages",
Colin Crossfabb6082018-02-20 17:22:23 -08001183 }
1184
Colin Cross10f7c4a2018-05-23 10:59:28 -07001185 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1186 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001187
Colin Cross8676c8c2023-10-12 15:58:57 -07001188 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001189 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001190
Colin Cross8676c8c2023-10-12 15:58:57 -07001191 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001192 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001193
Colin Crossab8d1382023-07-14 17:23:41 +00001194 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001195
Colin Crossab8d1382023-07-14 17:23:41 +00001196 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001197 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001198 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001199
Colin Cross4eae06d2023-06-20 22:40:02 -07001200 overlayRes := android.Paths{flata}
1201
1202 // Treat static library dependencies of static libraries as imports.
1203 transitiveStaticLibs := staticDeps.resPackages()
1204 linkDeps = append(linkDeps, transitiveStaticLibs...)
1205 for _, staticLib := range transitiveStaticLibs {
1206 linkFlags = append(linkFlags, "-I "+staticLib.String())
1207 }
Colin Crossfabb6082018-02-20 17:22:23 -08001208
Colin Crossab8d1382023-07-14 17:23:41 +00001209 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossbb77d8e2024-02-15 14:43:47 -08001210 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, aaptRTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001211 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001212
Colin Cross4eae06d2023-06-20 22:40:02 -07001213 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -08001214 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true, nil)
Colin Cross4eae06d2023-06-20 22:40:02 -07001215
Colin Crossf3b7bad2023-08-02 15:49:00 -07001216 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1217
Colin Crossab8d1382023-07-14 17:23:41 +00001218 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1219 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1220 resPackage: a.exportPackage,
1221 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001222 rTxt: a.rTxt,
1223 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001224 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001225
1226 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001227 })
1228 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1229 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1230
1231 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
1232 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
1233 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
1234 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
1235 // android_library_import modules. If this is fixed, AndroidLibraryDependency.ManifestsDepSet can be dropped
1236 // completely in favor of AndroidLibraryDependency.ResourceNodesDepSet.manifest
1237 //manifestDepSetBuilder.Transitive(transitiveStaticDeps.manifests)
1238 _ = staticManifestsDepSet
1239 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001240
Colin Cross312634e2023-11-21 15:13:56 -08001241 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1242 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1243 return p == a.exportPackage.String()
1244 })
1245 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1246 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1247 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001248
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001249 a.collectTransitiveHeaderJars(ctx)
Colin Cross40213022023-12-13 15:19:49 -08001250 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Crossdcf71b22021-02-01 13:59:03 -08001251 HeaderJars: android.PathsIfNonNil(a.classpathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001252 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1253 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08001254 ImplementationAndResourcesJars: android.PathsIfNonNil(a.classpathFile),
1255 ImplementationJars: android.PathsIfNonNil(a.classpathFile),
Jihoon Kangfe914ed2024-02-12 22:49:21 +00001256 StubsLinkType: Implementation,
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001257 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001258 })
Sam Delmerico82602492022-06-10 17:05:42 +00001259
1260 if proptools.Bool(a.properties.Extract_jni) {
1261 for _, t := range ctx.MultiTargets() {
1262 arch := t.Arch.Abi[0]
1263 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1264 a.jniPackages = append(a.jniPackages, path)
1265
1266 outDir := android.PathForModuleOut(ctx, "aarForJni")
1267 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1268 ctx.Build(pctx, android.BuildParams{
1269 Rule: extractJNI,
1270 Input: aarPath,
1271 Outputs: android.WritablePaths{path},
1272 Description: "extract JNI from AAR",
1273 Args: map[string]string{
1274 "outDir": outDir.String(),
1275 "archString": arch,
1276 },
1277 })
1278 }
Sam Delmerico82602492022-06-10 17:05:42 +00001279 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001280
Colin Cross40213022023-12-13 15:19:49 -08001281 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001282 JniPackages: a.jniPackages,
1283 })
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001284 android.CollectDependencyAconfigFiles(ctx, &a.mergedAconfigFiles)
Colin Crossdcf71b22021-02-01 13:59:03 -08001285}
Colin Crossfabb6082018-02-20 17:22:23 -08001286
1287func (a *AARImport) HeaderJars() android.Paths {
1288 return android.Paths{a.classpathFile}
1289}
1290
Colin Cross331a1212018-08-15 20:40:52 -07001291func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
1292 return android.Paths{a.classpathFile}
1293}
1294
Spandan Das59a4a2b2024-01-09 21:35:56 +00001295func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001296 return nil
1297}
1298
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001299func (a *AARImport) DexJarInstallPath() android.Path {
1300 return nil
1301}
1302
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001303func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Jiyong Park1be96912018-05-28 18:02:19 +09001304 return nil
1305}
1306
Jiyong Park45bf82e2020-12-15 22:29:02 +09001307var _ android.ApexModule = (*AARImport)(nil)
1308
1309// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001310func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1311 return a.depIsInSameApex(ctx, dep)
1312}
1313
Jiyong Park45bf82e2020-12-15 22:29:02 +09001314// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07001315func (g *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1316 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001317 return nil
1318}
1319
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001320var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001321
Colin Cross1b16b0e2019-02-12 14:41:32 -08001322// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1323//
1324// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1325// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001326func AARImportFactory() android.Module {
1327 module := &AARImport{}
1328
1329 module.AddProperties(&module.properties)
1330
1331 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001332 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001333 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001334 return module
1335}