blob: 92c1adf42f6cee1f46de62c9bfcc244e3d42fe3d [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 Cross8f1b0332024-01-25 13:39:06 -0800418 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700419 // When building an android_library using ResourceProcessorBusyBox the resources are merged into
420 // package-res.apk with --merge-only, but --no-static-lib-packages is not used so that R.txt only
421 // contains resources from this library.
422 linkFlags = append(linkFlags, "--merge-only")
423 } else {
424 // When building and app or when building an android_library without ResourceProcessorBusyBox
425 // --no-static-lib-packages is used to put all the resources into the app. If ResourceProcessorBusyBox
426 // is used then the app's R.txt will be post-processed along with the R.txt files from dependencies to
427 // sort resources into the right packages in R.class.
428 linkFlags = append(linkFlags, "--no-static-lib-packages")
429 }
430
Colin Crossa97c5d32018-03-28 14:58:31 -0700431 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700432 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
433 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700434 // This file isn't used by Soong, but is generated for exporting
435 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700436 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700437 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700438
Colin Cross4aaa84a2018-08-21 15:14:37 -0700439 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700440 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700441 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900442 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700443 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700444
Colin Crossa592e3e2019-02-19 16:59:53 -0800445 for i, zip := range resZips {
446 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700447 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800448 compiledResDirs = append(compiledResDirs, android.Paths{flata})
449 }
450
Colin Cross4aaa84a2018-08-21 15:14:37 -0700451 var compiledRes, compiledOverlay android.Paths
452
Colin Crossab8d1382023-07-14 17:23:41 +0000453 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
454 // of transitiveStaticLibs.
455 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
456
Colin Cross8f1b0332024-01-25 13:39:06 -0800457 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700458 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
459 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
460 // instead modules depending on this module will reference package-res.apk from all transitive static
461 // dependencies.
462 for _, staticDep := range staticDeps {
463 linkDeps = append(linkDeps, staticDep.resPackage)
464 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
465 if staticDep.usedResourceProcessor {
466 transitiveRJars = append(transitiveRJars, staticDep.rJar)
467 }
468 }
Colin Cross8676c8c2023-10-12 15:58:57 -0700469 for _, sharedDep := range sharedDeps {
470 if sharedDep.usedResourceProcessor {
471 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
472 }
473 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700474 } else {
475 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
476 // dependencies are compiled into this module's package-res.apk as overlays.
477 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
478 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700479
Colin Crossbec85302019-02-13 13:15:46 -0800480 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700481 // If we are using static android libraries, every source file becomes an overlay.
482 // This is to emulate old AAPT behavior which simulated library support.
483 for _, compiledResDir := range compiledResDirs {
484 compiledOverlay = append(compiledOverlay, compiledResDir...)
485 }
Colin Crossbec85302019-02-13 13:15:46 -0800486 } else if a.isLibrary {
487 // Otherwise, for a static library we treat all the resources equally with no overlay.
488 for _, compiledResDir := range compiledResDirs {
489 compiledRes = append(compiledRes, compiledResDir...)
490 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700491 } else if len(compiledResDirs) > 0 {
492 // Without static libraries, the first directory is our directory, which can then be
493 // overlaid by the rest.
494 compiledRes = append(compiledRes, compiledResDirs[0]...)
495 for _, compiledResDir := range compiledResDirs[1:] {
496 compiledOverlay = append(compiledOverlay, compiledResDir...)
497 }
498 }
499
Colin Crossa97c5d32018-03-28 14:58:31 -0700500 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900501 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700502 }
503
Colin Crosse560c4a2019-03-19 16:03:11 -0700504 var splitPackages android.WritablePaths
505 var splits []split
506
507 for _, s := range a.splitNames {
508 suffix := strings.Replace(s, ",", "_", -1)
509 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
510 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
511 splitPackages = append(splitPackages, path)
512 splits = append(splits, split{
513 name: s,
514 suffix: suffix,
515 path: path,
516 })
517 }
518
Colin Cross8f1b0332024-01-25 13:39:06 -0800519 if !a.useResourceProcessorBusyBox(ctx) {
Colin Crossf3b7bad2023-08-02 15:49:00 -0700520 // the subdir "android" is required to be filtered by package names
521 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
522 }
523
Colin Crossab8d1382023-07-14 17:23:41 +0000524 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
525 // provided to the final app aapt2Link step.
526 var transitiveAssets android.Paths
527 if !a.isLibrary {
528 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
529 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700530 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000531 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
532 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800533 // Extract assets from the resource package output so that they can be used later in aapt2link
534 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000535 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800536 assets := android.PathForModuleOut(ctx, "assets.zip")
537 ctx.Build(pctx, android.BuildParams{
538 Rule: extractAssetsRule,
539 Input: packageRes,
540 Output: assets,
541 Description: "extract assets from built resource file",
542 })
543 a.assetPackage = android.OptionalPathForPath(assets)
544 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700545
Colin Cross8f1b0332024-01-25 13:39:06 -0800546 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700547 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800548 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700549 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700550 transitiveRJars = append(transitiveRJars, rJar)
551 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700552 } else {
553 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700554 }
555
Colin Cross312634e2023-11-21 15:13:56 -0800556 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
557 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
558 return p == packageRes.String()
559 })
560 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
561 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
562
Colin Crossa97c5d32018-03-28 14:58:31 -0700563 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700564 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800565 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700566 a.exportPackage = packageRes
567 a.manifestPath = manifestPath
568 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700569 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700570 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700571 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000572 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
573 Direct(&resourcesNode{
574 resPackage: a.exportPackage,
575 manifest: a.manifestPath,
576 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700577 rTxt: a.rTxt,
578 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000579 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700580
Colin Cross8f1b0332024-01-25 13:39:06 -0800581 usedResourceProcessor: a.useResourceProcessorBusyBox(ctx),
Colin Crossab8d1382023-07-14 17:23:41 +0000582 }).
583 Transitive(staticResourcesNodesDepSet).Build()
584 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
585 Direct(rroDirs...).
586 Transitive(staticRRODirsDepSet).Build()
587 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
588 Direct(a.manifestPath).
589 DirectSlice(additionalManifests).
590 Transitive(staticManifestsDepSet).Build()
591}
592
Colin Cross4eae06d2023-06-20 22:40:02 -0700593var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
594 blueprint.RuleParams{
595 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
596 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
597 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
598 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
599 Rspfile: "${out}.args",
600 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
601 Restat: true,
602 }, "rTxt", "manifest", "args")
603
604// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
605// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
606// supports producing classes for static dependencies that only include resources from that dependency.
607func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800608 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700609
610 var args []string
611 var deps android.Paths
612
613 if !isLibrary {
614 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
615 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
616 // package.
617 args, deps = transitiveDeps.resourceProcessorDeps()
618 } else {
619 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
620 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
621 // inlined into the library before the final IDs are assigned during app compilation.
622 args = append(args, "--finalFields=false")
623 }
624
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800625 for i, arg := range aaptFlags {
626 const AAPT_CUSTOM_PACKAGE = "--custom-package"
627 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
628 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
629 if pkg == "" && i+1 < len(aaptFlags) {
630 pkg = aaptFlags[i+1]
631 }
632 args = append(args, "--packageForR "+pkg)
633 }
634 }
635
Colin Cross4eae06d2023-06-20 22:40:02 -0700636 deps = append(deps, rTxt, manifest)
637
638 ctx.Build(pctx, android.BuildParams{
639 Rule: resourceProcessorBusyBox,
640 Output: rJar,
641 Implicits: deps,
642 Description: "ResourceProcessorBusyBox",
643 Args: map[string]string{
644 "rTxt": rTxt.String(),
645 "manifest": manifest.String(),
646 "args": strings.Join(args, " "),
647 },
648 })
649}
650
Colin Crossab8d1382023-07-14 17:23:41 +0000651type resourcesNode struct {
652 resPackage android.Path
653 manifest android.Path
654 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700655 rTxt android.Path
656 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000657 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700658
659 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000660}
661
662type transitiveAarDeps []*resourcesNode
663
664func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700665 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000666 for _, dep := range t {
667 paths = append(paths, dep.resPackage)
668 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700669 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000670}
671
672func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700673 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000674 for _, dep := range t {
675 paths = append(paths, dep.manifest)
676 paths = append(paths, dep.additionalManifests...)
677 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700678 return paths
679}
680
681func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
682 for _, dep := range t {
683 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
684 deps = append(deps, dep.rTxt, dep.manifest)
685 }
686 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000687}
688
689func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700690 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000691 for _, dep := range t {
692 if dep.assets.Valid() {
693 paths = append(paths, dep.assets.Path())
694 }
695 }
696 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700697}
698
699// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900700func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700701 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000702 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700703
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100704 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000705 // Not all callers need to compute class loader context, those who don't just pass nil.
706 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100707 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000708 }
709
Colin Cross83bb3162018-06-25 15:48:06 -0700710 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700711 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700712 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700713 }
714
Colin Cross8676c8c2023-10-12 15:58:57 -0700715 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
716 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000717 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
718 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
719
Colin Crossa97c5d32018-03-28 14:58:31 -0700720 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000721 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000722
Colin Crossa97c5d32018-03-28 14:58:31 -0700723 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700724 aarDep, _ := module.(AndroidLibraryDependency)
725 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700726 exportPackage = aarDep.ExportPackage()
727 }
728
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000729 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700730 case instrumentationForTag:
731 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400732 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700733 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700734 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700735 sharedLibs = append(sharedLibs, exportPackage)
736 }
Colin Cross5446e882019-05-22 10:46:27 -0700737 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700738 if exportPackage != nil {
739 sharedLibs = append(sharedLibs, exportPackage)
740 }
741 case staticLibTag:
742 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700743 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000744 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
745 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700746 }
747 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000748
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000749 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700750 })
751
Colin Crossab8d1382023-07-14 17:23:41 +0000752 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
753 // Reverse the dependency order now going into the depset so that it comes out in order after the second
754 // reverse later.
755 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
756 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
757 // dependency has to be listed last.
758 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700759 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
760 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
761 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700762
Colin Crossab8d1382023-07-14 17:23:41 +0000763 staticRRODirs = rroDirsDepSetBuilder.Build()
764 staticManifests = manifestsDepSetBuilder.Build()
765
766 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700767 flags = append(flags, "--auto-add-overlay")
768 }
769
770 for _, sharedLib := range sharedLibs {
771 flags = append(flags, "-I "+sharedLib.String())
772 }
773
Colin Cross8676c8c2023-10-12 15:58:57 -0700774 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700775}
776
777type AndroidLibrary struct {
778 Library
779 aapt
780
781 androidLibraryProperties androidLibraryProperties
782
783 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700784}
785
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000786var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
787
788// For OutputFileProducer interface
789func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
790 switch tag {
791 case ".aar":
792 return []android.Path{a.aarFile}, nil
793 default:
794 return a.Library.OutputFiles(tag)
795 }
796}
797
Colin Crossa97c5d32018-03-28 14:58:31 -0700798var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
799
800func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
801 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900802 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100803 if sdkDep.hasFrameworkLibs() {
804 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700805 }
Colin Cross4a80a152022-12-21 21:51:52 -0800806 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700807}
808
809func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800810 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100811 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Alixf7a10272023-09-27 16:47:56 +0000812 a.aapt.buildActions(ctx,
813 aaptBuildActionOptions{
814 sdkContext: android.SdkContext(a),
815 classLoaderContexts: a.classLoaderContexts,
816 enforceDefaultTargetSdkVersion: false,
817 },
818 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700819
Colin Crossff694a82023-12-13 15:54:49 -0800820 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
821 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700822
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000823 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
824
Colin Cross4eae06d2023-06-20 22:40:02 -0700825 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
826 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800827 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700828 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700829 } else {
830 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700831 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700832
833 // apps manifests are handled by aapt, don't let Module see them
834 a.properties.Manifest = nil
835
Colin Cross014489c2020-06-02 20:09:13 -0700836 a.linter.mergedManifest = a.aapt.mergedManifestFile
837 a.linter.manifest = a.aapt.manifestPath
838 a.linter.resources = a.aapt.resourceFiles
839
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000840 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800841 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800842 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
843 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
844 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
845
846 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
847 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
848 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700849
Colin Cross4eae06d2023-06-20 22:40:02 -0700850 var extraSrcJars android.Paths
851 var extraCombinedJars android.Paths
852 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800853 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700854 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
855 // library and each of the transitive static android_library dependencies has already created an
856 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
857 extraClasspathJars = a.transitiveAaptRJars
858 } else {
859 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
860 // R.java files for the library's package and the packages from all transitive static android_library
861 // dependencies. Compile the srcjar alongside the rest of the sources.
862 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
863 }
864
865 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700866
Colin Crossf57c5782019-01-25 13:20:38 -0800867 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700868 var res android.Paths
869 if a.androidLibraryProperties.BuildAAR {
870 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
871 ctx.CheckbuildFile(a.aarFile)
872 }
Colin Cross89c31582018-04-30 15:55:11 -0700873
Sam Delmerico82602492022-06-10 17:05:42 +0000874 prebuiltJniPackages := android.Paths{}
875 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800876 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000877 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
878 }
879 })
880 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800881 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000882 JniPackages: prebuiltJniPackages,
883 })
884 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700885}
886
Colin Cross95b53b82023-10-17 13:21:02 -0700887func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
888 a.Library.IDEInfo(dpInfo)
889 a.aapt.IDEInfo(dpInfo)
890}
891
892func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800893 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700894 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
895 }
896}
897
Colin Cross1b16b0e2019-02-12 14:41:32 -0800898// android_library builds and links sources into a `.jar` file for the device along with Android resources.
899//
900// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000901// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800902// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
903// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700904func AndroidLibraryFactory() android.Module {
905 module := &AndroidLibrary{}
906
Colin Crossce6734e2020-06-15 16:09:53 -0700907 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700908 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700909 &module.aaptProperties,
910 &module.androidLibraryProperties)
911
912 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700913 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700914
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900915 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700916 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700917 return module
918}
919
Colin Crossfabb6082018-02-20 17:22:23 -0800920//
921// AAR (android library) prebuilts
922//
Colin Crossfabb6082018-02-20 17:22:23 -0800923
Vinh Trance0781f2022-04-13 01:30:44 +0000924// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800925type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000926 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800927 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000928 // If not blank, set to the version of the sdk to compile against.
929 // Defaults to private.
930 // Values are of one of the following forms:
931 // 1) numerical API level, "current", "none", or "core_platform"
932 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
933 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
934 // If the SDK kind is empty, it will be set to public
935 Sdk_version *string
936 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
937 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700938 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000939 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700940 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000941 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
942 Libs []string
943 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700944 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000945 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
946 // will be passed transitively through android_libraries to an android_app.
947 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
948 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800949}
950
951type AARImport struct {
952 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700953 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900954 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800955 prebuilt android.Prebuilt
956
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900957 // Functionality common to Module and Import.
958 embeddableInModuleAndImport
959
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500960 providesTransitiveHeaderJars
961
Colin Crossfabb6082018-02-20 17:22:23 -0800962 properties AARImportProperties
963
Colin Cross312634e2023-11-21 15:13:56 -0800964 classpathFile android.WritablePath
965 proguardFlags android.WritablePath
966 exportPackage android.WritablePath
967 transitiveAaptResourcePackagesFile android.Path
968 extraAaptPackagesFile android.WritablePath
969 manifest android.WritablePath
970 assetsPackage android.WritablePath
971 rTxt android.WritablePath
972 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700973
Colin Crossab8d1382023-07-14 17:23:41 +0000974 resourcesNodesDepSet *android.DepSet[*resourcesNode]
975 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700976
977 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000978
Sam Delmerico82602492022-06-10 17:05:42 +0000979 aarPath android.Path
980 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900981
982 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000983 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000984
985 // Single aconfig "cache file" merged from this module and all dependencies.
986 mergedAconfigFiles map[string]android.Paths
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000987}
988
989var _ android.OutputFileProducer = (*AARImport)(nil)
990
991// For OutputFileProducer interface
992func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
993 switch tag {
994 case ".aar":
995 return []android.Path{a.aarPath}, nil
996 case "":
997 return []android.Path{a.classpathFile}, nil
998 default:
999 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
1000 }
Colin Crossfabb6082018-02-20 17:22:23 -08001001}
1002
Jiyong Park92315372021-04-02 08:45:46 +09001003func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1004 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07001005}
1006
Jiyong Parkf1691d22021-03-29 20:11:58 +09001007func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001008 return ""
1009}
1010
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001011func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001012 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001013 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001014 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001015 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001016}
1017
Spandan Dasa26eda72023-03-02 00:56:06 +00001018func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1019 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001020}
1021
Spandan Dasca70fc42023-03-01 23:38:49 +00001022func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1023 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001024}
1025
Colin Cross1e743852019-10-28 11:37:20 -07001026func (a *AARImport) javaVersion() string {
1027 return ""
1028}
1029
Colin Crossa97c5d32018-03-28 14:58:31 -07001030var _ AndroidLibraryDependency = (*AARImport)(nil)
1031
1032func (a *AARImport) ExportPackage() android.Path {
1033 return a.exportPackage
1034}
Colin Crossab8d1382023-07-14 17:23:41 +00001035func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1036 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001037}
1038
Colin Crossab8d1382023-07-14 17:23:41 +00001039func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1040 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001041}
1042
Colin Crossab8d1382023-07-14 17:23:41 +00001043func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1044 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001045}
1046
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001047// RRO enforcement is not available on aar_import since its RRO dirs are not
1048// exported.
1049func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1050}
1051
1052// RRO enforcement is not available on aar_import since its RRO dirs are not
1053// exported.
1054func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1055 return false
1056}
1057
Colin Crossfabb6082018-02-20 17:22:23 -08001058func (a *AARImport) Prebuilt() *android.Prebuilt {
1059 return &a.prebuilt
1060}
1061
1062func (a *AARImport) Name() string {
1063 return a.prebuilt.Name(a.ModuleBase.Name())
1064}
1065
Jiyong Park618922e2020-01-08 13:35:43 +09001066func (a *AARImport) JacocoReportClassesFile() android.Path {
1067 return nil
1068}
1069
Colin Crossfabb6082018-02-20 17:22:23 -08001070func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001071 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001072 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001073 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001074 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001075 }
1076 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001077
Colin Cross42d48b72018-08-29 14:10:52 -07001078 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1079 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001080}
1081
Sam Delmerico82602492022-06-10 17:05:42 +00001082type JniPackageInfo struct {
1083 // List of zip files containing JNI libraries
1084 // Zip files should have directory structure jni/<arch>/*.so
1085 JniPackages android.Paths
1086}
1087
Colin Crossbc7d76c2023-12-12 16:39:03 -08001088var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001089
1090// Unzip an AAR and extract the JNI libs for $archString.
1091var extractJNI = pctx.AndroidStaticRule("extractJNI",
1092 blueprint.RuleParams{
1093 Command: `rm -rf $out $outDir && touch $out && ` +
1094 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1095 `jni_files=$$(find $outDir/jni -type f) && ` +
1096 // print error message if there are no JNI libs for this arch
1097 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001098 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001099 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1100 CommandDeps: []string{"${config.SoongZipCmd}"},
1101 },
1102 "outDir", "archString")
1103
Colin Crossfabb6082018-02-20 17:22:23 -08001104// 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 -07001105// 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 -08001106var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1107 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001108 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001109 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001110 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001111 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001112 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001113 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001114 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001115
1116func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1117 if len(a.properties.Aars) != 1 {
1118 ctx.PropertyErrorf("aars", "exactly one aar is required")
1119 return
1120 }
1121
Jiyong Park92315372021-04-02 08:45:46 +09001122 a.sdkVersion = a.SdkVersion(ctx)
1123 a.minSdkVersion = a.MinSdkVersion(ctx)
1124
Colin Crossff694a82023-12-13 15:54:49 -08001125 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1126 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001127
Nan Zhang4c819fb2018-08-27 18:31:46 -07001128 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001129 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1130
Colin Cross1001a792019-03-21 22:21:39 -07001131 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001132 inputFile := a.aarPath
1133 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1134 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001135 }
Colin Crossfabb6082018-02-20 17:22:23 -08001136
1137 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001138 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001139 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Cross4eae06d2023-06-20 22:40:02 -07001140 aarRTxt := extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001141 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001142 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001143 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001144 ProguardFlagsFiles: android.NewDepSet[android.Path](
1145 android.POSTORDER,
1146 android.Paths{a.proguardFlags},
1147 nil,
1148 ),
1149 })
Colin Crossfabb6082018-02-20 17:22:23 -08001150
1151 ctx.Build(pctx, android.BuildParams{
1152 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001153 Input: a.aarPath,
Colin Cross4eae06d2023-06-20 22:40:02 -07001154 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, aarRTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001155 Description: "unzip AAR",
1156 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001157 "outDir": extractedAARDir.String(),
1158 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001159 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001160 },
1161 })
1162
Colin Crossa0ba2f52019-06-22 12:59:27 -07001163 // Always set --pseudo-localize, it will be stripped out later for release
1164 // builds that don't want it.
1165 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001166 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001167 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001168 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001169
1170 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001171 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Cross4eae06d2023-06-20 22:40:02 -07001172 a.rTxt = android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001173 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001174
1175 var linkDeps android.Paths
1176
1177 linkFlags := []string{
1178 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001179 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001180 "--auto-add-overlay",
1181 }
1182
Colin Cross10f7c4a2018-05-23 10:59:28 -07001183 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1184 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001185
Colin Cross8676c8c2023-10-12 15:58:57 -07001186 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001187 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001188
Colin Cross8676c8c2023-10-12 15:58:57 -07001189 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001190 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001191
Colin Crossab8d1382023-07-14 17:23:41 +00001192 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001193
Colin Crossab8d1382023-07-14 17:23:41 +00001194 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001195 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001196 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001197
Colin Cross4eae06d2023-06-20 22:40:02 -07001198 overlayRes := android.Paths{flata}
1199
1200 // Treat static library dependencies of static libraries as imports.
1201 transitiveStaticLibs := staticDeps.resPackages()
1202 linkDeps = append(linkDeps, transitiveStaticLibs...)
1203 for _, staticLib := range transitiveStaticLibs {
1204 linkFlags = append(linkFlags, "-I "+staticLib.String())
1205 }
Colin Crossfabb6082018-02-20 17:22:23 -08001206
Colin Crossab8d1382023-07-14 17:23:41 +00001207 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossf3b7bad2023-08-02 15:49:00 -07001208 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, a.rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001209 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001210
Colin Cross4eae06d2023-06-20 22:40:02 -07001211 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -08001212 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true, nil)
Colin Cross4eae06d2023-06-20 22:40:02 -07001213
Colin Crossf3b7bad2023-08-02 15:49:00 -07001214 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1215
Colin Crossab8d1382023-07-14 17:23:41 +00001216 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1217 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1218 resPackage: a.exportPackage,
1219 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001220 rTxt: a.rTxt,
1221 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001222 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001223
1224 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001225 })
1226 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1227 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1228
1229 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
1230 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
1231 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
1232 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
1233 // android_library_import modules. If this is fixed, AndroidLibraryDependency.ManifestsDepSet can be dropped
1234 // completely in favor of AndroidLibraryDependency.ResourceNodesDepSet.manifest
1235 //manifestDepSetBuilder.Transitive(transitiveStaticDeps.manifests)
1236 _ = staticManifestsDepSet
1237 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001238
Colin Cross312634e2023-11-21 15:13:56 -08001239 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1240 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1241 return p == a.exportPackage.String()
1242 })
1243 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1244 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1245 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001246
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001247 a.collectTransitiveHeaderJars(ctx)
Colin Cross40213022023-12-13 15:19:49 -08001248 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Crossdcf71b22021-02-01 13:59:03 -08001249 HeaderJars: android.PathsIfNonNil(a.classpathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001250 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1251 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08001252 ImplementationAndResourcesJars: android.PathsIfNonNil(a.classpathFile),
1253 ImplementationJars: android.PathsIfNonNil(a.classpathFile),
Jihoon Kangfe914ed2024-02-12 22:49:21 +00001254 StubsLinkType: Implementation,
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001255 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001256 })
Sam Delmerico82602492022-06-10 17:05:42 +00001257
1258 if proptools.Bool(a.properties.Extract_jni) {
1259 for _, t := range ctx.MultiTargets() {
1260 arch := t.Arch.Abi[0]
1261 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1262 a.jniPackages = append(a.jniPackages, path)
1263
1264 outDir := android.PathForModuleOut(ctx, "aarForJni")
1265 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1266 ctx.Build(pctx, android.BuildParams{
1267 Rule: extractJNI,
1268 Input: aarPath,
1269 Outputs: android.WritablePaths{path},
1270 Description: "extract JNI from AAR",
1271 Args: map[string]string{
1272 "outDir": outDir.String(),
1273 "archString": arch,
1274 },
1275 })
1276 }
Sam Delmerico82602492022-06-10 17:05:42 +00001277 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001278
Colin Cross40213022023-12-13 15:19:49 -08001279 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001280 JniPackages: a.jniPackages,
1281 })
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001282 android.CollectDependencyAconfigFiles(ctx, &a.mergedAconfigFiles)
Colin Crossdcf71b22021-02-01 13:59:03 -08001283}
Colin Crossfabb6082018-02-20 17:22:23 -08001284
1285func (a *AARImport) HeaderJars() android.Paths {
1286 return android.Paths{a.classpathFile}
1287}
1288
Colin Cross331a1212018-08-15 20:40:52 -07001289func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
1290 return android.Paths{a.classpathFile}
1291}
1292
Spandan Das59a4a2b2024-01-09 21:35:56 +00001293func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001294 return nil
1295}
1296
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001297func (a *AARImport) DexJarInstallPath() android.Path {
1298 return nil
1299}
1300
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001301func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Jiyong Park1be96912018-05-28 18:02:19 +09001302 return nil
1303}
1304
Jiyong Park45bf82e2020-12-15 22:29:02 +09001305var _ android.ApexModule = (*AARImport)(nil)
1306
1307// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001308func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1309 return a.depIsInSameApex(ctx, dep)
1310}
1311
Jiyong Park45bf82e2020-12-15 22:29:02 +09001312// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07001313func (g *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1314 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001315 return nil
1316}
1317
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001318var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001319
Colin Cross1b16b0e2019-02-12 14:41:32 -08001320// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1321//
1322// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1323// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001324func AARImportFactory() android.Module {
1325 module := &AARImport{}
1326
1327 module.AddProperties(&module.properties)
1328
1329 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001330 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001331 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001332 return module
1333}