blob: 5f9f36073c9bac3d8b1cb2421deac40bb1e73514 [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
Eric Miao40eab202023-03-30 16:57:17 +0000207 linkFlags = append(linkFlags, "--enable-compact-entries")
Colin Crossa97c5d32018-03-28 14:58:31 -0700208
209 // Find implicit or explicit asset and resource dirs
Jiakai Zhangba82e282023-10-13 18:08:59 +0100210 assets := android.PathsRelativeToModuleSourceDir(android.SourceInput{
211 Context: ctx,
212 Paths: a.aaptProperties.Assets,
213 IncludeDirs: false,
214 })
Colin Crossa97c5d32018-03-28 14:58:31 -0700215 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
216 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800217 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700218
Colin Crossa97c5d32018-03-28 14:58:31 -0700219 // Glob directories into lists of paths
220 for _, dir := range resourceDirs {
221 resDirs = append(resDirs, globbedResourceDir{
222 dir: dir,
223 files: androidResourceGlob(ctx, dir),
224 })
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700225 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, a, dir)
Colin Crossa97c5d32018-03-28 14:58:31 -0700226 overlayDirs = append(overlayDirs, resOverlayDirs...)
227 rroDirs = append(rroDirs, resRRODirs...)
228 }
229
Colin Crossc20dc852020-11-10 12:27:45 -0800230 var assetDeps android.Paths
231 for i, dir := range assetDirs {
232 // Add a dependency on every file in the asset directory. This ensures the aapt2
233 // rule will be rerun if one of the files in the asset directory is modified.
234 assetDeps = append(assetDeps, androidResourceGlob(ctx, dir)...)
235
236 // Add a dependency on a file that contains a list of all the files in the asset directory.
237 // This ensures the aapt2 rule will be run if a file is removed from the asset directory,
238 // or a file is added whose timestamp is older than the output of aapt2.
239 assetFileListFile := android.PathForModuleOut(ctx, "asset_dir_globs", strconv.Itoa(i)+".glob")
240 androidResourceGlobList(ctx, dir, assetFileListFile)
241 assetDeps = append(assetDeps, assetFileListFile)
Colin Crossa97c5d32018-03-28 14:58:31 -0700242 }
243
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700244 assetDirStrings := assetDirs.Strings()
245 if a.noticeFile.Valid() {
246 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
Colin Crossc20dc852020-11-10 12:27:45 -0800247 assetDeps = append(assetDeps, a.noticeFile.Path())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700248 }
Jiakai Zhangba82e282023-10-13 18:08:59 +0100249 if len(assets) > 0 {
250 // aapt2 doesn't support adding individual asset files. Create a temp directory to hold asset
251 // files and pass it to aapt2.
252 tmpAssetDir := android.PathForModuleOut(ctx, "tmp_asset_dir")
253
254 rule := android.NewRuleBuilder(pctx, ctx)
255 rule.Command().
256 Text("rm -rf").Text(tmpAssetDir.String()).
257 Text("&&").
258 Text("mkdir -p").Text(tmpAssetDir.String())
259
260 for _, asset := range assets {
261 output := tmpAssetDir.Join(ctx, asset.Rel())
262 assetDeps = append(assetDeps, output)
263 rule.Command().Text("mkdir -p").Text(filepath.Dir(output.String()))
264 rule.Command().Text("cp").Input(asset).Output(output)
265 }
266
267 rule.Build("tmp_asset_dir", "tmp_asset_dir")
268
269 assetDirStrings = append(assetDirStrings, tmpAssetDir.String())
270 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700271
Colin Crossa97c5d32018-03-28 14:58:31 -0700272 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
273 linkDeps = append(linkDeps, manifestPath)
274
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700275 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossc20dc852020-11-10 12:27:45 -0800276 linkDeps = append(linkDeps, assetDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700277
Spandan Das50885c02023-02-23 21:31:33 +0000278 // Returns the effective version for {min|target}_sdk_version
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000279 effectiveVersionString := func(sdkVersion android.SdkSpec, minSdkVersion android.ApiLevel) string {
Spandan Das50885c02023-02-23 21:31:33 +0000280 // If {min|target}_sdk_version is current, use sdk_version to determine the effective level
281 // This is necessary for vendor modules.
282 // The effective version does not _only_ depend on {min|target}_sdk_version(level),
283 // but also on the sdk_version (kind+level)
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000284 if minSdkVersion.IsCurrent() {
Spandan Das50885c02023-02-23 21:31:33 +0000285 ret, err := sdkVersion.EffectiveVersionString(ctx)
286 if err != nil {
287 ctx.ModuleErrorf("invalid sdk_version: %s", err)
288 }
289 return ret
290 }
291 ret, err := minSdkVersion.EffectiveVersionString(ctx)
292 if err != nil {
293 ctx.ModuleErrorf("invalid min_sdk_version: %s", err)
294 }
295 return ret
Jiyong Park6a927c42020-01-21 02:03:43 +0900296 }
Spandan Das50885c02023-02-23 21:31:33 +0000297 // SDK version flags
298 sdkVersion := sdkContext.SdkVersion(ctx)
299 minSdkVersion := effectiveVersionString(sdkVersion, sdkContext.MinSdkVersion(ctx))
Colin Crossa97c5d32018-03-28 14:58:31 -0700300
Colin Cross83bb3162018-06-25 15:48:06 -0700301 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
Spandan Das6450b552023-02-23 19:27:07 +0000302 // Use minSdkVersion for target-sdk-version, even if `target_sdk_version` is set
303 // This behavior has been copied from Make.
Colin Cross83bb3162018-06-25 15:48:06 -0700304 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700305
Colin Crossa97c5d32018-03-28 14:58:31 -0700306 // Version code
307 if !hasVersionCode {
Dan Albert4f378d72020-07-23 17:32:15 -0700308 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion().String())
Colin Crossa97c5d32018-03-28 14:58:31 -0700309 }
310
311 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700312 var versionName string
313 if ctx.ModuleName() == "framework-res" {
314 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
315 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700316 // if it contains the build number. Use the PlatformVersionName instead.
317 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700318 } else {
319 versionName = ctx.Config().AppsDefaultVersionName()
320 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800321 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700322 linkFlags = append(linkFlags, "--version-name ", versionName)
323 }
324
Colin Crossa0ba2f52019-06-22 12:59:27 -0700325 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
326
327 // Always set --pseudo-localize, it will be stripped out later for release
328 // builds that don't want it.
329 compileFlags = append(compileFlags, "--pseudo-localize")
330
331 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700332}
333
Paul Duffin250e6192019-06-07 10:44:37 +0100334func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800335 if sdkDep.frameworkResModule != "" {
336 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700337 }
338}
339
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800340var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
341 blueprint.RuleParams{
342 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
343 CommandDeps: []string{"${config.Zip2ZipCmd}"},
344 })
345
Alixf7a10272023-09-27 16:47:56 +0000346type aaptBuildActionOptions struct {
347 sdkContext android.SdkContext
348 classLoaderContexts dexpreopt.ClassLoaderContextMap
349 excludedLibs []string
350 enforceDefaultTargetSdkVersion bool
351 extraLinkFlags []string
Jihoon Kang84b25892023-12-01 22:01:06 +0000352 aconfigTextFiles android.Paths
Alixf7a10272023-09-27 16:47:56 +0000353}
354
355func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700356
Colin Cross8676c8c2023-10-12 15:58:57 -0700357 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Alixf7a10272023-09-27 16:47:56 +0000358 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100359
Paul Duffin06530572022-02-03 17:54:15 +0000360 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000361 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000362
Colin Cross31656952018-05-24 16:11:20 -0700363 // App manifest file
364 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
365 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
366
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000367 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000368 SdkContext: opts.sdkContext,
369 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000370 IsLibrary: a.isLibrary,
371 DefaultManifestVersion: a.defaultManifestVersion,
372 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
373 UsesNonSdkApis: a.usesNonSdkApis,
374 UseEmbeddedDex: a.useEmbeddedDex,
375 HasNoCode: a.hasNoCode,
376 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000377 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000378 })
Colin Cross90c25c62019-04-19 16:22:57 -0700379
Colin Crossab8d1382023-07-14 17:23:41 +0000380 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700381 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000382
Luca Stefanifd898822019-09-10 22:13:31 +0200383 // Add additional manifest files to transitive manifests.
384 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000385 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
386 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
387 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
388 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
389 // android_library_import modules. If this is fixed, staticManifestsDepSet can be dropped completely in favor of
390 // staticResourcesNodesDepSet.manifests()
391 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700392
Colin Crossab8d1382023-07-14 17:23:41 +0000393 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000394 manifestMergerParams := ManifestMergerParams{
395 staticLibManifests: transitiveManifestPaths[1:],
Alix96ea88452023-08-31 15:48:23 +0000396 isLibrary: a.isLibrary,
397 packageName: a.manifestValues.applicationId,
398 }
Alixf7a10272023-09-27 16:47:56 +0000399 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700400 if !a.isLibrary {
401 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
402 // will be propagated to the final application and merged there. The merged manifest for libraries is
403 // only passed to Make, which can't handle transitive dependencies.
404 manifestPath = a.mergedManifestFile
405 }
406 } else {
407 a.mergedManifestFile = manifestPath
408 }
Colin Cross31656952018-05-24 16:11:20 -0700409
Alixf7a10272023-09-27 16:47:56 +0000410 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700411
412 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700413 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000414 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000415 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700416 if a.isLibrary {
417 linkFlags = append(linkFlags, "--static-lib")
418 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700419
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800420 linkFlags = append(linkFlags, "--no-static-lib-packages")
Colin Cross8f1b0332024-01-25 13:39:06 -0800421 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800422 // When building an android_library using ResourceProcessorBusyBox pass --merge-only to skip resource
423 // references validation until the final app link step when all static libraries are present.
Colin Cross4eae06d2023-06-20 22:40:02 -0700424 linkFlags = append(linkFlags, "--merge-only")
Colin Cross4eae06d2023-06-20 22:40:02 -0700425 }
426
Colin Crossa97c5d32018-03-28 14:58:31 -0700427 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700428 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
429 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700430 // This file isn't used by Soong, but is generated for exporting
431 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700432 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700433 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700434
Colin Cross4aaa84a2018-08-21 15:14:37 -0700435 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700436 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700437 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900438 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700439 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700440
Colin Crossa592e3e2019-02-19 16:59:53 -0800441 for i, zip := range resZips {
442 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700443 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800444 compiledResDirs = append(compiledResDirs, android.Paths{flata})
445 }
446
Colin Cross4aaa84a2018-08-21 15:14:37 -0700447 var compiledRes, compiledOverlay android.Paths
448
Colin Crossab8d1382023-07-14 17:23:41 +0000449 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
450 // of transitiveStaticLibs.
451 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
452
Colin Cross8f1b0332024-01-25 13:39:06 -0800453 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700454 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
455 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
456 // instead modules depending on this module will reference package-res.apk from all transitive static
457 // dependencies.
Colin Cross1d3f5902024-03-05 11:51:54 -0800458 for _, sharedDep := range sharedDeps {
459 if sharedDep.usedResourceProcessor {
460 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
461 }
462 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700463 for _, staticDep := range staticDeps {
464 linkDeps = append(linkDeps, staticDep.resPackage)
465 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
466 if staticDep.usedResourceProcessor {
467 transitiveRJars = append(transitiveRJars, staticDep.rJar)
468 }
469 }
470 } else {
471 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
472 // dependencies are compiled into this module's package-res.apk as overlays.
473 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
474 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700475
Colin Crossbec85302019-02-13 13:15:46 -0800476 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700477 // If we are using static android libraries, every source file becomes an overlay.
478 // This is to emulate old AAPT behavior which simulated library support.
479 for _, compiledResDir := range compiledResDirs {
480 compiledOverlay = append(compiledOverlay, compiledResDir...)
481 }
Colin Crossbec85302019-02-13 13:15:46 -0800482 } else if a.isLibrary {
483 // Otherwise, for a static library we treat all the resources equally with no overlay.
484 for _, compiledResDir := range compiledResDirs {
485 compiledRes = append(compiledRes, compiledResDir...)
486 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700487 } else if len(compiledResDirs) > 0 {
488 // Without static libraries, the first directory is our directory, which can then be
489 // overlaid by the rest.
490 compiledRes = append(compiledRes, compiledResDirs[0]...)
491 for _, compiledResDir := range compiledResDirs[1:] {
492 compiledOverlay = append(compiledOverlay, compiledResDir...)
493 }
494 }
495
Colin Crossa97c5d32018-03-28 14:58:31 -0700496 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900497 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700498 }
499
Colin Crosse560c4a2019-03-19 16:03:11 -0700500 var splitPackages android.WritablePaths
501 var splits []split
502
503 for _, s := range a.splitNames {
504 suffix := strings.Replace(s, ",", "_", -1)
505 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
506 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
507 splitPackages = append(splitPackages, path)
508 splits = append(splits, split{
509 name: s,
510 suffix: suffix,
511 path: path,
512 })
513 }
514
Colin Cross8f1b0332024-01-25 13:39:06 -0800515 if !a.useResourceProcessorBusyBox(ctx) {
Colin Crossf3b7bad2023-08-02 15:49:00 -0700516 // the subdir "android" is required to be filtered by package names
517 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
518 }
519
Colin Crossab8d1382023-07-14 17:23:41 +0000520 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
521 // provided to the final app aapt2Link step.
522 var transitiveAssets android.Paths
523 if !a.isLibrary {
524 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
525 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700526 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000527 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
528 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800529 // Extract assets from the resource package output so that they can be used later in aapt2link
530 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000531 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800532 assets := android.PathForModuleOut(ctx, "assets.zip")
533 ctx.Build(pctx, android.BuildParams{
534 Rule: extractAssetsRule,
535 Input: packageRes,
536 Output: assets,
537 Description: "extract assets from built resource file",
538 })
539 a.assetPackage = android.OptionalPathForPath(assets)
540 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700541
Colin Cross8f1b0332024-01-25 13:39:06 -0800542 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700543 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800544 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700545 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700546 transitiveRJars = append(transitiveRJars, rJar)
547 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700548 } else {
549 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700550 }
551
Colin Cross312634e2023-11-21 15:13:56 -0800552 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
553 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
554 return p == packageRes.String()
555 })
556 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
557 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
558
Colin Cross1d3f5902024-03-05 11:51:54 -0800559 // Reverse the list of R.jar files so that the current module comes first, and direct dependencies come before
560 // transitive dependencies.
561 transitiveRJars = android.ReversePaths(transitiveRJars)
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)
Spandan Das0727ba72024-02-13 16:37:43 +0000812 if a.usesLibrary.shouldDisableDexpreopt {
813 a.dexpreopter.disableDexpreopt()
814 }
Alixf7a10272023-09-27 16:47:56 +0000815 a.aapt.buildActions(ctx,
816 aaptBuildActionOptions{
817 sdkContext: android.SdkContext(a),
818 classLoaderContexts: a.classLoaderContexts,
819 enforceDefaultTargetSdkVersion: false,
820 },
821 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700822
Colin Crossff694a82023-12-13 15:54:49 -0800823 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
824 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700825
yangbill2af0b6e2024-03-15 09:29:29 +0000826 a.stem = proptools.StringDefault(a.overridableProperties.Stem, ctx.ModuleName())
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000827
Colin Cross4eae06d2023-06-20 22:40:02 -0700828 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
829 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800830 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700831 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700832 } else {
833 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700834 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700835
836 // apps manifests are handled by aapt, don't let Module see them
837 a.properties.Manifest = nil
838
Colin Cross014489c2020-06-02 20:09:13 -0700839 a.linter.mergedManifest = a.aapt.mergedManifestFile
840 a.linter.manifest = a.aapt.manifestPath
841 a.linter.resources = a.aapt.resourceFiles
842
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000843 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800844 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800845 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
846 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
847 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
848
849 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
850 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
851 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700852
Colin Cross4eae06d2023-06-20 22:40:02 -0700853 var extraSrcJars android.Paths
854 var extraCombinedJars android.Paths
855 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800856 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700857 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
858 // library and each of the transitive static android_library dependencies has already created an
859 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
860 extraClasspathJars = a.transitiveAaptRJars
861 } else {
862 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
863 // R.java files for the library's package and the packages from all transitive static android_library
864 // dependencies. Compile the srcjar alongside the rest of the sources.
865 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
866 }
867
868 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700869
Colin Crossf57c5782019-01-25 13:20:38 -0800870 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700871 var res android.Paths
872 if a.androidLibraryProperties.BuildAAR {
873 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
874 ctx.CheckbuildFile(a.aarFile)
875 }
Colin Cross89c31582018-04-30 15:55:11 -0700876
Sam Delmerico82602492022-06-10 17:05:42 +0000877 prebuiltJniPackages := android.Paths{}
878 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800879 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000880 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
881 }
882 })
883 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800884 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000885 JniPackages: prebuiltJniPackages,
886 })
887 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700888}
889
Colin Cross95b53b82023-10-17 13:21:02 -0700890func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
891 a.Library.IDEInfo(dpInfo)
892 a.aapt.IDEInfo(dpInfo)
893}
894
895func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800896 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700897 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
898 }
899}
900
Colin Cross1b16b0e2019-02-12 14:41:32 -0800901// android_library builds and links sources into a `.jar` file for the device along with Android resources.
902//
903// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000904// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800905// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
906// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700907func AndroidLibraryFactory() android.Module {
908 module := &AndroidLibrary{}
909
Colin Crossce6734e2020-06-15 16:09:53 -0700910 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700911 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700912 &module.aaptProperties,
913 &module.androidLibraryProperties)
914
915 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700916 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700917
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900918 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700919 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700920 return module
921}
922
Colin Crossfabb6082018-02-20 17:22:23 -0800923//
924// AAR (android library) prebuilts
925//
Colin Crossfabb6082018-02-20 17:22:23 -0800926
Vinh Trance0781f2022-04-13 01:30:44 +0000927// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800928type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000929 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800930 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000931 // If not blank, set to the version of the sdk to compile against.
932 // Defaults to private.
933 // Values are of one of the following forms:
934 // 1) numerical API level, "current", "none", or "core_platform"
935 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
936 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
937 // If the SDK kind is empty, it will be set to public
938 Sdk_version *string
939 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
940 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700941 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000942 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700943 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000944 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
945 Libs []string
946 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700947 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000948 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
949 // will be passed transitively through android_libraries to an android_app.
950 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
951 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800952}
953
954type AARImport struct {
955 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700956 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900957 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800958 prebuilt android.Prebuilt
959
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900960 // Functionality common to Module and Import.
961 embeddableInModuleAndImport
962
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500963 providesTransitiveHeaderJars
964
Colin Crossfabb6082018-02-20 17:22:23 -0800965 properties AARImportProperties
966
Colin Cross312634e2023-11-21 15:13:56 -0800967 classpathFile android.WritablePath
968 proguardFlags android.WritablePath
969 exportPackage android.WritablePath
970 transitiveAaptResourcePackagesFile android.Path
971 extraAaptPackagesFile android.WritablePath
972 manifest android.WritablePath
973 assetsPackage android.WritablePath
974 rTxt android.WritablePath
975 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700976
Colin Crossab8d1382023-07-14 17:23:41 +0000977 resourcesNodesDepSet *android.DepSet[*resourcesNode]
978 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700979
980 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000981
Sam Delmerico82602492022-06-10 17:05:42 +0000982 aarPath android.Path
983 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900984
985 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000986 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000987
988 // Single aconfig "cache file" merged from this module and all dependencies.
989 mergedAconfigFiles map[string]android.Paths
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000990}
991
992var _ android.OutputFileProducer = (*AARImport)(nil)
993
994// For OutputFileProducer interface
995func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
996 switch tag {
997 case ".aar":
998 return []android.Path{a.aarPath}, nil
999 case "":
1000 return []android.Path{a.classpathFile}, nil
1001 default:
1002 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
1003 }
Colin Crossfabb6082018-02-20 17:22:23 -08001004}
1005
Jiyong Park92315372021-04-02 08:45:46 +09001006func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1007 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07001008}
1009
Jiyong Parkf1691d22021-03-29 20:11:58 +09001010func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001011 return ""
1012}
1013
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001014func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001015 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001016 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001017 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001018 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001019}
1020
Spandan Dasa26eda72023-03-02 00:56:06 +00001021func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1022 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001023}
1024
Spandan Dasca70fc42023-03-01 23:38:49 +00001025func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1026 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001027}
1028
Colin Cross1e743852019-10-28 11:37:20 -07001029func (a *AARImport) javaVersion() string {
1030 return ""
1031}
1032
Colin Crossa97c5d32018-03-28 14:58:31 -07001033var _ AndroidLibraryDependency = (*AARImport)(nil)
1034
1035func (a *AARImport) ExportPackage() android.Path {
1036 return a.exportPackage
1037}
Colin Crossab8d1382023-07-14 17:23:41 +00001038func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1039 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001040}
1041
Colin Crossab8d1382023-07-14 17:23:41 +00001042func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1043 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001044}
1045
Colin Crossab8d1382023-07-14 17:23:41 +00001046func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1047 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001048}
1049
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001050// RRO enforcement is not available on aar_import since its RRO dirs are not
1051// exported.
1052func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1053}
1054
1055// RRO enforcement is not available on aar_import since its RRO dirs are not
1056// exported.
1057func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1058 return false
1059}
1060
Colin Crossfabb6082018-02-20 17:22:23 -08001061func (a *AARImport) Prebuilt() *android.Prebuilt {
1062 return &a.prebuilt
1063}
1064
1065func (a *AARImport) Name() string {
1066 return a.prebuilt.Name(a.ModuleBase.Name())
1067}
1068
Jiyong Park618922e2020-01-08 13:35:43 +09001069func (a *AARImport) JacocoReportClassesFile() android.Path {
1070 return nil
1071}
1072
Colin Crossfabb6082018-02-20 17:22:23 -08001073func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001074 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001075 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001076 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001077 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001078 }
1079 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001080
Colin Cross42d48b72018-08-29 14:10:52 -07001081 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1082 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001083}
1084
Sam Delmerico82602492022-06-10 17:05:42 +00001085type JniPackageInfo struct {
1086 // List of zip files containing JNI libraries
1087 // Zip files should have directory structure jni/<arch>/*.so
1088 JniPackages android.Paths
1089}
1090
Colin Crossbc7d76c2023-12-12 16:39:03 -08001091var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001092
1093// Unzip an AAR and extract the JNI libs for $archString.
1094var extractJNI = pctx.AndroidStaticRule("extractJNI",
1095 blueprint.RuleParams{
1096 Command: `rm -rf $out $outDir && touch $out && ` +
1097 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1098 `jni_files=$$(find $outDir/jni -type f) && ` +
1099 // print error message if there are no JNI libs for this arch
1100 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001101 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001102 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1103 CommandDeps: []string{"${config.SoongZipCmd}"},
1104 },
1105 "outDir", "archString")
1106
Colin Crossfabb6082018-02-20 17:22:23 -08001107// 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 -07001108// 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 -08001109var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1110 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001111 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001112 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001113 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001114 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001115 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001116 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001117 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001118
1119func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1120 if len(a.properties.Aars) != 1 {
1121 ctx.PropertyErrorf("aars", "exactly one aar is required")
1122 return
1123 }
1124
Jiyong Park92315372021-04-02 08:45:46 +09001125 a.sdkVersion = a.SdkVersion(ctx)
1126 a.minSdkVersion = a.MinSdkVersion(ctx)
1127
Colin Crossff694a82023-12-13 15:54:49 -08001128 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1129 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001130
Nan Zhang4c819fb2018-08-27 18:31:46 -07001131 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001132 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1133
Colin Cross1001a792019-03-21 22:21:39 -07001134 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001135 inputFile := a.aarPath
1136 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1137 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001138 }
Colin Crossfabb6082018-02-20 17:22:23 -08001139
1140 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001141 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001142 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001143 a.rTxt = extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001144 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001145 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001146 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001147 ProguardFlagsFiles: android.NewDepSet[android.Path](
1148 android.POSTORDER,
1149 android.Paths{a.proguardFlags},
1150 nil,
1151 ),
1152 })
Colin Crossfabb6082018-02-20 17:22:23 -08001153
1154 ctx.Build(pctx, android.BuildParams{
1155 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001156 Input: a.aarPath,
Colin Crossbb77d8e2024-02-15 14:43:47 -08001157 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, a.rTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001158 Description: "unzip AAR",
1159 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001160 "outDir": extractedAARDir.String(),
1161 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001162 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001163 },
1164 })
1165
Colin Crossa0ba2f52019-06-22 12:59:27 -07001166 // Always set --pseudo-localize, it will be stripped out later for release
1167 // builds that don't want it.
1168 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001169 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001170 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001171 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001172
1173 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001174 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001175 aaptRTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001176 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001177
1178 var linkDeps android.Paths
1179
1180 linkFlags := []string{
1181 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001182 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001183 "--auto-add-overlay",
Colin Cross7c4dc5d2024-02-13 14:29:45 -08001184 "--no-static-lib-packages",
Colin Crossfabb6082018-02-20 17:22:23 -08001185 }
1186
Colin Cross10f7c4a2018-05-23 10:59:28 -07001187 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1188 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001189
Colin Cross8676c8c2023-10-12 15:58:57 -07001190 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001191 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001192
Colin Cross8676c8c2023-10-12 15:58:57 -07001193 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001194 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001195
Colin Crossab8d1382023-07-14 17:23:41 +00001196 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001197
Colin Crossab8d1382023-07-14 17:23:41 +00001198 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001199 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001200 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001201
Colin Cross4eae06d2023-06-20 22:40:02 -07001202 overlayRes := android.Paths{flata}
1203
1204 // Treat static library dependencies of static libraries as imports.
1205 transitiveStaticLibs := staticDeps.resPackages()
1206 linkDeps = append(linkDeps, transitiveStaticLibs...)
1207 for _, staticLib := range transitiveStaticLibs {
1208 linkFlags = append(linkFlags, "-I "+staticLib.String())
1209 }
Colin Crossfabb6082018-02-20 17:22:23 -08001210
Colin Crossab8d1382023-07-14 17:23:41 +00001211 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossbb77d8e2024-02-15 14:43:47 -08001212 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, aaptRTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001213 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001214
Colin Cross4eae06d2023-06-20 22:40:02 -07001215 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -08001216 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true, nil)
Colin Cross4eae06d2023-06-20 22:40:02 -07001217
Colin Crossf3b7bad2023-08-02 15:49:00 -07001218 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1219
Colin Crossab8d1382023-07-14 17:23:41 +00001220 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1221 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1222 resPackage: a.exportPackage,
1223 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001224 rTxt: a.rTxt,
1225 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001226 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001227
1228 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001229 })
1230 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1231 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1232
1233 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
1234 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
1235 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
1236 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
1237 // android_library_import modules. If this is fixed, AndroidLibraryDependency.ManifestsDepSet can be dropped
1238 // completely in favor of AndroidLibraryDependency.ResourceNodesDepSet.manifest
1239 //manifestDepSetBuilder.Transitive(transitiveStaticDeps.manifests)
1240 _ = staticManifestsDepSet
1241 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001242
Colin Cross312634e2023-11-21 15:13:56 -08001243 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1244 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1245 return p == a.exportPackage.String()
1246 })
1247 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1248 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1249 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001250
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001251 a.collectTransitiveHeaderJars(ctx)
Colin Cross40213022023-12-13 15:19:49 -08001252 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Crossdcf71b22021-02-01 13:59:03 -08001253 HeaderJars: android.PathsIfNonNil(a.classpathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001254 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1255 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08001256 ImplementationAndResourcesJars: android.PathsIfNonNil(a.classpathFile),
1257 ImplementationJars: android.PathsIfNonNil(a.classpathFile),
Jihoon Kangfe914ed2024-02-12 22:49:21 +00001258 StubsLinkType: Implementation,
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001259 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001260 })
Sam Delmerico82602492022-06-10 17:05:42 +00001261
1262 if proptools.Bool(a.properties.Extract_jni) {
1263 for _, t := range ctx.MultiTargets() {
1264 arch := t.Arch.Abi[0]
1265 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1266 a.jniPackages = append(a.jniPackages, path)
1267
1268 outDir := android.PathForModuleOut(ctx, "aarForJni")
1269 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1270 ctx.Build(pctx, android.BuildParams{
1271 Rule: extractJNI,
1272 Input: aarPath,
1273 Outputs: android.WritablePaths{path},
1274 Description: "extract JNI from AAR",
1275 Args: map[string]string{
1276 "outDir": outDir.String(),
1277 "archString": arch,
1278 },
1279 })
1280 }
Sam Delmerico82602492022-06-10 17:05:42 +00001281 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001282
Colin Cross40213022023-12-13 15:19:49 -08001283 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001284 JniPackages: a.jniPackages,
1285 })
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001286 android.CollectDependencyAconfigFiles(ctx, &a.mergedAconfigFiles)
Colin Crossdcf71b22021-02-01 13:59:03 -08001287}
Colin Crossfabb6082018-02-20 17:22:23 -08001288
1289func (a *AARImport) HeaderJars() android.Paths {
1290 return android.Paths{a.classpathFile}
1291}
1292
Colin Cross331a1212018-08-15 20:40:52 -07001293func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
1294 return android.Paths{a.classpathFile}
1295}
1296
Spandan Das59a4a2b2024-01-09 21:35:56 +00001297func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001298 return nil
1299}
1300
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001301func (a *AARImport) DexJarInstallPath() android.Path {
1302 return nil
1303}
1304
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001305func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Jiyong Park1be96912018-05-28 18:02:19 +09001306 return nil
1307}
1308
Jiyong Park45bf82e2020-12-15 22:29:02 +09001309var _ android.ApexModule = (*AARImport)(nil)
1310
1311// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001312func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1313 return a.depIsInSameApex(ctx, dep)
1314}
1315
Jiyong Park45bf82e2020-12-15 22:29:02 +09001316// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07001317func (g *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1318 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001319 return nil
1320}
1321
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001322var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001323
Colin Cross1b16b0e2019-02-12 14:41:32 -08001324// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1325//
1326// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1327// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001328func AARImportFactory() android.Module {
1329 module := &AARImport{}
1330
1331 module.AddProperties(&module.properties)
1332
1333 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001334 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001335 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001336 return module
1337}