blob: b3275316ef2e7c57ca10256450ef534c9f13886f [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...)
Colin Crossab8d1382023-07-14 17:23:41 +0000389 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700390
Colin Crossab8d1382023-07-14 17:23:41 +0000391 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000392 manifestMergerParams := ManifestMergerParams{
393 staticLibManifests: transitiveManifestPaths[1:],
Alix96ea88452023-08-31 15:48:23 +0000394 isLibrary: a.isLibrary,
395 packageName: a.manifestValues.applicationId,
396 }
Alixf7a10272023-09-27 16:47:56 +0000397 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700398 if !a.isLibrary {
399 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
400 // will be propagated to the final application and merged there. The merged manifest for libraries is
401 // only passed to Make, which can't handle transitive dependencies.
402 manifestPath = a.mergedManifestFile
403 }
404 } else {
405 a.mergedManifestFile = manifestPath
406 }
Colin Cross31656952018-05-24 16:11:20 -0700407
Alixf7a10272023-09-27 16:47:56 +0000408 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700409
410 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700411 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000412 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000413 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700414 if a.isLibrary {
415 linkFlags = append(linkFlags, "--static-lib")
416 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700417
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800418 linkFlags = append(linkFlags, "--no-static-lib-packages")
Colin Cross8f1b0332024-01-25 13:39:06 -0800419 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800420 // When building an android_library using ResourceProcessorBusyBox pass --merge-only to skip resource
421 // references validation until the final app link step when all static libraries are present.
Colin Cross4eae06d2023-06-20 22:40:02 -0700422 linkFlags = append(linkFlags, "--merge-only")
Colin Cross4eae06d2023-06-20 22:40:02 -0700423 }
424
Colin Crossa97c5d32018-03-28 14:58:31 -0700425 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700426 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
427 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700428 // This file isn't used by Soong, but is generated for exporting
429 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700430 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700431 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700432
Colin Cross4aaa84a2018-08-21 15:14:37 -0700433 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700434 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700435 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900436 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700437 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700438
Colin Crossa592e3e2019-02-19 16:59:53 -0800439 for i, zip := range resZips {
440 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700441 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800442 compiledResDirs = append(compiledResDirs, android.Paths{flata})
443 }
444
Colin Cross4aaa84a2018-08-21 15:14:37 -0700445 var compiledRes, compiledOverlay android.Paths
446
Colin Crossab8d1382023-07-14 17:23:41 +0000447 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
448 // of transitiveStaticLibs.
449 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
450
Colin Cross8f1b0332024-01-25 13:39:06 -0800451 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700452 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
453 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
454 // instead modules depending on this module will reference package-res.apk from all transitive static
455 // dependencies.
Colin Cross1d3f5902024-03-05 11:51:54 -0800456 for _, sharedDep := range sharedDeps {
457 if sharedDep.usedResourceProcessor {
458 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
459 }
460 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700461 for _, staticDep := range staticDeps {
462 linkDeps = append(linkDeps, staticDep.resPackage)
463 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
464 if staticDep.usedResourceProcessor {
465 transitiveRJars = append(transitiveRJars, staticDep.rJar)
466 }
467 }
468 } else {
469 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
470 // dependencies are compiled into this module's package-res.apk as overlays.
471 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
472 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700473
Colin Crossbec85302019-02-13 13:15:46 -0800474 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700475 // If we are using static android libraries, every source file becomes an overlay.
476 // This is to emulate old AAPT behavior which simulated library support.
477 for _, compiledResDir := range compiledResDirs {
478 compiledOverlay = append(compiledOverlay, compiledResDir...)
479 }
Colin Crossbec85302019-02-13 13:15:46 -0800480 } else if a.isLibrary {
481 // Otherwise, for a static library we treat all the resources equally with no overlay.
482 for _, compiledResDir := range compiledResDirs {
483 compiledRes = append(compiledRes, compiledResDir...)
484 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700485 } else if len(compiledResDirs) > 0 {
486 // Without static libraries, the first directory is our directory, which can then be
487 // overlaid by the rest.
488 compiledRes = append(compiledRes, compiledResDirs[0]...)
489 for _, compiledResDir := range compiledResDirs[1:] {
490 compiledOverlay = append(compiledOverlay, compiledResDir...)
491 }
492 }
493
Colin Crossa97c5d32018-03-28 14:58:31 -0700494 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900495 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700496 }
497
Colin Crosse560c4a2019-03-19 16:03:11 -0700498 var splitPackages android.WritablePaths
499 var splits []split
500
501 for _, s := range a.splitNames {
502 suffix := strings.Replace(s, ",", "_", -1)
503 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
504 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
505 splitPackages = append(splitPackages, path)
506 splits = append(splits, split{
507 name: s,
508 suffix: suffix,
509 path: path,
510 })
511 }
512
Colin Cross8f1b0332024-01-25 13:39:06 -0800513 if !a.useResourceProcessorBusyBox(ctx) {
Colin Crossf3b7bad2023-08-02 15:49:00 -0700514 // the subdir "android" is required to be filtered by package names
515 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
516 }
517
Colin Crossab8d1382023-07-14 17:23:41 +0000518 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
519 // provided to the final app aapt2Link step.
520 var transitiveAssets android.Paths
521 if !a.isLibrary {
522 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
523 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700524 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000525 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
526 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800527 // Extract assets from the resource package output so that they can be used later in aapt2link
528 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000529 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800530 assets := android.PathForModuleOut(ctx, "assets.zip")
531 ctx.Build(pctx, android.BuildParams{
532 Rule: extractAssetsRule,
533 Input: packageRes,
534 Output: assets,
535 Description: "extract assets from built resource file",
536 })
537 a.assetPackage = android.OptionalPathForPath(assets)
538 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700539
Colin Cross8f1b0332024-01-25 13:39:06 -0800540 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700541 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800542 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700543 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700544 transitiveRJars = append(transitiveRJars, rJar)
545 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700546 } else {
547 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700548 }
549
Colin Cross312634e2023-11-21 15:13:56 -0800550 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
551 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
552 return p == packageRes.String()
553 })
554 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
555 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
556
Colin Cross1d3f5902024-03-05 11:51:54 -0800557 // Reverse the list of R.jar files so that the current module comes first, and direct dependencies come before
558 // transitive dependencies.
559 transitiveRJars = android.ReversePaths(transitiveRJars)
560
Colin Crossa97c5d32018-03-28 14:58:31 -0700561 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700562 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800563 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700564 a.exportPackage = packageRes
565 a.manifestPath = manifestPath
566 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700567 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700568 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700569 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000570 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
571 Direct(&resourcesNode{
572 resPackage: a.exportPackage,
573 manifest: a.manifestPath,
574 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700575 rTxt: a.rTxt,
576 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000577 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700578
Colin Cross8f1b0332024-01-25 13:39:06 -0800579 usedResourceProcessor: a.useResourceProcessorBusyBox(ctx),
Colin Crossab8d1382023-07-14 17:23:41 +0000580 }).
581 Transitive(staticResourcesNodesDepSet).Build()
582 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
583 Direct(rroDirs...).
584 Transitive(staticRRODirsDepSet).Build()
585 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
586 Direct(a.manifestPath).
587 DirectSlice(additionalManifests).
588 Transitive(staticManifestsDepSet).Build()
589}
590
Colin Cross4eae06d2023-06-20 22:40:02 -0700591var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
592 blueprint.RuleParams{
593 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
594 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
595 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
596 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
597 Rspfile: "${out}.args",
598 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
599 Restat: true,
600 }, "rTxt", "manifest", "args")
601
602// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
603// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
604// supports producing classes for static dependencies that only include resources from that dependency.
605func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800606 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700607
608 var args []string
609 var deps android.Paths
610
611 if !isLibrary {
612 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
613 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
614 // package.
615 args, deps = transitiveDeps.resourceProcessorDeps()
616 } else {
617 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
618 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
619 // inlined into the library before the final IDs are assigned during app compilation.
620 args = append(args, "--finalFields=false")
621 }
622
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800623 for i, arg := range aaptFlags {
624 const AAPT_CUSTOM_PACKAGE = "--custom-package"
625 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
626 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
627 if pkg == "" && i+1 < len(aaptFlags) {
628 pkg = aaptFlags[i+1]
629 }
630 args = append(args, "--packageForR "+pkg)
631 }
632 }
633
Colin Cross4eae06d2023-06-20 22:40:02 -0700634 deps = append(deps, rTxt, manifest)
635
636 ctx.Build(pctx, android.BuildParams{
637 Rule: resourceProcessorBusyBox,
638 Output: rJar,
639 Implicits: deps,
640 Description: "ResourceProcessorBusyBox",
641 Args: map[string]string{
642 "rTxt": rTxt.String(),
643 "manifest": manifest.String(),
644 "args": strings.Join(args, " "),
645 },
646 })
647}
648
Colin Crossab8d1382023-07-14 17:23:41 +0000649type resourcesNode struct {
650 resPackage android.Path
651 manifest android.Path
652 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700653 rTxt android.Path
654 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000655 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700656
657 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000658}
659
660type transitiveAarDeps []*resourcesNode
661
662func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700663 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000664 for _, dep := range t {
665 paths = append(paths, dep.resPackage)
666 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700667 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000668}
669
670func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700671 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000672 for _, dep := range t {
673 paths = append(paths, dep.manifest)
674 paths = append(paths, dep.additionalManifests...)
675 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700676 return paths
677}
678
679func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
680 for _, dep := range t {
681 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
682 deps = append(deps, dep.rTxt, dep.manifest)
683 }
684 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000685}
686
687func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700688 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000689 for _, dep := range t {
690 if dep.assets.Valid() {
691 paths = append(paths, dep.assets.Path())
692 }
693 }
694 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700695}
696
697// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900698func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700699 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000700 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700701
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100702 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000703 // Not all callers need to compute class loader context, those who don't just pass nil.
704 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100705 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000706 }
707
Colin Cross83bb3162018-06-25 15:48:06 -0700708 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700709 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700710 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700711 }
712
Colin Cross8676c8c2023-10-12 15:58:57 -0700713 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
714 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000715 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
716 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
717
Colin Crossa97c5d32018-03-28 14:58:31 -0700718 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000719 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000720
Colin Crossa97c5d32018-03-28 14:58:31 -0700721 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700722 aarDep, _ := module.(AndroidLibraryDependency)
723 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700724 exportPackage = aarDep.ExportPackage()
725 }
726
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000727 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700728 case instrumentationForTag:
729 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400730 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700731 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700732 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700733 sharedLibs = append(sharedLibs, exportPackage)
734 }
Colin Cross5446e882019-05-22 10:46:27 -0700735 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700736 if exportPackage != nil {
737 sharedLibs = append(sharedLibs, exportPackage)
738 }
739 case staticLibTag:
740 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700741 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000742 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
743 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700744 }
745 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000746
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000747 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700748 })
749
Colin Crossab8d1382023-07-14 17:23:41 +0000750 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
751 // Reverse the dependency order now going into the depset so that it comes out in order after the second
752 // reverse later.
753 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
754 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
Colin Cross81794962024-02-20 12:43:54 -0800755 // dependency has to be listed last. This is also inconsistent with the way manifests from the same
756 // transitive dependencies are merged.
Colin Crossab8d1382023-07-14 17:23:41 +0000757 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700758 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
759 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
760 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700761
Colin Crossab8d1382023-07-14 17:23:41 +0000762 staticRRODirs = rroDirsDepSetBuilder.Build()
763 staticManifests = manifestsDepSetBuilder.Build()
764
765 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700766 flags = append(flags, "--auto-add-overlay")
767 }
768
769 for _, sharedLib := range sharedLibs {
770 flags = append(flags, "-I "+sharedLib.String())
771 }
772
Colin Cross8676c8c2023-10-12 15:58:57 -0700773 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700774}
775
776type AndroidLibrary struct {
777 Library
778 aapt
779
780 androidLibraryProperties androidLibraryProperties
781
782 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700783}
784
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000785var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
786
787// For OutputFileProducer interface
788func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
789 switch tag {
790 case ".aar":
791 return []android.Path{a.aarFile}, nil
792 default:
793 return a.Library.OutputFiles(tag)
794 }
795}
796
Colin Crossa97c5d32018-03-28 14:58:31 -0700797var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
798
799func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
800 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900801 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100802 if sdkDep.hasFrameworkLibs() {
803 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700804 }
Colin Cross4a80a152022-12-21 21:51:52 -0800805 a.usesLibrary.deps(ctx, false)
Jihoon Kang9049c272024-03-19 21:57:36 +0000806
807 for _, aconfig_declaration := range a.aaptProperties.Flags_packages {
808 ctx.AddDependency(ctx.Module(), aconfigDeclarationTag, aconfig_declaration)
809 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700810}
811
812func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800813 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100814 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000815 if a.usesLibrary.shouldDisableDexpreopt {
816 a.dexpreopter.disableDexpreopt()
817 }
Alixf7a10272023-09-27 16:47:56 +0000818 a.aapt.buildActions(ctx,
819 aaptBuildActionOptions{
820 sdkContext: android.SdkContext(a),
821 classLoaderContexts: a.classLoaderContexts,
822 enforceDefaultTargetSdkVersion: false,
Jihoon Kang9049c272024-03-19 21:57:36 +0000823 aconfigTextFiles: getAconfigFilePaths(ctx),
Alixf7a10272023-09-27 16:47:56 +0000824 },
825 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700826
Colin Crossff694a82023-12-13 15:54:49 -0800827 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
828 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700829
yangbill2af0b6e2024-03-15 09:29:29 +0000830 a.stem = proptools.StringDefault(a.overridableProperties.Stem, ctx.ModuleName())
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000831
Colin Cross4eae06d2023-06-20 22:40:02 -0700832 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
833 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800834 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700835 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700836 } else {
837 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700838 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700839
840 // apps manifests are handled by aapt, don't let Module see them
841 a.properties.Manifest = nil
842
Colin Cross014489c2020-06-02 20:09:13 -0700843 a.linter.mergedManifest = a.aapt.mergedManifestFile
844 a.linter.manifest = a.aapt.manifestPath
845 a.linter.resources = a.aapt.resourceFiles
846
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000847 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800848 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800849 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
850 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
851 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
852
853 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
854 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
855 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700856
Colin Cross4eae06d2023-06-20 22:40:02 -0700857 var extraSrcJars android.Paths
858 var extraCombinedJars android.Paths
859 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800860 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700861 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
862 // library and each of the transitive static android_library dependencies has already created an
863 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
864 extraClasspathJars = a.transitiveAaptRJars
865 } else {
866 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
867 // R.java files for the library's package and the packages from all transitive static android_library
868 // dependencies. Compile the srcjar alongside the rest of the sources.
869 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
870 }
871
872 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700873
Colin Crossf57c5782019-01-25 13:20:38 -0800874 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700875 var res android.Paths
876 if a.androidLibraryProperties.BuildAAR {
877 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
878 ctx.CheckbuildFile(a.aarFile)
879 }
Colin Cross89c31582018-04-30 15:55:11 -0700880
Sam Delmerico82602492022-06-10 17:05:42 +0000881 prebuiltJniPackages := android.Paths{}
882 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800883 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000884 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
885 }
886 })
887 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800888 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000889 JniPackages: prebuiltJniPackages,
890 })
891 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700892}
893
Colin Cross95b53b82023-10-17 13:21:02 -0700894func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
895 a.Library.IDEInfo(dpInfo)
896 a.aapt.IDEInfo(dpInfo)
897}
898
899func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800900 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700901 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
902 }
903}
904
Colin Cross1b16b0e2019-02-12 14:41:32 -0800905// android_library builds and links sources into a `.jar` file for the device along with Android resources.
906//
907// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000908// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800909// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
910// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700911func AndroidLibraryFactory() android.Module {
912 module := &AndroidLibrary{}
913
Colin Crossce6734e2020-06-15 16:09:53 -0700914 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700915 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700916 &module.aaptProperties,
917 &module.androidLibraryProperties)
918
919 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700920 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700921
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900922 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700923 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700924 return module
925}
926
Colin Crossfabb6082018-02-20 17:22:23 -0800927//
928// AAR (android library) prebuilts
929//
Colin Crossfabb6082018-02-20 17:22:23 -0800930
Vinh Trance0781f2022-04-13 01:30:44 +0000931// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800932type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000933 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800934 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000935 // If not blank, set to the version of the sdk to compile against.
936 // Defaults to private.
937 // Values are of one of the following forms:
938 // 1) numerical API level, "current", "none", or "core_platform"
939 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
940 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
941 // If the SDK kind is empty, it will be set to public
942 Sdk_version *string
943 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
944 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700945 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000946 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700947 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000948 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
949 Libs []string
950 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700951 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000952 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
953 // will be passed transitively through android_libraries to an android_app.
954 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
955 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800956}
957
958type AARImport struct {
959 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700960 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900961 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800962 prebuilt android.Prebuilt
963
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900964 // Functionality common to Module and Import.
965 embeddableInModuleAndImport
966
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500967 providesTransitiveHeaderJars
968
Colin Crossfabb6082018-02-20 17:22:23 -0800969 properties AARImportProperties
970
Colin Cross81794962024-02-20 12:43:54 -0800971 headerJarFile android.WritablePath
972 implementationJarFile android.WritablePath
Colin Cross312634e2023-11-21 15:13:56 -0800973 proguardFlags android.WritablePath
974 exportPackage android.WritablePath
975 transitiveAaptResourcePackagesFile android.Path
976 extraAaptPackagesFile android.WritablePath
977 manifest android.WritablePath
978 assetsPackage android.WritablePath
979 rTxt android.WritablePath
980 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700981
Colin Crossab8d1382023-07-14 17:23:41 +0000982 resourcesNodesDepSet *android.DepSet[*resourcesNode]
983 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700984
985 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000986
Sam Delmerico82602492022-06-10 17:05:42 +0000987 aarPath android.Path
988 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900989
990 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000991 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000992
Colin Cross81794962024-02-20 12:43:54 -0800993 usesLibrary
994 classLoaderContexts dexpreopt.ClassLoaderContextMap
995
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000996 // 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 "":
Colin Cross81794962024-02-20 12:43:54 -08001008 return []android.Path{a.implementationJarFile}, nil
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001009 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 Cross81794962024-02-20 12:43:54 -08001091
1092 a.usesLibrary.deps(ctx, false)
Colin Crossfabb6082018-02-20 17:22:23 -08001093}
1094
Sam Delmerico82602492022-06-10 17:05:42 +00001095type JniPackageInfo struct {
1096 // List of zip files containing JNI libraries
1097 // Zip files should have directory structure jni/<arch>/*.so
1098 JniPackages android.Paths
1099}
1100
Colin Crossbc7d76c2023-12-12 16:39:03 -08001101var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001102
1103// Unzip an AAR and extract the JNI libs for $archString.
1104var extractJNI = pctx.AndroidStaticRule("extractJNI",
1105 blueprint.RuleParams{
1106 Command: `rm -rf $out $outDir && touch $out && ` +
1107 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1108 `jni_files=$$(find $outDir/jni -type f) && ` +
1109 // print error message if there are no JNI libs for this arch
1110 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001111 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001112 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1113 CommandDeps: []string{"${config.SoongZipCmd}"},
1114 },
1115 "outDir", "archString")
1116
Colin Crossfabb6082018-02-20 17:22:23 -08001117// 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 -07001118// 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 -08001119var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1120 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001121 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001122 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001123 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001124 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001125 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001126 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001127 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001128
1129func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1130 if len(a.properties.Aars) != 1 {
1131 ctx.PropertyErrorf("aars", "exactly one aar is required")
1132 return
1133 }
1134
Jiyong Park92315372021-04-02 08:45:46 +09001135 a.sdkVersion = a.SdkVersion(ctx)
1136 a.minSdkVersion = a.MinSdkVersion(ctx)
1137
Colin Crossff694a82023-12-13 15:54:49 -08001138 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1139 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001140
Nan Zhang4c819fb2018-08-27 18:31:46 -07001141 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001142 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1143
Colin Cross1001a792019-03-21 22:21:39 -07001144 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001145 inputFile := a.aarPath
1146 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1147 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001148 }
Colin Crossfabb6082018-02-20 17:22:23 -08001149
1150 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross81794962024-02-20 12:43:54 -08001151 classpathFile := extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001152 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001153 a.rTxt = extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001154 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001155 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Cross40213022023-12-13 15:19:49 -08001156 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001157 ProguardFlagsFiles: android.NewDepSet[android.Path](
1158 android.POSTORDER,
1159 android.Paths{a.proguardFlags},
1160 nil,
1161 ),
1162 })
Colin Crossfabb6082018-02-20 17:22:23 -08001163
1164 ctx.Build(pctx, android.BuildParams{
1165 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001166 Input: a.aarPath,
Colin Cross81794962024-02-20 12:43:54 -08001167 Outputs: android.WritablePaths{classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, a.rTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001168 Description: "unzip AAR",
1169 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001170 "outDir": extractedAARDir.String(),
Colin Cross81794962024-02-20 12:43:54 -08001171 "combinedClassesJar": classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001172 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001173 },
1174 })
1175
Colin Crossa0ba2f52019-06-22 12:59:27 -07001176 // Always set --pseudo-localize, it will be stripped out later for release
1177 // builds that don't want it.
1178 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001179 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001180 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001181 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001182
1183 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001184 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001185 aaptRTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001186 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001187
1188 var linkDeps android.Paths
1189
1190 linkFlags := []string{
1191 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001192 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001193 "--auto-add-overlay",
Colin Cross7c4dc5d2024-02-13 14:29:45 -08001194 "--no-static-lib-packages",
Colin Crossfabb6082018-02-20 17:22:23 -08001195 }
1196
Colin Cross10f7c4a2018-05-23 10:59:28 -07001197 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1198 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001199
Colin Cross8676c8c2023-10-12 15:58:57 -07001200 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001201 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001202
Colin Cross8676c8c2023-10-12 15:58:57 -07001203 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001204 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001205
Colin Crossab8d1382023-07-14 17:23:41 +00001206 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001207
Colin Crossab8d1382023-07-14 17:23:41 +00001208 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001209 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001210 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001211
Colin Cross4eae06d2023-06-20 22:40:02 -07001212 overlayRes := android.Paths{flata}
1213
1214 // Treat static library dependencies of static libraries as imports.
1215 transitiveStaticLibs := staticDeps.resPackages()
1216 linkDeps = append(linkDeps, transitiveStaticLibs...)
1217 for _, staticLib := range transitiveStaticLibs {
1218 linkFlags = append(linkFlags, "-I "+staticLib.String())
1219 }
Colin Crossfabb6082018-02-20 17:22:23 -08001220
Colin Crossab8d1382023-07-14 17:23:41 +00001221 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossbb77d8e2024-02-15 14:43:47 -08001222 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, aaptRTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001223 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001224
Colin Cross4eae06d2023-06-20 22:40:02 -07001225 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
Colin Crossd3f7d1a2024-01-03 19:42:25 -08001226 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true, nil)
Colin Cross4eae06d2023-06-20 22:40:02 -07001227
Colin Crossf3b7bad2023-08-02 15:49:00 -07001228 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1229
Colin Crossab8d1382023-07-14 17:23:41 +00001230 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1231 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1232 resPackage: a.exportPackage,
1233 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001234 rTxt: a.rTxt,
1235 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001236 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001237
1238 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001239 })
1240 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1241 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1242
1243 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
Colin Cross81794962024-02-20 12:43:54 -08001244 manifestDepSetBuilder.Transitive(staticManifestsDepSet)
Colin Crossab8d1382023-07-14 17:23:41 +00001245 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001246
Colin Cross312634e2023-11-21 15:13:56 -08001247 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1248 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1249 return p == a.exportPackage.String()
1250 })
1251 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1252 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1253 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001254
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001255 a.collectTransitiveHeaderJars(ctx)
Colin Cross81794962024-02-20 12:43:54 -08001256
1257 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
1258
1259 var staticJars android.Paths
1260 var staticHeaderJars android.Paths
1261 ctx.VisitDirectDeps(func(module android.Module) {
1262 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
1263 tag := ctx.OtherModuleDependencyTag(module)
1264 switch tag {
1265 case staticLibTag:
1266 staticJars = append(staticJars, dep.ImplementationJars...)
1267 staticHeaderJars = append(staticHeaderJars, dep.HeaderJars...)
1268 }
1269 }
1270 addCLCFromDep(ctx, module, a.classLoaderContexts)
1271 })
1272
1273 if len(staticJars) > 0 {
1274 combineJars := append(android.Paths{classpathFile}, staticJars...)
1275 a.implementationJarFile = android.PathForModuleOut(ctx, "combined", ctx.ModuleName()+".jar")
1276 TransformJarsToJar(ctx, a.implementationJarFile, "combine", combineJars, android.OptionalPath{}, false, nil, nil)
1277 } else {
1278 a.implementationJarFile = classpathFile
1279 }
1280
1281 if len(staticHeaderJars) > 0 {
1282 combineJars := append(android.Paths{classpathFile}, staticHeaderJars...)
1283 a.headerJarFile = android.PathForModuleOut(ctx, "turbine-combined", ctx.ModuleName()+".jar")
1284 TransformJarsToJar(ctx, a.headerJarFile, "combine header jars", combineJars, android.OptionalPath{}, false, nil, nil)
1285 } else {
1286 a.headerJarFile = classpathFile
1287 }
1288
Colin Cross40213022023-12-13 15:19:49 -08001289 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Cross81794962024-02-20 12:43:54 -08001290 HeaderJars: android.PathsIfNonNil(a.headerJarFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001291 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1292 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Cross81794962024-02-20 12:43:54 -08001293 ImplementationAndResourcesJars: android.PathsIfNonNil(a.implementationJarFile),
1294 ImplementationJars: android.PathsIfNonNil(a.implementationJarFile),
Jihoon Kangfe914ed2024-02-12 22:49:21 +00001295 StubsLinkType: Implementation,
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001296 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001297 })
Sam Delmerico82602492022-06-10 17:05:42 +00001298
1299 if proptools.Bool(a.properties.Extract_jni) {
1300 for _, t := range ctx.MultiTargets() {
1301 arch := t.Arch.Abi[0]
1302 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1303 a.jniPackages = append(a.jniPackages, path)
1304
1305 outDir := android.PathForModuleOut(ctx, "aarForJni")
1306 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1307 ctx.Build(pctx, android.BuildParams{
1308 Rule: extractJNI,
1309 Input: aarPath,
1310 Outputs: android.WritablePaths{path},
1311 Description: "extract JNI from AAR",
1312 Args: map[string]string{
1313 "outDir": outDir.String(),
1314 "archString": arch,
1315 },
1316 })
1317 }
Sam Delmerico82602492022-06-10 17:05:42 +00001318 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001319
Colin Cross40213022023-12-13 15:19:49 -08001320 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001321 JniPackages: a.jniPackages,
1322 })
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001323 android.CollectDependencyAconfigFiles(ctx, &a.mergedAconfigFiles)
Colin Crossdcf71b22021-02-01 13:59:03 -08001324}
Colin Crossfabb6082018-02-20 17:22:23 -08001325
1326func (a *AARImport) HeaderJars() android.Paths {
Colin Cross81794962024-02-20 12:43:54 -08001327 return android.Paths{a.headerJarFile}
Colin Crossfabb6082018-02-20 17:22:23 -08001328}
1329
Colin Cross331a1212018-08-15 20:40:52 -07001330func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
Colin Cross81794962024-02-20 12:43:54 -08001331 return android.Paths{a.implementationJarFile}
Colin Cross331a1212018-08-15 20:40:52 -07001332}
1333
Colin Cross81794962024-02-20 12:43:54 -08001334func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
1335 return OptionalDexJarPath{}
Colin Crossf24a22a2019-01-31 14:12:44 -08001336}
1337
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001338func (a *AARImport) DexJarInstallPath() android.Path {
1339 return nil
1340}
1341
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001342func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Colin Cross81794962024-02-20 12:43:54 -08001343 return a.classLoaderContexts
Jiyong Park1be96912018-05-28 18:02:19 +09001344}
1345
Colin Cross81794962024-02-20 12:43:54 -08001346var _ UsesLibraryDependency = (*AARImport)(nil)
1347
Jiyong Park45bf82e2020-12-15 22:29:02 +09001348var _ android.ApexModule = (*AARImport)(nil)
1349
1350// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001351func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1352 return a.depIsInSameApex(ctx, dep)
1353}
1354
Jiyong Park45bf82e2020-12-15 22:29:02 +09001355// Implements android.ApexModule
Colin Cross81794962024-02-20 12:43:54 -08001356func (a *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
Dan Albertc8060532020-07-22 22:32:17 -07001357 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001358 return nil
1359}
1360
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001361var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001362
Colin Cross1b16b0e2019-02-12 14:41:32 -08001363// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1364//
1365// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1366// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001367func AARImportFactory() android.Module {
1368 module := &AARImport{}
1369
Colin Cross81794962024-02-20 12:43:54 -08001370 module.AddProperties(
1371 &module.properties,
1372 &module.usesLibrary.usesLibraryProperties,
1373 )
Colin Crossfabb6082018-02-20 17:22:23 -08001374
1375 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001376 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001377 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001378 return module
1379}