blob: 5a478d0655470e6e56e7bcac595148a63e57bfbf [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
Rico Winda2fa2632024-03-13 13:09:17 +0100354 forceNonFinalResourceIDs bool
Alixf7a10272023-09-27 16:47:56 +0000355 extraLinkFlags []string
Jihoon Kang84b25892023-12-01 22:01:06 +0000356 aconfigTextFiles android.Paths
Alixf7a10272023-09-27 16:47:56 +0000357}
358
359func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700360
Colin Cross8676c8c2023-10-12 15:58:57 -0700361 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Alixf7a10272023-09-27 16:47:56 +0000362 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100363
Paul Duffin06530572022-02-03 17:54:15 +0000364 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000365 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000366
Colin Cross31656952018-05-24 16:11:20 -0700367 // App manifest file
368 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
369 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
370
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000371 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000372 SdkContext: opts.sdkContext,
373 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000374 IsLibrary: a.isLibrary,
375 DefaultManifestVersion: a.defaultManifestVersion,
376 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
377 UsesNonSdkApis: a.usesNonSdkApis,
378 UseEmbeddedDex: a.useEmbeddedDex,
379 HasNoCode: a.hasNoCode,
380 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000381 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000382 })
Colin Cross90c25c62019-04-19 16:22:57 -0700383
Colin Crossab8d1382023-07-14 17:23:41 +0000384 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700385 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000386
Luca Stefanifd898822019-09-10 22:13:31 +0200387 // Add additional manifest files to transitive manifests.
388 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000389 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
Colin Crossab8d1382023-07-14 17:23:41 +0000390 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700391
Colin Crossab8d1382023-07-14 17:23:41 +0000392 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000393 manifestMergerParams := ManifestMergerParams{
394 staticLibManifests: transitiveManifestPaths[1:],
Alix96ea88452023-08-31 15:48:23 +0000395 isLibrary: a.isLibrary,
396 packageName: a.manifestValues.applicationId,
397 }
Alixf7a10272023-09-27 16:47:56 +0000398 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700399 if !a.isLibrary {
400 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
401 // will be propagated to the final application and merged there. The merged manifest for libraries is
402 // only passed to Make, which can't handle transitive dependencies.
403 manifestPath = a.mergedManifestFile
404 }
405 } else {
406 a.mergedManifestFile = manifestPath
407 }
Colin Cross31656952018-05-24 16:11:20 -0700408
Alixf7a10272023-09-27 16:47:56 +0000409 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700410
411 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700412 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000413 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000414 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700415 if a.isLibrary {
416 linkFlags = append(linkFlags, "--static-lib")
417 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700418
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800419 linkFlags = append(linkFlags, "--no-static-lib-packages")
Colin Cross8f1b0332024-01-25 13:39:06 -0800420 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800421 // When building an android_library using ResourceProcessorBusyBox pass --merge-only to skip resource
422 // references validation until the final app link step when all static libraries are present.
Colin Cross4eae06d2023-06-20 22:40:02 -0700423 linkFlags = append(linkFlags, "--merge-only")
Colin Cross4eae06d2023-06-20 22:40:02 -0700424 }
425
Colin Crossa97c5d32018-03-28 14:58:31 -0700426 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700427 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
428 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700429 // This file isn't used by Soong, but is generated for exporting
430 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700431 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700432 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700433
Colin Cross4aaa84a2018-08-21 15:14:37 -0700434 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700435 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700436 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900437 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700438 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700439
Colin Crossa592e3e2019-02-19 16:59:53 -0800440 for i, zip := range resZips {
441 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700442 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800443 compiledResDirs = append(compiledResDirs, android.Paths{flata})
444 }
445
Colin Cross4aaa84a2018-08-21 15:14:37 -0700446 var compiledRes, compiledOverlay android.Paths
447
Colin Crossab8d1382023-07-14 17:23:41 +0000448 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
449 // of transitiveStaticLibs.
450 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
451
Colin Cross8f1b0332024-01-25 13:39:06 -0800452 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700453 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
454 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
455 // instead modules depending on this module will reference package-res.apk from all transitive static
456 // dependencies.
Colin Cross1d3f5902024-03-05 11:51:54 -0800457 for _, sharedDep := range sharedDeps {
458 if sharedDep.usedResourceProcessor {
459 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
460 }
461 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700462 for _, staticDep := range staticDeps {
463 linkDeps = append(linkDeps, staticDep.resPackage)
464 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
465 if staticDep.usedResourceProcessor {
466 transitiveRJars = append(transitiveRJars, staticDep.rJar)
467 }
468 }
469 } else {
470 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
471 // dependencies are compiled into this module's package-res.apk as overlays.
472 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
473 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700474
Colin Crossbec85302019-02-13 13:15:46 -0800475 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700476 // If we are using static android libraries, every source file becomes an overlay.
477 // This is to emulate old AAPT behavior which simulated library support.
478 for _, compiledResDir := range compiledResDirs {
479 compiledOverlay = append(compiledOverlay, compiledResDir...)
480 }
Colin Crossbec85302019-02-13 13:15:46 -0800481 } else if a.isLibrary {
482 // Otherwise, for a static library we treat all the resources equally with no overlay.
483 for _, compiledResDir := range compiledResDirs {
484 compiledRes = append(compiledRes, compiledResDir...)
485 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700486 } else if len(compiledResDirs) > 0 {
487 // Without static libraries, the first directory is our directory, which can then be
488 // overlaid by the rest.
489 compiledRes = append(compiledRes, compiledResDirs[0]...)
490 for _, compiledResDir := range compiledResDirs[1:] {
491 compiledOverlay = append(compiledOverlay, compiledResDir...)
492 }
493 }
494
Colin Crossa97c5d32018-03-28 14:58:31 -0700495 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900496 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700497 }
498
Colin Crosse560c4a2019-03-19 16:03:11 -0700499 var splitPackages android.WritablePaths
500 var splits []split
501
502 for _, s := range a.splitNames {
503 suffix := strings.Replace(s, ",", "_", -1)
504 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
505 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
506 splitPackages = append(splitPackages, path)
507 splits = append(splits, split{
508 name: s,
509 suffix: suffix,
510 path: path,
511 })
512 }
513
Colin Cross8f1b0332024-01-25 13:39:06 -0800514 if !a.useResourceProcessorBusyBox(ctx) {
Colin Crossf3b7bad2023-08-02 15:49:00 -0700515 // the subdir "android" is required to be filtered by package names
516 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
517 }
518
Colin Crossab8d1382023-07-14 17:23:41 +0000519 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
520 // provided to the final app aapt2Link step.
521 var transitiveAssets android.Paths
522 if !a.isLibrary {
523 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
524 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700525 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000526 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
527 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800528 // Extract assets from the resource package output so that they can be used later in aapt2link
529 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000530 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800531 assets := android.PathForModuleOut(ctx, "assets.zip")
532 ctx.Build(pctx, android.BuildParams{
533 Rule: extractAssetsRule,
534 Input: packageRes,
535 Output: assets,
536 Description: "extract assets from built resource file",
537 })
538 a.assetPackage = android.OptionalPathForPath(assets)
539 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700540
Colin Cross8f1b0332024-01-25 13:39:06 -0800541 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700542 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Rico Winda2fa2632024-03-13 13:09:17 +0100543 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags,
544 opts.forceNonFinalResourceIDs)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700545 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700546 transitiveRJars = append(transitiveRJars, rJar)
547 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700548 } else {
549 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700550 }
551
Colin Cross312634e2023-11-21 15:13:56 -0800552 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
553 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
554 return p == packageRes.String()
555 })
556 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
557 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
558
Colin Cross1d3f5902024-03-05 11:51:54 -0800559 // Reverse the list of R.jar files so that the current module comes first, and direct dependencies come before
560 // transitive dependencies.
561 transitiveRJars = android.ReversePaths(transitiveRJars)
562
Colin Crossa97c5d32018-03-28 14:58:31 -0700563 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700564 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800565 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700566 a.exportPackage = packageRes
567 a.manifestPath = manifestPath
568 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700569 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700570 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700571 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000572 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
573 Direct(&resourcesNode{
574 resPackage: a.exportPackage,
575 manifest: a.manifestPath,
576 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700577 rTxt: a.rTxt,
578 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000579 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700580
Colin Cross8f1b0332024-01-25 13:39:06 -0800581 usedResourceProcessor: a.useResourceProcessorBusyBox(ctx),
Colin Crossab8d1382023-07-14 17:23:41 +0000582 }).
583 Transitive(staticResourcesNodesDepSet).Build()
584 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
585 Direct(rroDirs...).
586 Transitive(staticRRODirsDepSet).Build()
587 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
588 Direct(a.manifestPath).
589 DirectSlice(additionalManifests).
590 Transitive(staticManifestsDepSet).Build()
591}
592
Colin Cross4eae06d2023-06-20 22:40:02 -0700593var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
594 blueprint.RuleParams{
595 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
596 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
597 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
598 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
599 Rspfile: "${out}.args",
600 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
601 Restat: true,
602 }, "rTxt", "manifest", "args")
603
604// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
605// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
606// supports producing classes for static dependencies that only include resources from that dependency.
607func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Rico Winda2fa2632024-03-13 13:09:17 +0100608 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string,
609 forceNonFinalIds bool) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700610
611 var args []string
612 var deps android.Paths
613
614 if !isLibrary {
615 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
616 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
617 // package.
618 args, deps = transitiveDeps.resourceProcessorDeps()
Rico Winda2fa2632024-03-13 13:09:17 +0100619 if forceNonFinalIds {
620 args = append(args, "--finalFields=false")
621 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700622 } else {
623 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
624 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
625 // inlined into the library before the final IDs are assigned during app compilation.
626 args = append(args, "--finalFields=false")
627 }
628
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800629 for i, arg := range aaptFlags {
630 const AAPT_CUSTOM_PACKAGE = "--custom-package"
631 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
632 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
633 if pkg == "" && i+1 < len(aaptFlags) {
634 pkg = aaptFlags[i+1]
635 }
636 args = append(args, "--packageForR "+pkg)
637 }
638 }
639
Colin Cross4eae06d2023-06-20 22:40:02 -0700640 deps = append(deps, rTxt, manifest)
641
642 ctx.Build(pctx, android.BuildParams{
643 Rule: resourceProcessorBusyBox,
644 Output: rJar,
645 Implicits: deps,
646 Description: "ResourceProcessorBusyBox",
647 Args: map[string]string{
648 "rTxt": rTxt.String(),
649 "manifest": manifest.String(),
650 "args": strings.Join(args, " "),
651 },
652 })
653}
654
Colin Crossab8d1382023-07-14 17:23:41 +0000655type resourcesNode struct {
656 resPackage android.Path
657 manifest android.Path
658 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700659 rTxt android.Path
660 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000661 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700662
663 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000664}
665
666type transitiveAarDeps []*resourcesNode
667
668func (t transitiveAarDeps) resPackages() 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.resPackage)
672 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700673 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000674}
675
676func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700677 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000678 for _, dep := range t {
679 paths = append(paths, dep.manifest)
680 paths = append(paths, dep.additionalManifests...)
681 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700682 return paths
683}
684
685func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
686 for _, dep := range t {
687 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
688 deps = append(deps, dep.rTxt, dep.manifest)
689 }
690 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000691}
692
693func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700694 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000695 for _, dep := range t {
696 if dep.assets.Valid() {
697 paths = append(paths, dep.assets.Path())
698 }
699 }
700 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700701}
702
703// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900704func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700705 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000706 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700707
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100708 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000709 // Not all callers need to compute class loader context, those who don't just pass nil.
710 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100711 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000712 }
713
Colin Cross83bb3162018-06-25 15:48:06 -0700714 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700715 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700716 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700717 }
718
Colin Cross8676c8c2023-10-12 15:58:57 -0700719 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
720 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000721 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
722 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
723
Colin Crossa97c5d32018-03-28 14:58:31 -0700724 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000725 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000726
Colin Crossa97c5d32018-03-28 14:58:31 -0700727 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700728 aarDep, _ := module.(AndroidLibraryDependency)
729 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700730 exportPackage = aarDep.ExportPackage()
731 }
732
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000733 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700734 case instrumentationForTag:
735 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400736 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700737 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700738 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700739 sharedLibs = append(sharedLibs, exportPackage)
740 }
Colin Cross5446e882019-05-22 10:46:27 -0700741 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700742 if exportPackage != nil {
743 sharedLibs = append(sharedLibs, exportPackage)
744 }
745 case staticLibTag:
746 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700747 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000748 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
749 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700750 }
751 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000752
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000753 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700754 })
755
Colin Crossab8d1382023-07-14 17:23:41 +0000756 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
757 // Reverse the dependency order now going into the depset so that it comes out in order after the second
758 // reverse later.
759 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
760 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
Colin Cross9055e212024-03-23 04:43:41 +0000761 // dependency has to be listed last. This is also inconsistent with the way manifests from the same
762 // transitive dependencies are merged.
Colin Crossab8d1382023-07-14 17:23:41 +0000763 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700764 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
765 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
766 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700767
Colin Crossab8d1382023-07-14 17:23:41 +0000768 staticRRODirs = rroDirsDepSetBuilder.Build()
769 staticManifests = manifestsDepSetBuilder.Build()
770
771 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700772 flags = append(flags, "--auto-add-overlay")
773 }
774
775 for _, sharedLib := range sharedLibs {
776 flags = append(flags, "-I "+sharedLib.String())
777 }
778
Colin Cross8676c8c2023-10-12 15:58:57 -0700779 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700780}
781
782type AndroidLibrary struct {
783 Library
784 aapt
785
786 androidLibraryProperties androidLibraryProperties
787
788 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700789}
790
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000791var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
792
793// For OutputFileProducer interface
794func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
795 switch tag {
796 case ".aar":
797 return []android.Path{a.aarFile}, nil
798 default:
799 return a.Library.OutputFiles(tag)
800 }
801}
802
Colin Crossa97c5d32018-03-28 14:58:31 -0700803var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
804
805func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
806 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900807 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100808 if sdkDep.hasFrameworkLibs() {
809 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700810 }
Colin Cross4a80a152022-12-21 21:51:52 -0800811 a.usesLibrary.deps(ctx, false)
Jihoon Kang9049c272024-03-19 21:57:36 +0000812
813 for _, aconfig_declaration := range a.aaptProperties.Flags_packages {
814 ctx.AddDependency(ctx.Module(), aconfigDeclarationTag, aconfig_declaration)
815 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700816}
817
818func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800819 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100820 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000821 if a.usesLibrary.shouldDisableDexpreopt {
822 a.dexpreopter.disableDexpreopt()
823 }
Alixf7a10272023-09-27 16:47:56 +0000824 a.aapt.buildActions(ctx,
825 aaptBuildActionOptions{
826 sdkContext: android.SdkContext(a),
827 classLoaderContexts: a.classLoaderContexts,
828 enforceDefaultTargetSdkVersion: false,
Jihoon Kang9049c272024-03-19 21:57:36 +0000829 aconfigTextFiles: getAconfigFilePaths(ctx),
Alixf7a10272023-09-27 16:47:56 +0000830 },
831 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700832
Colin Crossff694a82023-12-13 15:54:49 -0800833 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
834 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700835
yangbill2af0b6e2024-03-15 09:29:29 +0000836 a.stem = proptools.StringDefault(a.overridableProperties.Stem, ctx.ModuleName())
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000837
Colin Cross4eae06d2023-06-20 22:40:02 -0700838 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
839 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800840 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700841 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700842 } else {
843 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700844 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700845
846 // apps manifests are handled by aapt, don't let Module see them
847 a.properties.Manifest = nil
848
Colin Cross014489c2020-06-02 20:09:13 -0700849 a.linter.mergedManifest = a.aapt.mergedManifestFile
850 a.linter.manifest = a.aapt.manifestPath
851 a.linter.resources = a.aapt.resourceFiles
852
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000853 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800854 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800855 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
856 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
857 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
858
859 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
860 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
861 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700862
Colin Cross4eae06d2023-06-20 22:40:02 -0700863 var extraSrcJars android.Paths
864 var extraCombinedJars android.Paths
865 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800866 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700867 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
868 // library and each of the transitive static android_library dependencies has already created an
869 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
870 extraClasspathJars = a.transitiveAaptRJars
871 } else {
872 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
873 // R.java files for the library's package and the packages from all transitive static android_library
874 // dependencies. Compile the srcjar alongside the rest of the sources.
875 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
876 }
877
878 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700879
Colin Crossf57c5782019-01-25 13:20:38 -0800880 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700881 var res android.Paths
882 if a.androidLibraryProperties.BuildAAR {
883 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
884 ctx.CheckbuildFile(a.aarFile)
885 }
Colin Cross89c31582018-04-30 15:55:11 -0700886
Sam Delmerico82602492022-06-10 17:05:42 +0000887 prebuiltJniPackages := android.Paths{}
888 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800889 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000890 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
891 }
892 })
893 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800894 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000895 JniPackages: prebuiltJniPackages,
896 })
897 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700898}
899
Colin Cross95b53b82023-10-17 13:21:02 -0700900func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
901 a.Library.IDEInfo(dpInfo)
902 a.aapt.IDEInfo(dpInfo)
903}
904
905func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800906 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700907 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
908 }
909}
910
Colin Cross1b16b0e2019-02-12 14:41:32 -0800911// android_library builds and links sources into a `.jar` file for the device along with Android resources.
912//
913// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000914// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800915// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
916// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700917func AndroidLibraryFactory() android.Module {
918 module := &AndroidLibrary{}
919
Colin Crossce6734e2020-06-15 16:09:53 -0700920 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700921 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700922 &module.aaptProperties,
923 &module.androidLibraryProperties)
924
925 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700926 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700927
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900928 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700929 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700930 return module
931}
932
Colin Crossfabb6082018-02-20 17:22:23 -0800933//
934// AAR (android library) prebuilts
935//
Colin Crossfabb6082018-02-20 17:22:23 -0800936
Vinh Trance0781f2022-04-13 01:30:44 +0000937// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800938type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000939 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800940 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000941 // If not blank, set to the version of the sdk to compile against.
942 // Defaults to private.
943 // Values are of one of the following forms:
944 // 1) numerical API level, "current", "none", or "core_platform"
945 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
946 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
947 // If the SDK kind is empty, it will be set to public
948 Sdk_version *string
949 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
950 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700951 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000952 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700953 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000954 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
955 Libs []string
956 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700957 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000958 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
959 // will be passed transitively through android_libraries to an android_app.
960 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
961 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800962}
963
964type AARImport struct {
965 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700966 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900967 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800968 prebuilt android.Prebuilt
969
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900970 // Functionality common to Module and Import.
971 embeddableInModuleAndImport
972
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500973 providesTransitiveHeaderJars
974
Colin Crossfabb6082018-02-20 17:22:23 -0800975 properties AARImportProperties
976
Colin Cross9055e212024-03-23 04:43:41 +0000977 headerJarFile android.WritablePath
978 implementationJarFile android.WritablePath
Colin Cross312634e2023-11-21 15:13:56 -0800979 proguardFlags android.WritablePath
980 exportPackage android.WritablePath
981 transitiveAaptResourcePackagesFile android.Path
982 extraAaptPackagesFile android.WritablePath
983 manifest android.WritablePath
984 assetsPackage android.WritablePath
985 rTxt android.WritablePath
986 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700987
Colin Crossab8d1382023-07-14 17:23:41 +0000988 resourcesNodesDepSet *android.DepSet[*resourcesNode]
989 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700990
991 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000992
Sam Delmerico82602492022-06-10 17:05:42 +0000993 aarPath android.Path
994 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900995
996 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000997 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000998
Colin Cross9055e212024-03-23 04:43:41 +0000999 usesLibrary
1000 classLoaderContexts dexpreopt.ClassLoaderContextMap
1001
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001002 // Single aconfig "cache file" merged from this module and all dependencies.
1003 mergedAconfigFiles map[string]android.Paths
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001004}
1005
1006var _ android.OutputFileProducer = (*AARImport)(nil)
1007
1008// For OutputFileProducer interface
1009func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
1010 switch tag {
1011 case ".aar":
1012 return []android.Path{a.aarPath}, nil
1013 case "":
Colin Cross9055e212024-03-23 04:43:41 +00001014 return []android.Path{a.implementationJarFile}, nil
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001015 default:
1016 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
1017 }
Colin Crossfabb6082018-02-20 17:22:23 -08001018}
1019
Jiyong Park92315372021-04-02 08:45:46 +09001020func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1021 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07001022}
1023
Jiyong Parkf1691d22021-03-29 20:11:58 +09001024func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001025 return ""
1026}
1027
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001028func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001029 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001030 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001031 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001032 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001033}
1034
Spandan Dasa26eda72023-03-02 00:56:06 +00001035func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1036 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001037}
1038
Spandan Dasca70fc42023-03-01 23:38:49 +00001039func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1040 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001041}
1042
Colin Cross1e743852019-10-28 11:37:20 -07001043func (a *AARImport) javaVersion() string {
1044 return ""
1045}
1046
Colin Crossa97c5d32018-03-28 14:58:31 -07001047var _ AndroidLibraryDependency = (*AARImport)(nil)
1048
1049func (a *AARImport) ExportPackage() android.Path {
1050 return a.exportPackage
1051}
Colin Crossab8d1382023-07-14 17:23:41 +00001052func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1053 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001054}
1055
Colin Crossab8d1382023-07-14 17:23:41 +00001056func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1057 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001058}
1059
Colin Crossab8d1382023-07-14 17:23:41 +00001060func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1061 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001062}
1063
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001064// RRO enforcement is not available on aar_import since its RRO dirs are not
1065// exported.
1066func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1067}
1068
1069// RRO enforcement is not available on aar_import since its RRO dirs are not
1070// exported.
1071func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1072 return false
1073}
1074
Colin Crossfabb6082018-02-20 17:22:23 -08001075func (a *AARImport) Prebuilt() *android.Prebuilt {
1076 return &a.prebuilt
1077}
1078
1079func (a *AARImport) Name() string {
1080 return a.prebuilt.Name(a.ModuleBase.Name())
1081}
1082
Jiyong Park618922e2020-01-08 13:35:43 +09001083func (a *AARImport) JacocoReportClassesFile() android.Path {
1084 return nil
1085}
1086
Colin Crossfabb6082018-02-20 17:22:23 -08001087func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001088 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001089 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001090 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001091 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001092 }
1093 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001094
Colin Cross42d48b72018-08-29 14:10:52 -07001095 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1096 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Cross9055e212024-03-23 04:43:41 +00001097
1098 a.usesLibrary.deps(ctx, false)
Colin Crossfabb6082018-02-20 17:22:23 -08001099}
1100
Sam Delmerico82602492022-06-10 17:05:42 +00001101type JniPackageInfo struct {
1102 // List of zip files containing JNI libraries
1103 // Zip files should have directory structure jni/<arch>/*.so
1104 JniPackages android.Paths
1105}
1106
Colin Crossbc7d76c2023-12-12 16:39:03 -08001107var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001108
1109// Unzip an AAR and extract the JNI libs for $archString.
1110var extractJNI = pctx.AndroidStaticRule("extractJNI",
1111 blueprint.RuleParams{
1112 Command: `rm -rf $out $outDir && touch $out && ` +
1113 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1114 `jni_files=$$(find $outDir/jni -type f) && ` +
1115 // print error message if there are no JNI libs for this arch
1116 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001117 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001118 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1119 CommandDeps: []string{"${config.SoongZipCmd}"},
1120 },
1121 "outDir", "archString")
1122
Colin Crossfabb6082018-02-20 17:22:23 -08001123// 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 -07001124// 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 -08001125var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1126 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001127 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001128 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001129 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001130 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001131 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001132 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001133 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001134
1135func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1136 if len(a.properties.Aars) != 1 {
1137 ctx.PropertyErrorf("aars", "exactly one aar is required")
1138 return
1139 }
1140
Jiyong Park92315372021-04-02 08:45:46 +09001141 a.sdkVersion = a.SdkVersion(ctx)
1142 a.minSdkVersion = a.MinSdkVersion(ctx)
1143
Colin Crossff694a82023-12-13 15:54:49 -08001144 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1145 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001146
Nan Zhang4c819fb2018-08-27 18:31:46 -07001147 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001148 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1149
Colin Cross1001a792019-03-21 22:21:39 -07001150 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001151 inputFile := a.aarPath
1152 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1153 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001154 }
Colin Crossfabb6082018-02-20 17:22:23 -08001155
1156 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross28ac2ff2024-04-02 12:21:34 -07001157 classpathFile := extractedAARDir.Join(ctx, ctx.ModuleName()+".jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001158 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001159 a.rTxt = extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001160 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001161 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001162 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001163 ProguardFlagsFiles: android.NewDepSet[android.Path](
1164 android.POSTORDER,
1165 android.Paths{a.proguardFlags},
1166 nil,
1167 ),
1168 })
Colin Crossfabb6082018-02-20 17:22:23 -08001169
1170 ctx.Build(pctx, android.BuildParams{
1171 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001172 Input: a.aarPath,
Colin Cross9055e212024-03-23 04:43:41 +00001173 Outputs: android.WritablePaths{classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, a.rTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001174 Description: "unzip AAR",
1175 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001176 "outDir": extractedAARDir.String(),
Colin Cross9055e212024-03-23 04:43:41 +00001177 "combinedClassesJar": classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001178 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001179 },
1180 })
1181
Colin Crossa0ba2f52019-06-22 12:59:27 -07001182 // Always set --pseudo-localize, it will be stripped out later for release
1183 // builds that don't want it.
1184 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001185 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001186 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001187 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001188
1189 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001190 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001191 aaptRTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001192 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001193
1194 var linkDeps android.Paths
1195
1196 linkFlags := []string{
1197 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001198 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001199 "--auto-add-overlay",
Colin Cross7c4dc5d2024-02-13 14:29:45 -08001200 "--no-static-lib-packages",
Colin Crossfabb6082018-02-20 17:22:23 -08001201 }
1202
Colin Cross10f7c4a2018-05-23 10:59:28 -07001203 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1204 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001205
Colin Cross8676c8c2023-10-12 15:58:57 -07001206 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001207 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001208
Colin Cross8676c8c2023-10-12 15:58:57 -07001209 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001210 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001211
Colin Crossab8d1382023-07-14 17:23:41 +00001212 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001213
Colin Crossab8d1382023-07-14 17:23:41 +00001214 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001215 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001216 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001217
Colin Cross4eae06d2023-06-20 22:40:02 -07001218 overlayRes := android.Paths{flata}
1219
1220 // Treat static library dependencies of static libraries as imports.
1221 transitiveStaticLibs := staticDeps.resPackages()
1222 linkDeps = append(linkDeps, transitiveStaticLibs...)
1223 for _, staticLib := range transitiveStaticLibs {
1224 linkFlags = append(linkFlags, "-I "+staticLib.String())
1225 }
Colin Crossfabb6082018-02-20 17:22:23 -08001226
Colin Crossab8d1382023-07-14 17:23:41 +00001227 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossbb77d8e2024-02-15 14:43:47 -08001228 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, aaptRTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001229 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001230
Colin Cross4eae06d2023-06-20 22:40:02 -07001231 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
Rico Winda2fa2632024-03-13 13:09:17 +01001232 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true, nil, false)
Colin Cross4eae06d2023-06-20 22:40:02 -07001233
Colin Crossf3b7bad2023-08-02 15:49:00 -07001234 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1235
Colin Crossab8d1382023-07-14 17:23:41 +00001236 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1237 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1238 resPackage: a.exportPackage,
1239 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001240 rTxt: a.rTxt,
1241 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001242 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001243
1244 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001245 })
1246 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1247 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1248
1249 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
Colin Cross9055e212024-03-23 04:43:41 +00001250 manifestDepSetBuilder.Transitive(staticManifestsDepSet)
Colin Crossab8d1382023-07-14 17:23:41 +00001251 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001252
Colin Cross312634e2023-11-21 15:13:56 -08001253 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1254 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1255 return p == a.exportPackage.String()
1256 })
1257 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1258 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1259 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001260
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001261 a.collectTransitiveHeaderJars(ctx)
Colin Cross9055e212024-03-23 04:43:41 +00001262
1263 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
1264
1265 var staticJars android.Paths
1266 var staticHeaderJars android.Paths
1267 ctx.VisitDirectDeps(func(module android.Module) {
1268 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
1269 tag := ctx.OtherModuleDependencyTag(module)
1270 switch tag {
1271 case staticLibTag:
1272 staticJars = append(staticJars, dep.ImplementationJars...)
1273 staticHeaderJars = append(staticHeaderJars, dep.HeaderJars...)
1274 }
1275 }
1276 addCLCFromDep(ctx, module, a.classLoaderContexts)
1277 })
1278
Colin Cross28ac2ff2024-04-02 12:21:34 -07001279 var implementationJarFile android.OutputPath
Colin Cross9055e212024-03-23 04:43:41 +00001280 if len(staticJars) > 0 {
1281 combineJars := append(android.Paths{classpathFile}, staticJars...)
Colin Cross28ac2ff2024-04-02 12:21:34 -07001282 implementationJarFile = android.PathForModuleOut(ctx, "combined", ctx.ModuleName()+".jar").OutputPath
1283 TransformJarsToJar(ctx, implementationJarFile, "combine", combineJars, android.OptionalPath{}, false, nil, nil)
Colin Cross9055e212024-03-23 04:43:41 +00001284 } else {
Colin Cross28ac2ff2024-04-02 12:21:34 -07001285 implementationJarFile = classpathFile
Colin Cross9055e212024-03-23 04:43:41 +00001286 }
1287
Colin Cross28ac2ff2024-04-02 12:21:34 -07001288 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1289 a.implementationJarFile = implementationJarFile.WithoutRel()
1290
Colin Cross9055e212024-03-23 04:43:41 +00001291 if len(staticHeaderJars) > 0 {
1292 combineJars := append(android.Paths{classpathFile}, staticHeaderJars...)
1293 a.headerJarFile = android.PathForModuleOut(ctx, "turbine-combined", ctx.ModuleName()+".jar")
1294 TransformJarsToJar(ctx, a.headerJarFile, "combine header jars", combineJars, android.OptionalPath{}, false, nil, nil)
1295 } else {
1296 a.headerJarFile = classpathFile
1297 }
1298
Colin Cross40213022023-12-13 15:19:49 -08001299 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Cross9055e212024-03-23 04:43:41 +00001300 HeaderJars: android.PathsIfNonNil(a.headerJarFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001301 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1302 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Cross9055e212024-03-23 04:43:41 +00001303 ImplementationAndResourcesJars: android.PathsIfNonNil(a.implementationJarFile),
1304 ImplementationJars: android.PathsIfNonNil(a.implementationJarFile),
Jihoon Kangfe914ed2024-02-12 22:49:21 +00001305 StubsLinkType: Implementation,
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001306 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001307 })
Sam Delmerico82602492022-06-10 17:05:42 +00001308
1309 if proptools.Bool(a.properties.Extract_jni) {
1310 for _, t := range ctx.MultiTargets() {
1311 arch := t.Arch.Abi[0]
1312 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1313 a.jniPackages = append(a.jniPackages, path)
1314
1315 outDir := android.PathForModuleOut(ctx, "aarForJni")
1316 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1317 ctx.Build(pctx, android.BuildParams{
1318 Rule: extractJNI,
1319 Input: aarPath,
1320 Outputs: android.WritablePaths{path},
1321 Description: "extract JNI from AAR",
1322 Args: map[string]string{
1323 "outDir": outDir.String(),
1324 "archString": arch,
1325 },
1326 })
1327 }
Sam Delmerico82602492022-06-10 17:05:42 +00001328 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001329
Colin Cross40213022023-12-13 15:19:49 -08001330 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001331 JniPackages: a.jniPackages,
1332 })
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001333 android.CollectDependencyAconfigFiles(ctx, &a.mergedAconfigFiles)
Colin Crossdcf71b22021-02-01 13:59:03 -08001334}
Colin Crossfabb6082018-02-20 17:22:23 -08001335
1336func (a *AARImport) HeaderJars() android.Paths {
Colin Cross9055e212024-03-23 04:43:41 +00001337 return android.Paths{a.headerJarFile}
Colin Crossfabb6082018-02-20 17:22:23 -08001338}
1339
Colin Cross331a1212018-08-15 20:40:52 -07001340func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
Colin Cross9055e212024-03-23 04:43:41 +00001341 return android.Paths{a.implementationJarFile}
Colin Cross331a1212018-08-15 20:40:52 -07001342}
1343
Colin Cross9055e212024-03-23 04:43:41 +00001344func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
1345 return OptionalDexJarPath{}
Colin Crossf24a22a2019-01-31 14:12:44 -08001346}
1347
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001348func (a *AARImport) DexJarInstallPath() android.Path {
1349 return nil
1350}
1351
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001352func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Colin Cross9055e212024-03-23 04:43:41 +00001353 return a.classLoaderContexts
Jiyong Park1be96912018-05-28 18:02:19 +09001354}
1355
Colin Cross9055e212024-03-23 04:43:41 +00001356var _ UsesLibraryDependency = (*AARImport)(nil)
1357
Jiyong Park45bf82e2020-12-15 22:29:02 +09001358var _ android.ApexModule = (*AARImport)(nil)
1359
1360// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001361func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1362 return a.depIsInSameApex(ctx, dep)
1363}
1364
Jiyong Park45bf82e2020-12-15 22:29:02 +09001365// Implements android.ApexModule
Colin Cross9055e212024-03-23 04:43:41 +00001366func (a *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
Dan Albertc8060532020-07-22 22:32:17 -07001367 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001368 return nil
1369}
1370
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001371var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001372
Colin Cross1b16b0e2019-02-12 14:41:32 -08001373// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1374//
1375// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1376// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001377func AARImportFactory() android.Module {
1378 module := &AARImport{}
1379
Colin Cross9055e212024-03-23 04:43:41 +00001380 module.AddProperties(
1381 &module.properties,
1382 &module.usesLibrary.usesLibraryProperties,
1383 )
Colin Crossfabb6082018-02-20 17:22:23 -08001384
1385 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001386 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001387 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001388 return module
1389}