blob: 2835792801f1ce0209dab9deacf59d685236eb60 [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"`
Jihoon Kang9049c272024-03-19 21:57:36 +0000107
108 // Names of aconfig_declarations modules that specify aconfig flags that the module depends on.
109 Flags_packages []string
Colin Crossa97c5d32018-03-28 14:58:31 -0700110}
111
112type aapt struct {
Colin Cross312634e2023-11-21 15:13:56 -0800113 aaptSrcJar android.Path
114 transitiveAaptRJars android.Paths
115 transitiveAaptResourcePackagesFile android.Path
116 exportPackage android.Path
117 manifestPath android.Path
118 proguardOptionsFile android.Path
119 rTxt android.Path
120 rJar android.Path
121 extraAaptPackagesFile android.Path
122 mergedManifestFile android.Path
123 noticeFile android.OptionalPath
124 assetPackage android.OptionalPath
125 isLibrary bool
126 defaultManifestVersion string
127 useEmbeddedNativeLibs bool
128 useEmbeddedDex bool
129 usesNonSdkApis bool
130 hasNoCode bool
131 LoggingParent string
132 resourceFiles android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700133
Colin Crosse560c4a2019-03-19 16:03:11 -0700134 splitNames []string
135 splits []split
136
Colin Crossa97c5d32018-03-28 14:58:31 -0700137 aaptProperties aaptProperties
Colin Crossab8d1382023-07-14 17:23:41 +0000138
139 resourcesNodesDepSet *android.DepSet[*resourcesNode]
140 rroDirsDepSet *android.DepSet[rroDir]
141 manifestsDepSet *android.DepSet[android.Path]
Alix96ea88452023-08-31 15:48:23 +0000142
143 manifestValues struct {
144 applicationId string
145 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700146}
147
Colin Crosse560c4a2019-03-19 16:03:11 -0700148type split struct {
149 name string
150 suffix string
151 path android.Path
152}
153
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700154// Propagate RRO enforcement flag to static lib dependencies transitively.
155func propagateRROEnforcementMutator(ctx android.TopDownMutatorContext) {
156 m := ctx.Module()
157 if d, ok := m.(AndroidLibraryDependency); ok && d.IsRROEnforced(ctx) {
158 ctx.VisitDirectDepsWithTag(staticLibTag, func(d android.Module) {
159 if a, ok := d.(AndroidLibraryDependency); ok {
160 a.SetRROEnforcedForDependent(true)
161 }
162 })
163 }
164}
165
Colin Cross8f1b0332024-01-25 13:39:06 -0800166func (a *aapt) useResourceProcessorBusyBox(ctx android.BaseModuleContext) bool {
167 return BoolDefault(a.aaptProperties.Use_resource_processor, ctx.Config().UseResourceProcessorByDefault())
Colin Cross4eae06d2023-06-20 22:40:02 -0700168}
169
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900170func (a *aapt) filterProduct() string {
171 return String(a.aaptProperties.Filter_product)
172}
173
Colin Crossa97c5d32018-03-28 14:58:31 -0700174func (a *aapt) ExportPackage() android.Path {
175 return a.exportPackage
176}
Colin Crossab8d1382023-07-14 17:23:41 +0000177func (a *aapt) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
178 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800179}
180
Colin Crossab8d1382023-07-14 17:23:41 +0000181func (a *aapt) RRODirsDepSet() *android.DepSet[rroDir] {
182 return a.rroDirsDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800183}
184
Colin Crossab8d1382023-07-14 17:23:41 +0000185func (a *aapt) ManifestsDepSet() *android.DepSet[android.Path] {
186 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800187}
188
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700189func (a *aapt) SetRROEnforcedForDependent(enforce bool) {
190 a.aaptProperties.RROEnforcedForDependent = enforce
191}
192
193func (a *aapt) IsRROEnforced(ctx android.BaseModuleContext) bool {
194 // True if RRO is enforced for this module or...
195 return ctx.Config().EnforceRROForModule(ctx.ModuleName()) ||
Jeongik Chacee5ba92021-02-19 12:11:51 +0900196 // if RRO is enforced for any of its dependents.
197 a.aaptProperties.RROEnforcedForDependent
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700198}
199
Jiyong Parkf1691d22021-03-29 20:11:58 +0900200func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext android.SdkContext,
Colin Crossa0ba2f52019-06-22 12:59:27 -0700201 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
202 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700203
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800204 hasVersionCode := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-code")
205 hasVersionName := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-name")
Colin Crossa97c5d32018-03-28 14:58:31 -0700206
Colin Crossa97c5d32018-03-28 14:58:31 -0700207 // Flags specified in Android.bp
208 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
209
Eric Miao40eab202023-03-30 16:57:17 +0000210 linkFlags = append(linkFlags, "--enable-compact-entries")
Colin Crossa97c5d32018-03-28 14:58:31 -0700211
212 // Find implicit or explicit asset and resource dirs
Jiakai Zhangba82e282023-10-13 18:08:59 +0100213 assets := android.PathsRelativeToModuleSourceDir(android.SourceInput{
214 Context: ctx,
215 Paths: a.aaptProperties.Assets,
216 IncludeDirs: false,
217 })
Colin Crossa97c5d32018-03-28 14:58:31 -0700218 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
219 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800220 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700221
Colin Crossa97c5d32018-03-28 14:58:31 -0700222 // Glob directories into lists of paths
223 for _, dir := range resourceDirs {
224 resDirs = append(resDirs, globbedResourceDir{
225 dir: dir,
226 files: androidResourceGlob(ctx, dir),
227 })
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700228 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, a, dir)
Colin Crossa97c5d32018-03-28 14:58:31 -0700229 overlayDirs = append(overlayDirs, resOverlayDirs...)
230 rroDirs = append(rroDirs, resRRODirs...)
231 }
232
Colin Crossc20dc852020-11-10 12:27:45 -0800233 var assetDeps android.Paths
234 for i, dir := range assetDirs {
235 // Add a dependency on every file in the asset directory. This ensures the aapt2
236 // rule will be rerun if one of the files in the asset directory is modified.
237 assetDeps = append(assetDeps, androidResourceGlob(ctx, dir)...)
238
239 // Add a dependency on a file that contains a list of all the files in the asset directory.
240 // This ensures the aapt2 rule will be run if a file is removed from the asset directory,
241 // or a file is added whose timestamp is older than the output of aapt2.
242 assetFileListFile := android.PathForModuleOut(ctx, "asset_dir_globs", strconv.Itoa(i)+".glob")
243 androidResourceGlobList(ctx, dir, assetFileListFile)
244 assetDeps = append(assetDeps, assetFileListFile)
Colin Crossa97c5d32018-03-28 14:58:31 -0700245 }
246
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700247 assetDirStrings := assetDirs.Strings()
248 if a.noticeFile.Valid() {
249 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
Colin Crossc20dc852020-11-10 12:27:45 -0800250 assetDeps = append(assetDeps, a.noticeFile.Path())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700251 }
Jiakai Zhangba82e282023-10-13 18:08:59 +0100252 if len(assets) > 0 {
253 // aapt2 doesn't support adding individual asset files. Create a temp directory to hold asset
254 // files and pass it to aapt2.
255 tmpAssetDir := android.PathForModuleOut(ctx, "tmp_asset_dir")
256
257 rule := android.NewRuleBuilder(pctx, ctx)
258 rule.Command().
259 Text("rm -rf").Text(tmpAssetDir.String()).
260 Text("&&").
261 Text("mkdir -p").Text(tmpAssetDir.String())
262
263 for _, asset := range assets {
264 output := tmpAssetDir.Join(ctx, asset.Rel())
265 assetDeps = append(assetDeps, output)
266 rule.Command().Text("mkdir -p").Text(filepath.Dir(output.String()))
267 rule.Command().Text("cp").Input(asset).Output(output)
268 }
269
270 rule.Build("tmp_asset_dir", "tmp_asset_dir")
271
272 assetDirStrings = append(assetDirStrings, tmpAssetDir.String())
273 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700274
Colin Crossa97c5d32018-03-28 14:58:31 -0700275 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
276 linkDeps = append(linkDeps, manifestPath)
277
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700278 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossc20dc852020-11-10 12:27:45 -0800279 linkDeps = append(linkDeps, assetDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700280
Spandan Das50885c02023-02-23 21:31:33 +0000281 // Returns the effective version for {min|target}_sdk_version
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000282 effectiveVersionString := func(sdkVersion android.SdkSpec, minSdkVersion android.ApiLevel) string {
Spandan Das50885c02023-02-23 21:31:33 +0000283 // If {min|target}_sdk_version is current, use sdk_version to determine the effective level
284 // This is necessary for vendor modules.
285 // The effective version does not _only_ depend on {min|target}_sdk_version(level),
286 // but also on the sdk_version (kind+level)
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000287 if minSdkVersion.IsCurrent() {
Spandan Das50885c02023-02-23 21:31:33 +0000288 ret, err := sdkVersion.EffectiveVersionString(ctx)
289 if err != nil {
290 ctx.ModuleErrorf("invalid sdk_version: %s", err)
291 }
292 return ret
293 }
294 ret, err := minSdkVersion.EffectiveVersionString(ctx)
295 if err != nil {
296 ctx.ModuleErrorf("invalid min_sdk_version: %s", err)
297 }
298 return ret
Jiyong Park6a927c42020-01-21 02:03:43 +0900299 }
Spandan Das50885c02023-02-23 21:31:33 +0000300 // SDK version flags
301 sdkVersion := sdkContext.SdkVersion(ctx)
302 minSdkVersion := effectiveVersionString(sdkVersion, sdkContext.MinSdkVersion(ctx))
Colin Crossa97c5d32018-03-28 14:58:31 -0700303
Colin Cross83bb3162018-06-25 15:48:06 -0700304 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
Spandan Das6450b552023-02-23 19:27:07 +0000305 // Use minSdkVersion for target-sdk-version, even if `target_sdk_version` is set
306 // This behavior has been copied from Make.
Colin Cross83bb3162018-06-25 15:48:06 -0700307 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700308
Colin Crossa97c5d32018-03-28 14:58:31 -0700309 // Version code
310 if !hasVersionCode {
Dan Albert4f378d72020-07-23 17:32:15 -0700311 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion().String())
Colin Crossa97c5d32018-03-28 14:58:31 -0700312 }
313
314 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700315 var versionName string
316 if ctx.ModuleName() == "framework-res" {
317 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
318 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700319 // if it contains the build number. Use the PlatformVersionName instead.
320 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700321 } else {
322 versionName = ctx.Config().AppsDefaultVersionName()
323 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800324 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700325 linkFlags = append(linkFlags, "--version-name ", versionName)
326 }
327
Colin Crossa0ba2f52019-06-22 12:59:27 -0700328 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
329
330 // Always set --pseudo-localize, it will be stripped out later for release
331 // builds that don't want it.
332 compileFlags = append(compileFlags, "--pseudo-localize")
333
334 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700335}
336
Paul Duffin250e6192019-06-07 10:44:37 +0100337func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800338 if sdkDep.frameworkResModule != "" {
339 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700340 }
341}
342
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800343var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
344 blueprint.RuleParams{
345 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
346 CommandDeps: []string{"${config.Zip2ZipCmd}"},
347 })
348
Alixf7a10272023-09-27 16:47:56 +0000349type aaptBuildActionOptions struct {
350 sdkContext android.SdkContext
351 classLoaderContexts dexpreopt.ClassLoaderContextMap
352 excludedLibs []string
353 enforceDefaultTargetSdkVersion bool
354 extraLinkFlags []string
Jihoon Kang84b25892023-12-01 22:01:06 +0000355 aconfigTextFiles android.Paths
Alixf7a10272023-09-27 16:47:56 +0000356}
357
358func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700359
Colin Cross8676c8c2023-10-12 15:58:57 -0700360 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Alixf7a10272023-09-27 16:47:56 +0000361 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100362
Paul Duffin06530572022-02-03 17:54:15 +0000363 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000364 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000365
Colin Cross31656952018-05-24 16:11:20 -0700366 // App manifest file
367 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
368 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
369
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000370 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000371 SdkContext: opts.sdkContext,
372 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000373 IsLibrary: a.isLibrary,
374 DefaultManifestVersion: a.defaultManifestVersion,
375 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
376 UsesNonSdkApis: a.usesNonSdkApis,
377 UseEmbeddedDex: a.useEmbeddedDex,
378 HasNoCode: a.hasNoCode,
379 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000380 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000381 })
Colin Cross90c25c62019-04-19 16:22:57 -0700382
Colin Crossab8d1382023-07-14 17:23:41 +0000383 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700384 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000385
Luca Stefanifd898822019-09-10 22:13:31 +0200386 // Add additional manifest files to transitive manifests.
387 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000388 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
389 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
390 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
391 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
392 // android_library_import modules. If this is fixed, staticManifestsDepSet can be dropped completely in favor of
393 // staticResourcesNodesDepSet.manifests()
394 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700395
Colin Crossab8d1382023-07-14 17:23:41 +0000396 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000397 manifestMergerParams := ManifestMergerParams{
398 staticLibManifests: transitiveManifestPaths[1:],
Alix96ea88452023-08-31 15:48:23 +0000399 isLibrary: a.isLibrary,
400 packageName: a.manifestValues.applicationId,
401 }
Alixf7a10272023-09-27 16:47:56 +0000402 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700403 if !a.isLibrary {
404 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
405 // will be propagated to the final application and merged there. The merged manifest for libraries is
406 // only passed to Make, which can't handle transitive dependencies.
407 manifestPath = a.mergedManifestFile
408 }
409 } else {
410 a.mergedManifestFile = manifestPath
411 }
Colin Cross31656952018-05-24 16:11:20 -0700412
Alixf7a10272023-09-27 16:47:56 +0000413 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700414
415 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700416 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000417 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000418 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700419 if a.isLibrary {
420 linkFlags = append(linkFlags, "--static-lib")
421 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700422
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800423 linkFlags = append(linkFlags, "--no-static-lib-packages")
Colin Cross8f1b0332024-01-25 13:39:06 -0800424 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800425 // When building an android_library using ResourceProcessorBusyBox pass --merge-only to skip resource
426 // references validation until the final app link step when all static libraries are present.
Colin Cross4eae06d2023-06-20 22:40:02 -0700427 linkFlags = append(linkFlags, "--merge-only")
Colin Cross4eae06d2023-06-20 22:40:02 -0700428 }
429
Colin Crossa97c5d32018-03-28 14:58:31 -0700430 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700431 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
432 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700433 // This file isn't used by Soong, but is generated for exporting
434 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700435 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700436 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700437
Colin Cross4aaa84a2018-08-21 15:14:37 -0700438 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700439 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700440 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900441 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700442 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700443
Colin Crossa592e3e2019-02-19 16:59:53 -0800444 for i, zip := range resZips {
445 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700446 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800447 compiledResDirs = append(compiledResDirs, android.Paths{flata})
448 }
449
Colin Cross4aaa84a2018-08-21 15:14:37 -0700450 var compiledRes, compiledOverlay android.Paths
451
Colin Crossab8d1382023-07-14 17:23:41 +0000452 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
453 // of transitiveStaticLibs.
454 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
455
Colin Cross8f1b0332024-01-25 13:39:06 -0800456 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700457 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
458 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
459 // instead modules depending on this module will reference package-res.apk from all transitive static
460 // dependencies.
Colin Cross1d3f5902024-03-05 11:51:54 -0800461 for _, sharedDep := range sharedDeps {
462 if sharedDep.usedResourceProcessor {
463 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
464 }
465 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700466 for _, staticDep := range staticDeps {
467 linkDeps = append(linkDeps, staticDep.resPackage)
468 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
469 if staticDep.usedResourceProcessor {
470 transitiveRJars = append(transitiveRJars, staticDep.rJar)
471 }
472 }
473 } else {
474 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
475 // dependencies are compiled into this module's package-res.apk as overlays.
476 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
477 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700478
Colin Crossbec85302019-02-13 13:15:46 -0800479 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700480 // If we are using static android libraries, every source file becomes an overlay.
481 // This is to emulate old AAPT behavior which simulated library support.
482 for _, compiledResDir := range compiledResDirs {
483 compiledOverlay = append(compiledOverlay, compiledResDir...)
484 }
Colin Crossbec85302019-02-13 13:15:46 -0800485 } else if a.isLibrary {
486 // Otherwise, for a static library we treat all the resources equally with no overlay.
487 for _, compiledResDir := range compiledResDirs {
488 compiledRes = append(compiledRes, compiledResDir...)
489 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700490 } else if len(compiledResDirs) > 0 {
491 // Without static libraries, the first directory is our directory, which can then be
492 // overlaid by the rest.
493 compiledRes = append(compiledRes, compiledResDirs[0]...)
494 for _, compiledResDir := range compiledResDirs[1:] {
495 compiledOverlay = append(compiledOverlay, compiledResDir...)
496 }
497 }
498
Colin Crossa97c5d32018-03-28 14:58:31 -0700499 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900500 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700501 }
502
Colin Crosse560c4a2019-03-19 16:03:11 -0700503 var splitPackages android.WritablePaths
504 var splits []split
505
506 for _, s := range a.splitNames {
507 suffix := strings.Replace(s, ",", "_", -1)
508 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
509 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
510 splitPackages = append(splitPackages, path)
511 splits = append(splits, split{
512 name: s,
513 suffix: suffix,
514 path: path,
515 })
516 }
517
Colin Cross8f1b0332024-01-25 13:39:06 -0800518 if !a.useResourceProcessorBusyBox(ctx) {
Colin Crossf3b7bad2023-08-02 15:49:00 -0700519 // the subdir "android" is required to be filtered by package names
520 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
521 }
522
Colin Crossab8d1382023-07-14 17:23:41 +0000523 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
524 // provided to the final app aapt2Link step.
525 var transitiveAssets android.Paths
526 if !a.isLibrary {
527 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
528 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700529 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000530 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
531 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800532 // Extract assets from the resource package output so that they can be used later in aapt2link
533 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000534 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800535 assets := android.PathForModuleOut(ctx, "assets.zip")
536 ctx.Build(pctx, android.BuildParams{
537 Rule: extractAssetsRule,
538 Input: packageRes,
539 Output: assets,
540 Description: "extract assets from built resource file",
541 })
542 a.assetPackage = android.OptionalPathForPath(assets)
543 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700544
Colin Cross8f1b0332024-01-25 13:39:06 -0800545 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700546 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800547 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700548 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700549 transitiveRJars = append(transitiveRJars, rJar)
550 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700551 } else {
552 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700553 }
554
Colin Cross312634e2023-11-21 15:13:56 -0800555 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
556 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
557 return p == packageRes.String()
558 })
559 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
560 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
561
Colin Cross1d3f5902024-03-05 11:51:54 -0800562 // Reverse the list of R.jar files so that the current module comes first, and direct dependencies come before
563 // transitive dependencies.
564 transitiveRJars = android.ReversePaths(transitiveRJars)
565
Colin Crossa97c5d32018-03-28 14:58:31 -0700566 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700567 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800568 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700569 a.exportPackage = packageRes
570 a.manifestPath = manifestPath
571 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700572 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700573 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700574 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000575 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
576 Direct(&resourcesNode{
577 resPackage: a.exportPackage,
578 manifest: a.manifestPath,
579 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700580 rTxt: a.rTxt,
581 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000582 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700583
Colin Cross8f1b0332024-01-25 13:39:06 -0800584 usedResourceProcessor: a.useResourceProcessorBusyBox(ctx),
Colin Crossab8d1382023-07-14 17:23:41 +0000585 }).
586 Transitive(staticResourcesNodesDepSet).Build()
587 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
588 Direct(rroDirs...).
589 Transitive(staticRRODirsDepSet).Build()
590 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
591 Direct(a.manifestPath).
592 DirectSlice(additionalManifests).
593 Transitive(staticManifestsDepSet).Build()
594}
595
Colin Cross4eae06d2023-06-20 22:40:02 -0700596var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
597 blueprint.RuleParams{
598 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
599 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
600 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
601 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
602 Rspfile: "${out}.args",
603 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
604 Restat: true,
605 }, "rTxt", "manifest", "args")
606
607// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
608// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
609// supports producing classes for static dependencies that only include resources from that dependency.
610func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800611 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700612
613 var args []string
614 var deps android.Paths
615
616 if !isLibrary {
617 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
618 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
619 // package.
620 args, deps = transitiveDeps.resourceProcessorDeps()
621 } else {
622 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
623 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
624 // inlined into the library before the final IDs are assigned during app compilation.
625 args = append(args, "--finalFields=false")
626 }
627
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800628 for i, arg := range aaptFlags {
629 const AAPT_CUSTOM_PACKAGE = "--custom-package"
630 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
631 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
632 if pkg == "" && i+1 < len(aaptFlags) {
633 pkg = aaptFlags[i+1]
634 }
635 args = append(args, "--packageForR "+pkg)
636 }
637 }
638
Colin Cross4eae06d2023-06-20 22:40:02 -0700639 deps = append(deps, rTxt, manifest)
640
641 ctx.Build(pctx, android.BuildParams{
642 Rule: resourceProcessorBusyBox,
643 Output: rJar,
644 Implicits: deps,
645 Description: "ResourceProcessorBusyBox",
646 Args: map[string]string{
647 "rTxt": rTxt.String(),
648 "manifest": manifest.String(),
649 "args": strings.Join(args, " "),
650 },
651 })
652}
653
Colin Crossab8d1382023-07-14 17:23:41 +0000654type resourcesNode struct {
655 resPackage android.Path
656 manifest android.Path
657 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700658 rTxt android.Path
659 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000660 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700661
662 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000663}
664
665type transitiveAarDeps []*resourcesNode
666
667func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700668 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000669 for _, dep := range t {
670 paths = append(paths, dep.resPackage)
671 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700672 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000673}
674
675func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700676 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000677 for _, dep := range t {
678 paths = append(paths, dep.manifest)
679 paths = append(paths, dep.additionalManifests...)
680 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700681 return paths
682}
683
684func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
685 for _, dep := range t {
686 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
687 deps = append(deps, dep.rTxt, dep.manifest)
688 }
689 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000690}
691
692func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700693 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000694 for _, dep := range t {
695 if dep.assets.Valid() {
696 paths = append(paths, dep.assets.Path())
697 }
698 }
699 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700700}
701
702// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900703func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700704 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000705 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700706
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100707 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000708 // Not all callers need to compute class loader context, those who don't just pass nil.
709 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100710 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000711 }
712
Colin Cross83bb3162018-06-25 15:48:06 -0700713 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700714 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700715 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700716 }
717
Colin Cross8676c8c2023-10-12 15:58:57 -0700718 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
719 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000720 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
721 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
722
Colin Crossa97c5d32018-03-28 14:58:31 -0700723 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000724 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000725
Colin Crossa97c5d32018-03-28 14:58:31 -0700726 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700727 aarDep, _ := module.(AndroidLibraryDependency)
728 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700729 exportPackage = aarDep.ExportPackage()
730 }
731
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000732 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700733 case instrumentationForTag:
734 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400735 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700736 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700737 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700738 sharedLibs = append(sharedLibs, exportPackage)
739 }
Colin Cross5446e882019-05-22 10:46:27 -0700740 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700741 if exportPackage != nil {
742 sharedLibs = append(sharedLibs, exportPackage)
743 }
744 case staticLibTag:
745 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700746 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000747 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
748 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700749 }
750 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000751
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000752 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700753 })
754
Colin Crossab8d1382023-07-14 17:23:41 +0000755 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
756 // Reverse the dependency order now going into the depset so that it comes out in order after the second
757 // reverse later.
758 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
759 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
760 // dependency has to be listed last.
761 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700762 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
763 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
764 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700765
Colin Crossab8d1382023-07-14 17:23:41 +0000766 staticRRODirs = rroDirsDepSetBuilder.Build()
767 staticManifests = manifestsDepSetBuilder.Build()
768
769 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700770 flags = append(flags, "--auto-add-overlay")
771 }
772
773 for _, sharedLib := range sharedLibs {
774 flags = append(flags, "-I "+sharedLib.String())
775 }
776
Colin Cross8676c8c2023-10-12 15:58:57 -0700777 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700778}
779
780type AndroidLibrary struct {
781 Library
782 aapt
783
784 androidLibraryProperties androidLibraryProperties
785
786 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700787}
788
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000789var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
790
791// For OutputFileProducer interface
792func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
793 switch tag {
794 case ".aar":
795 return []android.Path{a.aarFile}, nil
796 default:
797 return a.Library.OutputFiles(tag)
798 }
799}
800
Colin Crossa97c5d32018-03-28 14:58:31 -0700801var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
802
803func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
804 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900805 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100806 if sdkDep.hasFrameworkLibs() {
807 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700808 }
Colin Cross4a80a152022-12-21 21:51:52 -0800809 a.usesLibrary.deps(ctx, false)
Jihoon Kang9049c272024-03-19 21:57:36 +0000810
811 for _, aconfig_declaration := range a.aaptProperties.Flags_packages {
812 ctx.AddDependency(ctx.Module(), aconfigDeclarationTag, aconfig_declaration)
813 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700814}
815
816func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800817 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100818 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000819 if a.usesLibrary.shouldDisableDexpreopt {
820 a.dexpreopter.disableDexpreopt()
821 }
Alixf7a10272023-09-27 16:47:56 +0000822 a.aapt.buildActions(ctx,
823 aaptBuildActionOptions{
824 sdkContext: android.SdkContext(a),
825 classLoaderContexts: a.classLoaderContexts,
826 enforceDefaultTargetSdkVersion: false,
Jihoon Kang9049c272024-03-19 21:57:36 +0000827 aconfigTextFiles: getAconfigFilePaths(ctx),
Alixf7a10272023-09-27 16:47:56 +0000828 },
829 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700830
Colin Crossff694a82023-12-13 15:54:49 -0800831 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
832 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700833
yangbill2af0b6e2024-03-15 09:29:29 +0000834 a.stem = proptools.StringDefault(a.overridableProperties.Stem, ctx.ModuleName())
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000835
Colin Cross4eae06d2023-06-20 22:40:02 -0700836 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
837 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800838 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700839 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700840 } else {
841 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700842 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700843
844 // apps manifests are handled by aapt, don't let Module see them
845 a.properties.Manifest = nil
846
Colin Cross014489c2020-06-02 20:09:13 -0700847 a.linter.mergedManifest = a.aapt.mergedManifestFile
848 a.linter.manifest = a.aapt.manifestPath
849 a.linter.resources = a.aapt.resourceFiles
850
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000851 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800852 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800853 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
854 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
855 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
856
857 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
858 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
859 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700860
Colin Cross4eae06d2023-06-20 22:40:02 -0700861 var extraSrcJars android.Paths
862 var extraCombinedJars android.Paths
863 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800864 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700865 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
866 // library and each of the transitive static android_library dependencies has already created an
867 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
868 extraClasspathJars = a.transitiveAaptRJars
869 } else {
870 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
871 // R.java files for the library's package and the packages from all transitive static android_library
872 // dependencies. Compile the srcjar alongside the rest of the sources.
873 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
874 }
875
876 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700877
Colin Crossf57c5782019-01-25 13:20:38 -0800878 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700879 var res android.Paths
880 if a.androidLibraryProperties.BuildAAR {
881 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
882 ctx.CheckbuildFile(a.aarFile)
883 }
Colin Cross89c31582018-04-30 15:55:11 -0700884
Sam Delmerico82602492022-06-10 17:05:42 +0000885 prebuiltJniPackages := android.Paths{}
886 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800887 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000888 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
889 }
890 })
891 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800892 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000893 JniPackages: prebuiltJniPackages,
894 })
895 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700896}
897
Colin Cross95b53b82023-10-17 13:21:02 -0700898func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
899 a.Library.IDEInfo(dpInfo)
900 a.aapt.IDEInfo(dpInfo)
901}
902
903func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800904 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700905 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
906 }
907}
908
Colin Cross1b16b0e2019-02-12 14:41:32 -0800909// android_library builds and links sources into a `.jar` file for the device along with Android resources.
910//
911// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000912// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800913// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
914// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700915func AndroidLibraryFactory() android.Module {
916 module := &AndroidLibrary{}
917
Colin Crossce6734e2020-06-15 16:09:53 -0700918 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700919 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700920 &module.aaptProperties,
921 &module.androidLibraryProperties)
922
923 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700924 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700925
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900926 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700927 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700928 return module
929}
930
Colin Crossfabb6082018-02-20 17:22:23 -0800931//
932// AAR (android library) prebuilts
933//
Colin Crossfabb6082018-02-20 17:22:23 -0800934
Vinh Trance0781f2022-04-13 01:30:44 +0000935// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800936type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000937 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800938 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000939 // If not blank, set to the version of the sdk to compile against.
940 // Defaults to private.
941 // Values are of one of the following forms:
942 // 1) numerical API level, "current", "none", or "core_platform"
943 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
944 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
945 // If the SDK kind is empty, it will be set to public
946 Sdk_version *string
947 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
948 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700949 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000950 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700951 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000952 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
953 Libs []string
954 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700955 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000956 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
957 // will be passed transitively through android_libraries to an android_app.
958 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
959 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800960}
961
962type AARImport struct {
963 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700964 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900965 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800966 prebuilt android.Prebuilt
967
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900968 // Functionality common to Module and Import.
969 embeddableInModuleAndImport
970
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500971 providesTransitiveHeaderJars
972
Colin Crossfabb6082018-02-20 17:22:23 -0800973 properties AARImportProperties
974
Colin Cross312634e2023-11-21 15:13:56 -0800975 classpathFile android.WritablePath
976 proguardFlags android.WritablePath
977 exportPackage android.WritablePath
978 transitiveAaptResourcePackagesFile android.Path
979 extraAaptPackagesFile android.WritablePath
980 manifest android.WritablePath
981 assetsPackage android.WritablePath
982 rTxt android.WritablePath
983 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700984
Colin Crossab8d1382023-07-14 17:23:41 +0000985 resourcesNodesDepSet *android.DepSet[*resourcesNode]
986 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700987
988 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000989
Sam Delmerico82602492022-06-10 17:05:42 +0000990 aarPath android.Path
991 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900992
993 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000994 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000995
996 // Single aconfig "cache file" merged from this module and all dependencies.
997 mergedAconfigFiles map[string]android.Paths
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000998}
999
1000var _ android.OutputFileProducer = (*AARImport)(nil)
1001
1002// For OutputFileProducer interface
1003func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
1004 switch tag {
1005 case ".aar":
1006 return []android.Path{a.aarPath}, nil
1007 case "":
1008 return []android.Path{a.classpathFile}, nil
1009 default:
1010 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
1011 }
Colin Crossfabb6082018-02-20 17:22:23 -08001012}
1013
Jiyong Park92315372021-04-02 08:45:46 +09001014func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1015 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07001016}
1017
Jiyong Parkf1691d22021-03-29 20:11:58 +09001018func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001019 return ""
1020}
1021
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001022func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001023 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001024 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001025 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001026 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001027}
1028
Spandan Dasa26eda72023-03-02 00:56:06 +00001029func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1030 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001031}
1032
Spandan Dasca70fc42023-03-01 23:38:49 +00001033func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1034 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001035}
1036
Colin Cross1e743852019-10-28 11:37:20 -07001037func (a *AARImport) javaVersion() string {
1038 return ""
1039}
1040
Colin Crossa97c5d32018-03-28 14:58:31 -07001041var _ AndroidLibraryDependency = (*AARImport)(nil)
1042
1043func (a *AARImport) ExportPackage() android.Path {
1044 return a.exportPackage
1045}
Colin Crossab8d1382023-07-14 17:23:41 +00001046func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1047 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001048}
1049
Colin Crossab8d1382023-07-14 17:23:41 +00001050func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1051 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001052}
1053
Colin Crossab8d1382023-07-14 17:23:41 +00001054func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1055 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001056}
1057
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001058// RRO enforcement is not available on aar_import since its RRO dirs are not
1059// exported.
1060func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1061}
1062
1063// RRO enforcement is not available on aar_import since its RRO dirs are not
1064// exported.
1065func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1066 return false
1067}
1068
Colin Crossfabb6082018-02-20 17:22:23 -08001069func (a *AARImport) Prebuilt() *android.Prebuilt {
1070 return &a.prebuilt
1071}
1072
1073func (a *AARImport) Name() string {
1074 return a.prebuilt.Name(a.ModuleBase.Name())
1075}
1076
Jiyong Park618922e2020-01-08 13:35:43 +09001077func (a *AARImport) JacocoReportClassesFile() android.Path {
1078 return nil
1079}
1080
Colin Crossfabb6082018-02-20 17:22:23 -08001081func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001082 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001083 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001084 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001085 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001086 }
1087 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001088
Colin Cross42d48b72018-08-29 14:10:52 -07001089 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1090 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001091}
1092
Sam Delmerico82602492022-06-10 17:05:42 +00001093type JniPackageInfo struct {
1094 // List of zip files containing JNI libraries
1095 // Zip files should have directory structure jni/<arch>/*.so
1096 JniPackages android.Paths
1097}
1098
Colin Crossbc7d76c2023-12-12 16:39:03 -08001099var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001100
1101// Unzip an AAR and extract the JNI libs for $archString.
1102var extractJNI = pctx.AndroidStaticRule("extractJNI",
1103 blueprint.RuleParams{
1104 Command: `rm -rf $out $outDir && touch $out && ` +
1105 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1106 `jni_files=$$(find $outDir/jni -type f) && ` +
1107 // print error message if there are no JNI libs for this arch
1108 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001109 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001110 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1111 CommandDeps: []string{"${config.SoongZipCmd}"},
1112 },
1113 "outDir", "archString")
1114
Colin Crossfabb6082018-02-20 17:22:23 -08001115// 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 -07001116// 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 -08001117var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1118 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001119 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001120 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001121 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001122 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001123 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001124 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001125 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001126
1127func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1128 if len(a.properties.Aars) != 1 {
1129 ctx.PropertyErrorf("aars", "exactly one aar is required")
1130 return
1131 }
1132
Jiyong Park92315372021-04-02 08:45:46 +09001133 a.sdkVersion = a.SdkVersion(ctx)
1134 a.minSdkVersion = a.MinSdkVersion(ctx)
1135
Colin Crossff694a82023-12-13 15:54:49 -08001136 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1137 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001138
Nan Zhang4c819fb2018-08-27 18:31:46 -07001139 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001140 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1141
Colin Cross1001a792019-03-21 22:21:39 -07001142 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001143 inputFile := a.aarPath
1144 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1145 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001146 }
Colin Crossfabb6082018-02-20 17:22:23 -08001147
1148 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001149 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001150 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001151 a.rTxt = extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001152 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001153 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001154 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001155 ProguardFlagsFiles: android.NewDepSet[android.Path](
1156 android.POSTORDER,
1157 android.Paths{a.proguardFlags},
1158 nil,
1159 ),
1160 })
Colin Crossfabb6082018-02-20 17:22:23 -08001161
1162 ctx.Build(pctx, android.BuildParams{
1163 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001164 Input: a.aarPath,
Colin Crossbb77d8e2024-02-15 14:43:47 -08001165 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, a.rTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001166 Description: "unzip AAR",
1167 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001168 "outDir": extractedAARDir.String(),
1169 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001170 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001171 },
1172 })
1173
Colin Crossa0ba2f52019-06-22 12:59:27 -07001174 // Always set --pseudo-localize, it will be stripped out later for release
1175 // builds that don't want it.
1176 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001177 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001178 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001179 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001180
1181 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001182 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001183 aaptRTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001184 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001185
1186 var linkDeps android.Paths
1187
1188 linkFlags := []string{
1189 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001190 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001191 "--auto-add-overlay",
Colin Cross7c4dc5d2024-02-13 14:29:45 -08001192 "--no-static-lib-packages",
Colin Crossfabb6082018-02-20 17:22:23 -08001193 }
1194
Colin Cross10f7c4a2018-05-23 10:59:28 -07001195 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1196 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001197
Colin Cross8676c8c2023-10-12 15:58:57 -07001198 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001199 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001200
Colin Cross8676c8c2023-10-12 15:58:57 -07001201 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001202 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001203
Colin Crossab8d1382023-07-14 17:23:41 +00001204 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001205
Colin Crossab8d1382023-07-14 17:23:41 +00001206 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001207 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001208 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001209
Colin Cross4eae06d2023-06-20 22:40:02 -07001210 overlayRes := android.Paths{flata}
1211
1212 // Treat static library dependencies of static libraries as imports.
1213 transitiveStaticLibs := staticDeps.resPackages()
1214 linkDeps = append(linkDeps, transitiveStaticLibs...)
1215 for _, staticLib := range transitiveStaticLibs {
1216 linkFlags = append(linkFlags, "-I "+staticLib.String())
1217 }
Colin Crossfabb6082018-02-20 17:22:23 -08001218
Colin Crossab8d1382023-07-14 17:23:41 +00001219 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossbb77d8e2024-02-15 14:43:47 -08001220 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, aaptRTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001221 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001222
Colin Cross4eae06d2023-06-20 22:40:02 -07001223 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -08001224 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true, nil)
Colin Cross4eae06d2023-06-20 22:40:02 -07001225
Colin Crossf3b7bad2023-08-02 15:49:00 -07001226 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1227
Colin Crossab8d1382023-07-14 17:23:41 +00001228 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1229 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1230 resPackage: a.exportPackage,
1231 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001232 rTxt: a.rTxt,
1233 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001234 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001235
1236 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001237 })
1238 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1239 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1240
1241 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
1242 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
1243 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
1244 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
1245 // android_library_import modules. If this is fixed, AndroidLibraryDependency.ManifestsDepSet can be dropped
1246 // completely in favor of AndroidLibraryDependency.ResourceNodesDepSet.manifest
1247 //manifestDepSetBuilder.Transitive(transitiveStaticDeps.manifests)
1248 _ = staticManifestsDepSet
1249 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001250
Colin Cross312634e2023-11-21 15:13:56 -08001251 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1252 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1253 return p == a.exportPackage.String()
1254 })
1255 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1256 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1257 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001258
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001259 a.collectTransitiveHeaderJars(ctx)
Colin Cross40213022023-12-13 15:19:49 -08001260 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Crossdcf71b22021-02-01 13:59:03 -08001261 HeaderJars: android.PathsIfNonNil(a.classpathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001262 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1263 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08001264 ImplementationAndResourcesJars: android.PathsIfNonNil(a.classpathFile),
1265 ImplementationJars: android.PathsIfNonNil(a.classpathFile),
Jihoon Kangfe914ed2024-02-12 22:49:21 +00001266 StubsLinkType: Implementation,
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001267 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001268 })
Sam Delmerico82602492022-06-10 17:05:42 +00001269
1270 if proptools.Bool(a.properties.Extract_jni) {
1271 for _, t := range ctx.MultiTargets() {
1272 arch := t.Arch.Abi[0]
1273 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1274 a.jniPackages = append(a.jniPackages, path)
1275
1276 outDir := android.PathForModuleOut(ctx, "aarForJni")
1277 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1278 ctx.Build(pctx, android.BuildParams{
1279 Rule: extractJNI,
1280 Input: aarPath,
1281 Outputs: android.WritablePaths{path},
1282 Description: "extract JNI from AAR",
1283 Args: map[string]string{
1284 "outDir": outDir.String(),
1285 "archString": arch,
1286 },
1287 })
1288 }
Sam Delmerico82602492022-06-10 17:05:42 +00001289 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001290
Colin Cross40213022023-12-13 15:19:49 -08001291 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001292 JniPackages: a.jniPackages,
1293 })
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001294 android.CollectDependencyAconfigFiles(ctx, &a.mergedAconfigFiles)
Colin Crossdcf71b22021-02-01 13:59:03 -08001295}
Colin Crossfabb6082018-02-20 17:22:23 -08001296
1297func (a *AARImport) HeaderJars() android.Paths {
1298 return android.Paths{a.classpathFile}
1299}
1300
Colin Cross331a1212018-08-15 20:40:52 -07001301func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
1302 return android.Paths{a.classpathFile}
1303}
1304
Spandan Das59a4a2b2024-01-09 21:35:56 +00001305func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001306 return nil
1307}
1308
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001309func (a *AARImport) DexJarInstallPath() android.Path {
1310 return nil
1311}
1312
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001313func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Jiyong Park1be96912018-05-28 18:02:19 +09001314 return nil
1315}
1316
Jiyong Park45bf82e2020-12-15 22:29:02 +09001317var _ android.ApexModule = (*AARImport)(nil)
1318
1319// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001320func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1321 return a.depIsInSameApex(ctx, dep)
1322}
1323
Jiyong Park45bf82e2020-12-15 22:29:02 +09001324// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07001325func (g *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1326 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001327 return nil
1328}
1329
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001330var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001331
Colin Cross1b16b0e2019-02-12 14:41:32 -08001332// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1333//
1334// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1335// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001336func AARImportFactory() android.Module {
1337 module := &AARImport{}
1338
1339 module.AddProperties(&module.properties)
1340
1341 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001342 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001343 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001344 return module
1345}