blob: 037342a217333bc3cc3d71f8537f8a567865b1db [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 {
Colin Crosseee4ab12024-03-27 11:54:10 -0700167 return BoolDefault(a.aaptProperties.Use_resource_processor, ctx.Config().UseResourceProcessorByDefault()) &&
168 // TODO(b/331641946): remove this when ResourceProcessorBusyBox supports generating shared libraries.
169 !slices.Contains(a.aaptProperties.Aaptflags, "--shared-lib")
Colin Cross4eae06d2023-06-20 22:40:02 -0700170}
171
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900172func (a *aapt) filterProduct() string {
173 return String(a.aaptProperties.Filter_product)
174}
175
Colin Crossa97c5d32018-03-28 14:58:31 -0700176func (a *aapt) ExportPackage() android.Path {
177 return a.exportPackage
178}
Colin Crossab8d1382023-07-14 17:23:41 +0000179func (a *aapt) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
180 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800181}
182
Colin Crossab8d1382023-07-14 17:23:41 +0000183func (a *aapt) RRODirsDepSet() *android.DepSet[rroDir] {
184 return a.rroDirsDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800185}
186
Colin Crossab8d1382023-07-14 17:23:41 +0000187func (a *aapt) ManifestsDepSet() *android.DepSet[android.Path] {
188 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800189}
190
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700191func (a *aapt) SetRROEnforcedForDependent(enforce bool) {
192 a.aaptProperties.RROEnforcedForDependent = enforce
193}
194
195func (a *aapt) IsRROEnforced(ctx android.BaseModuleContext) bool {
196 // True if RRO is enforced for this module or...
197 return ctx.Config().EnforceRROForModule(ctx.ModuleName()) ||
Jeongik Chacee5ba92021-02-19 12:11:51 +0900198 // if RRO is enforced for any of its dependents.
199 a.aaptProperties.RROEnforcedForDependent
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700200}
201
Jiyong Parkf1691d22021-03-29 20:11:58 +0900202func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext android.SdkContext,
Colin Crossa0ba2f52019-06-22 12:59:27 -0700203 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
204 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700205
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800206 hasVersionCode := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-code")
207 hasVersionName := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-name")
Colin Crossa97c5d32018-03-28 14:58:31 -0700208
Colin Crossa97c5d32018-03-28 14:58:31 -0700209 // Flags specified in Android.bp
210 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
211
Eric Miao40eab202023-03-30 16:57:17 +0000212 linkFlags = append(linkFlags, "--enable-compact-entries")
Colin Crossa97c5d32018-03-28 14:58:31 -0700213
214 // Find implicit or explicit asset and resource dirs
Jiakai Zhangba82e282023-10-13 18:08:59 +0100215 assets := android.PathsRelativeToModuleSourceDir(android.SourceInput{
216 Context: ctx,
217 Paths: a.aaptProperties.Assets,
218 IncludeDirs: false,
219 })
Colin Crossa97c5d32018-03-28 14:58:31 -0700220 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
221 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800222 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700223
Colin Crossa97c5d32018-03-28 14:58:31 -0700224 // Glob directories into lists of paths
225 for _, dir := range resourceDirs {
226 resDirs = append(resDirs, globbedResourceDir{
227 dir: dir,
228 files: androidResourceGlob(ctx, dir),
229 })
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700230 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, a, dir)
Colin Crossa97c5d32018-03-28 14:58:31 -0700231 overlayDirs = append(overlayDirs, resOverlayDirs...)
232 rroDirs = append(rroDirs, resRRODirs...)
233 }
234
Colin Crossc20dc852020-11-10 12:27:45 -0800235 var assetDeps android.Paths
236 for i, dir := range assetDirs {
237 // Add a dependency on every file in the asset directory. This ensures the aapt2
238 // rule will be rerun if one of the files in the asset directory is modified.
239 assetDeps = append(assetDeps, androidResourceGlob(ctx, dir)...)
240
241 // Add a dependency on a file that contains a list of all the files in the asset directory.
242 // This ensures the aapt2 rule will be run if a file is removed from the asset directory,
243 // or a file is added whose timestamp is older than the output of aapt2.
244 assetFileListFile := android.PathForModuleOut(ctx, "asset_dir_globs", strconv.Itoa(i)+".glob")
245 androidResourceGlobList(ctx, dir, assetFileListFile)
246 assetDeps = append(assetDeps, assetFileListFile)
Colin Crossa97c5d32018-03-28 14:58:31 -0700247 }
248
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700249 assetDirStrings := assetDirs.Strings()
250 if a.noticeFile.Valid() {
251 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
Colin Crossc20dc852020-11-10 12:27:45 -0800252 assetDeps = append(assetDeps, a.noticeFile.Path())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700253 }
Jiakai Zhangba82e282023-10-13 18:08:59 +0100254 if len(assets) > 0 {
255 // aapt2 doesn't support adding individual asset files. Create a temp directory to hold asset
256 // files and pass it to aapt2.
257 tmpAssetDir := android.PathForModuleOut(ctx, "tmp_asset_dir")
258
259 rule := android.NewRuleBuilder(pctx, ctx)
260 rule.Command().
261 Text("rm -rf").Text(tmpAssetDir.String()).
262 Text("&&").
263 Text("mkdir -p").Text(tmpAssetDir.String())
264
265 for _, asset := range assets {
266 output := tmpAssetDir.Join(ctx, asset.Rel())
267 assetDeps = append(assetDeps, output)
268 rule.Command().Text("mkdir -p").Text(filepath.Dir(output.String()))
269 rule.Command().Text("cp").Input(asset).Output(output)
270 }
271
272 rule.Build("tmp_asset_dir", "tmp_asset_dir")
273
274 assetDirStrings = append(assetDirStrings, tmpAssetDir.String())
275 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700276
Colin Crossa97c5d32018-03-28 14:58:31 -0700277 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
278 linkDeps = append(linkDeps, manifestPath)
279
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700280 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossc20dc852020-11-10 12:27:45 -0800281 linkDeps = append(linkDeps, assetDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700282
Spandan Das50885c02023-02-23 21:31:33 +0000283 // Returns the effective version for {min|target}_sdk_version
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000284 effectiveVersionString := func(sdkVersion android.SdkSpec, minSdkVersion android.ApiLevel) string {
Spandan Das50885c02023-02-23 21:31:33 +0000285 // If {min|target}_sdk_version is current, use sdk_version to determine the effective level
286 // This is necessary for vendor modules.
287 // The effective version does not _only_ depend on {min|target}_sdk_version(level),
288 // but also on the sdk_version (kind+level)
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000289 if minSdkVersion.IsCurrent() {
Spandan Das50885c02023-02-23 21:31:33 +0000290 ret, err := sdkVersion.EffectiveVersionString(ctx)
291 if err != nil {
292 ctx.ModuleErrorf("invalid sdk_version: %s", err)
293 }
294 return ret
295 }
296 ret, err := minSdkVersion.EffectiveVersionString(ctx)
297 if err != nil {
298 ctx.ModuleErrorf("invalid min_sdk_version: %s", err)
299 }
300 return ret
Jiyong Park6a927c42020-01-21 02:03:43 +0900301 }
Spandan Das50885c02023-02-23 21:31:33 +0000302 // SDK version flags
303 sdkVersion := sdkContext.SdkVersion(ctx)
304 minSdkVersion := effectiveVersionString(sdkVersion, sdkContext.MinSdkVersion(ctx))
Colin Crossa97c5d32018-03-28 14:58:31 -0700305
Colin Cross83bb3162018-06-25 15:48:06 -0700306 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
Spandan Das6450b552023-02-23 19:27:07 +0000307 // Use minSdkVersion for target-sdk-version, even if `target_sdk_version` is set
308 // This behavior has been copied from Make.
Colin Cross83bb3162018-06-25 15:48:06 -0700309 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700310
Colin Crossa97c5d32018-03-28 14:58:31 -0700311 // Version code
312 if !hasVersionCode {
Dan Albert4f378d72020-07-23 17:32:15 -0700313 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion().String())
Colin Crossa97c5d32018-03-28 14:58:31 -0700314 }
315
316 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700317 var versionName string
318 if ctx.ModuleName() == "framework-res" {
319 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
320 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700321 // if it contains the build number. Use the PlatformVersionName instead.
322 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700323 } else {
324 versionName = ctx.Config().AppsDefaultVersionName()
325 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800326 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700327 linkFlags = append(linkFlags, "--version-name ", versionName)
328 }
329
Colin Crossa0ba2f52019-06-22 12:59:27 -0700330 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
331
332 // Always set --pseudo-localize, it will be stripped out later for release
333 // builds that don't want it.
334 compileFlags = append(compileFlags, "--pseudo-localize")
335
336 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700337}
338
Paul Duffin250e6192019-06-07 10:44:37 +0100339func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800340 if sdkDep.frameworkResModule != "" {
341 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700342 }
343}
344
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800345var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
346 blueprint.RuleParams{
347 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
348 CommandDeps: []string{"${config.Zip2ZipCmd}"},
349 })
350
Alixf7a10272023-09-27 16:47:56 +0000351type aaptBuildActionOptions struct {
352 sdkContext android.SdkContext
353 classLoaderContexts dexpreopt.ClassLoaderContextMap
354 excludedLibs []string
355 enforceDefaultTargetSdkVersion bool
Rico Winda2fa2632024-03-13 13:09:17 +0100356 forceNonFinalResourceIDs bool
Alixf7a10272023-09-27 16:47:56 +0000357 extraLinkFlags []string
Jihoon Kang84b25892023-12-01 22:01:06 +0000358 aconfigTextFiles android.Paths
Alixf7a10272023-09-27 16:47:56 +0000359}
360
361func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700362
Colin Cross8676c8c2023-10-12 15:58:57 -0700363 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Alixf7a10272023-09-27 16:47:56 +0000364 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100365
Paul Duffin06530572022-02-03 17:54:15 +0000366 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000367 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000368
Colin Cross31656952018-05-24 16:11:20 -0700369 // App manifest file
370 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
371 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
372
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000373 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000374 SdkContext: opts.sdkContext,
375 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000376 IsLibrary: a.isLibrary,
377 DefaultManifestVersion: a.defaultManifestVersion,
378 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
379 UsesNonSdkApis: a.usesNonSdkApis,
380 UseEmbeddedDex: a.useEmbeddedDex,
381 HasNoCode: a.hasNoCode,
382 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000383 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000384 })
Colin Cross90c25c62019-04-19 16:22:57 -0700385
Colin Crossab8d1382023-07-14 17:23:41 +0000386 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700387 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000388
Luca Stefanifd898822019-09-10 22:13:31 +0200389 // Add additional manifest files to transitive manifests.
390 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000391 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
Colin Crossab8d1382023-07-14 17:23:41 +0000392 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700393
Colin Crossab8d1382023-07-14 17:23:41 +0000394 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000395 manifestMergerParams := ManifestMergerParams{
396 staticLibManifests: transitiveManifestPaths[1:],
Alix96ea88452023-08-31 15:48:23 +0000397 isLibrary: a.isLibrary,
398 packageName: a.manifestValues.applicationId,
399 }
Alixf7a10272023-09-27 16:47:56 +0000400 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700401 if !a.isLibrary {
402 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
403 // will be propagated to the final application and merged there. The merged manifest for libraries is
404 // only passed to Make, which can't handle transitive dependencies.
405 manifestPath = a.mergedManifestFile
406 }
407 } else {
408 a.mergedManifestFile = manifestPath
409 }
Colin Cross31656952018-05-24 16:11:20 -0700410
Alixf7a10272023-09-27 16:47:56 +0000411 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700412
413 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700414 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000415 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000416 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700417 if a.isLibrary {
418 linkFlags = append(linkFlags, "--static-lib")
419 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700420
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800421 linkFlags = append(linkFlags, "--no-static-lib-packages")
Colin Cross8f1b0332024-01-25 13:39:06 -0800422 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross7c4dc5d2024-02-13 14:29:45 -0800423 // When building an android_library using ResourceProcessorBusyBox pass --merge-only to skip resource
424 // references validation until the final app link step when all static libraries are present.
Colin Cross4eae06d2023-06-20 22:40:02 -0700425 linkFlags = append(linkFlags, "--merge-only")
Colin Cross4eae06d2023-06-20 22:40:02 -0700426 }
427
Colin Crossa97c5d32018-03-28 14:58:31 -0700428 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700429 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
430 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700431 // This file isn't used by Soong, but is generated for exporting
432 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700433 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700434 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700435
Colin Cross4aaa84a2018-08-21 15:14:37 -0700436 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700437 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700438 a.resourceFiles = append(a.resourceFiles, dir.files...)
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900439 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700440 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700441
Colin Crossa592e3e2019-02-19 16:59:53 -0800442 for i, zip := range resZips {
443 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700444 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800445 compiledResDirs = append(compiledResDirs, android.Paths{flata})
446 }
447
Colin Cross4aaa84a2018-08-21 15:14:37 -0700448 var compiledRes, compiledOverlay android.Paths
449
Colin Crossab8d1382023-07-14 17:23:41 +0000450 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
451 // of transitiveStaticLibs.
452 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
453
Colin Cross8f1b0332024-01-25 13:39:06 -0800454 if a.isLibrary && a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700455 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
456 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
457 // instead modules depending on this module will reference package-res.apk from all transitive static
458 // dependencies.
Colin Cross1d3f5902024-03-05 11:51:54 -0800459 for _, sharedDep := range sharedDeps {
460 if sharedDep.usedResourceProcessor {
461 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
462 }
463 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700464 for _, staticDep := range staticDeps {
465 linkDeps = append(linkDeps, staticDep.resPackage)
466 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
467 if staticDep.usedResourceProcessor {
468 transitiveRJars = append(transitiveRJars, staticDep.rJar)
469 }
470 }
471 } else {
472 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
473 // dependencies are compiled into this module's package-res.apk as overlays.
474 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
475 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700476
Colin Crossbec85302019-02-13 13:15:46 -0800477 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700478 // If we are using static android libraries, every source file becomes an overlay.
479 // This is to emulate old AAPT behavior which simulated library support.
480 for _, compiledResDir := range compiledResDirs {
481 compiledOverlay = append(compiledOverlay, compiledResDir...)
482 }
Colin Crossbec85302019-02-13 13:15:46 -0800483 } else if a.isLibrary {
484 // Otherwise, for a static library we treat all the resources equally with no overlay.
485 for _, compiledResDir := range compiledResDirs {
486 compiledRes = append(compiledRes, compiledResDir...)
487 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700488 } else if len(compiledResDirs) > 0 {
489 // Without static libraries, the first directory is our directory, which can then be
490 // overlaid by the rest.
491 compiledRes = append(compiledRes, compiledResDirs[0]...)
492 for _, compiledResDir := range compiledResDirs[1:] {
493 compiledOverlay = append(compiledOverlay, compiledResDir...)
494 }
495 }
496
Colin Crossa97c5d32018-03-28 14:58:31 -0700497 for _, dir := range overlayDirs {
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900498 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags, a.filterProduct()).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700499 }
500
Colin Crosse560c4a2019-03-19 16:03:11 -0700501 var splitPackages android.WritablePaths
502 var splits []split
503
504 for _, s := range a.splitNames {
505 suffix := strings.Replace(s, ",", "_", -1)
506 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
507 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
508 splitPackages = append(splitPackages, path)
509 splits = append(splits, split{
510 name: s,
511 suffix: suffix,
512 path: path,
513 })
514 }
515
Colin Cross8f1b0332024-01-25 13:39:06 -0800516 if !a.useResourceProcessorBusyBox(ctx) {
Colin Crossf3b7bad2023-08-02 15:49:00 -0700517 // the subdir "android" is required to be filtered by package names
518 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
519 }
520
Colin Crossab8d1382023-07-14 17:23:41 +0000521 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
522 // provided to the final app aapt2Link step.
523 var transitiveAssets android.Paths
524 if !a.isLibrary {
525 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
526 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700527 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +0000528 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages,
529 opts.aconfigTextFiles)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800530 // Extract assets from the resource package output so that they can be used later in aapt2link
531 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000532 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800533 assets := android.PathForModuleOut(ctx, "assets.zip")
534 ctx.Build(pctx, android.BuildParams{
535 Rule: extractAssetsRule,
536 Input: packageRes,
537 Output: assets,
538 Description: "extract assets from built resource file",
539 })
540 a.assetPackage = android.OptionalPathForPath(assets)
541 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700542
Colin Cross8f1b0332024-01-25 13:39:06 -0800543 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700544 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
Rico Winda2fa2632024-03-13 13:09:17 +0100545 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary, a.aaptProperties.Aaptflags,
546 opts.forceNonFinalResourceIDs)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700547 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700548 transitiveRJars = append(transitiveRJars, rJar)
549 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700550 } else {
551 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700552 }
553
Colin Cross312634e2023-11-21 15:13:56 -0800554 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
555 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
556 return p == packageRes.String()
557 })
558 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
559 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
560
Colin Cross1d3f5902024-03-05 11:51:54 -0800561 // Reverse the list of R.jar files so that the current module comes first, and direct dependencies come before
562 // transitive dependencies.
563 transitiveRJars = android.ReversePaths(transitiveRJars)
564
Colin Crossa97c5d32018-03-28 14:58:31 -0700565 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700566 a.transitiveAaptRJars = transitiveRJars
Colin Cross312634e2023-11-21 15:13:56 -0800567 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700568 a.exportPackage = packageRes
569 a.manifestPath = manifestPath
570 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700571 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700572 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700573 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000574 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
575 Direct(&resourcesNode{
576 resPackage: a.exportPackage,
577 manifest: a.manifestPath,
578 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700579 rTxt: a.rTxt,
580 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000581 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700582
Colin Cross8f1b0332024-01-25 13:39:06 -0800583 usedResourceProcessor: a.useResourceProcessorBusyBox(ctx),
Colin Crossab8d1382023-07-14 17:23:41 +0000584 }).
585 Transitive(staticResourcesNodesDepSet).Build()
586 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
587 Direct(rroDirs...).
588 Transitive(staticRRODirsDepSet).Build()
589 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
590 Direct(a.manifestPath).
591 DirectSlice(additionalManifests).
592 Transitive(staticManifestsDepSet).Build()
593}
594
Colin Cross4eae06d2023-06-20 22:40:02 -0700595var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
596 blueprint.RuleParams{
597 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
598 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
599 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
600 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
601 Rspfile: "${out}.args",
602 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
603 Restat: true,
604 }, "rTxt", "manifest", "args")
605
606// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
607// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
608// supports producing classes for static dependencies that only include resources from that dependency.
609func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
Rico Winda2fa2632024-03-13 13:09:17 +0100610 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool, aaptFlags []string,
611 forceNonFinalIds bool) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700612
613 var args []string
614 var deps android.Paths
615
616 if !isLibrary {
617 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
618 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
619 // package.
620 args, deps = transitiveDeps.resourceProcessorDeps()
Rico Winda2fa2632024-03-13 13:09:17 +0100621 if forceNonFinalIds {
622 args = append(args, "--finalFields=false")
623 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700624 } else {
625 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
626 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
627 // inlined into the library before the final IDs are assigned during app compilation.
628 args = append(args, "--finalFields=false")
629 }
630
Colin Crossd3f7d1a2024-01-03 19:42:25 -0800631 for i, arg := range aaptFlags {
632 const AAPT_CUSTOM_PACKAGE = "--custom-package"
633 if strings.HasPrefix(arg, AAPT_CUSTOM_PACKAGE) {
634 pkg := strings.TrimSpace(strings.TrimPrefix(arg, AAPT_CUSTOM_PACKAGE))
635 if pkg == "" && i+1 < len(aaptFlags) {
636 pkg = aaptFlags[i+1]
637 }
638 args = append(args, "--packageForR "+pkg)
639 }
640 }
641
Colin Cross4eae06d2023-06-20 22:40:02 -0700642 deps = append(deps, rTxt, manifest)
643
644 ctx.Build(pctx, android.BuildParams{
645 Rule: resourceProcessorBusyBox,
646 Output: rJar,
647 Implicits: deps,
648 Description: "ResourceProcessorBusyBox",
649 Args: map[string]string{
650 "rTxt": rTxt.String(),
651 "manifest": manifest.String(),
652 "args": strings.Join(args, " "),
653 },
654 })
655}
656
Colin Crossab8d1382023-07-14 17:23:41 +0000657type resourcesNode struct {
658 resPackage android.Path
659 manifest android.Path
660 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700661 rTxt android.Path
662 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000663 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700664
665 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000666}
667
668type transitiveAarDeps []*resourcesNode
669
670func (t transitiveAarDeps) resPackages() 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.resPackage)
674 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700675 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000676}
677
678func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700679 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000680 for _, dep := range t {
681 paths = append(paths, dep.manifest)
682 paths = append(paths, dep.additionalManifests...)
683 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700684 return paths
685}
686
687func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
688 for _, dep := range t {
689 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
690 deps = append(deps, dep.rTxt, dep.manifest)
691 }
692 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000693}
694
695func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700696 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000697 for _, dep := range t {
698 if dep.assets.Valid() {
699 paths = append(paths, dep.assets.Path())
700 }
701 }
702 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700703}
704
705// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900706func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700707 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000708 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700709
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100710 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000711 // Not all callers need to compute class loader context, those who don't just pass nil.
712 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100713 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000714 }
715
Colin Cross83bb3162018-06-25 15:48:06 -0700716 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700717 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700718 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700719 }
720
Colin Cross8676c8c2023-10-12 15:58:57 -0700721 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
722 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000723 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
724 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
725
Colin Crossa97c5d32018-03-28 14:58:31 -0700726 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000727 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000728
Colin Crossa97c5d32018-03-28 14:58:31 -0700729 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700730 aarDep, _ := module.(AndroidLibraryDependency)
731 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700732 exportPackage = aarDep.ExportPackage()
733 }
734
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000735 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700736 case instrumentationForTag:
737 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400738 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700739 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700740 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700741 sharedLibs = append(sharedLibs, exportPackage)
742 }
Colin Cross5446e882019-05-22 10:46:27 -0700743 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700744 if exportPackage != nil {
745 sharedLibs = append(sharedLibs, exportPackage)
746 }
747 case staticLibTag:
748 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700749 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000750 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
751 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700752 }
753 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000754
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000755 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700756 })
757
Colin Crossab8d1382023-07-14 17:23:41 +0000758 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
759 // Reverse the dependency order now going into the depset so that it comes out in order after the second
760 // reverse later.
761 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
762 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
Colin Cross9055e212024-03-23 04:43:41 +0000763 // dependency has to be listed last. This is also inconsistent with the way manifests from the same
764 // transitive dependencies are merged.
Colin Crossab8d1382023-07-14 17:23:41 +0000765 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700766 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
767 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
768 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700769
Colin Crossab8d1382023-07-14 17:23:41 +0000770 staticRRODirs = rroDirsDepSetBuilder.Build()
771 staticManifests = manifestsDepSetBuilder.Build()
772
773 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700774 flags = append(flags, "--auto-add-overlay")
775 }
776
777 for _, sharedLib := range sharedLibs {
778 flags = append(flags, "-I "+sharedLib.String())
779 }
780
Colin Cross8676c8c2023-10-12 15:58:57 -0700781 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700782}
783
784type AndroidLibrary struct {
785 Library
786 aapt
787
788 androidLibraryProperties androidLibraryProperties
789
790 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700791}
792
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000793var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
794
795// For OutputFileProducer interface
796func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
797 switch tag {
798 case ".aar":
799 return []android.Path{a.aarFile}, nil
800 default:
801 return a.Library.OutputFiles(tag)
802 }
803}
804
Colin Crossa97c5d32018-03-28 14:58:31 -0700805var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
806
807func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000808 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700809 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900810 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100811 if sdkDep.hasFrameworkLibs() {
812 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700813 }
Jihoon Kang9049c272024-03-19 21:57:36 +0000814
815 for _, aconfig_declaration := range a.aaptProperties.Flags_packages {
816 ctx.AddDependency(ctx.Module(), aconfigDeclarationTag, aconfig_declaration)
817 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700818}
819
820func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800821 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100822 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000823 if a.usesLibrary.shouldDisableDexpreopt {
824 a.dexpreopter.disableDexpreopt()
825 }
Alixf7a10272023-09-27 16:47:56 +0000826 a.aapt.buildActions(ctx,
827 aaptBuildActionOptions{
828 sdkContext: android.SdkContext(a),
829 classLoaderContexts: a.classLoaderContexts,
830 enforceDefaultTargetSdkVersion: false,
Jihoon Kang9049c272024-03-19 21:57:36 +0000831 aconfigTextFiles: getAconfigFilePaths(ctx),
Alixf7a10272023-09-27 16:47:56 +0000832 },
833 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700834
Colin Crossff694a82023-12-13 15:54:49 -0800835 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
836 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -0700837
yangbill2af0b6e2024-03-15 09:29:29 +0000838 a.stem = proptools.StringDefault(a.overridableProperties.Stem, ctx.ModuleName())
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000839
Colin Cross4eae06d2023-06-20 22:40:02 -0700840 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
841 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross8f1b0332024-01-25 13:39:06 -0800842 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700843 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700844 } else {
845 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700846 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700847
848 // apps manifests are handled by aapt, don't let Module see them
849 a.properties.Manifest = nil
850
Colin Cross014489c2020-06-02 20:09:13 -0700851 a.linter.mergedManifest = a.aapt.mergedManifestFile
852 a.linter.manifest = a.aapt.manifestPath
853 a.linter.resources = a.aapt.resourceFiles
854
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000855 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -0800856 android.SetProvider(ctx, ProguardSpecInfoProvider, proguardSpecInfo)
Colin Cross312634e2023-11-21 15:13:56 -0800857 exportedProguardFlagsFiles := proguardSpecInfo.ProguardFlagsFiles.ToList()
858 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, exportedProguardFlagsFiles...)
859 a.extraProguardFlagsFiles = append(a.extraProguardFlagsFiles, a.proguardOptionsFile)
860
861 combinedExportedProguardFlagFile := android.PathForModuleOut(ctx, "export_proguard_flags")
862 writeCombinedProguardFlagsFile(ctx, combinedExportedProguardFlagFile, exportedProguardFlagsFiles)
863 a.combinedExportedProguardFlagsFile = combinedExportedProguardFlagFile
Colin Crossa97c5d32018-03-28 14:58:31 -0700864
Colin Cross4eae06d2023-06-20 22:40:02 -0700865 var extraSrcJars android.Paths
866 var extraCombinedJars android.Paths
867 var extraClasspathJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800868 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700869 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
870 // library and each of the transitive static android_library dependencies has already created an
871 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
872 extraClasspathJars = a.transitiveAaptRJars
873 } else {
874 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
875 // R.java files for the library's package and the packages from all transitive static android_library
876 // dependencies. Compile the srcjar alongside the rest of the sources.
877 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
878 }
879
880 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700881
Colin Crossf57c5782019-01-25 13:20:38 -0800882 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700883 var res android.Paths
884 if a.androidLibraryProperties.BuildAAR {
885 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
886 ctx.CheckbuildFile(a.aarFile)
887 }
Colin Cross89c31582018-04-30 15:55:11 -0700888
Sam Delmerico82602492022-06-10 17:05:42 +0000889 prebuiltJniPackages := android.Paths{}
890 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800891 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +0000892 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
893 }
894 })
895 if len(prebuiltJniPackages) > 0 {
Colin Cross40213022023-12-13 15:19:49 -0800896 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Sam Delmerico82602492022-06-10 17:05:42 +0000897 JniPackages: prebuiltJniPackages,
898 })
899 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700900}
901
Colin Cross95b53b82023-10-17 13:21:02 -0700902func (a *AndroidLibrary) IDEInfo(dpInfo *android.IdeInfo) {
903 a.Library.IDEInfo(dpInfo)
904 a.aapt.IDEInfo(dpInfo)
905}
906
907func (a *aapt) IDEInfo(dpInfo *android.IdeInfo) {
Colin Cross8f1b0332024-01-25 13:39:06 -0800908 if a.rJar != nil {
Colin Cross95b53b82023-10-17 13:21:02 -0700909 dpInfo.Jars = append(dpInfo.Jars, a.rJar.String())
910 }
911}
912
Colin Cross1b16b0e2019-02-12 14:41:32 -0800913// android_library builds and links sources into a `.jar` file for the device along with Android resources.
914//
915// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000916// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800917// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
918// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700919func AndroidLibraryFactory() android.Module {
920 module := &AndroidLibrary{}
921
Colin Crossce6734e2020-06-15 16:09:53 -0700922 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700923 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700924 &module.aaptProperties,
925 &module.androidLibraryProperties)
926
927 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700928 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700929
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900930 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700931 InitJavaModule(module, android.DeviceSupported)
Colin Crossa97c5d32018-03-28 14:58:31 -0700932 return module
933}
934
Colin Crossfabb6082018-02-20 17:22:23 -0800935//
936// AAR (android library) prebuilts
937//
Colin Crossfabb6082018-02-20 17:22:23 -0800938
Vinh Trance0781f2022-04-13 01:30:44 +0000939// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800940type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000941 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800942 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000943 // If not blank, set to the version of the sdk to compile against.
944 // Defaults to private.
945 // Values are of one of the following forms:
946 // 1) numerical API level, "current", "none", or "core_platform"
947 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
948 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
949 // If the SDK kind is empty, it will be set to public
950 Sdk_version *string
951 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
952 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700953 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000954 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700955 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000956 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
957 Libs []string
958 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700959 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000960 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
961 // will be passed transitively through android_libraries to an android_app.
962 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
963 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800964}
965
966type AARImport struct {
967 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700968 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900969 android.ApexModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800970 prebuilt android.Prebuilt
971
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900972 // Functionality common to Module and Import.
973 embeddableInModuleAndImport
974
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500975 providesTransitiveHeaderJars
976
Colin Crossfabb6082018-02-20 17:22:23 -0800977 properties AARImportProperties
978
Colin Cross9055e212024-03-23 04:43:41 +0000979 headerJarFile android.WritablePath
980 implementationJarFile android.WritablePath
Colin Cross312634e2023-11-21 15:13:56 -0800981 proguardFlags android.WritablePath
982 exportPackage android.WritablePath
983 transitiveAaptResourcePackagesFile android.Path
984 extraAaptPackagesFile android.WritablePath
985 manifest android.WritablePath
986 assetsPackage android.WritablePath
987 rTxt android.WritablePath
988 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700989
Colin Crossab8d1382023-07-14 17:23:41 +0000990 resourcesNodesDepSet *android.DepSet[*resourcesNode]
991 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700992
993 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000994
Sam Delmerico82602492022-06-10 17:05:42 +0000995 aarPath android.Path
996 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900997
998 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000999 minSdkVersion android.ApiLevel
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001000
Colin Cross9055e212024-03-23 04:43:41 +00001001 usesLibrary
1002 classLoaderContexts dexpreopt.ClassLoaderContextMap
1003
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001004 // Single aconfig "cache file" merged from this module and all dependencies.
1005 mergedAconfigFiles map[string]android.Paths
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001006}
1007
1008var _ android.OutputFileProducer = (*AARImport)(nil)
1009
1010// For OutputFileProducer interface
1011func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
1012 switch tag {
1013 case ".aar":
1014 return []android.Path{a.aarPath}, nil
1015 case "":
Colin Cross9055e212024-03-23 04:43:41 +00001016 return []android.Path{a.implementationJarFile}, nil
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001017 default:
1018 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
1019 }
Colin Crossfabb6082018-02-20 17:22:23 -08001020}
1021
Jiyong Park92315372021-04-02 08:45:46 +09001022func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1023 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07001024}
1025
Jiyong Parkf1691d22021-03-29 20:11:58 +09001026func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +01001027 return ""
1028}
1029
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001030func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -07001031 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001032 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -07001033 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001034 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07001035}
1036
Spandan Dasa26eda72023-03-02 00:56:06 +00001037func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
1038 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00001039}
1040
Spandan Dasca70fc42023-03-01 23:38:49 +00001041func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1042 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -07001043}
1044
Colin Cross1e743852019-10-28 11:37:20 -07001045func (a *AARImport) javaVersion() string {
1046 return ""
1047}
1048
Colin Crossa97c5d32018-03-28 14:58:31 -07001049var _ AndroidLibraryDependency = (*AARImport)(nil)
1050
1051func (a *AARImport) ExportPackage() android.Path {
1052 return a.exportPackage
1053}
Colin Crossab8d1382023-07-14 17:23:41 +00001054func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
1055 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -08001056}
1057
Colin Crossab8d1382023-07-14 17:23:41 +00001058func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
1059 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -07001060}
1061
Colin Crossab8d1382023-07-14 17:23:41 +00001062func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
1063 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001064}
1065
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001066// RRO enforcement is not available on aar_import since its RRO dirs are not
1067// exported.
1068func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1069}
1070
1071// RRO enforcement is not available on aar_import since its RRO dirs are not
1072// exported.
1073func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1074 return false
1075}
1076
Colin Crossfabb6082018-02-20 17:22:23 -08001077func (a *AARImport) Prebuilt() *android.Prebuilt {
1078 return &a.prebuilt
1079}
1080
1081func (a *AARImport) Name() string {
1082 return a.prebuilt.Name(a.ModuleBase.Name())
1083}
1084
Jiyong Park618922e2020-01-08 13:35:43 +09001085func (a *AARImport) JacocoReportClassesFile() android.Path {
1086 return nil
1087}
1088
Colin Crossfabb6082018-02-20 17:22:23 -08001089func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001090 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001091 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001092 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001093 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001094 }
1095 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001096
Colin Cross42d48b72018-08-29 14:10:52 -07001097 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1098 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Cross9055e212024-03-23 04:43:41 +00001099
1100 a.usesLibrary.deps(ctx, false)
Colin Crossfabb6082018-02-20 17:22:23 -08001101}
1102
Sam Delmerico82602492022-06-10 17:05:42 +00001103type JniPackageInfo struct {
1104 // List of zip files containing JNI libraries
1105 // Zip files should have directory structure jni/<arch>/*.so
1106 JniPackages android.Paths
1107}
1108
Colin Crossbc7d76c2023-12-12 16:39:03 -08001109var JniPackageProvider = blueprint.NewProvider[JniPackageInfo]()
Sam Delmerico82602492022-06-10 17:05:42 +00001110
1111// Unzip an AAR and extract the JNI libs for $archString.
1112var extractJNI = pctx.AndroidStaticRule("extractJNI",
1113 blueprint.RuleParams{
1114 Command: `rm -rf $out $outDir && touch $out && ` +
1115 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1116 `jni_files=$$(find $outDir/jni -type f) && ` +
1117 // print error message if there are no JNI libs for this arch
1118 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001119 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001120 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1121 CommandDeps: []string{"${config.SoongZipCmd}"},
1122 },
1123 "outDir", "archString")
1124
Colin Crossfabb6082018-02-20 17:22:23 -08001125// 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 -07001126// 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 -08001127var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1128 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001129 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001130 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001131 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001132 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001133 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001134 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001135 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001136
1137func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1138 if len(a.properties.Aars) != 1 {
1139 ctx.PropertyErrorf("aars", "exactly one aar is required")
1140 return
1141 }
1142
Jiyong Park92315372021-04-02 08:45:46 +09001143 a.sdkVersion = a.SdkVersion(ctx)
1144 a.minSdkVersion = a.MinSdkVersion(ctx)
1145
Colin Crossff694a82023-12-13 15:54:49 -08001146 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
1147 a.hideApexVariantFromMake = !apexInfo.IsForPlatform()
Colin Cross56a83212020-09-15 18:30:11 -07001148
Nan Zhang4c819fb2018-08-27 18:31:46 -07001149 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001150 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1151
Colin Cross1001a792019-03-21 22:21:39 -07001152 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001153 inputFile := a.aarPath
1154 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1155 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001156 }
Colin Crossfabb6082018-02-20 17:22:23 -08001157
1158 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross9055e212024-03-23 04:43:41 +00001159 classpathFile := extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001160 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001161 a.rTxt = extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001162 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001163 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
Colin Crosscde55342024-03-27 14:11:51 -07001164 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
Colin Cross40213022023-12-13 15:19:49 -08001165 android.SetProvider(ctx, ProguardSpecInfoProvider, ProguardSpecInfo{
Sam Delmerico95d70942023-08-02 18:00:35 -04001166 ProguardFlagsFiles: android.NewDepSet[android.Path](
1167 android.POSTORDER,
1168 android.Paths{a.proguardFlags},
Colin Crosscde55342024-03-27 14:11:51 -07001169 transitiveProguardFlags,
1170 ),
1171 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1172 android.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001173 nil,
Colin Crosscde55342024-03-27 14:11:51 -07001174 transitiveUnconditionalExportedFlags,
Sam Delmerico95d70942023-08-02 18:00:35 -04001175 ),
1176 })
Colin Crossfabb6082018-02-20 17:22:23 -08001177
1178 ctx.Build(pctx, android.BuildParams{
1179 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001180 Input: a.aarPath,
Colin Cross9055e212024-03-23 04:43:41 +00001181 Outputs: android.WritablePaths{classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, a.rTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001182 Description: "unzip AAR",
1183 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001184 "outDir": extractedAARDir.String(),
Colin Cross9055e212024-03-23 04:43:41 +00001185 "combinedClassesJar": classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001186 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001187 },
1188 })
1189
Colin Crossa0ba2f52019-06-22 12:59:27 -07001190 // Always set --pseudo-localize, it will be stripped out later for release
1191 // builds that don't want it.
1192 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001193 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001194 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001195 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001196
1197 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001198 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Crossbb77d8e2024-02-15 14:43:47 -08001199 aaptRTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001200 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001201
1202 var linkDeps android.Paths
1203
1204 linkFlags := []string{
1205 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001206 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001207 "--auto-add-overlay",
Colin Cross7c4dc5d2024-02-13 14:29:45 -08001208 "--no-static-lib-packages",
Colin Crossfabb6082018-02-20 17:22:23 -08001209 }
1210
Colin Cross10f7c4a2018-05-23 10:59:28 -07001211 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1212 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001213
Colin Cross8676c8c2023-10-12 15:58:57 -07001214 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001215 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001216
Colin Cross8676c8c2023-10-12 15:58:57 -07001217 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001218 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001219
Colin Crossab8d1382023-07-14 17:23:41 +00001220 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001221
Colin Crossab8d1382023-07-14 17:23:41 +00001222 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001223 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001224 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001225
Colin Cross4eae06d2023-06-20 22:40:02 -07001226 overlayRes := android.Paths{flata}
1227
1228 // Treat static library dependencies of static libraries as imports.
1229 transitiveStaticLibs := staticDeps.resPackages()
1230 linkDeps = append(linkDeps, transitiveStaticLibs...)
1231 for _, staticLib := range transitiveStaticLibs {
1232 linkFlags = append(linkFlags, "-I "+staticLib.String())
1233 }
Colin Crossfabb6082018-02-20 17:22:23 -08001234
Colin Crossab8d1382023-07-14 17:23:41 +00001235 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossbb77d8e2024-02-15 14:43:47 -08001236 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, aaptRTxt,
Jihoon Kang84b25892023-12-01 22:01:06 +00001237 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001238
Colin Cross4eae06d2023-06-20 22:40:02 -07001239 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
Rico Winda2fa2632024-03-13 13:09:17 +01001240 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true, nil, false)
Colin Cross4eae06d2023-06-20 22:40:02 -07001241
Colin Crossf3b7bad2023-08-02 15:49:00 -07001242 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1243
Colin Crossab8d1382023-07-14 17:23:41 +00001244 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1245 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1246 resPackage: a.exportPackage,
1247 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001248 rTxt: a.rTxt,
1249 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001250 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001251
1252 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001253 })
1254 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1255 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1256
1257 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
Colin Cross9055e212024-03-23 04:43:41 +00001258 manifestDepSetBuilder.Transitive(staticManifestsDepSet)
Colin Crossab8d1382023-07-14 17:23:41 +00001259 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001260
Colin Cross312634e2023-11-21 15:13:56 -08001261 transitiveAaptResourcePackages := staticDeps.resPackages().Strings()
1262 transitiveAaptResourcePackages = slices.DeleteFunc(transitiveAaptResourcePackages, func(p string) bool {
1263 return p == a.exportPackage.String()
1264 })
1265 transitiveAaptResourcePackagesFile := android.PathForModuleOut(ctx, "transitive-res-packages")
1266 android.WriteFileRule(ctx, transitiveAaptResourcePackagesFile, strings.Join(transitiveAaptResourcePackages, "\n"))
1267 a.transitiveAaptResourcePackagesFile = transitiveAaptResourcePackagesFile
Colin Cross4eae06d2023-06-20 22:40:02 -07001268
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001269 a.collectTransitiveHeaderJars(ctx)
Colin Cross9055e212024-03-23 04:43:41 +00001270
1271 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
1272
1273 var staticJars android.Paths
1274 var staticHeaderJars android.Paths
1275 ctx.VisitDirectDeps(func(module android.Module) {
1276 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
1277 tag := ctx.OtherModuleDependencyTag(module)
1278 switch tag {
1279 case staticLibTag:
1280 staticJars = append(staticJars, dep.ImplementationJars...)
1281 staticHeaderJars = append(staticHeaderJars, dep.HeaderJars...)
1282 }
1283 }
1284 addCLCFromDep(ctx, module, a.classLoaderContexts)
1285 })
1286
1287 if len(staticJars) > 0 {
1288 combineJars := append(android.Paths{classpathFile}, staticJars...)
1289 a.implementationJarFile = android.PathForModuleOut(ctx, "combined", ctx.ModuleName()+".jar")
1290 TransformJarsToJar(ctx, a.implementationJarFile, "combine", combineJars, android.OptionalPath{}, false, nil, nil)
1291 } else {
1292 a.implementationJarFile = classpathFile
1293 }
1294
1295 if len(staticHeaderJars) > 0 {
1296 combineJars := append(android.Paths{classpathFile}, staticHeaderJars...)
1297 a.headerJarFile = android.PathForModuleOut(ctx, "turbine-combined", ctx.ModuleName()+".jar")
1298 TransformJarsToJar(ctx, a.headerJarFile, "combine header jars", combineJars, android.OptionalPath{}, false, nil, nil)
1299 } else {
1300 a.headerJarFile = classpathFile
1301 }
1302
Colin Cross40213022023-12-13 15:19:49 -08001303 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Colin Cross9055e212024-03-23 04:43:41 +00001304 HeaderJars: android.PathsIfNonNil(a.headerJarFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001305 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1306 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Cross9055e212024-03-23 04:43:41 +00001307 ImplementationAndResourcesJars: android.PathsIfNonNil(a.implementationJarFile),
1308 ImplementationJars: android.PathsIfNonNil(a.implementationJarFile),
Jihoon Kangfe914ed2024-02-12 22:49:21 +00001309 StubsLinkType: Implementation,
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001310 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001311 })
Sam Delmerico82602492022-06-10 17:05:42 +00001312
1313 if proptools.Bool(a.properties.Extract_jni) {
1314 for _, t := range ctx.MultiTargets() {
1315 arch := t.Arch.Abi[0]
1316 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1317 a.jniPackages = append(a.jniPackages, path)
1318
1319 outDir := android.PathForModuleOut(ctx, "aarForJni")
1320 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1321 ctx.Build(pctx, android.BuildParams{
1322 Rule: extractJNI,
1323 Input: aarPath,
1324 Outputs: android.WritablePaths{path},
1325 Description: "extract JNI from AAR",
1326 Args: map[string]string{
1327 "outDir": outDir.String(),
1328 "archString": arch,
1329 },
1330 })
1331 }
Sam Delmerico82602492022-06-10 17:05:42 +00001332 }
Colin Crosse8eeec92023-12-14 14:50:05 -08001333
Colin Cross40213022023-12-13 15:19:49 -08001334 android.SetProvider(ctx, JniPackageProvider, JniPackageInfo{
Colin Crosse8eeec92023-12-14 14:50:05 -08001335 JniPackages: a.jniPackages,
1336 })
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001337 android.CollectDependencyAconfigFiles(ctx, &a.mergedAconfigFiles)
Colin Crossdcf71b22021-02-01 13:59:03 -08001338}
Colin Crossfabb6082018-02-20 17:22:23 -08001339
1340func (a *AARImport) HeaderJars() android.Paths {
Colin Cross9055e212024-03-23 04:43:41 +00001341 return android.Paths{a.headerJarFile}
Colin Crossfabb6082018-02-20 17:22:23 -08001342}
1343
Colin Cross331a1212018-08-15 20:40:52 -07001344func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
Colin Cross9055e212024-03-23 04:43:41 +00001345 return android.Paths{a.implementationJarFile}
Colin Cross331a1212018-08-15 20:40:52 -07001346}
1347
Colin Cross9055e212024-03-23 04:43:41 +00001348func (a *AARImport) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
1349 return OptionalDexJarPath{}
Colin Crossf24a22a2019-01-31 14:12:44 -08001350}
1351
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001352func (a *AARImport) DexJarInstallPath() android.Path {
1353 return nil
1354}
1355
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001356func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Colin Cross9055e212024-03-23 04:43:41 +00001357 return a.classLoaderContexts
Jiyong Park1be96912018-05-28 18:02:19 +09001358}
1359
Colin Cross9055e212024-03-23 04:43:41 +00001360var _ UsesLibraryDependency = (*AARImport)(nil)
1361
Jiyong Park45bf82e2020-12-15 22:29:02 +09001362var _ android.ApexModule = (*AARImport)(nil)
1363
1364// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001365func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1366 return a.depIsInSameApex(ctx, dep)
1367}
1368
Jiyong Park45bf82e2020-12-15 22:29:02 +09001369// Implements android.ApexModule
Colin Cross9055e212024-03-23 04:43:41 +00001370func (a *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
Dan Albertc8060532020-07-22 22:32:17 -07001371 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001372 return nil
1373}
1374
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001375var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001376
Jiakai Zhangf98da192024-04-15 11:15:41 +00001377func (a *AARImport) UsesLibrary() *usesLibrary {
1378 return &a.usesLibrary
1379}
1380
1381var _ ModuleWithUsesLibrary = (*AARImport)(nil)
1382
Colin Cross1b16b0e2019-02-12 14:41:32 -08001383// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1384//
1385// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1386// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001387func AARImportFactory() android.Module {
1388 module := &AARImport{}
1389
Colin Cross9055e212024-03-23 04:43:41 +00001390 module.AddProperties(
1391 &module.properties,
1392 &module.usesLibrary.usesLibraryProperties,
1393 )
Colin Crossfabb6082018-02-20 17:22:23 -08001394
1395 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001396 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001397 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Colin Crossfabb6082018-02-20 17:22:23 -08001398 return module
1399}