blob: 85a6fbb96bd7e864569e347b26faec6e11807ada [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
Colin Crossa97c5d32018-03-28 14:58:31 -070069 // list of directories relative to the Blueprints file containing assets.
Colin Cross0ddae7f2019-02-07 15:30:01 -080070 // Defaults to ["assets"] if a directory called assets exists. Set to []
71 // to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070072 Asset_dirs []string
73
74 // list of directories relative to the Blueprints file containing
Colin Cross0ddae7f2019-02-07 15:30:01 -080075 // Android resources. Defaults to ["res"] if a directory called res exists.
76 // Set to [] to disable the default.
Colin Crossa97c5d32018-03-28 14:58:31 -070077 Resource_dirs []string
78
Colin Crossa592e3e2019-02-19 16:59:53 -080079 // list of zip files containing Android resources.
Colin Cross27b922f2019-03-04 22:35:41 -080080 Resource_zips []string `android:"path"`
Colin Crossa592e3e2019-02-19 16:59:53 -080081
Colin Crossa97c5d32018-03-28 14:58:31 -070082 // path to AndroidManifest.xml. If unset, defaults to "AndroidManifest.xml".
Colin Cross27b922f2019-03-04 22:35:41 -080083 Manifest *string `android:"path"`
changho.shinb5432b72019-08-08 18:37:17 +090084
85 // paths to additional manifest files to merge with main manifest.
86 Additional_manifests []string `android:"path"`
Sasha Smundak541056c2019-10-28 15:50:06 -070087
88 // do not include AndroidManifest from dependent libraries
89 Dont_merge_manifests *bool
Jaewoong Jungc779cd42020-10-06 18:56:10 -070090
Colin Cross4eae06d2023-06-20 22:40:02 -070091 // If use_resource_processor is set, use Bazel's resource processor instead of aapt2 to generate R.class files.
92 // The resource processor produces more optimal R.class files that only list resources in the package of the
93 // library that provided them, as opposed to aapt2 which produces R.java files for every package containing
94 // every resource. Using the resource processor can provide significant build time speedups, but requires
95 // fixing the module to use the correct package to reference each resource, and to avoid having any other
96 // libraries in the tree that use the same package name. Defaults to false, but will default to true in the
97 // future.
98 Use_resource_processor *bool
99
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700100 // true if RRO is enforced for any of the dependent modules
101 RROEnforcedForDependent bool `blueprint:"mutated"`
Colin Crossa97c5d32018-03-28 14:58:31 -0700102}
103
104type aapt struct {
Colin Cross4eae06d2023-06-20 22:40:02 -0700105 aaptSrcJar android.Path
106 transitiveAaptRJars android.Paths
107 transitiveAaptResourcePackages android.Paths
108 exportPackage android.Path
109 manifestPath android.Path
110 proguardOptionsFile android.Path
111 rTxt android.Path
112 rJar android.Path
113 extraAaptPackagesFile android.Path
114 mergedManifestFile android.Path
115 noticeFile android.OptionalPath
116 assetPackage android.OptionalPath
117 isLibrary bool
118 defaultManifestVersion string
119 useEmbeddedNativeLibs bool
120 useEmbeddedDex bool
121 usesNonSdkApis bool
122 hasNoCode bool
123 LoggingParent string
124 resourceFiles android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700125
Colin Crosse560c4a2019-03-19 16:03:11 -0700126 splitNames []string
127 splits []split
128
Colin Crossa97c5d32018-03-28 14:58:31 -0700129 aaptProperties aaptProperties
Colin Crossab8d1382023-07-14 17:23:41 +0000130
131 resourcesNodesDepSet *android.DepSet[*resourcesNode]
132 rroDirsDepSet *android.DepSet[rroDir]
133 manifestsDepSet *android.DepSet[android.Path]
Colin Crossa97c5d32018-03-28 14:58:31 -0700134}
135
Colin Crosse560c4a2019-03-19 16:03:11 -0700136type split struct {
137 name string
138 suffix string
139 path android.Path
140}
141
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700142// Propagate RRO enforcement flag to static lib dependencies transitively.
143func propagateRROEnforcementMutator(ctx android.TopDownMutatorContext) {
144 m := ctx.Module()
145 if d, ok := m.(AndroidLibraryDependency); ok && d.IsRROEnforced(ctx) {
146 ctx.VisitDirectDepsWithTag(staticLibTag, func(d android.Module) {
147 if a, ok := d.(AndroidLibraryDependency); ok {
148 a.SetRROEnforcedForDependent(true)
149 }
150 })
151 }
152}
153
Colin Cross4eae06d2023-06-20 22:40:02 -0700154func (a *aapt) useResourceProcessorBusyBox() bool {
155 return BoolDefault(a.aaptProperties.Use_resource_processor, false)
156}
157
Colin Crossa97c5d32018-03-28 14:58:31 -0700158func (a *aapt) ExportPackage() android.Path {
159 return a.exportPackage
160}
Colin Crossab8d1382023-07-14 17:23:41 +0000161func (a *aapt) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
162 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800163}
164
Colin Crossab8d1382023-07-14 17:23:41 +0000165func (a *aapt) RRODirsDepSet() *android.DepSet[rroDir] {
166 return a.rroDirsDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800167}
168
Colin Crossab8d1382023-07-14 17:23:41 +0000169func (a *aapt) ManifestsDepSet() *android.DepSet[android.Path] {
170 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800171}
172
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700173func (a *aapt) SetRROEnforcedForDependent(enforce bool) {
174 a.aaptProperties.RROEnforcedForDependent = enforce
175}
176
177func (a *aapt) IsRROEnforced(ctx android.BaseModuleContext) bool {
178 // True if RRO is enforced for this module or...
179 return ctx.Config().EnforceRROForModule(ctx.ModuleName()) ||
Jeongik Chacee5ba92021-02-19 12:11:51 +0900180 // if RRO is enforced for any of its dependents.
181 a.aaptProperties.RROEnforcedForDependent
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700182}
183
Jiyong Parkf1691d22021-03-29 20:11:58 +0900184func (a *aapt) aapt2Flags(ctx android.ModuleContext, sdkContext android.SdkContext,
Colin Crossa0ba2f52019-06-22 12:59:27 -0700185 manifestPath android.Path) (compileFlags, linkFlags []string, linkDeps android.Paths,
186 resDirs, overlayDirs []globbedResourceDir, rroDirs []rroDir, resZips android.Paths) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700187
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800188 hasVersionCode := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-code")
189 hasVersionName := android.PrefixInList(a.aaptProperties.Aaptflags, "--version-name")
Colin Crossa97c5d32018-03-28 14:58:31 -0700190
Colin Crossa97c5d32018-03-28 14:58:31 -0700191 // Flags specified in Android.bp
192 linkFlags = append(linkFlags, a.aaptProperties.Aaptflags...)
193
Colin Crossa97c5d32018-03-28 14:58:31 -0700194 // Find implicit or explicit asset and resource dirs
195 assetDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets")
196 resourceDirs := android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res")
Colin Cross8a497952019-03-05 22:25:09 -0800197 resourceZips := android.PathsForModuleSrc(ctx, a.aaptProperties.Resource_zips)
Colin Crossa97c5d32018-03-28 14:58:31 -0700198
Colin Crossa97c5d32018-03-28 14:58:31 -0700199 // Glob directories into lists of paths
200 for _, dir := range resourceDirs {
201 resDirs = append(resDirs, globbedResourceDir{
202 dir: dir,
203 files: androidResourceGlob(ctx, dir),
204 })
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700205 resOverlayDirs, resRRODirs := overlayResourceGlob(ctx, a, dir)
Colin Crossa97c5d32018-03-28 14:58:31 -0700206 overlayDirs = append(overlayDirs, resOverlayDirs...)
207 rroDirs = append(rroDirs, resRRODirs...)
208 }
209
Colin Crossc20dc852020-11-10 12:27:45 -0800210 var assetDeps android.Paths
211 for i, dir := range assetDirs {
212 // Add a dependency on every file in the asset directory. This ensures the aapt2
213 // rule will be rerun if one of the files in the asset directory is modified.
214 assetDeps = append(assetDeps, androidResourceGlob(ctx, dir)...)
215
216 // Add a dependency on a file that contains a list of all the files in the asset directory.
217 // This ensures the aapt2 rule will be run if a file is removed from the asset directory,
218 // or a file is added whose timestamp is older than the output of aapt2.
219 assetFileListFile := android.PathForModuleOut(ctx, "asset_dir_globs", strconv.Itoa(i)+".glob")
220 androidResourceGlobList(ctx, dir, assetFileListFile)
221 assetDeps = append(assetDeps, assetFileListFile)
Colin Crossa97c5d32018-03-28 14:58:31 -0700222 }
223
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700224 assetDirStrings := assetDirs.Strings()
225 if a.noticeFile.Valid() {
226 assetDirStrings = append(assetDirStrings, filepath.Dir(a.noticeFile.Path().String()))
Colin Crossc20dc852020-11-10 12:27:45 -0800227 assetDeps = append(assetDeps, a.noticeFile.Path())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700228 }
229
Colin Crossa97c5d32018-03-28 14:58:31 -0700230 linkFlags = append(linkFlags, "--manifest "+manifestPath.String())
231 linkDeps = append(linkDeps, manifestPath)
232
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700233 linkFlags = append(linkFlags, android.JoinWithPrefix(assetDirStrings, "-A "))
Colin Crossc20dc852020-11-10 12:27:45 -0800234 linkDeps = append(linkDeps, assetDeps...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700235
Spandan Das50885c02023-02-23 21:31:33 +0000236 // Returns the effective version for {min|target}_sdk_version
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000237 effectiveVersionString := func(sdkVersion android.SdkSpec, minSdkVersion android.ApiLevel) string {
Spandan Das50885c02023-02-23 21:31:33 +0000238 // If {min|target}_sdk_version is current, use sdk_version to determine the effective level
239 // This is necessary for vendor modules.
240 // The effective version does not _only_ depend on {min|target}_sdk_version(level),
241 // but also on the sdk_version (kind+level)
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000242 if minSdkVersion.IsCurrent() {
Spandan Das50885c02023-02-23 21:31:33 +0000243 ret, err := sdkVersion.EffectiveVersionString(ctx)
244 if err != nil {
245 ctx.ModuleErrorf("invalid sdk_version: %s", err)
246 }
247 return ret
248 }
249 ret, err := minSdkVersion.EffectiveVersionString(ctx)
250 if err != nil {
251 ctx.ModuleErrorf("invalid min_sdk_version: %s", err)
252 }
253 return ret
Jiyong Park6a927c42020-01-21 02:03:43 +0900254 }
Spandan Das50885c02023-02-23 21:31:33 +0000255 // SDK version flags
256 sdkVersion := sdkContext.SdkVersion(ctx)
257 minSdkVersion := effectiveVersionString(sdkVersion, sdkContext.MinSdkVersion(ctx))
Colin Crossa97c5d32018-03-28 14:58:31 -0700258
Colin Cross83bb3162018-06-25 15:48:06 -0700259 linkFlags = append(linkFlags, "--min-sdk-version "+minSdkVersion)
Spandan Das6450b552023-02-23 19:27:07 +0000260 // Use minSdkVersion for target-sdk-version, even if `target_sdk_version` is set
261 // This behavior has been copied from Make.
Colin Cross83bb3162018-06-25 15:48:06 -0700262 linkFlags = append(linkFlags, "--target-sdk-version "+minSdkVersion)
Colin Crossa97c5d32018-03-28 14:58:31 -0700263
Colin Crossa97c5d32018-03-28 14:58:31 -0700264 // Version code
265 if !hasVersionCode {
Dan Albert4f378d72020-07-23 17:32:15 -0700266 linkFlags = append(linkFlags, "--version-code", ctx.Config().PlatformSdkVersion().String())
Colin Crossa97c5d32018-03-28 14:58:31 -0700267 }
268
269 if !hasVersionName {
Colin Cross402d5e02018-04-25 14:54:06 -0700270 var versionName string
271 if ctx.ModuleName() == "framework-res" {
272 // Some builds set AppsDefaultVersionName() to include the build number ("O-123456"). aapt2 copies the
273 // version name of framework-res into app manifests as compileSdkVersionCodename, which confuses things
Colin Crossbfd347d2018-05-09 11:11:35 -0700274 // if it contains the build number. Use the PlatformVersionName instead.
275 versionName = ctx.Config().PlatformVersionName()
Colin Cross402d5e02018-04-25 14:54:06 -0700276 } else {
277 versionName = ctx.Config().AppsDefaultVersionName()
278 }
Colin Cross0b9f31f2019-02-28 11:00:01 -0800279 versionName = proptools.NinjaEscape(versionName)
Colin Crossa97c5d32018-03-28 14:58:31 -0700280 linkFlags = append(linkFlags, "--version-name ", versionName)
281 }
282
Colin Crossa0ba2f52019-06-22 12:59:27 -0700283 linkFlags, compileFlags = android.FilterList(linkFlags, []string{"--legacy"})
284
285 // Always set --pseudo-localize, it will be stripped out later for release
286 // builds that don't want it.
287 compileFlags = append(compileFlags, "--pseudo-localize")
288
289 return compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resourceZips
Colin Crossa97c5d32018-03-28 14:58:31 -0700290}
291
Paul Duffin250e6192019-06-07 10:44:37 +0100292func (a *aapt) deps(ctx android.BottomUpMutatorContext, sdkDep sdkDep) {
Colin Cross42308aa2018-11-14 21:44:17 -0800293 if sdkDep.frameworkResModule != "" {
294 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossa97c5d32018-03-28 14:58:31 -0700295 }
296}
297
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800298var extractAssetsRule = pctx.AndroidStaticRule("extractAssets",
299 blueprint.RuleParams{
300 Command: `${config.Zip2ZipCmd} -i ${in} -o ${out} "assets/**/*"`,
301 CommandDeps: []string{"${config.Zip2ZipCmd}"},
302 })
303
Alixf7a10272023-09-27 16:47:56 +0000304type aaptBuildActionOptions struct {
305 sdkContext android.SdkContext
306 classLoaderContexts dexpreopt.ClassLoaderContextMap
307 excludedLibs []string
308 enforceDefaultTargetSdkVersion bool
309 extraLinkFlags []string
310}
311
312func (a *aapt) buildActions(ctx android.ModuleContext, opts aaptBuildActionOptions) {
Colin Cross5446e882019-05-22 10:46:27 -0700313
Colin Cross8676c8c2023-10-12 15:58:57 -0700314 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedExportPackages, libFlags :=
Alixf7a10272023-09-27 16:47:56 +0000315 aaptLibs(ctx, opts.sdkContext, opts.classLoaderContexts)
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100316
Paul Duffin06530572022-02-03 17:54:15 +0000317 // Exclude any libraries from the supplied list.
Alixf7a10272023-09-27 16:47:56 +0000318 opts.classLoaderContexts = opts.classLoaderContexts.ExcludeLibs(opts.excludedLibs)
Paul Duffin06530572022-02-03 17:54:15 +0000319
Colin Cross31656952018-05-24 16:11:20 -0700320 // App manifest file
321 manifestFile := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
322 manifestSrcPath := android.PathForModuleSrc(ctx, manifestFile)
323
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000324 manifestPath := ManifestFixer(ctx, manifestSrcPath, ManifestFixerParams{
Alixf7a10272023-09-27 16:47:56 +0000325 SdkContext: opts.sdkContext,
326 ClassLoaderContexts: opts.classLoaderContexts,
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000327 IsLibrary: a.isLibrary,
328 DefaultManifestVersion: a.defaultManifestVersion,
329 UseEmbeddedNativeLibs: a.useEmbeddedNativeLibs,
330 UsesNonSdkApis: a.usesNonSdkApis,
331 UseEmbeddedDex: a.useEmbeddedDex,
332 HasNoCode: a.hasNoCode,
333 LoggingParent: a.LoggingParent,
Alixf7a10272023-09-27 16:47:56 +0000334 EnforceDefaultTargetSdkVersion: opts.enforceDefaultTargetSdkVersion,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000335 })
Colin Cross90c25c62019-04-19 16:22:57 -0700336
Colin Crossab8d1382023-07-14 17:23:41 +0000337 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Cross8676c8c2023-10-12 15:58:57 -0700338 sharedDeps := transitiveAarDeps(sharedResourcesNodesDepSet.ToList())
Colin Crossab8d1382023-07-14 17:23:41 +0000339
Luca Stefanifd898822019-09-10 22:13:31 +0200340 // Add additional manifest files to transitive manifests.
341 additionalManifests := android.PathsForModuleSrc(ctx, a.aaptProperties.Additional_manifests)
Colin Crossab8d1382023-07-14 17:23:41 +0000342 transitiveManifestPaths := append(android.Paths{manifestPath}, additionalManifests...)
343 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
344 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
345 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
346 // android_library_import modules. If this is fixed, staticManifestsDepSet can be dropped completely in favor of
347 // staticResourcesNodesDepSet.manifests()
348 transitiveManifestPaths = append(transitiveManifestPaths, staticManifestsDepSet.ToList()...)
Colin Cross90c25c62019-04-19 16:22:57 -0700349
Colin Crossab8d1382023-07-14 17:23:41 +0000350 if len(transitiveManifestPaths) > 1 && !Bool(a.aaptProperties.Dont_merge_manifests) {
Alixf7a10272023-09-27 16:47:56 +0000351 manifestMergerParams := ManifestMergerParams{
352 staticLibManifests: transitiveManifestPaths[1:],
353 isLibrary: a.isLibrary}
354 a.mergedManifestFile = manifestMerger(ctx, transitiveManifestPaths[0], manifestMergerParams)
Colin Cross90c25c62019-04-19 16:22:57 -0700355 if !a.isLibrary {
356 // Only use the merged manifest for applications. For libraries, the transitive closure of manifests
357 // will be propagated to the final application and merged there. The merged manifest for libraries is
358 // only passed to Make, which can't handle transitive dependencies.
359 manifestPath = a.mergedManifestFile
360 }
361 } else {
362 a.mergedManifestFile = manifestPath
363 }
Colin Cross31656952018-05-24 16:11:20 -0700364
Alixf7a10272023-09-27 16:47:56 +0000365 compileFlags, linkFlags, linkDeps, resDirs, overlayDirs, rroDirs, resZips := a.aapt2Flags(ctx, opts.sdkContext, manifestPath)
Colin Cross31656952018-05-24 16:11:20 -0700366
367 linkFlags = append(linkFlags, libFlags...)
Colin Cross8676c8c2023-10-12 15:58:57 -0700368 linkDeps = append(linkDeps, sharedExportPackages...)
Colin Crossab8d1382023-07-14 17:23:41 +0000369 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Alixf7a10272023-09-27 16:47:56 +0000370 linkFlags = append(linkFlags, opts.extraLinkFlags...)
Colin Cross1b6a3cf2018-07-24 14:51:30 -0700371 if a.isLibrary {
372 linkFlags = append(linkFlags, "--static-lib")
373 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700374
Colin Cross4eae06d2023-06-20 22:40:02 -0700375 if a.isLibrary && a.useResourceProcessorBusyBox() {
376 // When building an android_library using ResourceProcessorBusyBox the resources are merged into
377 // package-res.apk with --merge-only, but --no-static-lib-packages is not used so that R.txt only
378 // contains resources from this library.
379 linkFlags = append(linkFlags, "--merge-only")
380 } else {
381 // When building and app or when building an android_library without ResourceProcessorBusyBox
382 // --no-static-lib-packages is used to put all the resources into the app. If ResourceProcessorBusyBox
383 // is used then the app's R.txt will be post-processed along with the R.txt files from dependencies to
384 // sort resources into the right packages in R.class.
385 linkFlags = append(linkFlags, "--no-static-lib-packages")
386 }
387
Colin Crossa97c5d32018-03-28 14:58:31 -0700388 packageRes := android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossa97c5d32018-03-28 14:58:31 -0700389 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
390 rTxt := android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -0700391 // This file isn't used by Soong, but is generated for exporting
392 extraPackages := android.PathForModuleOut(ctx, "extra_packages")
Colin Cross4eae06d2023-06-20 22:40:02 -0700393 var transitiveRJars android.Paths
Colin Crossf3b7bad2023-08-02 15:49:00 -0700394 var srcJar android.WritablePath
Colin Crossa97c5d32018-03-28 14:58:31 -0700395
Colin Cross4aaa84a2018-08-21 15:14:37 -0700396 var compiledResDirs []android.Paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700397 for _, dir := range resDirs {
Colin Cross014489c2020-06-02 20:09:13 -0700398 a.resourceFiles = append(a.resourceFiles, dir.files...)
Colin Crossa0ba2f52019-06-22 12:59:27 -0700399 compiledResDirs = append(compiledResDirs, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths())
Colin Crossa97c5d32018-03-28 14:58:31 -0700400 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700401
Colin Crossa592e3e2019-02-19 16:59:53 -0800402 for i, zip := range resZips {
403 flata := android.PathForModuleOut(ctx, fmt.Sprintf("reszip.%d.flata", i))
Colin Crossa0ba2f52019-06-22 12:59:27 -0700404 aapt2CompileZip(ctx, flata, zip, "", compileFlags)
Colin Crossa592e3e2019-02-19 16:59:53 -0800405 compiledResDirs = append(compiledResDirs, android.Paths{flata})
406 }
407
Colin Cross4aaa84a2018-08-21 15:14:37 -0700408 var compiledRes, compiledOverlay android.Paths
409
Colin Crossab8d1382023-07-14 17:23:41 +0000410 // AAPT2 overlays are in lowest to highest priority order, reverse the topological order
411 // of transitiveStaticLibs.
412 transitiveStaticLibs := android.ReversePaths(staticDeps.resPackages())
413
Colin Cross4eae06d2023-06-20 22:40:02 -0700414 if a.isLibrary && a.useResourceProcessorBusyBox() {
415 // When building an android_library with ResourceProcessorBusyBox enabled treat static library dependencies
416 // as imports. The resources from dependencies will not be merged into this module's package-res.apk, and
417 // instead modules depending on this module will reference package-res.apk from all transitive static
418 // dependencies.
419 for _, staticDep := range staticDeps {
420 linkDeps = append(linkDeps, staticDep.resPackage)
421 linkFlags = append(linkFlags, "-I "+staticDep.resPackage.String())
422 if staticDep.usedResourceProcessor {
423 transitiveRJars = append(transitiveRJars, staticDep.rJar)
424 }
425 }
Colin Cross8676c8c2023-10-12 15:58:57 -0700426 for _, sharedDep := range sharedDeps {
427 if sharedDep.usedResourceProcessor {
428 transitiveRJars = append(transitiveRJars, sharedDep.rJar)
429 }
430 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700431 } else {
432 // When building an app or building a library without ResourceProcessorBusyBox enabled all static
433 // dependencies are compiled into this module's package-res.apk as overlays.
434 compiledOverlay = append(compiledOverlay, transitiveStaticLibs...)
435 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700436
Colin Crossbec85302019-02-13 13:15:46 -0800437 if len(transitiveStaticLibs) > 0 {
Colin Cross4aaa84a2018-08-21 15:14:37 -0700438 // If we are using static android libraries, every source file becomes an overlay.
439 // This is to emulate old AAPT behavior which simulated library support.
440 for _, compiledResDir := range compiledResDirs {
441 compiledOverlay = append(compiledOverlay, compiledResDir...)
442 }
Colin Crossbec85302019-02-13 13:15:46 -0800443 } else if a.isLibrary {
444 // Otherwise, for a static library we treat all the resources equally with no overlay.
445 for _, compiledResDir := range compiledResDirs {
446 compiledRes = append(compiledRes, compiledResDir...)
447 }
Colin Cross4aaa84a2018-08-21 15:14:37 -0700448 } else if len(compiledResDirs) > 0 {
449 // Without static libraries, the first directory is our directory, which can then be
450 // overlaid by the rest.
451 compiledRes = append(compiledRes, compiledResDirs[0]...)
452 for _, compiledResDir := range compiledResDirs[1:] {
453 compiledOverlay = append(compiledOverlay, compiledResDir...)
454 }
455 }
456
Colin Crossa97c5d32018-03-28 14:58:31 -0700457 for _, dir := range overlayDirs {
Colin Crossa0ba2f52019-06-22 12:59:27 -0700458 compiledOverlay = append(compiledOverlay, aapt2Compile(ctx, dir.dir, dir.files, compileFlags).Paths()...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700459 }
460
Colin Crosse560c4a2019-03-19 16:03:11 -0700461 var splitPackages android.WritablePaths
462 var splits []split
463
464 for _, s := range a.splitNames {
465 suffix := strings.Replace(s, ",", "_", -1)
466 path := android.PathForModuleOut(ctx, "package_"+suffix+".apk")
467 linkFlags = append(linkFlags, "--split", path.String()+":"+s)
468 splitPackages = append(splitPackages, path)
469 splits = append(splits, split{
470 name: s,
471 suffix: suffix,
472 path: path,
473 })
474 }
475
Colin Crossf3b7bad2023-08-02 15:49:00 -0700476 if !a.useResourceProcessorBusyBox() {
477 // the subdir "android" is required to be filtered by package names
478 srcJar = android.PathForModuleGen(ctx, "android", "R.srcjar")
479 }
480
Colin Crossab8d1382023-07-14 17:23:41 +0000481 // No need to specify assets from dependencies to aapt2Link for libraries, all transitive assets will be
482 // provided to the final app aapt2Link step.
483 var transitiveAssets android.Paths
484 if !a.isLibrary {
485 transitiveAssets = android.ReverseSliceInPlace(staticDeps.assets())
486 }
Colin Crossf3b7bad2023-08-02 15:49:00 -0700487 aapt2Link(ctx, packageRes, srcJar, proguardOptionsFile, rTxt,
Colin Crossab8d1382023-07-14 17:23:41 +0000488 linkFlags, linkDeps, compiledRes, compiledOverlay, transitiveAssets, splitPackages)
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800489 // Extract assets from the resource package output so that they can be used later in aapt2link
490 // for modules that depend on this one.
Colin Crossab8d1382023-07-14 17:23:41 +0000491 if android.PrefixInList(linkFlags, "-A ") {
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800492 assets := android.PathForModuleOut(ctx, "assets.zip")
493 ctx.Build(pctx, android.BuildParams{
494 Rule: extractAssetsRule,
495 Input: packageRes,
496 Output: assets,
497 Description: "extract assets from built resource file",
498 })
499 a.assetPackage = android.OptionalPathForPath(assets)
500 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700501
Colin Cross4eae06d2023-06-20 22:40:02 -0700502 if a.useResourceProcessorBusyBox() {
503 rJar := android.PathForModuleOut(ctx, "busybox/R.jar")
504 resourceProcessorBusyBoxGenerateBinaryR(ctx, rTxt, a.mergedManifestFile, rJar, staticDeps, a.isLibrary)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700505 aapt2ExtractExtraPackages(ctx, extraPackages, rJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700506 transitiveRJars = append(transitiveRJars, rJar)
507 a.rJar = rJar
Colin Crossf3b7bad2023-08-02 15:49:00 -0700508 } else {
509 aapt2ExtractExtraPackages(ctx, extraPackages, srcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700510 }
511
Colin Crossa97c5d32018-03-28 14:58:31 -0700512 a.aaptSrcJar = srcJar
Colin Cross4eae06d2023-06-20 22:40:02 -0700513 a.transitiveAaptRJars = transitiveRJars
514 a.transitiveAaptResourcePackages = staticDeps.resPackages()
Colin Crossa97c5d32018-03-28 14:58:31 -0700515 a.exportPackage = packageRes
516 a.manifestPath = manifestPath
517 a.proguardOptionsFile = proguardOptionsFile
Colin Cross66f78822018-05-02 12:58:28 -0700518 a.extraAaptPackagesFile = extraPackages
Colin Crossa97c5d32018-03-28 14:58:31 -0700519 a.rTxt = rTxt
Colin Crosse560c4a2019-03-19 16:03:11 -0700520 a.splits = splits
Colin Crossab8d1382023-07-14 17:23:41 +0000521 a.resourcesNodesDepSet = android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL).
522 Direct(&resourcesNode{
523 resPackage: a.exportPackage,
524 manifest: a.manifestPath,
525 additionalManifests: additionalManifests,
Colin Cross4eae06d2023-06-20 22:40:02 -0700526 rTxt: a.rTxt,
527 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +0000528 assets: a.assetPackage,
Colin Cross4eae06d2023-06-20 22:40:02 -0700529
530 usedResourceProcessor: a.useResourceProcessorBusyBox(),
Colin Crossab8d1382023-07-14 17:23:41 +0000531 }).
532 Transitive(staticResourcesNodesDepSet).Build()
533 a.rroDirsDepSet = android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL).
534 Direct(rroDirs...).
535 Transitive(staticRRODirsDepSet).Build()
536 a.manifestsDepSet = android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
537 Direct(a.manifestPath).
538 DirectSlice(additionalManifests).
539 Transitive(staticManifestsDepSet).Build()
540}
541
Colin Cross4eae06d2023-06-20 22:40:02 -0700542var resourceProcessorBusyBox = pctx.AndroidStaticRule("resourceProcessorBusyBox",
543 blueprint.RuleParams{
544 Command: "${config.JavaCmd} -cp ${config.ResourceProcessorBusyBox} " +
545 "com.google.devtools.build.android.ResourceProcessorBusyBox --tool=GENERATE_BINARY_R -- @${out}.args && " +
546 "if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out}; fi",
547 CommandDeps: []string{"${config.ResourceProcessorBusyBox}"},
548 Rspfile: "${out}.args",
549 RspfileContent: "--primaryRTxt ${rTxt} --primaryManifest ${manifest} --classJarOutput ${out}.tmp ${args}",
550 Restat: true,
551 }, "rTxt", "manifest", "args")
552
553// resourceProcessorBusyBoxGenerateBinaryR converts the R.txt file produced by aapt2 into R.class files
554// using Bazel's ResourceProcessorBusyBox tool, which is faster than compiling the R.java files and
555// supports producing classes for static dependencies that only include resources from that dependency.
556func resourceProcessorBusyBoxGenerateBinaryR(ctx android.ModuleContext, rTxt, manifest android.Path,
557 rJar android.WritablePath, transitiveDeps transitiveAarDeps, isLibrary bool) {
558
559 var args []string
560 var deps android.Paths
561
562 if !isLibrary {
563 // When compiling an app, pass all R.txt and AndroidManifest.xml from transitive static library dependencies
564 // to ResourceProcessorBusyBox so that it can regenerate R.class files with the final resource IDs for each
565 // package.
566 args, deps = transitiveDeps.resourceProcessorDeps()
567 } else {
568 // When compiling a library don't pass any dependencies as it only needs to generate an R.class file for this
569 // library. Pass --finalFields=false so that the R.class file contains non-final fields so they don't get
570 // inlined into the library before the final IDs are assigned during app compilation.
571 args = append(args, "--finalFields=false")
572 }
573
574 deps = append(deps, rTxt, manifest)
575
576 ctx.Build(pctx, android.BuildParams{
577 Rule: resourceProcessorBusyBox,
578 Output: rJar,
579 Implicits: deps,
580 Description: "ResourceProcessorBusyBox",
581 Args: map[string]string{
582 "rTxt": rTxt.String(),
583 "manifest": manifest.String(),
584 "args": strings.Join(args, " "),
585 },
586 })
587}
588
Colin Crossab8d1382023-07-14 17:23:41 +0000589type resourcesNode struct {
590 resPackage android.Path
591 manifest android.Path
592 additionalManifests android.Paths
Colin Cross4eae06d2023-06-20 22:40:02 -0700593 rTxt android.Path
594 rJar android.Path
Colin Crossab8d1382023-07-14 17:23:41 +0000595 assets android.OptionalPath
Colin Cross4eae06d2023-06-20 22:40:02 -0700596
597 usedResourceProcessor bool
Colin Crossab8d1382023-07-14 17:23:41 +0000598}
599
600type transitiveAarDeps []*resourcesNode
601
602func (t transitiveAarDeps) resPackages() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700603 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000604 for _, dep := range t {
605 paths = append(paths, dep.resPackage)
606 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700607 return paths
Colin Crossab8d1382023-07-14 17:23:41 +0000608}
609
610func (t transitiveAarDeps) manifests() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700611 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000612 for _, dep := range t {
613 paths = append(paths, dep.manifest)
614 paths = append(paths, dep.additionalManifests...)
615 }
Colin Cross4eae06d2023-06-20 22:40:02 -0700616 return paths
617}
618
619func (t transitiveAarDeps) resourceProcessorDeps() (args []string, deps android.Paths) {
620 for _, dep := range t {
621 args = append(args, "--library="+dep.rTxt.String()+","+dep.manifest.String())
622 deps = append(deps, dep.rTxt, dep.manifest)
623 }
624 return args, deps
Colin Crossab8d1382023-07-14 17:23:41 +0000625}
626
627func (t transitiveAarDeps) assets() android.Paths {
Colin Cross4eae06d2023-06-20 22:40:02 -0700628 paths := make(android.Paths, 0, len(t))
Colin Crossab8d1382023-07-14 17:23:41 +0000629 for _, dep := range t {
630 if dep.assets.Valid() {
631 paths = append(paths, dep.assets.Path())
632 }
633 }
634 return paths
Colin Crossa97c5d32018-03-28 14:58:31 -0700635}
636
637// aaptLibs collects libraries from dependencies and sdk_version and converts them into paths
Jiyong Parkf1691d22021-03-29 20:11:58 +0900638func aaptLibs(ctx android.ModuleContext, sdkContext android.SdkContext, classLoaderContexts dexpreopt.ClassLoaderContextMap) (
Colin Cross8676c8c2023-10-12 15:58:57 -0700639 staticResourcesNodes, sharedResourcesNodes *android.DepSet[*resourcesNode], staticRRODirs *android.DepSet[rroDir],
Colin Crossab8d1382023-07-14 17:23:41 +0000640 staticManifests *android.DepSet[android.Path], sharedLibs android.Paths, flags []string) {
Colin Crossa97c5d32018-03-28 14:58:31 -0700641
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100642 if classLoaderContexts == nil {
Ulya Trafimovich18554242020-11-03 15:55:11 +0000643 // Not all callers need to compute class loader context, those who don't just pass nil.
644 // Create a temporary class loader context here (it will be computed, but not used).
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100645 classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000646 }
647
Colin Cross83bb3162018-06-25 15:48:06 -0700648 sdkDep := decodeSdkDep(ctx, sdkContext)
Colin Crossa97c5d32018-03-28 14:58:31 -0700649 if sdkDep.useFiles {
Colin Cross86a60ae2018-05-29 14:44:55 -0700650 sharedLibs = append(sharedLibs, sdkDep.jars...)
Colin Crossa97c5d32018-03-28 14:58:31 -0700651 }
652
Colin Cross8676c8c2023-10-12 15:58:57 -0700653 var staticResourcesNodeDepSets []*android.DepSet[*resourcesNode]
654 var sharedResourcesNodeDepSets []*android.DepSet[*resourcesNode]
Colin Crossab8d1382023-07-14 17:23:41 +0000655 rroDirsDepSetBuilder := android.NewDepSetBuilder[rroDir](android.TOPOLOGICAL)
656 manifestsDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
657
Colin Crossa97c5d32018-03-28 14:58:31 -0700658 ctx.VisitDirectDeps(func(module android.Module) {
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000659 depTag := ctx.OtherModuleDependencyTag(module)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000660
Colin Crossa97c5d32018-03-28 14:58:31 -0700661 var exportPackage android.Path
Colin Cross66f78822018-05-02 12:58:28 -0700662 aarDep, _ := module.(AndroidLibraryDependency)
663 if aarDep != nil {
Colin Crossa97c5d32018-03-28 14:58:31 -0700664 exportPackage = aarDep.ExportPackage()
665 }
666
Ulya Trafimovich65b03192020-12-03 16:50:22 +0000667 switch depTag {
Colin Cross4b964c02018-10-15 16:18:06 -0700668 case instrumentationForTag:
669 // Nothing, instrumentationForTag is treated as libTag for javac but not for aapt2.
Liz Kammeref28a4c2022-09-23 16:50:56 -0400670 case sdkLibTag, libTag:
Colin Cross5446e882019-05-22 10:46:27 -0700671 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700672 sharedResourcesNodeDepSets = append(sharedResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Cross5446e882019-05-22 10:46:27 -0700673 sharedLibs = append(sharedLibs, exportPackage)
674 }
Colin Cross5446e882019-05-22 10:46:27 -0700675 case frameworkResTag:
Colin Crossa97c5d32018-03-28 14:58:31 -0700676 if exportPackage != nil {
677 sharedLibs = append(sharedLibs, exportPackage)
678 }
679 case staticLibTag:
680 if exportPackage != nil {
Colin Cross8676c8c2023-10-12 15:58:57 -0700681 staticResourcesNodeDepSets = append(staticResourcesNodeDepSets, aarDep.ResourcesNodeDepSet())
Colin Crossab8d1382023-07-14 17:23:41 +0000682 rroDirsDepSetBuilder.Transitive(aarDep.RRODirsDepSet())
683 manifestsDepSetBuilder.Transitive(aarDep.ManifestsDepSet())
Colin Crossa97c5d32018-03-28 14:58:31 -0700684 }
685 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000686
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +0000687 addCLCFromDep(ctx, module, classLoaderContexts)
Colin Crossa97c5d32018-03-28 14:58:31 -0700688 })
689
Colin Crossab8d1382023-07-14 17:23:41 +0000690 // AAPT2 overlays are in lowest to highest priority order, the topological order will be reversed later.
691 // Reverse the dependency order now going into the depset so that it comes out in order after the second
692 // reverse later.
693 // NOTE: this is legacy and probably incorrect behavior, for most other cases (e.g. conflicting classes in
694 // dependencies) the highest priority dependency is listed first, but for resources the highest priority
695 // dependency has to be listed last.
696 staticResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
Colin Cross8676c8c2023-10-12 15:58:57 -0700697 android.ReverseSliceInPlace(staticResourcesNodeDepSets))
698 sharedResourcesNodes = android.NewDepSet(android.TOPOLOGICAL, nil,
699 android.ReverseSliceInPlace(sharedResourcesNodeDepSets))
Colin Crossa97c5d32018-03-28 14:58:31 -0700700
Colin Crossab8d1382023-07-14 17:23:41 +0000701 staticRRODirs = rroDirsDepSetBuilder.Build()
702 staticManifests = manifestsDepSetBuilder.Build()
703
704 if len(staticResourcesNodes.ToList()) > 0 {
Colin Crossa97c5d32018-03-28 14:58:31 -0700705 flags = append(flags, "--auto-add-overlay")
706 }
707
708 for _, sharedLib := range sharedLibs {
709 flags = append(flags, "-I "+sharedLib.String())
710 }
711
Colin Cross8676c8c2023-10-12 15:58:57 -0700712 return staticResourcesNodes, sharedResourcesNodes, staticRRODirs, staticManifests, sharedLibs, flags
Colin Crossa97c5d32018-03-28 14:58:31 -0700713}
714
715type AndroidLibrary struct {
716 Library
717 aapt
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -0500718 android.BazelModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700719
720 androidLibraryProperties androidLibraryProperties
721
722 aarFile android.WritablePath
Colin Cross89c31582018-04-30 15:55:11 -0700723}
724
Saeid Farivar Asanjan1fca3012021-09-14 18:40:19 +0000725var _ android.OutputFileProducer = (*AndroidLibrary)(nil)
726
727// For OutputFileProducer interface
728func (a *AndroidLibrary) OutputFiles(tag string) (android.Paths, error) {
729 switch tag {
730 case ".aar":
731 return []android.Path{a.aarFile}, nil
732 default:
733 return a.Library.OutputFiles(tag)
734 }
735}
736
Colin Crossa97c5d32018-03-28 14:58:31 -0700737var _ AndroidLibraryDependency = (*AndroidLibrary)(nil)
738
739func (a *AndroidLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
740 a.Module.deps(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900741 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100742 if sdkDep.hasFrameworkLibs() {
743 a.aapt.deps(ctx, sdkDep)
Colin Crossa97c5d32018-03-28 14:58:31 -0700744 }
Colin Cross4a80a152022-12-21 21:51:52 -0800745 a.usesLibrary.deps(ctx, false)
Colin Crossa97c5d32018-03-28 14:58:31 -0700746}
747
748func (a *AndroidLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Crosse4246ab2019-02-05 21:55:21 -0800749 a.aapt.isLibrary = true
Ulya Trafimovich42c7f0d2021-08-17 16:20:29 +0100750 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Alixf7a10272023-09-27 16:47:56 +0000751 a.aapt.buildActions(ctx,
752 aaptBuildActionOptions{
753 sdkContext: android.SdkContext(a),
754 classLoaderContexts: a.classLoaderContexts,
755 enforceDefaultTargetSdkVersion: false,
756 },
757 )
Colin Crossa97c5d32018-03-28 14:58:31 -0700758
Colin Cross56a83212020-09-15 18:30:11 -0700759 a.hideApexVariantFromMake = !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
760
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000761 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
762
Colin Cross4eae06d2023-06-20 22:40:02 -0700763 ctx.CheckbuildFile(a.aapt.proguardOptionsFile)
764 ctx.CheckbuildFile(a.aapt.exportPackage)
Colin Cross4eae06d2023-06-20 22:40:02 -0700765 if a.useResourceProcessorBusyBox() {
766 ctx.CheckbuildFile(a.aapt.rJar)
Colin Crossf3b7bad2023-08-02 15:49:00 -0700767 } else {
768 ctx.CheckbuildFile(a.aapt.aaptSrcJar)
Colin Cross4eae06d2023-06-20 22:40:02 -0700769 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700770
771 // apps manifests are handled by aapt, don't let Module see them
772 a.properties.Manifest = nil
773
Colin Cross014489c2020-06-02 20:09:13 -0700774 a.linter.mergedManifest = a.aapt.mergedManifestFile
775 a.linter.manifest = a.aapt.manifestPath
776 a.linter.resources = a.aapt.resourceFiles
777
Colin Crossa97c5d32018-03-28 14:58:31 -0700778 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles,
779 a.proguardOptionsFile)
780
Colin Cross4eae06d2023-06-20 22:40:02 -0700781 var extraSrcJars android.Paths
782 var extraCombinedJars android.Paths
783 var extraClasspathJars android.Paths
784 if a.useResourceProcessorBusyBox() {
785 // When building a library with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox for this
786 // library and each of the transitive static android_library dependencies has already created an
787 // R.class file for the appropriate package. Add all of those R.class files to the classpath.
788 extraClasspathJars = a.transitiveAaptRJars
789 } else {
790 // When building a library without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
791 // R.java files for the library's package and the packages from all transitive static android_library
792 // dependencies. Compile the srcjar alongside the rest of the sources.
793 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
794 }
795
796 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Crossa97c5d32018-03-28 14:58:31 -0700797
Colin Crossf57c5782019-01-25 13:20:38 -0800798 a.aarFile = android.PathForModuleOut(ctx, ctx.ModuleName()+".aar")
Colin Crossa97c5d32018-03-28 14:58:31 -0700799 var res android.Paths
800 if a.androidLibraryProperties.BuildAAR {
801 BuildAAR(ctx, a.aarFile, a.outputFile, a.manifestPath, a.rTxt, res)
802 ctx.CheckbuildFile(a.aarFile)
803 }
Colin Cross89c31582018-04-30 15:55:11 -0700804
Sam Delmerico95d70942023-08-02 18:00:35 -0400805 proguardSpecInfo := a.collectProguardSpecInfo(ctx)
806 ctx.SetProvider(ProguardSpecInfoProvider, proguardSpecInfo)
807 a.exportedProguardFlagFiles = proguardSpecInfo.ProguardFlagsFiles.ToList()
Sam Delmerico82602492022-06-10 17:05:42 +0000808
809 prebuiltJniPackages := android.Paths{}
810 ctx.VisitDirectDeps(func(module android.Module) {
811 if info, ok := ctx.OtherModuleProvider(module, JniPackageProvider).(JniPackageInfo); ok {
812 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
813 }
814 })
815 if len(prebuiltJniPackages) > 0 {
816 ctx.SetProvider(JniPackageProvider, JniPackageInfo{
817 JniPackages: prebuiltJniPackages,
818 })
819 }
Colin Crossa97c5d32018-03-28 14:58:31 -0700820}
821
Colin Cross1b16b0e2019-02-12 14:41:32 -0800822// android_library builds and links sources into a `.jar` file for the device along with Android resources.
823//
824// An android_library has a single variant that produces a `.jar` file containing `.class` files that were
Sam Delmerico82602492022-06-10 17:05:42 +0000825// compiled against the device bootclasspath, along with a `package-res.apk` file containing Android resources compiled
Colin Cross1b16b0e2019-02-12 14:41:32 -0800826// with aapt2. This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
827// an android_app module.
Colin Crossa97c5d32018-03-28 14:58:31 -0700828func AndroidLibraryFactory() android.Module {
829 module := &AndroidLibrary{}
830
Colin Crossce6734e2020-06-15 16:09:53 -0700831 module.Module.addHostAndDeviceProperties()
Colin Crossa97c5d32018-03-28 14:58:31 -0700832 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700833 &module.aaptProperties,
834 &module.androidLibraryProperties)
835
836 module.androidLibraryProperties.BuildAAR = true
Colin Cross014489c2020-06-02 20:09:13 -0700837 module.Module.linter.library = true
Colin Crossa97c5d32018-03-28 14:58:31 -0700838
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900839 android.InitApexModule(module)
Colin Cross48de9a42018-10-02 13:53:33 -0700840 InitJavaModule(module, android.DeviceSupported)
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -0500841 android.InitBazelModule(module)
Colin Crossa97c5d32018-03-28 14:58:31 -0700842 return module
843}
844
Colin Crossfabb6082018-02-20 17:22:23 -0800845//
846// AAR (android library) prebuilts
847//
Colin Crossfabb6082018-02-20 17:22:23 -0800848
Vinh Trance0781f2022-04-13 01:30:44 +0000849// Properties for android_library_import
Colin Crossfabb6082018-02-20 17:22:23 -0800850type AARImportProperties struct {
Vinh Trance0781f2022-04-13 01:30:44 +0000851 // ARR (android library prebuilt) filepath. Exactly one ARR is required.
Colin Cross27b922f2019-03-04 22:35:41 -0800852 Aars []string `android:"path"`
Vinh Trance0781f2022-04-13 01:30:44 +0000853 // If not blank, set to the version of the sdk to compile against.
854 // Defaults to private.
855 // Values are of one of the following forms:
856 // 1) numerical API level, "current", "none", or "core_platform"
857 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
858 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
859 // If the SDK kind is empty, it will be set to public
860 Sdk_version *string
861 // If not blank, set the minimum version of the sdk that the compiled artifacts will run against.
862 // Defaults to sdk_version if not set. See sdk_version for possible values.
Colin Cross479884c2018-07-10 13:39:30 -0700863 Min_sdk_version *string
Vinh Trance0781f2022-04-13 01:30:44 +0000864 // List of java static libraries that the included ARR (android library prebuilts) has dependencies to.
Colin Crossa97c5d32018-03-28 14:58:31 -0700865 Static_libs []string
Vinh Trance0781f2022-04-13 01:30:44 +0000866 // List of java libraries that the included ARR (android library prebuilts) has dependencies to.
867 Libs []string
868 // If set to true, run Jetifier against .aar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -0700869 Jetifier *bool
Sam Delmerico82602492022-06-10 17:05:42 +0000870 // If true, extract JNI libs from AAR archive. These libs will be accessible to android_app modules and
871 // will be passed transitively through android_libraries to an android_app.
872 //TODO(b/241138093) evaluate whether we can have this flag default to true for Bazel conversion
873 Extract_jni *bool
Colin Crossfabb6082018-02-20 17:22:23 -0800874}
875
876type AARImport struct {
877 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -0700878 android.DefaultableModuleBase
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900879 android.ApexModuleBase
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -0500880 android.BazelModuleBase
Colin Crossfabb6082018-02-20 17:22:23 -0800881 prebuilt android.Prebuilt
882
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900883 // Functionality common to Module and Import.
884 embeddableInModuleAndImport
885
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500886 providesTransitiveHeaderJars
887
Colin Crossfabb6082018-02-20 17:22:23 -0800888 properties AARImportProperties
889
Colin Cross4eae06d2023-06-20 22:40:02 -0700890 classpathFile android.WritablePath
891 proguardFlags android.WritablePath
892 exportPackage android.WritablePath
893 transitiveAaptResourcePackages android.Paths
894 extraAaptPackagesFile android.WritablePath
895 manifest android.WritablePath
896 assetsPackage android.WritablePath
897 rTxt android.WritablePath
898 rJar android.WritablePath
Colin Cross66f78822018-05-02 12:58:28 -0700899
Colin Crossab8d1382023-07-14 17:23:41 +0000900 resourcesNodesDepSet *android.DepSet[*resourcesNode]
901 manifestsDepSet *android.DepSet[android.Path]
Colin Cross56a83212020-09-15 18:30:11 -0700902
903 hideApexVariantFromMake bool
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000904
Sam Delmerico82602492022-06-10 17:05:42 +0000905 aarPath android.Path
906 jniPackages android.Paths
Jiyong Park92315372021-04-02 08:45:46 +0900907
908 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000909 minSdkVersion android.ApiLevel
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +0000910}
911
912var _ android.OutputFileProducer = (*AARImport)(nil)
913
914// For OutputFileProducer interface
915func (a *AARImport) OutputFiles(tag string) (android.Paths, error) {
916 switch tag {
917 case ".aar":
918 return []android.Path{a.aarPath}, nil
919 case "":
920 return []android.Path{a.classpathFile}, nil
921 default:
922 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
923 }
Colin Crossfabb6082018-02-20 17:22:23 -0800924}
925
Jiyong Park92315372021-04-02 08:45:46 +0900926func (a *AARImport) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
927 return android.SdkSpecFrom(ctx, String(a.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700928}
929
Jiyong Parkf1691d22021-03-29 20:11:58 +0900930func (a *AARImport) SystemModules() string {
Paul Duffine25c6442019-10-11 13:50:28 +0100931 return ""
932}
933
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000934func (a *AARImport) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Colin Cross479884c2018-07-10 13:39:30 -0700935 if a.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000936 return android.ApiLevelFrom(ctx, *a.properties.Min_sdk_version)
Colin Cross479884c2018-07-10 13:39:30 -0700937 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000938 return a.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -0700939}
940
Spandan Dasa26eda72023-03-02 00:56:06 +0000941func (a *AARImport) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
942 return android.SdkSpecFrom(ctx, "").ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000943}
944
Spandan Dasca70fc42023-03-01 23:38:49 +0000945func (a *AARImport) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
946 return a.SdkVersion(ctx).ApiLevel
Dan Willemsen419290a2018-10-31 15:28:47 -0700947}
948
Colin Cross1e743852019-10-28 11:37:20 -0700949func (a *AARImport) javaVersion() string {
950 return ""
951}
952
Colin Crossa97c5d32018-03-28 14:58:31 -0700953var _ AndroidLibraryDependency = (*AARImport)(nil)
954
955func (a *AARImport) ExportPackage() android.Path {
956 return a.exportPackage
957}
Colin Crossab8d1382023-07-14 17:23:41 +0000958func (a *AARImport) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
959 return a.resourcesNodesDepSet
Colin Crossc1c37552019-01-31 11:42:41 -0800960}
961
Colin Crossab8d1382023-07-14 17:23:41 +0000962func (a *AARImport) RRODirsDepSet() *android.DepSet[rroDir] {
963 return android.NewDepSet[rroDir](android.TOPOLOGICAL, nil, nil)
Colin Cross66f78822018-05-02 12:58:28 -0700964}
965
Colin Crossab8d1382023-07-14 17:23:41 +0000966func (a *AARImport) ManifestsDepSet() *android.DepSet[android.Path] {
967 return a.manifestsDepSet
Jaewoong Jung6431ca72020-01-15 14:15:10 -0800968}
969
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700970// RRO enforcement is not available on aar_import since its RRO dirs are not
971// exported.
972func (a *AARImport) SetRROEnforcedForDependent(enforce bool) {
973}
974
975// RRO enforcement is not available on aar_import since its RRO dirs are not
976// exported.
977func (a *AARImport) IsRROEnforced(ctx android.BaseModuleContext) bool {
978 return false
979}
980
Colin Crossfabb6082018-02-20 17:22:23 -0800981func (a *AARImport) Prebuilt() *android.Prebuilt {
982 return &a.prebuilt
983}
984
985func (a *AARImport) Name() string {
986 return a.prebuilt.Name(a.ModuleBase.Name())
987}
988
Jiyong Park618922e2020-01-08 13:35:43 +0900989func (a *AARImport) JacocoReportClassesFile() android.Path {
990 return nil
991}
992
Colin Crossfabb6082018-02-20 17:22:23 -0800993func (a *AARImport) DepsMutator(ctx android.BottomUpMutatorContext) {
Jeongik Cha816a23a2020-07-08 01:09:23 +0900994 if !ctx.Config().AlwaysUsePrebuiltSdks() {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900995 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Colin Crossa97c5d32018-03-28 14:58:31 -0700996 if sdkDep.useModule && sdkDep.frameworkResModule != "" {
Colin Cross42d48b72018-08-29 14:10:52 -0700997 ctx.AddVariationDependencies(nil, frameworkResTag, sdkDep.frameworkResModule)
Colin Crossfabb6082018-02-20 17:22:23 -0800998 }
999 }
Colin Crossa97c5d32018-03-28 14:58:31 -07001000
Colin Cross42d48b72018-08-29 14:10:52 -07001001 ctx.AddVariationDependencies(nil, libTag, a.properties.Libs...)
1002 ctx.AddVariationDependencies(nil, staticLibTag, a.properties.Static_libs...)
Colin Crossfabb6082018-02-20 17:22:23 -08001003}
1004
Sam Delmerico82602492022-06-10 17:05:42 +00001005type JniPackageInfo struct {
1006 // List of zip files containing JNI libraries
1007 // Zip files should have directory structure jni/<arch>/*.so
1008 JniPackages android.Paths
1009}
1010
1011var JniPackageProvider = blueprint.NewProvider(JniPackageInfo{})
1012
1013// Unzip an AAR and extract the JNI libs for $archString.
1014var extractJNI = pctx.AndroidStaticRule("extractJNI",
1015 blueprint.RuleParams{
1016 Command: `rm -rf $out $outDir && touch $out && ` +
1017 `unzip -qoDD -d $outDir $in "jni/${archString}/*" && ` +
1018 `jni_files=$$(find $outDir/jni -type f) && ` +
1019 // print error message if there are no JNI libs for this arch
1020 `[ -n "$$jni_files" ] || (echo "ERROR: no JNI libs found for arch ${archString}" && exit 1) && ` +
Sam Delmerico80ee45c2023-06-22 15:36:02 -04001021 `${config.SoongZipCmd} -o $out -L 0 -P 'lib/${archString}' ` +
Sam Delmerico82602492022-06-10 17:05:42 +00001022 `-C $outDir/jni/${archString} $$(echo $$jni_files | xargs -n1 printf " -f %s")`,
1023 CommandDeps: []string{"${config.SoongZipCmd}"},
1024 },
1025 "outDir", "archString")
1026
Colin Crossfabb6082018-02-20 17:22:23 -08001027// 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 -07001028// 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 -08001029var unzipAAR = pctx.AndroidStaticRule("unzipAAR",
1030 blueprint.RuleParams{
Dan Willemsen304cfec2019-05-28 14:49:06 -07001031 Command: `rm -rf $outDir && mkdir -p $outDir && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001032 `unzip -qoDD -d $outDir $in && rm -rf $outDir/res && touch $out && ` +
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001033 `${config.Zip2ZipCmd} -i $in -o $assetsPackage 'assets/**/*' && ` +
Colin Cross205e9112020-08-06 13:20:17 -07001034 `${config.MergeZipsCmd} $combinedClassesJar $$(ls $outDir/classes.jar 2> /dev/null) $$(ls $outDir/libs/*.jar 2> /dev/null)`,
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001035 CommandDeps: []string{"${config.MergeZipsCmd}", "${config.Zip2ZipCmd}"},
Colin Crossfabb6082018-02-20 17:22:23 -08001036 },
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001037 "outDir", "combinedClassesJar", "assetsPackage")
Colin Crossfabb6082018-02-20 17:22:23 -08001038
1039func (a *AARImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1040 if len(a.properties.Aars) != 1 {
1041 ctx.PropertyErrorf("aars", "exactly one aar is required")
1042 return
1043 }
1044
Jiyong Park92315372021-04-02 08:45:46 +09001045 a.sdkVersion = a.SdkVersion(ctx)
1046 a.minSdkVersion = a.MinSdkVersion(ctx)
1047
Colin Cross56a83212020-09-15 18:30:11 -07001048 a.hideApexVariantFromMake = !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
1049
Nan Zhang4c819fb2018-08-27 18:31:46 -07001050 aarName := ctx.ModuleName() + ".aar"
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001051 a.aarPath = android.PathForModuleSrc(ctx, a.properties.Aars[0])
1052
Colin Cross1001a792019-03-21 22:21:39 -07001053 if Bool(a.properties.Jetifier) {
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001054 inputFile := a.aarPath
1055 a.aarPath = android.PathForModuleOut(ctx, "jetifier", aarName)
1056 TransformJetifier(ctx, a.aarPath.(android.WritablePath), inputFile)
Nan Zhang4c819fb2018-08-27 18:31:46 -07001057 }
Colin Crossfabb6082018-02-20 17:22:23 -08001058
1059 extractedAARDir := android.PathForModuleOut(ctx, "aar")
Colin Cross205e9112020-08-06 13:20:17 -07001060 a.classpathFile = extractedAARDir.Join(ctx, "classes-combined.jar")
Colin Cross10f7c4a2018-05-23 10:59:28 -07001061 a.manifest = extractedAARDir.Join(ctx, "AndroidManifest.xml")
Colin Cross4eae06d2023-06-20 22:40:02 -07001062 aarRTxt := extractedAARDir.Join(ctx, "R.txt")
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001063 a.assetsPackage = android.PathForModuleOut(ctx, "assets.zip")
Sam Delmerico95d70942023-08-02 18:00:35 -04001064 a.proguardFlags = extractedAARDir.Join(ctx, "proguard.txt")
1065 ctx.SetProvider(ProguardSpecInfoProvider, ProguardSpecInfo{
1066 ProguardFlagsFiles: android.NewDepSet[android.Path](
1067 android.POSTORDER,
1068 android.Paths{a.proguardFlags},
1069 nil,
1070 ),
1071 })
Colin Crossfabb6082018-02-20 17:22:23 -08001072
1073 ctx.Build(pctx, android.BuildParams{
1074 Rule: unzipAAR,
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001075 Input: a.aarPath,
Colin Cross4eae06d2023-06-20 22:40:02 -07001076 Outputs: android.WritablePaths{a.classpathFile, a.proguardFlags, a.manifest, a.assetsPackage, aarRTxt},
Colin Crossfabb6082018-02-20 17:22:23 -08001077 Description: "unzip AAR",
1078 Args: map[string]string{
Colin Cross205e9112020-08-06 13:20:17 -07001079 "outDir": extractedAARDir.String(),
1080 "combinedClassesJar": a.classpathFile.String(),
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001081 "assetsPackage": a.assetsPackage.String(),
Colin Crossfabb6082018-02-20 17:22:23 -08001082 },
1083 })
1084
Colin Crossa0ba2f52019-06-22 12:59:27 -07001085 // Always set --pseudo-localize, it will be stripped out later for release
1086 // builds that don't want it.
1087 compileFlags := []string{"--pseudo-localize"}
Colin Crossfabb6082018-02-20 17:22:23 -08001088 compiledResDir := android.PathForModuleOut(ctx, "flat-res")
Colin Crossfabb6082018-02-20 17:22:23 -08001089 flata := compiledResDir.Join(ctx, "gen_res.flata")
Saeid Farivar Asanjanf0436962020-10-05 19:09:09 +00001090 aapt2CompileZip(ctx, flata, a.aarPath, "res", compileFlags)
Colin Crossfabb6082018-02-20 17:22:23 -08001091
1092 a.exportPackage = android.PathForModuleOut(ctx, "package-res.apk")
Colin Crossfabb6082018-02-20 17:22:23 -08001093 proguardOptionsFile := android.PathForModuleGen(ctx, "proguard.options")
Colin Cross4eae06d2023-06-20 22:40:02 -07001094 a.rTxt = android.PathForModuleOut(ctx, "R.txt")
Colin Cross66f78822018-05-02 12:58:28 -07001095 a.extraAaptPackagesFile = android.PathForModuleOut(ctx, "extra_packages")
Colin Crossfabb6082018-02-20 17:22:23 -08001096
1097 var linkDeps android.Paths
1098
1099 linkFlags := []string{
1100 "--static-lib",
Colin Cross4eae06d2023-06-20 22:40:02 -07001101 "--merge-only",
Colin Crossfabb6082018-02-20 17:22:23 -08001102 "--auto-add-overlay",
1103 }
1104
Colin Cross10f7c4a2018-05-23 10:59:28 -07001105 linkFlags = append(linkFlags, "--manifest "+a.manifest.String())
1106 linkDeps = append(linkDeps, a.manifest)
Colin Crossfabb6082018-02-20 17:22:23 -08001107
Colin Cross8676c8c2023-10-12 15:58:57 -07001108 staticResourcesNodesDepSet, sharedResourcesNodesDepSet, staticRRODirsDepSet, staticManifestsDepSet, sharedLibs, libFlags :=
Jiyong Parkf1691d22021-03-29 20:11:58 +09001109 aaptLibs(ctx, android.SdkContext(a), nil)
Colin Cross31656952018-05-24 16:11:20 -07001110
Colin Cross8676c8c2023-10-12 15:58:57 -07001111 _ = sharedResourcesNodesDepSet
Colin Crossab8d1382023-07-14 17:23:41 +00001112 _ = staticRRODirsDepSet
Colin Cross8676c8c2023-10-12 15:58:57 -07001113
Colin Crossab8d1382023-07-14 17:23:41 +00001114 staticDeps := transitiveAarDeps(staticResourcesNodesDepSet.ToList())
Colin Crossfabb6082018-02-20 17:22:23 -08001115
Colin Crossab8d1382023-07-14 17:23:41 +00001116 linkDeps = append(linkDeps, sharedLibs...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001117 linkDeps = append(linkDeps, staticDeps.resPackages()...)
Colin Crossa97c5d32018-03-28 14:58:31 -07001118 linkFlags = append(linkFlags, libFlags...)
Colin Crossfabb6082018-02-20 17:22:23 -08001119
Colin Cross4eae06d2023-06-20 22:40:02 -07001120 overlayRes := android.Paths{flata}
1121
1122 // Treat static library dependencies of static libraries as imports.
1123 transitiveStaticLibs := staticDeps.resPackages()
1124 linkDeps = append(linkDeps, transitiveStaticLibs...)
1125 for _, staticLib := range transitiveStaticLibs {
1126 linkFlags = append(linkFlags, "-I "+staticLib.String())
1127 }
Colin Crossfabb6082018-02-20 17:22:23 -08001128
Colin Crossab8d1382023-07-14 17:23:41 +00001129 transitiveAssets := android.ReverseSliceInPlace(staticDeps.assets())
Colin Crossf3b7bad2023-08-02 15:49:00 -07001130 aapt2Link(ctx, a.exportPackage, nil, proguardOptionsFile, a.rTxt,
Jaewoong Jung6431ca72020-01-15 14:15:10 -08001131 linkFlags, linkDeps, nil, overlayRes, transitiveAssets, nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001132
Colin Cross4eae06d2023-06-20 22:40:02 -07001133 a.rJar = android.PathForModuleOut(ctx, "busybox/R.jar")
1134 resourceProcessorBusyBoxGenerateBinaryR(ctx, a.rTxt, a.manifest, a.rJar, nil, true)
1135
Colin Crossf3b7bad2023-08-02 15:49:00 -07001136 aapt2ExtractExtraPackages(ctx, a.extraAaptPackagesFile, a.rJar)
1137
Colin Crossab8d1382023-07-14 17:23:41 +00001138 resourcesNodesDepSetBuilder := android.NewDepSetBuilder[*resourcesNode](android.TOPOLOGICAL)
1139 resourcesNodesDepSetBuilder.Direct(&resourcesNode{
1140 resPackage: a.exportPackage,
1141 manifest: a.manifest,
Colin Cross4eae06d2023-06-20 22:40:02 -07001142 rTxt: a.rTxt,
1143 rJar: a.rJar,
Colin Crossab8d1382023-07-14 17:23:41 +00001144 assets: android.OptionalPathForPath(a.assetsPackage),
Colin Cross4eae06d2023-06-20 22:40:02 -07001145
1146 usedResourceProcessor: true,
Colin Crossab8d1382023-07-14 17:23:41 +00001147 })
1148 resourcesNodesDepSetBuilder.Transitive(staticResourcesNodesDepSet)
1149 a.resourcesNodesDepSet = resourcesNodesDepSetBuilder.Build()
1150
1151 manifestDepSetBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).Direct(a.manifest)
1152 // TODO(b/288358614): Soong has historically not merged manifests from dependencies of android_library_import
1153 // modules. Merging manifests from dependencies could remove the need for pom2bp to generate the "-nodeps" copies
1154 // of androidx libraries, but doing so triggers errors due to errors introduced by existing dependencies of
1155 // android_library_import modules. If this is fixed, AndroidLibraryDependency.ManifestsDepSet can be dropped
1156 // completely in favor of AndroidLibraryDependency.ResourceNodesDepSet.manifest
1157 //manifestDepSetBuilder.Transitive(transitiveStaticDeps.manifests)
1158 _ = staticManifestsDepSet
1159 a.manifestsDepSet = manifestDepSetBuilder.Build()
Michael Rosenfeld5ad15572021-12-03 13:25:10 -08001160
Colin Cross4eae06d2023-06-20 22:40:02 -07001161 a.transitiveAaptResourcePackages = staticDeps.resPackages()
1162
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001163 a.collectTransitiveHeaderJars(ctx)
Colin Crossdcf71b22021-02-01 13:59:03 -08001164 ctx.SetProvider(JavaInfoProvider, JavaInfo{
1165 HeaderJars: android.PathsIfNonNil(a.classpathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001166 TransitiveLibsHeaderJars: a.transitiveLibsHeaderJars,
1167 TransitiveStaticLibsHeaderJars: a.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08001168 ImplementationAndResourcesJars: android.PathsIfNonNil(a.classpathFile),
1169 ImplementationJars: android.PathsIfNonNil(a.classpathFile),
Joe Onorato6fe59eb2023-07-16 13:20:33 -07001170 // TransitiveAconfigFiles: // TODO(b/289117800): LOCAL_ACONFIG_FILES for prebuilts
Colin Crossdcf71b22021-02-01 13:59:03 -08001171 })
Sam Delmerico82602492022-06-10 17:05:42 +00001172
1173 if proptools.Bool(a.properties.Extract_jni) {
1174 for _, t := range ctx.MultiTargets() {
1175 arch := t.Arch.Abi[0]
1176 path := android.PathForModuleOut(ctx, arch+"_jni.zip")
1177 a.jniPackages = append(a.jniPackages, path)
1178
1179 outDir := android.PathForModuleOut(ctx, "aarForJni")
1180 aarPath := android.PathForModuleSrc(ctx, a.properties.Aars[0])
1181 ctx.Build(pctx, android.BuildParams{
1182 Rule: extractJNI,
1183 Input: aarPath,
1184 Outputs: android.WritablePaths{path},
1185 Description: "extract JNI from AAR",
1186 Args: map[string]string{
1187 "outDir": outDir.String(),
1188 "archString": arch,
1189 },
1190 })
1191 }
1192
1193 ctx.SetProvider(JniPackageProvider, JniPackageInfo{
1194 JniPackages: a.jniPackages,
1195 })
1196 }
Colin Crossdcf71b22021-02-01 13:59:03 -08001197}
Colin Crossfabb6082018-02-20 17:22:23 -08001198
1199func (a *AARImport) HeaderJars() android.Paths {
1200 return android.Paths{a.classpathFile}
1201}
1202
Colin Cross331a1212018-08-15 20:40:52 -07001203func (a *AARImport) ImplementationAndResourcesJars() android.Paths {
1204 return android.Paths{a.classpathFile}
1205}
1206
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00001207func (a *AARImport) DexJarBuildPath() android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001208 return nil
1209}
1210
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001211func (a *AARImport) DexJarInstallPath() android.Path {
1212 return nil
1213}
1214
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001215func (a *AARImport) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
Jiyong Park1be96912018-05-28 18:02:19 +09001216 return nil
1217}
1218
Jiyong Park45bf82e2020-12-15 22:29:02 +09001219var _ android.ApexModule = (*AARImport)(nil)
1220
1221// Implements android.ApexModule
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001222func (a *AARImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1223 return a.depIsInSameApex(ctx, dep)
1224}
1225
Jiyong Park45bf82e2020-12-15 22:29:02 +09001226// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07001227func (g *AARImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1228 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09001229 return nil
1230}
1231
Sam Delmericoaf8bb702022-07-25 15:39:32 -04001232var _ android.PrebuiltInterface = (*AARImport)(nil)
Colin Crossfabb6082018-02-20 17:22:23 -08001233
Colin Cross1b16b0e2019-02-12 14:41:32 -08001234// android_library_import imports an `.aar` file into the build graph as if it was built with android_library.
1235//
1236// This module is not suitable for installing on a device, but can be used as a `static_libs` dependency of
1237// an android_app module.
Colin Crossfabb6082018-02-20 17:22:23 -08001238func AARImportFactory() android.Module {
1239 module := &AARImport{}
1240
1241 module.AddProperties(&module.properties)
1242
1243 android.InitPrebuiltModule(module, &module.properties.Aars)
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09001244 android.InitApexModule(module)
Sam Delmerico82602492022-06-10 17:05:42 +00001245 InitJavaModuleMultiTargets(module, android.DeviceSupported)
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001246 android.InitBazelModule(module)
Colin Crossfabb6082018-02-20 17:22:23 -08001247 return module
1248}
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001249
1250type bazelAapt struct {
1251 Manifest bazel.Label
1252 Resource_files bazel.LabelListAttribute
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001253 Resource_zips bazel.LabelListAttribute
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001254 Assets_dir bazel.StringAttribute
1255 Assets bazel.LabelListAttribute
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001256}
1257
1258type bazelAndroidLibrary struct {
1259 *javaLibraryAttributes
1260 *bazelAapt
1261}
1262
1263type bazelAndroidLibraryImport struct {
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001264 Aar bazel.Label
1265 Deps bazel.LabelListAttribute
1266 Exports bazel.LabelListAttribute
1267 Sdk_version bazel.StringAttribute
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001268}
1269
Chris Parsons637458d2023-09-19 20:09:00 +00001270func (a *aapt) convertAaptAttrsWithBp2Build(ctx android.Bp2buildMutatorContext) (*bazelAapt, bool) {
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001271 manifest := proptools.StringDefault(a.aaptProperties.Manifest, "AndroidManifest.xml")
1272
1273 resourceFiles := bazel.LabelList{
1274 Includes: []bazel.Label{},
1275 }
1276 for _, dir := range android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Resource_dirs, "res") {
1277 files := android.RootToModuleRelativePaths(ctx, androidResourceGlob(ctx, dir))
1278 resourceFiles.Includes = append(resourceFiles.Includes, files...)
1279 }
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001280
1281 assetsDir := bazel.StringAttribute{}
1282 var assets bazel.LabelList
1283 for i, dir := range android.PathsWithOptionalDefaultForModuleSrc(ctx, a.aaptProperties.Asset_dirs, "assets") {
1284 if i > 0 {
1285 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_PROPERTY_UNSUPPORTED, "multiple asset_dirs")
1286 return &bazelAapt{}, false
1287 }
1288 // Assets_dirs are relative to the module dir when specified, but if the default in used in
1289 // PathsWithOptionalDefaultForModuleSrc, then dir is relative to the top.
1290 assetsRelDir, error := filepath.Rel(ctx.ModuleDir(), dir.Rel())
1291 if error != nil {
1292 assetsRelDir = dir.Rel()
1293 }
1294 assetsDir.Value = proptools.StringPtr(assetsRelDir)
1295 assets = bazel.MakeLabelList(android.RootToModuleRelativePaths(ctx, androidResourceGlob(ctx, dir)))
1296
1297 }
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001298 var resourceZips bazel.LabelList
1299 if len(a.aaptProperties.Resource_zips) > 0 {
1300 if ctx.ModuleName() == "framework-res" {
1301 resourceZips = android.BazelLabelForModuleSrc(ctx, a.aaptProperties.Resource_zips)
1302 } else {
1303 //TODO: b/301593550 - Implement support for this
1304 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_PROPERTY_UNSUPPORTED, "resource_zips")
1305 return &bazelAapt{}, false
1306 }
1307 }
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001308 return &bazelAapt{
1309 android.BazelLabelForModuleSrcSingle(ctx, manifest),
1310 bazel.MakeLabelListAttribute(resourceFiles),
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001311 bazel.MakeLabelListAttribute(resourceZips),
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001312 assetsDir,
1313 bazel.MakeLabelListAttribute(assets),
1314 }, true
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001315}
1316
Chris Parsons637458d2023-09-19 20:09:00 +00001317func (a *AARImport) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Romain Jobredeauxafc5d272023-09-21 11:07:30 -04001318 if len(a.properties.Aars) == 0 {
1319 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_PROPERTY_UNSUPPORTED, "aars can't be empty")
1320 return
1321 }
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001322 aars := android.BazelLabelForModuleSrcExcludes(ctx, a.properties.Aars, []string{})
1323 exportableStaticLibs := []string{}
1324 // TODO(b/240716882): investigate and handle static_libs deps that are not imports. They are not supported for export by Bazel.
1325 for _, depName := range a.properties.Static_libs {
1326 if dep, ok := ctx.ModuleFromName(depName); ok {
1327 switch dep.(type) {
1328 case *AARImport, *Import:
1329 exportableStaticLibs = append(exportableStaticLibs, depName)
1330 }
1331 }
1332 }
1333 name := android.RemoveOptionalPrebuiltPrefix(a.Name())
1334 deps := android.BazelLabelForModuleDeps(ctx, android.LastUniqueStrings(android.CopyOf(append(a.properties.Static_libs, a.properties.Libs...))))
1335 exports := android.BazelLabelForModuleDeps(ctx, android.LastUniqueStrings(exportableStaticLibs))
1336
1337 ctx.CreateBazelTargetModule(
1338 bazel.BazelTargetModuleProperties{
1339 Rule_class: "aar_import",
Alixa381cd12023-05-10 14:49:38 +00001340 Bzl_load_location: "//build/bazel/rules/android:aar_import.bzl",
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001341 },
1342 android.CommonAttributes{Name: name},
1343 &bazelAndroidLibraryImport{
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001344 Aar: aars.Includes[0],
1345 Deps: bazel.MakeLabelListAttribute(deps),
1346 Exports: bazel.MakeLabelListAttribute(exports),
1347 Sdk_version: bazel.StringAttribute{Value: a.properties.Sdk_version},
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001348 },
1349 )
1350
Alix14101de2023-01-06 03:42:07 +00001351 neverlink := true
1352 ctx.CreateBazelTargetModule(
Alix32540022023-03-16 21:06:13 +00001353 AndroidLibraryBazelTargetModuleProperties(),
Alix14101de2023-01-06 03:42:07 +00001354 android.CommonAttributes{Name: name + "-neverlink"},
1355 &bazelAndroidLibrary{
1356 javaLibraryAttributes: &javaLibraryAttributes{
1357 Neverlink: bazel.BoolAttribute{Value: &neverlink},
1358 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001359 javaCommonAttributes: &javaCommonAttributes{
1360 Sdk_version: bazel.StringAttribute{Value: a.properties.Sdk_version},
1361 },
Alix14101de2023-01-06 03:42:07 +00001362 },
1363 },
1364 )
1365
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001366}
Alix32540022023-03-16 21:06:13 +00001367func AndroidLibraryBazelTargetModuleProperties() bazel.BazelTargetModuleProperties {
1368 return bazel.BazelTargetModuleProperties{
1369 Rule_class: "android_library",
Alixa381cd12023-05-10 14:49:38 +00001370 Bzl_load_location: "//build/bazel/rules/android:android_library.bzl",
Alix32540022023-03-16 21:06:13 +00001371 }
1372}
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001373
Chris Parsons637458d2023-09-19 20:09:00 +00001374func (a *AndroidLibrary) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Liz Kammer7f375862023-08-04 16:37:42 -04001375 commonAttrs, bp2buildInfo, supported := a.convertLibraryAttrsBp2Build(ctx)
1376 if !supported {
1377 return
1378 }
1379
Alix8062f4d2022-11-14 21:38:07 +00001380 depLabels := bp2buildInfo.DepLabels
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001381
1382 deps := depLabels.Deps
1383 if !commonAttrs.Srcs.IsEmpty() {
1384 deps.Append(depLabels.StaticDeps) // we should only append these if there are sources to use them
1385 } else if !depLabels.Deps.IsEmpty() {
Zi Wang10664792023-09-27 12:29:34 -07001386 // android_library does not accept deps when there are no srcs because
1387 // there is no compilation happening, but it accepts exports.
1388 // The non-empty deps here are unnecessary as deps on the android_library
1389 // since they aren't being propagated to any dependencies.
1390 // So we can drop deps here.
1391 deps = bazel.LabelListAttribute{}
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001392 }
Alix82fb94e2022-10-26 20:40:18 +00001393 name := a.Name()
Alix32540022023-03-16 21:06:13 +00001394 props := AndroidLibraryBazelTargetModuleProperties()
Alix82fb94e2022-10-26 20:40:18 +00001395
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001396 aaptAttrs, supported := a.convertAaptAttrsWithBp2Build(ctx)
1397 if !supported {
1398 return
1399 }
Alixee51bd62023-08-29 16:01:46 +00001400 if hasJavaResources := aaptAttrs.ConvertJavaResources(ctx, commonAttrs); hasJavaResources {
1401 return
1402 }
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001403 ctx.CreateBazelTargetModule(
Alix82fb94e2022-10-26 20:40:18 +00001404 props,
1405 android.CommonAttributes{Name: name},
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001406 &bazelAndroidLibrary{
1407 &javaLibraryAttributes{
1408 javaCommonAttributes: commonAttrs,
1409 Deps: deps,
1410 Exports: depLabels.StaticDeps,
1411 },
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001412 aaptAttrs,
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001413 },
1414 )
Alix82fb94e2022-10-26 20:40:18 +00001415
1416 neverlink := true
1417 ctx.CreateBazelTargetModule(
1418 props,
1419 android.CommonAttributes{Name: name + "-neverlink"},
1420 &bazelAndroidLibrary{
1421 javaLibraryAttributes: &javaLibraryAttributes{
1422 Neverlink: bazel.BoolAttribute{Value: &neverlink},
1423 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001424 javaCommonAttributes: &javaCommonAttributes{
1425 Sdk_version: bazel.StringAttribute{Value: a.deviceProperties.Sdk_version},
1426 Java_version: bazel.StringAttribute{Value: a.properties.Java_version},
1427 },
Alix82fb94e2022-10-26 20:40:18 +00001428 },
1429 },
1430 )
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001431}