blob: 368f2416a11d808e85e674daa7cdb15f47d5d81c [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 Crossc20dc852020-11-10 12:27:45 -080020 "strconv"
Colin Crossa97c5d32018-03-28 14:58:31 -070021 "strings"
Colin Crossfabb6082018-02-20 17:22:23 -080022
Jaewoong Jung9befb0c2020-01-18 10:33:43 -080023 "android/soong/android"
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -050024 "android/soong/bazel"
Ulya Trafimovich31e444e2020-08-14 17:32:16 +010025 "android/soong/dexpreopt"
Romain Jobredeaux7a71e072023-08-16 17:39:12 -040026 "android/soong/ui/metrics/bp2build_metrics_proto"
Jaewoong Jung9befb0c2020-01-18 10:33:43 -080027
Colin Crossfabb6082018-02-20 17:22:23 -080028 "github.com/google/blueprint"
Colin Crossa97c5d32018-03-28 14:58:31 -070029 "github.com/google/blueprint/proptools"
Colin Crossfabb6082018-02-20 17:22:23 -080030)
31
Colin Crossa97c5d32018-03-28 14:58:31 -070032type AndroidLibraryDependency interface {
Colin Crossa97c5d32018-03-28 14:58:31 -070033 ExportPackage() android.Path
Colin Crossab8d1382023-07-14 17:23:41 +000034 ResourcesNodeDepSet() *android.DepSet[*resourcesNode]
35 RRODirsDepSet() *android.DepSet[rroDir]
36 ManifestsDepSet() *android.DepSet[android.Path]
Jaewoong Jungc779cd42020-10-06 18:56:10 -070037 SetRROEnforcedForDependent(enforce bool)
38 IsRROEnforced(ctx android.BaseModuleContext) bool
Colin Crossa97c5d32018-03-28 14:58:31 -070039}
40
41func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000042 RegisterAARBuildComponents(android.InitRegistrationContext)
43}
44
45func RegisterAARBuildComponents(ctx android.RegistrationContext) {
46 ctx.RegisterModuleType("android_library_import", AARImportFactory)
47 ctx.RegisterModuleType("android_library", AndroidLibraryFactory)
Paul Duffin04ba70d2021-03-22 13:56:43 +000048 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
49 ctx.TopDown("propagate_rro_enforcement", propagateRROEnforcementMutator).Parallel()
50 })
Colin Crossa97c5d32018-03-28 14:58:31 -070051}
52
53//
54// AAR (android library)
55//
56
57type androidLibraryProperties struct {
58 BuildAAR bool `blueprint:"mutated"`
59}
60
61type aaptProperties struct {
62 // flags passed to aapt when creating the apk
63 Aaptflags []string
64
Dan Willemsen72be5902018-10-24 20:24:57 -070065 // include all resource configurations, not just the product-configured
66 // ones.
67 Aapt_include_all_resources *bool
68
Jiakai Zhangba82e282023-10-13 18:08:59 +010069 // list of files to use as assets.
70 Assets []string `android:"path"`
71
Colin Crossa97c5d32018-03-28 14:58:31 -070072 // list of directories relative to the Blueprints file containing assets.
Colin Cross0ddae7f2019-02-07 15:30:01 -080073 // Defaults to ["assets"] if a directory called assets exists. Set to []
74 // to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070075 Asset_dirs []string
76
77 // list of directories relative to the Blueprints file containing
Colin Cross0ddae7f2019-02-07 15:30:01 -080078 // Android resources. Defaults to ["res"] if a directory called res exists.
79 // Set to [] to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070080 Resource_dirs []string
81
Colin Crossa592e3e2019-02-19 16:59:53 -080082 // list of zip files containing Android resources.
Colin Cross27b922f2019-03-04 22:35:41 -080083 Resource_zips []string `android:"path"`
Colin Crossa592e3e2019-02-19 16:59:53 -080084
Colin Crossa97c5d32018-03-28 14:58:31 -070085 // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml".
Colin Cross27b922f2019-03-04 22:35:41 -080086 Manifest *string `android:"path"`
changho.shinb5432b72019-08-08 18:37:17 +090087
88 // paths to additional manifest files to merge with main manifest.
89 Additional_manifests []string `android:"path"`
Sasha Smundak541056c2019-10-28 15:50:06 -070090
91 // do not include AndroidManifest from dependent libraries
92 Dont_merge_manifests *bool
Jaewoong Jungc779cd42020-10-06 18:56:10 -070093
Colin Cross4eae06d2023-06-20 22:40:02 -070094 // If use_resource_processor is set, use Bazel's resource processor instead of aapt2 to generate R.class files.
95 // The resource processor produces more optimal R.class files that only list resources in the package of the
96 // library that provided them, as opposed to aapt2 which produces R.java files for every package containing
97 // every resource. Using the resource processor can provide significant build time speedups, but requires
98 // fixing the module to use the correct package to reference each resource, and to avoid having any other
99 // libraries in the tree that use the same package name. Defaults to false, but will default to true in the
100 // future.
101 Use_resource_processor *bool
102
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700103 // true if RRO is enforced for any of the dependent modules
104 RROEnforcedForDependent bool `blueprint:"mutated"`
Colin Crossa97c5d32018-03-28 14:58:31 -0700105}
106
107type aapt struct {
Colin Cross4eae06d2023-06-20 22:40:02 -0700108 aaptSrcJar android.Path
109 transitiveAaptRJars android.Paths
110 transitiveAaptResourcePackages android.Paths
111 exportPackage android.Path
112 manifestPath android.Path
113 proguardOptionsFile android.Path
114 rTxt android.Path
115 rJar android.Path
116 extraAaptPackagesFile android.Path
117 mergedManifestFile android.Path
118 noticeFile android.OptionalPath
119 assetPackage android.OptionalPath
120 isLibrary bool
121 defaultManifestVersion string
122 useEmbeddedNativeLibs bool
123 useEmbeddedDex bool
124 usesNonSdkApis bool
125 hasNoCode bool
126 LoggingParent string
127 resourceFiles android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700128
Colin Crosse560c4a2019-03-19 16:03:11 -0700129 splitNames []string
130 splits []split
131
Colin Crossa97c5d32018-03-28 14:58:31 -0700132 aaptProperties aaptProperties
Colin Crossab8d1382023-07-14 17:23:41 +0000133
134 resourcesNodesDepSet *android.DepSet[*resourcesNode]
135 rroDirsDepSet *android.DepSet[rroDir]
136 manifestsDepSet *android.DepSet[android.Path]
Colin Crossa97c5d32018-03-28 14:58:31 -0700137}
138
Colin Crosse560c4a2019-03-19 16:03:11 -0700139type split struct {
140 name string
141 suffix string
142 path android.Path
143}
144
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700145// Propagate RRO enforcement flag to static lib dependencies transitively.
146func propagateRROEnforcementMutator(ctx android.TopDownMutatorContext) {
147 m := ctx.Module()
148 if d, ok := m.(AndroidLibraryDependency); ok && d.IsRROEnforced(ctx) {
149 ctx.VisitDirectDepsWithTag(staticLibTag, func(d android.Module) {
150 if a, ok := d.(AndroidLibraryDependency); ok {
151 a.SetRROEnforcedForDependent(true)
152 }
153 })
154 }
155}
156
Colin Cross4eae06d2023-06-20 22:40:02 -0700157func (a *aapt) useResourceProcessorBusyBox() bool {
158 return BoolDefault(a.aaptProperties.Use_resource_processor, false)
159}
160
Colin Crossa97c5d32018-03-28 14:58:31 -0700161func (a *aapt) ExportPackage() android.Path {
162 return a.exportPackage
163}
Colin Crossab8d1382023-07-14 17:23:41 +0000164func (a *aapt) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
165 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800166}
167
Colin Crossab8d1382023-07-14 17:23:41 +0000168func (a *aapt) RRODirsDepSet() *android.DepSet[rroDir] {
169 return a.rroDirsDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800170}
171
Colin Crossab8d1382023-07-14 17:23:41 +0000172func (a *aapt) ManifestsDepSet() *android.DepSet[android.Path] {
173 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800174}
175
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700176func (a *aapt) SetRROEnforcedForDependent(enforce bool) {
177 a.aaptProperties.RROEnforcedForDependent = enforce
178}
179
180func (a *aapt) IsRROEnforced(ctx android.BaseModuleContext) bool {
181 // True if RRO is enforced for this module or...
182 return ctx.Config().EnforceRROForModule(ctx.ModuleName()) ||
Jeongik Chacee5ba92021-02-19 12:11:51 +0900183 // if RRO is enforced for any of its dependents.
184 a.aaptProperties.RROEnforcedForDependent
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700185}
186
Jiyong Parkf1691d22021-03-29 20:11:58 +0900187func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext android.SdkContext,
Colin Crossa0ba2f52019-06-22 12:59:27 -0700188 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
189 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700190
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800191 hasVersionCode := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-code")
192 hasVersionName := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-name")
Colin Crossa97c5d32018-03-28 14:58:31 -0700193
Colin Crossa97c5d32018-03-28 14:58:31 -0700194 // Flags specified in Android.bp
195 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
196
Colin Crossa97c5d32018-03-28 14:58:31 -0700197 // Find implicit or explicit asset and resource dirs
Jiakai Zhangba82e282023-10-13 18:08:59 +0100198 assets := android.PathsRelativeToModuleSourceDir(android.SourceInput{
199 Context: ctx,
200 Paths: a.aaptProperties.Assets,
201 IncludeDirs: false,
202 })
Colin Crossa97c5d32018-03-28 14:58:31 -0700203 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
204 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800205 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700206
Colin Crossa97c5d32018-03-28 14:58:31 -0700207 // Glob directories into lists of paths
208 for _, dir := range resourceDirs {
209 resDirs = append(resDirs, globbedResourceDir{
210 dir: dir,
211 files: androidResourceGlob(ctx, dir),
212 })
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700213 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, a, dir)
Colin Crossa97c5d32018-03-28 14:58:31 -0700214 overlayDirs = append(overlayDirs, resOverlayDirs...)
215 rroDirs = append(rroDirs, resRRODirs...)
216 }
217
Colin Crossc20dc852020-11-10 12:27:45 -0800218 var assetDeps android.Paths
219 for i, dir := range assetDirs {
220 // Add a dependency on every file in the asset directory. This ensures the aapt2
221 // rule will be rerun if one of the files in the asset directory is modified.
222 assetDeps = append(assetDeps, androidResourceGlob(ctx, dir)...)
223
224 // Add a dependency on a file that contains a list of all the files in the asset directory.
225 // This ensures the aapt2 rule will be run if a file is removed from the asset directory,
226 // or a file is added whose timestamp is older than the output of aapt2.
227 assetFileListFile := android.PathForModuleOut(ctx, "asset_dir_globs", strconv.Itoa(i)+".glob")
228 androidResourceGlobList(ctx, dir, assetFileListFile)
229 assetDeps = append(assetDeps, assetFileListFile)
Colin Crossa97c5d32018-03-28 14:58:31 -0700230 }
231
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700232 assetDirStrings := assetDirs.Strings()
233 if a.noticeFile.Valid() {
234 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
Colin Crossc20dc852020-11-10 12:27:45 -0800235 assetDeps = append(assetDeps, a.noticeFile.Path())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700236 }
Jiakai Zhangba82e282023-10-13 18:08:59 +0100237 if len(assets) > 0 {
238 // aapt2 doesn't support adding individual asset files. Create a temp directory to hold asset
239 // files and pass it to aapt2.
240 tmpAssetDir := android.PathForModuleOut(ctx, "tmp_asset_dir")
241
242 rule := android.NewRuleBuilder(pctx, ctx)
243 rule.Command().
244 Text("rm -rf").Text(tmpAssetDir.String()).
245 Text("&&").
246 Text("mkdir -p").Text(tmpAssetDir.String())
247
248 for _, asset := range assets {
249 output := tmpAssetDir.Join(ctx, asset.Rel())
250 assetDeps = append(assetDeps, output)
251 rule.Command().Text("mkdir -p").Text(filepath.Dir(output.String()))
252 rule.Command().Text("cp").Input(asset).Output(output)
253 }
254
255 rule.Build("tmp_asset_dir", "tmp_asset_dir")
256
257 assetDirStrings = append(assetDirStrings, tmpAssetDir.String())
258 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700259
Colin Crossa97c5d32018-03-28 14:58:31 -0700260 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
261 linkDeps = append(linkDeps, manifestPath)
262
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700263 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossc20dc852020-11-10 12:27:45 -0800264 linkDeps = append(linkDeps, assetDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700265
Spandan Das50885c02023-02-23 21:31:33 +0000266 // Returns the effective version for {min|target}_sdk_version
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000267 effectiveVersionString := func(sdkVersion android.SdkSpec, minSdkVersion android.ApiLevel) string {
Spandan Das50885c02023-02-23 21:31:33 +0000268 // If {min|target}_sdk_version is current, use sdk_version to determine the effective level
269 // This is necessary for vendor modules.
270 // The effective version does not _only_ depend on {min|target}_sdk_version(level),
271 // but also on the sdk_version (kind+level)
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000272 if minSdkVersion.IsCurrent() {
Spandan Das50885c02023-02-23 21:31:33 +0000273 ret, err := sdkVersion.EffectiveVersionString(ctx)
274 if err != nil {
275 ctx.ModuleErrorf("invalid sdk_version: %s", err)
276 }
277 return ret
278 }
279 ret, err := minSdkVersion.EffectiveVersionString(ctx)
280 if err != nil {
281 ctx.ModuleErrorf("invalid min_sdk_version: %s", err)
282 }
283 return ret
Jiyong Park6a927c42020-01-21 02:03:43 +0900284 }
Spandan Das50885c02023-02-23 21:31:33 +0000285 // SDK version flags
286 sdkVersion := sdkContext.SdkVersion(ctx)
287 minSdkVersion := effectiveVersionString(sdkVersion, sdkContext.MinSdkVersion(ctx))
Colin Crossa97c5d32018-03-28 14:58:31 -0700288
Colin Cross83bb3162018-06-25 15:48:06 -0700289 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
Spandan Das6450b552023-02-23 19:27:07 +0000290 // Use minSdkVersion for target-sdk-version, even if `target_sdk_version` is set
291 // This behavior has been copied from Make.
Colin Cross83bb3162018-06-25 15:48:06 -0700292 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700293
Colin Crossa97c5d32018-03-28 14:58:31 -0700294 // Version code
295 if !hasVersionCode {
Dan Albert4f378d72020-07-23 17:32:15 -0700296 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion().String())
Colin Crossa97c5d32018-03-28 14:58:31 -0700297 }
298
299 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700300 var versionName string
301 if ctx.ModuleName() == "framework-res" {
302 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
303 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700304 // if it contains the build number. Use the PlatformVersionName instead.
305 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700306 } else {
307 versionName = ctx.Config().AppsDefaultVersionName()
308 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800309 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700310 linkFlags = append(linkFlags, "--version-name ", versionName)
311 }
312
Colin Crossa0ba2f52019-06-22 12:59:27 -0700313 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
314
315 // Always set --pseudo-localize, it will be stripped out later for release
316 // builds that don't want it.
317 compileFlags = append(compileFlags, "--pseudo-localize")
318
319 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700320}
321
Paul Duffin250e6192019-06-07 10:44:37 +0100322func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800323 if sdkDep.frameworkResModule != "" {
324 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700325 }
326}
327
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800328var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
329 blueprint.RuleParams{
330 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
331 CommandDeps: []string{"${config.Zip2ZipCmd}"},
332 })
333
Alixf7a10272023-09-27 16:47:56 +0000334type aaptBuildActionOptions struct {
335 sdkContext android.SdkContext
336 classLoaderContexts dexpreopt.ClassLoaderContextMap
337 excludedLibs []string
338 enforceDefaultTargetSdkVersion bool
339 extraLinkFlags []string
340}
341
342func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700343
Colin Cross8676c8c2023-10-12 15:58:57 -0700344 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Alixf7a10272023-09-27 16:47:56 +0000345 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100346
Paul Duffin06530572022-02-03 17:54:15 +0000347 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000348 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000349
Colin Cross31656952018-05-24 16:11:20 -0700350 // App manifest file
351 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
352 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
353
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000354 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000355 SdkContext: opts.sdkContext,
356 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000357 IsLibrary: a.isLibrary,
358 DefaultManifestVersion: a.defaultManifestVersion,
359 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
360 UsesNonSdkApis: a.usesNonSdkApis,
361 UseEmbeddedDex: a.useEmbeddedDex,
362 HasNoCode: a.hasNoCode,
363 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000364 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000365 })
Colin Cross90c25c62019-04-19 16:22:57 -0700366
Colin Crossab8d1382023-07-14 17:23:41 +0000367 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700368 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000369
Luca Stefanifd898822019-09-10 22:13:31 +0200370 // Add additional manifest files to transitive manifests.
371 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000372 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
373 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
374 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
375 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
376 // android_library_import modules. If this is fixed, staticManifestsDepSet can be dropped completely in favor of
377 // staticResourcesNodesDepSet.manifests()
378 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700379
Colin Crossab8d1382023-07-14 17:23:41 +0000380 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000381 manifestMergerParams := ManifestMergerParams{
382 staticLibManifests: transitiveManifestPaths[1:],
383 isLibrary: a.isLibrary}
384 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700385 if !a.isLibrary {
386 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
387 // will be propagated to the final application and merged there. The merged manifest for libraries is
388 // only passed to Make, which can't handle transitive dependencies.
389 manifestPath = a.mergedManifestFile
390 }
391 } else {
392 a.mergedManifestFile = manifestPath
393 }
Colin Cross31656952018-05-24 16:11:20 -0700394
Alixf7a10272023-09-27 16:47:56 +0000395 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700396
397 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700398 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000399 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000400 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700401 if a.isLibrary {
402 linkFlags = append(linkFlags, "--static-lib")
403 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700404
Colin Cross4eae06d2023-06-20 22:40:02 -0700405 if a.isLibrary && a.useResourceProcessorBusyBox() {
406 // When building an android_library using ResourceProcessorBusyBox the resources are merged into
407 // package-res.apk with --merge-only, but --no-static-lib-packages is not used so that R.txt only
408 // contains resources from this library.
409 linkFlags = append(linkFlags, "--merge-only")
410 } else {
411 // When building and app or when building an android_library without ResourceProcessorBusyBox
412 // --no-static-lib-packages is used to put all the resources into the app. If ResourceProcessorBusyBox
413 // is used then the app's R.txt will be post-processed along with the R.txt files from dependencies to
414 // sort resources into the right packages in R.class.
415 linkFlags = append(linkFlags, "--no-static-lib-packages")
416 }
417
Colin Crossa97c5d32018-03-28 14:58:31 -0700418 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700419 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
420 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700421 // This file isn't used by Soong, but is generated for exporting
422 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700423 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700424 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700425
Colin Cross4aaa84a2018-08-21 15:14:37 -0700426 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700427 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700428 a.resourceFiles = append(a.resourceFiles, dir.files...)
Colin Crossa0ba2f52019-06-22 12:59:27 -0700429 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700430 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700431
Colin Crossa592e3e2019-02-19 16:59:53 -0800432 for i, zip := range resZips {
433 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700434 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800435 compiledResDirs = append(compiledResDirs, android.Paths{flata})
436 }
437
Colin Cross4aaa84a2018-08-21 15:14:37 -0700438 var compiledRes, compiledOverlay android.Paths
439
Colin Crossab8d1382023-07-14 17:23:41 +0000440 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
441 // of transitiveStaticLibs.
442 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
443
Colin Cross4eae06d2023-06-20 22:40:02 -0700444 if a.isLibrary && a.useResourceProcessorBusyBox() {
445 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
446 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
447 // instead modules depending on this module will reference package-res.apk from all transitive static
448 // dependencies.
449 for _, staticDep := range staticDeps {
450 linkDeps = append(linkDeps, staticDep.resPackage)
451 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
452 if staticDep.usedResourceProcessor {
453 transitiveRJars = append(transitiveRJars, staticDep.rJar)
454 }
455 }
Colin Cross8676c8c2023-10-12 15:58:57 -0700456 for _, sharedDep := range sharedDeps {
457 if sharedDep.usedResourceProcessor {
458 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
459 }
460 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700461 } else {
462 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
463 // dependencies are compiled into this module's package-res.apk as overlays.
464 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
465 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700466
Colin Crossbec85302019-02-13 13:15:46 -0800467 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700468 // If we are using static android libraries, every source file becomes an overlay.
469 // This is to emulate old AAPT behavior which simulated library support.
470 for _, compiledResDir := range compiledResDirs {
471 compiledOverlay = append(compiledOverlay, compiledResDir...)
472 }
Colin Crossbec85302019-02-13 13:15:46 -0800473 } else if a.isLibrary {
474 // Otherwise, for a static library we treat all the resources equally with no overlay.
475 for _, compiledResDir := range compiledResDirs {
476 compiledRes = append(compiledRes, compiledResDir...)
477 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700478 } else if len(compiledResDirs) > 0 {
479 // Without static libraries, the first directory is our directory, which can then be
480 // overlaid by the rest.
481 compiledRes = append(compiledRes, compiledResDirs[0]...)
482 for _, compiledResDir := range compiledResDirs[1:] {
483 compiledOverlay = append(compiledOverlay, compiledResDir...)
484 }
485 }
486
Colin Crossa97c5d32018-03-28 14:58:31 -0700487 for _, dir := range overlayDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700488 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700489 }
490
Colin Crosse560c4a2019-03-19 16:03:11 -0700491 var splitPackages android.WritablePaths
492 var splits []split
493
494 for _, s := range a.splitNames {
495 suffix := strings.Replace(s, ",", "_", -1)
496 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
497 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
498 splitPackages = append(splitPackages, path)
499 splits = append(splits, split{
500 name: s,
501 suffix: suffix,
502 path: path,
503 })
504 }
505
Colin Crossf3b7bad2023-08-02 15:49:00 -0700506 if !a.useResourceProcessorBusyBox() {
507 // the subdir "android" is required to be filtered by package names
508 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
509 }
510
Colin Crossab8d1382023-07-14 17:23:41 +0000511 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
512 // provided to the final app aapt2Link step.
513 var transitiveAssets android.Paths
514 if !a.isLibrary {
515 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
516 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700517 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Colin Crossab8d1382023-07-14 17:23:41 +0000518 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800519 // Extract assets from the resource package output so that they can be used later in aapt2link
520 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000521 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800522 assets := android.PathForModuleOut(ctx, "assets.zip")
523 ctx.Build(pctx, android.BuildParams{
524 Rule: extractAssetsRule,
525 Input: packageRes,
526 Output: assets,
527 Description: "extract assets from built resource file",
528 })
529 a.assetPackage = android.OptionalPathForPath(assets)
530 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700531
Colin Cross4eae06d2023-06-20 22:40:02 -0700532 if a.useResourceProcessorBusyBox() {
533 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
534 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700535 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700536 transitiveRJars = append(transitiveRJars, rJar)
537 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700538 } else {
539 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700540 }
541
Colin Crossa97c5d32018-03-28 14:58:31 -0700542 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700543 a.transitiveAaptRJars = transitiveRJars
544 a.transitiveAaptResourcePackages = staticDeps.resPackages()
Colin Crossa97c5d32018-03-28 14:58:31 -0700545 a.exportPackage = packageRes
546 a.manifestPath = manifestPath
547 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700548 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700549 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700550 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000551 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
552 Direct(&resourcesNode{
553 resPackage: a.exportPackage,
554 manifest: a.manifestPath,
555 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700556 rTxt: a.rTxt,
557 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000558 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700559
560 usedResourceProcessor: a.useResourceProcessorBusyBox(),
Colin Crossab8d1382023-07-14 17:23:41 +0000561 }).
562 Transitive(staticResourcesNodesDepSet).Build()
563 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
564 Direct(rroDirs...).
565 Transitive(staticRRODirsDepSet).Build()
566 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
567 Direct(a.manifestPath).
568 DirectSlice(additionalManifests).
569 Transitive(staticManifestsDepSet).Build()
570}
571
Colin Cross4eae06d2023-06-20 22:40:02 -0700572var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
573 blueprint.RuleParams{
574 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
575 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
576 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
577 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
578 Rspfile: "${out}.args",
579 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
580 Restat: true,
581 }, "rTxt", "manifest", "args")
582
583// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
584// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
585// supports producing classes for static dependencies that only include resources from that dependency.
586func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
587 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool) {
588
589 var args []string
590 var deps android.Paths
591
592 if !isLibrary {
593 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
594 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
595 // package.
596 args, deps = transitiveDeps.resourceProcessorDeps()
597 } else {
598 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
599 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
600 // inlined into the library before the final IDs are assigned during app compilation.
601 args = append(args, "--finalFields=false")
602 }
603
604 deps = append(deps, rTxt, manifest)
605
606 ctx.Build(pctx, android.BuildParams{
607 Rule: resourceProcessorBusyBox,
608 Output: rJar,
609 Implicits: deps,
610 Description: "ResourceProcessorBusyBox",
611 Args: map[string]string{
612 "rTxt": rTxt.String(),
613 "manifest": manifest.String(),
614 "args": strings.Join(args, " "),
615 },
616 })
617}
618
Colin Crossab8d1382023-07-14 17:23:41 +0000619type resourcesNode struct {
620 resPackage android.Path
621 manifest android.Path
622 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700623 rTxt android.Path
624 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000625 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700626
627 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000628}
629
630type transitiveAarDeps []*resourcesNode
631
632func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700633 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000634 for _, dep := range t {
635 paths = append(paths, dep.resPackage)
636 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700637 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000638}
639
640func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700641 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000642 for _, dep := range t {
643 paths = append(paths, dep.manifest)
644 paths = append(paths, dep.additionalManifests...)
645 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700646 return paths
647}
648
649func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
650 for _, dep := range t {
651 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
652 deps = append(deps, dep.rTxt, dep.manifest)
653 }
654 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000655}
656
657func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700658 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000659 for _, dep := range t {
660 if dep.assets.Valid() {
661 paths = append(paths, dep.assets.Path())
662 }
663 }
664 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700665}
666
667// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900668func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700669 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000670 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700671
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100672 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000673 // Not all callers need to compute class loader context, those who don't just pass nil.
674 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100675 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000676 }
677
Colin Cross83bb3162018-06-25 15:48:06 -0700678 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700679 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700680 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700681 }
682
Colin Cross8676c8c2023-10-12 15:58:57 -0700683 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
684 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000685 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
686 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
687
Colin Crossa97c5d32018-03-28 14:58:31 -0700688 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000689 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000690
Colin Crossa97c5d32018-03-28 14:58:31 -0700691 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700692 aarDep, _ := module.(AndroidLibraryDependency)
693 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700694 exportPackage = aarDep.ExportPackage()
695 }
696
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000697 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700698 case instrumentationForTag:
699 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400700 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700701 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700702 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700703 sharedLibs = append(sharedLibs, exportPackage)
704 }
Colin Cross5446e882019-05-22 10:46:27 -0700705 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700706 if exportPackage != nil {
707 sharedLibs = append(sharedLibs, exportPackage)
708 }
709 case staticLibTag:
710 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700711 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000712 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
713 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700714 }
715 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000716
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000717 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700718 })
719
Colin Crossab8d1382023-07-14 17:23:41 +0000720 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
721 // Reverse the dependency order now going into the depset so that it comes out in order after the second
722 // reverse later.
723 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
724 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
725 // dependency has to be listed last.
726 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700727 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
728 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
729 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700730
Colin Crossab8d1382023-07-14 17:23:41 +0000731 staticRRODirs = rroDirsDepSetBuilder.Build()
732 staticManifests = manifestsDepSetBuilder.Build()
733
734 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700735 flags = append(flags, "--auto-add-overlay")
736 }
737
738 for _, sharedLib := range sharedLibs {
739 flags = append(flags, "-I "+sharedLib.String())
740 }
741
Colin Cross8676c8c2023-10-12 15:58:57 -0700742 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700743}
744
745type AndroidLibrary struct {
746 Library
747 aapt
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -0500748 android.BazelModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700749
750 androidLibraryProperties androidLibraryProperties
751
752 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700753}
754
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000755var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
756
757// For OutputFileProducer interface
758func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
759 switch tag {
760 case ".aar":
761 return []android.Path{a.aarFile}, nil
762 default:
763 return a.Library.OutputFiles(tag)
764 }
765}
766
Colin Crossa97c5d32018-03-28 14:58:31 -0700767var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
768
769func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
770 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900771 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100772 if sdkDep.hasFrameworkLibs() {
773 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700774 }
Colin Cross4a80a152022-12-21 21:51:52 -0800775 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700776}
777
778func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800779 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100780 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Alixf7a10272023-09-27 16:47:56 +0000781 a.aapt.buildActions(ctx,
782 aaptBuildActionOptions{
783 sdkContext: android.SdkContext(a),
784 classLoaderContexts: a.classLoaderContexts,
785 enforceDefaultTargetSdkVersion: false,
786 },
787 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700788
Colin Cross56a83212020-09-15 18:30:11 -0700789 a.hideApexVariantFromMake = !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
790
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000791 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
792
Colin Cross4eae06d2023-06-20 22:40:02 -0700793 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
794 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross4eae06d2023-06-20 22:40:02 -0700795 if a.useResourceProcessorBusyBox() {
796 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700797 } else {
798 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700799 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700800
801 // apps manifests are handled by aapt, don't let Module see them
802 a.properties.Manifest = nil
803
Colin Cross014489c2020-06-02 20:09:13 -0700804 a.linter.mergedManifest = a.aapt.mergedManifestFile
805 a.linter.manifest = a.aapt.manifestPath
806 a.linter.resources = a.aapt.resourceFiles
807
Colin Crossa97c5d32018-03-28 14:58:31 -0700808 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles,
809 a.proguardOptionsFile)
810
Colin Cross4eae06d2023-06-20 22:40:02 -0700811 var extraSrcJars android.Paths
812 var extraCombinedJars android.Paths
813 var extraClasspathJars android.Paths
814 if a.useResourceProcessorBusyBox() {
815 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
816 // library and each of the transitive static android_library dependencies has already created an
817 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
818 extraClasspathJars = a.transitiveAaptRJars
819 } else {
820 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
821 // R.java files for the library's package and the packages from all transitive static android_library
822 // dependencies. Compile the srcjar alongside the rest of the sources.
823 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
824 }
825
826 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700827
Colin Crossf57c5782019-01-25 13:20:38 -0800828 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700829 var res android.Paths
830 if a.androidLibraryProperties.BuildAAR {
831 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
832 ctx.CheckbuildFile(a.aarFile)
833 }
Colin Cross89c31582018-04-30 15:55:11 -0700834
Sam Delmerico95d70942023-08-02 18:00:35 -0400835 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
836 ctx.SetProvider(ProguardSpecInfoProvider, proguardSpecInfo)
837 a.exportedProguardFlagFiles = proguardSpecInfo.ProguardFlagsFiles.ToList()
Sam Delmerico82602492022-06-10 17:05:42 +0000838
839 prebuiltJniPackages := android.Paths{}
840 ctx.VisitDirectDeps(func(module android.Module) {
841 if info, ok := ctx.OtherModuleProvider(module, JniPackageProvider).(JniPackageInfo); ok {
842 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
843 }
844 })
845 if len(prebuiltJniPackages) > 0 {
846 ctx.SetProvider(JniPackageProvider, JniPackageInfo{
847 JniPackages: prebuiltJniPackages,
848 })
849 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700850}
851
Colin Cross1b16b0e2019-02-12 14:41:32 -0800852// android_library builds and links sources into a `.jar` file for the device along with Android resources.
853//
854// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000855// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800856// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
857// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700858func AndroidLibraryFactory() android.Module {
859 module := &AndroidLibrary{}
860
Colin Crossce6734e2020-06-15 16:09:53 -0700861 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700862 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700863 &module.aaptProperties,
864 &module.androidLibraryProperties)
865
866 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700867 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700868
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900869 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700870 InitJavaModule(module, android.DeviceSupported)
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -0500871 android.InitBazelModule(module)
Colin Crossa97c5d32018-03-28 14:58:31 -0700872 return module
873}
874
Colin Crossfabb6082018-02-20 17:22:23 -0800875//
876// AAR (android library) prebuilts
877//
Colin Crossfabb6082018-02-20 17:22:23 -0800878
Vinh Trance0781f2022-04-13 01:30:44 +0000879// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800880type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000881 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800882 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000883 // If not blank, set to the version of the sdk to compile against.
884 // Defaults to private.
885 // Values are of one of the following forms:
886 // 1) numerical API level, "current", "none", or "core_platform"
887 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
888 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
889 // If the SDK kind is empty, it will be set to public
890 Sdk_version *string
891 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
892 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700893 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000894 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700895 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000896 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
897 Libs []string
898 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700899 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000900 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
901 // will be passed transitively through android_libraries to an android_app.
902 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
903 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800904}
905
906type AARImport struct {
907 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700908 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900909 android.ApexModuleBase
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -0500910 android.BazelModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800911 prebuilt android.Prebuilt
912
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900913 // Functionality common to Module and Import.
914 embeddableInModuleAndImport
915
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500916 providesTransitiveHeaderJars
917
Colin Crossfabb6082018-02-20 17:22:23 -0800918 properties AARImportProperties
919
Colin Cross4eae06d2023-06-20 22:40:02 -0700920 classpathFile android.WritablePath
921 proguardFlags android.WritablePath
922 exportPackage android.WritablePath
923 transitiveAaptResourcePackages android.Paths
924 extraAaptPackagesFile android.WritablePath
925 manifest android.WritablePath
926 assetsPackage android.WritablePath
927 rTxt android.WritablePath
928 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700929
Colin Crossab8d1382023-07-14 17:23:41 +0000930 resourcesNodesDepSet *android.DepSet[*resourcesNode]
931 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700932
933 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000934
Sam Delmerico82602492022-06-10 17:05:42 +0000935 aarPath android.Path
936 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900937
938 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000939 minSdkVersion android.ApiLevel
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000940}
941
942var _ android.OutputFileProducer = (*AARImport)(nil)
943
944// For OutputFileProducer interface
945func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
946 switch tag {
947 case ".aar":
948 return []android.Path{a.aarPath}, nil
949 case "":
950 return []android.Path{a.classpathFile}, nil
951 default:
952 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
953 }
Colin Crossfabb6082018-02-20 17:22:23 -0800954}
955
Jiyong Park92315372021-04-02 08:45:46 +0900956func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
957 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700958}
959
Jiyong Parkf1691d22021-03-29 20:11:58 +0900960func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +0100961 return ""
962}
963
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000964func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -0700965 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000966 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -0700967 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000968 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -0700969}
970
Spandan Dasa26eda72023-03-02 00:56:06 +0000971func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
972 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000973}
974
Spandan Dasca70fc42023-03-01 23:38:49 +0000975func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
976 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -0700977}
978
Colin Cross1e743852019-10-28 11:37:20 -0700979func (a *AARImport) javaVersion() string {
980 return ""
981}
982
Colin Crossa97c5d32018-03-28 14:58:31 -0700983var _ AndroidLibraryDependency = (*AARImport)(nil)
984
985func (a *AARImport) ExportPackage() android.Path {
986 return a.exportPackage
987}
Colin Crossab8d1382023-07-14 17:23:41 +0000988func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
989 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800990}
991
Colin Crossab8d1382023-07-14 17:23:41 +0000992func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
993 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -0700994}
995
Colin Crossab8d1382023-07-14 17:23:41 +0000996func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
997 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800998}
999
Jaewoong Jungc779cd42020-10-06 18:56:10 -07001000// RRO enforcement is not available on aar_import since its RRO dirs are not
1001// exported.
1002func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
1003}
1004
1005// RRO enforcement is not available on aar_import since its RRO dirs are not
1006// exported.
1007func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
1008 return false
1009}
1010
Colin Crossfabb6082018-02-20 17:22:23 -08001011func (a *AARImport) Prebuilt() *android.Prebuilt {
1012 return &a.prebuilt
1013}
1014
1015func (a *AARImport) Name() string {
1016 return a.prebuilt.Name(a.ModuleBase.Name())
1017}
1018
Jiyong Park618922e2020-01-08 13:35:43 +09001019func (a *AARImport) JacocoReportClassesFile() android.Path {
1020 return nil
1021}
1022
Colin Crossfabb6082018-02-20 17:22:23 -08001023func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +09001024 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001025 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -07001026 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -07001027 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -08001028 }
1029 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001030
Colin Cross42d48b72018-08-29 14:10:52 -07001031 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1032 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001033}
1034
Sam Delmerico82602492022-06-10 17:05:42 +00001035type JniPackageInfo struct {
1036 // List of zip files containing JNI libraries
1037 // Zip files should have directory structure jni/<arch>/*.so
1038 JniPackages android.Paths
1039}
1040
1041var JniPackageProvider = blueprint.NewProvider(JniPackageInfo{})
1042
1043// Unzip an AAR and extract the JNI libs for $archString.
1044var extractJNI = pctx.AndroidStaticRule("extractJNI",
1045 blueprint.RuleParams{
1046 Command: `rm -rf $out $outDir && touch $out && ` +
1047 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1048 `jni_files=$$(find $outDir/jni -type f) && ` +
1049 // print error message if there are no JNI libs for this arch
1050 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001051 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001052 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1053 CommandDeps: []string{"${config.SoongZipCmd}"},
1054 },
1055 "outDir", "archString")
1056
Colin Crossfabb6082018-02-20 17:22:23 -08001057// 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 -07001058// 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 -08001059var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1060 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001061 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001062 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001063 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001064 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001065 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001066 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001067 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001068
1069func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1070 if len(a.properties.Aars) != 1 {
1071 ctx.PropertyErrorf("aars", "exactly one aar is required")
1072 return
1073 }
1074
Jiyong Park92315372021-04-02 08:45:46 +09001075 a.sdkVersion = a.SdkVersion(ctx)
1076 a.minSdkVersion = a.MinSdkVersion(ctx)
1077
Colin Cross56a83212020-09-15 18:30:11 -07001078 a.hideApexVariantFromMake = !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
1079
Nan Zhang4c819fb2018-08-27 18:31:46 -07001080 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001081 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1082
Colin Cross1001a792019-03-21 22:21:39 -07001083 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001084 inputFile := a.aarPath
1085 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1086 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001087 }
Colin Crossfabb6082018-02-20 17:22:23 -08001088
1089 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001090 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001091 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Cross4eae06d2023-06-20 22:40:02 -07001092 aarRTxt := extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001093 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001094 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
1095 ctx.SetProvider(ProguardSpecInfoProvider, ProguardSpecInfo{
1096 ProguardFlagsFiles: android.NewDepSet[android.Path](
1097 android.POSTORDER,
1098 android.Paths{a.proguardFlags},
1099 nil,
1100 ),
1101 })
Colin Crossfabb6082018-02-20 17:22:23 -08001102
1103 ctx.Build(pctx, android.BuildParams{
1104 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001105 Input: a.aarPath,
Colin Cross4eae06d2023-06-20 22:40:02 -07001106 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, aarRTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001107 Description: "unzip AAR",
1108 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001109 "outDir": extractedAARDir.String(),
1110 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001111 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001112 },
1113 })
1114
Colin Crossa0ba2f52019-06-22 12:59:27 -07001115 // Always set --pseudo-localize, it will be stripped out later for release
1116 // builds that don't want it.
1117 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001118 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001119 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001120 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001121
1122 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001123 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Cross4eae06d2023-06-20 22:40:02 -07001124 a.rTxt = android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001125 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001126
1127 var linkDeps android.Paths
1128
1129 linkFlags := []string{
1130 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001131 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001132 "--auto-add-overlay",
1133 }
1134
Colin Cross10f7c4a2018-05-23 10:59:28 -07001135 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1136 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001137
Colin Cross8676c8c2023-10-12 15:58:57 -07001138 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001139 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001140
Colin Cross8676c8c2023-10-12 15:58:57 -07001141 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001142 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001143
Colin Crossab8d1382023-07-14 17:23:41 +00001144 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001145
Colin Crossab8d1382023-07-14 17:23:41 +00001146 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001147 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001148 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001149
Colin Cross4eae06d2023-06-20 22:40:02 -07001150 overlayRes := android.Paths{flata}
1151
1152 // Treat static library dependencies of static libraries as imports.
1153 transitiveStaticLibs := staticDeps.resPackages()
1154 linkDeps = append(linkDeps, transitiveStaticLibs...)
1155 for _, staticLib := range transitiveStaticLibs {
1156 linkFlags = append(linkFlags, "-I "+staticLib.String())
1157 }
Colin Crossfabb6082018-02-20 17:22:23 -08001158
Colin Crossab8d1382023-07-14 17:23:41 +00001159 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossf3b7bad2023-08-02 15:49:00 -07001160 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, a.rTxt,
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001161 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001162
Colin Cross4eae06d2023-06-20 22:40:02 -07001163 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
1164 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true)
1165
Colin Crossf3b7bad2023-08-02 15:49:00 -07001166 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1167
Colin Crossab8d1382023-07-14 17:23:41 +00001168 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1169 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1170 resPackage: a.exportPackage,
1171 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001172 rTxt: a.rTxt,
1173 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001174 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001175
1176 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001177 })
1178 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1179 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1180
1181 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
1182 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
1183 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
1184 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
1185 // android_library_import modules. If this is fixed, AndroidLibraryDependency.ManifestsDepSet can be dropped
1186 // completely in favor of AndroidLibraryDependency.ResourceNodesDepSet.manifest
1187 //manifestDepSetBuilder.Transitive(transitiveStaticDeps.manifests)
1188 _ = staticManifestsDepSet
1189 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001190
Colin Cross4eae06d2023-06-20 22:40:02 -07001191 a.transitiveAaptResourcePackages = staticDeps.resPackages()
1192
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001193 a.collectTransitiveHeaderJars(ctx)
Colin Crossdcf71b22021-02-01 13:59:03 -08001194 ctx.SetProvider(JavaInfoProvider, JavaInfo{
1195 HeaderJars: android.PathsIfNonNil(a.classpathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001196 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1197 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08001198 ImplementationAndResourcesJars: android.PathsIfNonNil(a.classpathFile),
1199 ImplementationJars: android.PathsIfNonNil(a.classpathFile),
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001200 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001201 })
Sam Delmerico82602492022-06-10 17:05:42 +00001202
1203 if proptools.Bool(a.properties.Extract_jni) {
1204 for _, t := range ctx.MultiTargets() {
1205 arch := t.Arch.Abi[0]
1206 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1207 a.jniPackages = append(a.jniPackages, path)
1208
1209 outDir := android.PathForModuleOut(ctx, "aarForJni")
1210 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1211 ctx.Build(pctx, android.BuildParams{
1212 Rule: extractJNI,
1213 Input: aarPath,
1214 Outputs: android.WritablePaths{path},
1215 Description: "extract JNI from AAR",
1216 Args: map[string]string{
1217 "outDir": outDir.String(),
1218 "archString": arch,
1219 },
1220 })
1221 }
1222
1223 ctx.SetProvider(JniPackageProvider, JniPackageInfo{
1224 JniPackages: a.jniPackages,
1225 })
1226 }
Colin Crossdcf71b22021-02-01 13:59:03 -08001227}
Colin Crossfabb6082018-02-20 17:22:23 -08001228
1229func (a *AARImport) HeaderJars() android.Paths {
1230 return android.Paths{a.classpathFile}
1231}
1232
Colin Cross331a1212018-08-15 20:40:52 -07001233func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
1234 return android.Paths{a.classpathFile}
1235}
1236
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00001237func (a *AARImport) DexJarBuildPath() android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001238 return nil
1239}
1240
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001241func (a *AARImport) DexJarInstallPath() android.Path {
1242 return nil
1243}
1244
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001245func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Jiyong Park1be96912018-05-28 18:02:19 +09001246 return nil
1247}
1248
Jiyong Park45bf82e2020-12-15 22:29:02 +09001249var _ android.ApexModule = (*AARImport)(nil)
1250
1251// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001252func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1253 return a.depIsInSameApex(ctx, dep)
1254}
1255
Jiyong Park45bf82e2020-12-15 22:29:02 +09001256// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07001257func (g *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1258 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001259 return nil
1260}
1261
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001262var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001263
Colin Cross1b16b0e2019-02-12 14:41:32 -08001264// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1265//
1266// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1267// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001268func AARImportFactory() android.Module {
1269 module := &AARImport{}
1270
1271 module.AddProperties(&module.properties)
1272
1273 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001274 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001275 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001276 android.InitBazelModule(module)
Colin Crossfabb6082018-02-20 17:22:23 -08001277 return module
1278}
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001279
1280type bazelAapt struct {
1281 Manifest bazel.Label
1282 Resource_files bazel.LabelListAttribute
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001283 Resource_zips bazel.LabelListAttribute
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001284 Assets_dir bazel.StringAttribute
1285 Assets bazel.LabelListAttribute
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001286}
1287
1288type bazelAndroidLibrary struct {
1289 *javaLibraryAttributes
1290 *bazelAapt
1291}
1292
1293type bazelAndroidLibraryImport struct {
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001294 Aar bazel.Label
1295 Deps bazel.LabelListAttribute
1296 Exports bazel.LabelListAttribute
1297 Sdk_version bazel.StringAttribute
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001298}
1299
Chris Parsons637458d2023-09-19 20:09:00 +00001300func (a *aapt) convertAaptAttrsWithBp2Build(ctx android.Bp2buildMutatorContext) (*bazelAapt, bool) {
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001301 manifest := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
1302
1303 resourceFiles := bazel.LabelList{
1304 Includes: []bazel.Label{},
1305 }
1306 for _, dir := range android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res") {
1307 files := android.RootToModuleRelativePaths(ctx, androidResourceGlob(ctx, dir))
1308 resourceFiles.Includes = append(resourceFiles.Includes, files...)
1309 }
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001310
1311 assetsDir := bazel.StringAttribute{}
1312 var assets bazel.LabelList
1313 for i, dir := range android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets") {
1314 if i > 0 {
1315 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_PROPERTY_UNSUPPORTED, "multiple asset_dirs")
1316 return &bazelAapt{}, false
1317 }
1318 // Assets_dirs are relative to the module dir when specified, but if the default in used in
1319 // PathsWithOptionalDefaultForModuleSrc, then dir is relative to the top.
1320 assetsRelDir, error := filepath.Rel(ctx.ModuleDir(), dir.Rel())
1321 if error != nil {
1322 assetsRelDir = dir.Rel()
1323 }
1324 assetsDir.Value = proptools.StringPtr(assetsRelDir)
1325 assets = bazel.MakeLabelList(android.RootToModuleRelativePaths(ctx, androidResourceGlob(ctx, dir)))
1326
1327 }
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001328 var resourceZips bazel.LabelList
1329 if len(a.aaptProperties.Resource_zips) > 0 {
1330 if ctx.ModuleName() == "framework-res" {
1331 resourceZips = android.BazelLabelForModuleSrc(ctx, a.aaptProperties.Resource_zips)
1332 } else {
1333 //TODO: b/301593550 - Implement support for this
1334 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_PROPERTY_UNSUPPORTED, "resource_zips")
1335 return &bazelAapt{}, false
1336 }
1337 }
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001338 return &bazelAapt{
1339 android.BazelLabelForModuleSrcSingle(ctx, manifest),
1340 bazel.MakeLabelListAttribute(resourceFiles),
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001341 bazel.MakeLabelListAttribute(resourceZips),
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001342 assetsDir,
1343 bazel.MakeLabelListAttribute(assets),
1344 }, true
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001345}
1346
Chris Parsons637458d2023-09-19 20:09:00 +00001347func (a *AARImport) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Romain Jobredeauxafc5d272023-09-21 11:07:30 -04001348 if len(a.properties.Aars) == 0 {
1349 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_PROPERTY_UNSUPPORTED, "aars can't be empty")
1350 return
1351 }
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001352 aars := android.BazelLabelForModuleSrcExcludes(ctx, a.properties.Aars, []string{})
1353 exportableStaticLibs := []string{}
1354 // TODO(b/240716882): investigate and handle static_libs deps that are not imports. They are not supported for export by Bazel.
1355 for _, depName := range a.properties.Static_libs {
1356 if dep, ok := ctx.ModuleFromName(depName); ok {
1357 switch dep.(type) {
1358 case *AARImport, *Import:
1359 exportableStaticLibs = append(exportableStaticLibs, depName)
1360 }
1361 }
1362 }
1363 name := android.RemoveOptionalPrebuiltPrefix(a.Name())
1364 deps := android.BazelLabelForModuleDeps(ctx, android.LastUniqueStrings(android.CopyOf(append(a.properties.Static_libs, a.properties.Libs...))))
1365 exports := android.BazelLabelForModuleDeps(ctx, android.LastUniqueStrings(exportableStaticLibs))
1366
1367 ctx.CreateBazelTargetModule(
1368 bazel.BazelTargetModuleProperties{
1369 Rule_class: "aar_import",
Alixa381cd12023-05-10 14:49:38 +00001370 Bzl_load_location: "//build/bazel/rules/android:aar_import.bzl",
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001371 },
1372 android.CommonAttributes{Name: name},
1373 &bazelAndroidLibraryImport{
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001374 Aar: aars.Includes[0],
1375 Deps: bazel.MakeLabelListAttribute(deps),
1376 Exports: bazel.MakeLabelListAttribute(exports),
1377 Sdk_version: bazel.StringAttribute{Value: a.properties.Sdk_version},
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001378 },
1379 )
1380
Alix14101de2023-01-06 03:42:07 +00001381 neverlink := true
1382 ctx.CreateBazelTargetModule(
Alix32540022023-03-16 21:06:13 +00001383 AndroidLibraryBazelTargetModuleProperties(),
Alix14101de2023-01-06 03:42:07 +00001384 android.CommonAttributes{Name: name + "-neverlink"},
1385 &bazelAndroidLibrary{
1386 javaLibraryAttributes: &javaLibraryAttributes{
1387 Neverlink: bazel.BoolAttribute{Value: &neverlink},
1388 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001389 javaCommonAttributes: &javaCommonAttributes{
1390 Sdk_version: bazel.StringAttribute{Value: a.properties.Sdk_version},
1391 },
Alix14101de2023-01-06 03:42:07 +00001392 },
1393 },
1394 )
1395
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001396}
Alix32540022023-03-16 21:06:13 +00001397func AndroidLibraryBazelTargetModuleProperties() bazel.BazelTargetModuleProperties {
1398 return bazel.BazelTargetModuleProperties{
1399 Rule_class: "android_library",
Alixa381cd12023-05-10 14:49:38 +00001400 Bzl_load_location: "//build/bazel/rules/android:android_library.bzl",
Alix32540022023-03-16 21:06:13 +00001401 }
1402}
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001403
Chris Parsons637458d2023-09-19 20:09:00 +00001404func (a *AndroidLibrary) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Liz Kammer7f375862023-08-04 16:37:42 -04001405 commonAttrs, bp2buildInfo, supported := a.convertLibraryAttrsBp2Build(ctx)
1406 if !supported {
1407 return
1408 }
1409
Alix8062f4d2022-11-14 21:38:07 +00001410 depLabels := bp2buildInfo.DepLabels
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001411
1412 deps := depLabels.Deps
1413 if !commonAttrs.Srcs.IsEmpty() {
1414 deps.Append(depLabels.StaticDeps) // we should only append these if there are sources to use them
1415 } else if !depLabels.Deps.IsEmpty() {
Zi Wang10664792023-09-27 12:29:34 -07001416 // android_library does not accept deps when there are no srcs because
1417 // there is no compilation happening, but it accepts exports.
1418 // The non-empty deps here are unnecessary as deps on the android_library
1419 // since they aren't being propagated to any dependencies.
1420 // So we can drop deps here.
1421 deps = bazel.LabelListAttribute{}
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001422 }
Alix82fb94e2022-10-26 20:40:18 +00001423 name := a.Name()
Alix32540022023-03-16 21:06:13 +00001424 props := AndroidLibraryBazelTargetModuleProperties()
Alix82fb94e2022-10-26 20:40:18 +00001425
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001426 aaptAttrs, supported := a.convertAaptAttrsWithBp2Build(ctx)
1427 if !supported {
1428 return
1429 }
Alixee51bd62023-08-29 16:01:46 +00001430 if hasJavaResources := aaptAttrs.ConvertJavaResources(ctx, commonAttrs); hasJavaResources {
1431 return
1432 }
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001433 ctx.CreateBazelTargetModule(
Alix82fb94e2022-10-26 20:40:18 +00001434 props,
1435 android.CommonAttributes{Name: name},
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001436 &bazelAndroidLibrary{
1437 &javaLibraryAttributes{
1438 javaCommonAttributes: commonAttrs,
1439 Deps: deps,
1440 Exports: depLabels.StaticDeps,
1441 },
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001442 aaptAttrs,
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001443 },
1444 )
Alix82fb94e2022-10-26 20:40:18 +00001445
1446 neverlink := true
1447 ctx.CreateBazelTargetModule(
1448 props,
1449 android.CommonAttributes{Name: name + "-neverlink"},
1450 &bazelAndroidLibrary{
1451 javaLibraryAttributes: &javaLibraryAttributes{
1452 Neverlink: bazel.BoolAttribute{Value: &neverlink},
1453 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001454 javaCommonAttributes: &javaCommonAttributes{
1455 Sdk_version: bazel.StringAttribute{Value: a.deviceProperties.Sdk_version},
1456 Java_version: bazel.StringAttribute{Value: a.properties.Java_version},
1457 },
Alix82fb94e2022-10-26 20:40:18 +00001458 },
1459 },
1460 )
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001461}