blob: b3239ba9316ddcfdd4db97507b92c84eaacabe56 [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.
458 for _, staticDep := range staticDeps {
459 linkDeps = append(linkDeps, staticDep.resPackage)
460 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
461 if staticDep.usedResourceProcessor {
462 transitiveRJars = append(transitiveRJars, staticDep.rJar)
463 }
464 }
Colin Cross8676c8c2023-10-12 15:58:57 -0700465 for _, sharedDep := range sharedDeps {
466 if sharedDep.usedResourceProcessor {
467 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
468 }
469 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700470 } 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 Crossa97c5d32018-03-28 14:58:31 -0700559 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700560 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800561 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700562 a.exportPackage = packageRes
563 a.manifestPath = manifestPath
564 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700565 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700566 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700567 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000568 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
569 Direct(&resourcesNode{
570 resPackage: a.exportPackage,
571 manifest: a.manifestPath,
572 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700573 rTxt: a.rTxt,
574 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000575 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700576
Colin Cross8f1b0332024-01-25 13:39:06 -0800577 usedResourceProcessor: a.useResourceProcessorBusyBox(ctx),
Colin Crossab8d1382023-07-14 17:23:41 +0000578 }).
579 Transitive(staticResourcesNodesDepSet).Build()
580 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
581 Direct(rroDirs...).
582 Transitive(staticRRODirsDepSet).Build()
583 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
584 Direct(a.manifestPath).
585 DirectSlice(additionalManifests).
586 Transitive(staticManifestsDepSet).Build()
587}
588
Colin Cross4eae06d2023-06-20 22:40:02 -0700589var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
590 blueprint.RuleParams{
591 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
592 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
593 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
594 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
595 Rspfile: "${out}.args",
596 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
597 Restat: true,
598 }, "rTxt", "manifest", "args")
599
600// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
601// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
602// supports producing classes for static dependencies that only include resources from that dependency.
603func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800604 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700605
606 var args []string
607 var deps android.Paths
608
609 if !isLibrary {
610 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
611 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
612 // package.
613 args, deps = transitiveDeps.resourceProcessorDeps()
614 } else {
615 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
616 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
617 // inlined into the library before the final IDs are assigned during app compilation.
618 args = append(args, "--finalFields=false")
619 }
620
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800621 for i, arg := range aaptFlags {
622 const AAPT_CUSTOM_PACKAGE = "--custom-package"
623 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
624 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
625 if pkg == "" && i+1 < len(aaptFlags) {
626 pkg = aaptFlags[i+1]
627 }
628 args = append(args, "--packageForR "+pkg)
629 }
630 }
631
Colin Cross4eae06d2023-06-20 22:40:02 -0700632 deps = append(deps, rTxt, manifest)
633
634 ctx.Build(pctx, android.BuildParams{
635 Rule: resourceProcessorBusyBox,
636 Output: rJar,
637 Implicits: deps,
638 Description: "ResourceProcessorBusyBox",
639 Args: map[string]string{
640 "rTxt": rTxt.String(),
641 "manifest": manifest.String(),
642 "args": strings.Join(args, " "),
643 },
644 })
645}
646
Colin Crossab8d1382023-07-14 17:23:41 +0000647type resourcesNode struct {
648 resPackage android.Path
649 manifest android.Path
650 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700651 rTxt android.Path
652 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000653 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700654
655 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000656}
657
658type transitiveAarDeps []*resourcesNode
659
660func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700661 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000662 for _, dep := range t {
663 paths = append(paths, dep.resPackage)
664 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700665 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000666}
667
668func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700669 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000670 for _, dep := range t {
671 paths = append(paths, dep.manifest)
672 paths = append(paths, dep.additionalManifests...)
673 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700674 return paths
675}
676
677func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
678 for _, dep := range t {
679 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
680 deps = append(deps, dep.rTxt, dep.manifest)
681 }
682 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000683}
684
685func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700686 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000687 for _, dep := range t {
688 if dep.assets.Valid() {
689 paths = append(paths, dep.assets.Path())
690 }
691 }
692 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700693}
694
695// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900696func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700697 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000698 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700699
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100700 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000701 // Not all callers need to compute class loader context, those who don't just pass nil.
702 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100703 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000704 }
705
Colin Cross83bb3162018-06-25 15:48:06 -0700706 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700707 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700708 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700709 }
710
Colin Cross8676c8c2023-10-12 15:58:57 -0700711 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
712 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000713 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
714 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
715
Colin Crossa97c5d32018-03-28 14:58:31 -0700716 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000717 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000718
Colin Crossa97c5d32018-03-28 14:58:31 -0700719 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700720 aarDep, _ := module.(AndroidLibraryDependency)
721 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700722 exportPackage = aarDep.ExportPackage()
723 }
724
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000725 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700726 case instrumentationForTag:
727 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400728 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700729 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700730 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700731 sharedLibs = append(sharedLibs, exportPackage)
732 }
Colin Cross5446e882019-05-22 10:46:27 -0700733 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700734 if exportPackage != nil {
735 sharedLibs = append(sharedLibs, exportPackage)
736 }
737 case staticLibTag:
738 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700739 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000740 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
741 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700742 }
743 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000744
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000745 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700746 })
747
Colin Crossab8d1382023-07-14 17:23:41 +0000748 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
749 // Reverse the dependency order now going into the depset so that it comes out in order after the second
750 // reverse later.
751 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
752 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
753 // dependency has to be listed last.
754 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700755 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
756 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
757 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700758
Colin Crossab8d1382023-07-14 17:23:41 +0000759 staticRRODirs = rroDirsDepSetBuilder.Build()
760 staticManifests = manifestsDepSetBuilder.Build()
761
762 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700763 flags = append(flags, "--auto-add-overlay")
764 }
765
766 for _, sharedLib := range sharedLibs {
767 flags = append(flags, "-I "+sharedLib.String())
768 }
769
Colin Cross8676c8c2023-10-12 15:58:57 -0700770 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700771}
772
773type AndroidLibrary struct {
774 Library
775 aapt
776
777 androidLibraryProperties androidLibraryProperties
778
779 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700780}
781
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000782var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
783
784// For OutputFileProducer interface
785func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
786 switch tag {
787 case ".aar":
788 return []android.Path{a.aarFile}, nil
789 default:
790 return a.Library.OutputFiles(tag)
791 }
792}
793
Colin Crossa97c5d32018-03-28 14:58:31 -0700794var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
795
796func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
797 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900798 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100799 if sdkDep.hasFrameworkLibs() {
800 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700801 }
Colin Cross4a80a152022-12-21 21:51:52 -0800802 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700803}
804
805func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800806 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100807 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000808 if a.usesLibrary.shouldDisableDexpreopt {
809 a.dexpreopter.disableDexpreopt()
810 }
Alixf7a10272023-09-27 16:47:56 +0000811 a.aapt.buildActions(ctx,
812 aaptBuildActionOptions{
813 sdkContext: android.SdkContext(a),
814 classLoaderContexts: a.classLoaderContexts,
815 enforceDefaultTargetSdkVersion: false,
816 },
817 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700818
Colin Crossff694a82023-12-13 15:54:49 -0800819 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
820 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700821
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000822 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
823
Colin Cross4eae06d2023-06-20 22:40:02 -0700824 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
825 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800826 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700827 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700828 } else {
829 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700830 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700831
832 // apps manifests are handled by aapt, don't let Module see them
833 a.properties.Manifest = nil
834
Colin Cross014489c2020-06-02 20:09:13 -0700835 a.linter.mergedManifest = a.aapt.mergedManifestFile
836 a.linter.manifest = a.aapt.manifestPath
837 a.linter.resources = a.aapt.resourceFiles
838
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000839 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800840 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800841 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
842 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
843 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
844
845 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
846 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
847 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700848
Colin Cross4eae06d2023-06-20 22:40:02 -0700849 var extraSrcJars android.Paths
850 var extraCombinedJars android.Paths
851 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800852 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700853 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
854 // library and each of the transitive static android_library dependencies has already created an
855 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
856 extraClasspathJars = a.transitiveAaptRJars
857 } else {
858 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
859 // R.java files for the library's package and the packages from all transitive static android_library
860 // dependencies. Compile the srcjar alongside the rest of the sources.
861 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
862 }
863
864 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700865
Colin Crossf57c5782019-01-25 13:20:38 -0800866 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700867 var res android.Paths
868 if a.androidLibraryProperties.BuildAAR {
869 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
870 ctx.CheckbuildFile(a.aarFile)
871 }
Colin Cross89c31582018-04-30 15:55:11 -0700872
Sam Delmerico82602492022-06-10 17:05:42 +0000873 prebuiltJniPackages := android.Paths{}
874 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800875 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000876 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
877 }
878 })
879 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800880 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000881 JniPackages: prebuiltJniPackages,
882 })
883 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700884}
885
Colin Cross95b53b82023-10-17 13:21:02 -0700886func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
887 a.Library.IDEInfo(dpInfo)
888 a.aapt.IDEInfo(dpInfo)
889}
890
891func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800892 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700893 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
894 }
895}
896
Colin Cross1b16b0e2019-02-12 14:41:32 -0800897// android_library builds and links sources into a `.jar` file for the device along with Android resources.
898//
899// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000900// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800901// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
902// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700903func AndroidLibraryFactory() android.Module {
904 module := &AndroidLibrary{}
905
Colin Crossce6734e2020-06-15 16:09:53 -0700906 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700907 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700908 &module.aaptProperties,
909 &module.androidLibraryProperties)
910
911 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700912 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700913
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900914 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700915 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700916 return module
917}
918
Colin Crossfabb6082018-02-20 17:22:23 -0800919//
920// AAR (android library) prebuilts
921//
Colin Crossfabb6082018-02-20 17:22:23 -0800922
Vinh Trance0781f2022-04-13 01:30:44 +0000923// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800924type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000925 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800926 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000927 // If not blank, set to the version of the sdk to compile against.
928 // Defaults to private.
929 // Values are of one of the following forms:
930 // 1) numerical API level, "current", "none", or "core_platform"
931 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
932 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
933 // If the SDK kind is empty, it will be set to public
934 Sdk_version *string
935 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
936 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700937 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000938 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700939 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000940 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
941 Libs []string
942 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700943 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000944 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
945 // will be passed transitively through android_libraries to an android_app.
946 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
947 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800948}
949
950type AARImport struct {
951 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700952 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900953 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800954 prebuilt android.Prebuilt
955
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900956 // Functionality common to Module and Import.
957 embeddableInModuleAndImport
958
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500959 providesTransitiveHeaderJars
960
Colin Crossfabb6082018-02-20 17:22:23 -0800961 properties AARImportProperties
962
Colin Cross312634e2023-11-21 15:13:56 -0800963 classpathFile android.WritablePath
964 proguardFlags android.WritablePath
965 exportPackage android.WritablePath
966 transitiveAaptResourcePackagesFile android.Path
967 extraAaptPackagesFile android.WritablePath
968 manifest android.WritablePath
969 assetsPackage android.WritablePath
970 rTxt android.WritablePath
971 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700972
Colin Crossab8d1382023-07-14 17:23:41 +0000973 resourcesNodesDepSet *android.DepSet[*resourcesNode]
974 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700975
976 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000977
Sam Delmerico82602492022-06-10 17:05:42 +0000978 aarPath android.Path
979 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900980
981 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000982 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000983
984 // Single aconfig "cache file" merged from this module and all dependencies.
985 mergedAconfigFiles map[string]android.Paths
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000986}
987
988var _ android.OutputFileProducer = (*AARImport)(nil)
989
990// For OutputFileProducer interface
991func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
992 switch tag {
993 case ".aar":
994 return []android.Path{a.aarPath}, nil
995 case "":
996 return []android.Path{a.classpathFile}, nil
997 default:
998 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
999 }
Colin Crossfabb6082018-02-20 17:22:23 -08001000}
1001
Jiyong Park92315372021-04-02 08:45:46 +09001002func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1003 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07001004}
1005
Jiyong Parkf1691d22021-03-29 20:11:58 +09001006func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001007 return ""
1008}
1009
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001010func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001011 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001012 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001013 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001014 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001015}
1016
Spandan Dasa26eda72023-03-02 00:56:06 +00001017func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1018 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001019}
1020
Spandan Dasca70fc42023-03-01 23:38:49 +00001021func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1022 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001023}
1024
Colin Cross1e743852019-10-28 11:37:20 -07001025func (a *AARImport) javaVersion() string {
1026 return ""
1027}
1028
Colin Crossa97c5d32018-03-28 14:58:31 -07001029var _ AndroidLibraryDependency = (*AARImport)(nil)
1030
1031func (a *AARImport) ExportPackage() android.Path {
1032 return a.exportPackage
1033}
Colin Crossab8d1382023-07-14 17:23:41 +00001034func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1035 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001036}
1037
Colin Crossab8d1382023-07-14 17:23:41 +00001038func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1039 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001040}
1041
Colin Crossab8d1382023-07-14 17:23:41 +00001042func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1043 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001044}
1045
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001046// RRO enforcement is not available on aar_import since its RRO dirs are not
1047// exported.
1048func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1049}
1050
1051// RRO enforcement is not available on aar_import since its RRO dirs are not
1052// exported.
1053func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1054 return false
1055}
1056
Colin Crossfabb6082018-02-20 17:22:23 -08001057func (a *AARImport) Prebuilt() *android.Prebuilt {
1058 return &a.prebuilt
1059}
1060
1061func (a *AARImport) Name() string {
1062 return a.prebuilt.Name(a.ModuleBase.Name())
1063}
1064
Jiyong Park618922e2020-01-08 13:35:43 +09001065func (a *AARImport) JacocoReportClassesFile() android.Path {
1066 return nil
1067}
1068
Colin Crossfabb6082018-02-20 17:22:23 -08001069func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001070 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001071 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001072 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001073 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001074 }
1075 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001076
Colin Cross42d48b72018-08-29 14:10:52 -07001077 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1078 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001079}
1080
Sam Delmerico82602492022-06-10 17:05:42 +00001081type JniPackageInfo struct {
1082 // List of zip files containing JNI libraries
1083 // Zip files should have directory structure jni/<arch>/*.so
1084 JniPackages android.Paths
1085}
1086
Colin Crossbc7d76c2023-12-12 16:39:03 -08001087var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001088
1089// Unzip an AAR and extract the JNI libs for $archString.
1090var extractJNI = pctx.AndroidStaticRule("extractJNI",
1091 blueprint.RuleParams{
1092 Command: `rm -rf $out $outDir && touch $out && ` +
1093 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1094 `jni_files=$$(find $outDir/jni -type f) && ` +
1095 // print error message if there are no JNI libs for this arch
1096 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001097 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001098 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1099 CommandDeps: []string{"${config.SoongZipCmd}"},
1100 },
1101 "outDir", "archString")
1102
Colin Crossfabb6082018-02-20 17:22:23 -08001103// Unzip an AAR into its constituent files and directories. Any files in Outputs that don't exist in the AAR will be
Dan Willemsen304cfec2019-05-28 14:49:06 -07001104// touched to create an empty file. The res directory is not extracted, as it will be extracted in its own rule.
Colin Crossfabb6082018-02-20 17:22:23 -08001105var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1106 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001107 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001108 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001109 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001110 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001111 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001112 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001113 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001114
1115func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1116 if len(a.properties.Aars) != 1 {
1117 ctx.PropertyErrorf("aars", "exactly one aar is required")
1118 return
1119 }
1120
Jiyong Park92315372021-04-02 08:45:46 +09001121 a.sdkVersion = a.SdkVersion(ctx)
1122 a.minSdkVersion = a.MinSdkVersion(ctx)
1123
Colin Crossff694a82023-12-13 15:54:49 -08001124 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1125 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001126
Nan Zhang4c819fb2018-08-27 18:31:46 -07001127 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001128 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1129
Colin Cross1001a792019-03-21 22:21:39 -07001130 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001131 inputFile := a.aarPath
1132 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1133 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001134 }
Colin Crossfabb6082018-02-20 17:22:23 -08001135
1136 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001137 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001138 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001139 a.rTxt = extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001140 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001141 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001142 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001143 ProguardFlagsFiles: android.NewDepSet[android.Path](
1144 android.POSTORDER,
1145 android.Paths{a.proguardFlags},
1146 nil,
1147 ),
1148 })
Colin Crossfabb6082018-02-20 17:22:23 -08001149
1150 ctx.Build(pctx, android.BuildParams{
1151 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001152 Input: a.aarPath,
Colin Crossbb77d8e2024-02-15 14:43:47 -08001153 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, a.rTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001154 Description: "unzip AAR",
1155 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001156 "outDir": extractedAARDir.String(),
1157 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001158 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001159 },
1160 })
1161
Colin Crossa0ba2f52019-06-22 12:59:27 -07001162 // Always set --pseudo-localize, it will be stripped out later for release
1163 // builds that don't want it.
1164 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001165 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001166 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001167 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001168
1169 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001170 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001171 aaptRTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001172 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001173
1174 var linkDeps android.Paths
1175
1176 linkFlags := []string{
1177 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001178 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001179 "--auto-add-overlay",
Colin Cross7c4dc5d2024-02-13 14:29:45 -08001180 "--no-static-lib-packages",
Colin Crossfabb6082018-02-20 17:22:23 -08001181 }
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 Crossbb77d8e2024-02-15 14:43:47 -08001208 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, aaptRTxt,
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}