blob: 7c2cc37200309eb0ea521784ecdca9a27d7f82b5 [file] [log] [blame]
Colin Cross30e076a2015-04-13 13:58:27 -07001// Copyright 2015 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
Jaewoong Jungf9b44652020-12-21 12:29:12 -080017// This file contains the module implementations for android_app, android_test, and some more
18// related module types, including their override variants.
Colin Cross30e076a2015-04-13 13:58:27 -070019
20import (
Jiakai Zhang4f65a032023-06-01 15:16:58 +010021 "fmt"
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070022 "path/filepath"
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070023 "strings"
Colin Cross30e076a2015-04-13 13:58:27 -070024
Aditya Choudhary9b593522023-10-06 19:54:58 +000025 "android/soong/testing"
Colin Cross50ddcc42019-05-16 12:28:22 -070026 "github.com/google/blueprint"
27 "github.com/google/blueprint/proptools"
28
Colin Cross635c3b02016-05-18 15:37:25 -070029 "android/soong/android"
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -040030 "android/soong/bazel"
Colin Crossa4f08812018-10-02 22:03:40 -070031 "android/soong/cc"
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +010032 "android/soong/dexpreopt"
Romain Jobredeaux9973ace2023-08-30 00:27:09 -040033 "android/soong/genrule"
Colin Cross303e21f2018-08-07 16:49:25 -070034 "android/soong/tradefed"
Spandan Das0e0a8802023-09-20 19:53:30 +000035 "android/soong/ui/metrics/bp2build_metrics_proto"
Colin Cross30e076a2015-04-13 13:58:27 -070036)
37
Colin Cross3bc7ffa2017-11-22 16:19:37 -080038func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000039 RegisterAppBuildComponents(android.InitRegistrationContext)
Andrei Onea580636b2022-08-17 16:53:46 +000040 pctx.HostBinToolVariable("ModifyAllowlistCmd", "modify_permissions_allowlist")
Colin Cross3bc7ffa2017-11-22 16:19:37 -080041}
42
Andrei Onea580636b2022-08-17 16:53:46 +000043var (
44 modifyAllowlist = pctx.AndroidStaticRule("modifyAllowlist",
45 blueprint.RuleParams{
46 Command: "${ModifyAllowlistCmd} $in $packageName $out",
47 CommandDeps: []string{"${ModifyAllowlistCmd}"},
48 }, "packageName")
49)
50
Paul Duffinf9b1da02019-12-18 19:51:55 +000051func RegisterAppBuildComponents(ctx android.RegistrationContext) {
52 ctx.RegisterModuleType("android_app", AndroidAppFactory)
53 ctx.RegisterModuleType("android_test", AndroidTestFactory)
54 ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory)
55 ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory)
56 ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory)
57 ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000058}
59
Colin Cross30e076a2015-04-13 13:58:27 -070060// AndroidManifest.xml merging
61// package splits
62
Colin Crossfabb6082018-02-20 17:22:23 -080063type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -070064 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -070065 Additional_certificates []string
66
67 // If set, create package-export.apk, which other packages can
68 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -080069 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -070070
Colin Cross16056062017-12-13 22:46:28 -080071 // Specifies that this app should be installed to the priv-app directory,
72 // where the system will grant it additional privileges not available to
73 // normal apps.
74 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -070075
76 // list of resource labels to generate individual resource packages
77 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -040078
Colin Crossa4f08812018-10-02 22:03:40 -070079 // list of native libraries that will be provided in or alongside the resulting jar
80 Jni_libs []string `android:"arch_variant"`
81
Colin Cross7204cf02020-05-06 17:51:39 -070082 // if true, use JNI libraries that link against platform APIs even if this module sets
Colin Crossee87c602020-02-19 16:57:15 -080083 // sdk_version.
84 Jni_uses_platform_apis *bool
85
Colin Cross7204cf02020-05-06 17:51:39 -070086 // if true, use JNI libraries that link against SDK APIs even if this module does not set
87 // sdk_version.
88 Jni_uses_sdk_apis *bool
89
Jaewoong Jungbc625cd2019-05-06 15:48:44 -070090 // STL library to use for JNI libraries.
91 Stl *string `android:"arch_variant"`
92
Colin Crosse4246ab2019-02-05 21:55:21 -080093 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
94 // flag so that they are used from inside the APK at runtime. Defaults to true for android_test modules unless
Jiyong Park52cd06f2019-11-11 10:14:32 +090095 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
96 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
97 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -080098 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -080099
100 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
101 // they are used from inside the APK at runtime.
102 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700103
104 // Forces native libraries to always be packaged into the APK,
105 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
106 // True for android_test* modules.
107 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700108
109 // If set, find and merge all NOTICE files that this module and its dependencies have and store
110 // it in the APK as an asset.
111 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700112
113 // cc.Coverage related properties
114 PreventInstall bool `blueprint:"mutated"`
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700115 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100116
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000117 // It can be set to test the behaviour of default target sdk version.
118 // Only required when updatable: false. It is an error if updatable: true and this is false.
119 Enforce_default_target_sdk_version *bool
120
121 // If set, the targetSdkVersion for the target is set to the latest default API level.
122 // This would be by default false, unless updatable: true or
123 // enforce_default_target_sdk_version: true in which case this defaults to true.
124 EnforceDefaultTargetSdkVersion bool `blueprint:"mutated"`
125
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100126 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100127 // additional rules to make sure an app can safely be updated. Default is false.
128 // Prefer using other specific properties if build behaviour must be changed; avoid using this
129 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100130 Updatable *bool
Andrei Onea580636b2022-08-17 16:53:46 +0000131
132 // Specifies the file that contains the allowlist for this app.
133 Privapp_allowlist *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700134}
135
Jaewoong Jung525443a2019-02-28 15:35:54 -0800136// android_app properties that can be overridden by override_android_app
137type overridableAppProperties struct {
138 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
139 // or an android_app_certificate module name in the form ":module".
140 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700141
Jaewoong Jung1c1b6e62021-03-09 15:02:31 -0800142 // Name of the signing certificate lineage file or filegroup module.
143 Lineage *string `android:"path"`
Liz Kammere2b27f42020-05-07 13:24:05 -0700144
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400145 // For overriding the --rotation-min-sdk-version property of apksig
146 RotationMinSdkVersion *string
147
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700148 // the package name of this app. The package name in the manifest file is used if one was not given.
149 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800150
151 // the logging parent of this app.
152 Logging_parent *string
Liz Kammer9f9fd022020-06-18 19:44:06 +0000153
154 // Whether to rename the package in resources to the override name rather than the base name. Defaults to true.
155 Rename_resources_package *bool
zhidou198f5892022-02-17 02:33:12 +0000156
157 // Names of modules to be overridden. Listed modules can only be other binaries
158 // (in Make or Soong).
159 // This does not completely prevent installation of the overridden binaries, but if both
160 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
161 // from PRODUCT_PACKAGES.
162 Overrides []string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800163}
164
Colin Cross30e076a2015-04-13 13:58:27 -0700165type AndroidApp struct {
Romain Jobredeaux1282c422021-10-29 10:52:59 -0400166 android.BazelModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700167 Library
168 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800169 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700170
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900171 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700172
Colin Crossfabb6082018-02-20 17:22:23 -0800173 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700174
Jaewoong Jung525443a2019-02-28 15:35:54 -0800175 overridableAppProperties overridableAppProperties
176
Colin Cross403cc152020-07-06 14:15:24 -0700177 jniLibs []jniLib
178 installPathForJNISymbols android.Path
179 embeddedJniLibs bool
180 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700181
182 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800183
184 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
185 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800186
Colin Cross70dda7e2019-10-01 22:05:35 -0700187 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700188
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700189 onDeviceDir string
190
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800191 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700192
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900193 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100194
195 android.ApexBundleDepsInfo
Matt Banda8c801262022-04-01 17:48:31 +0000196
197 javaApiUsedByOutputFile android.ModuleOutPath
Andrei Onea580636b2022-08-17 16:53:46 +0000198
199 privAppAllowlist android.OptionalPath
Colin Crosse1731a52017-12-14 11:22:55 -0800200}
201
Martin Stjernholm6d415272020-01-31 17:10:36 +0000202func (a *AndroidApp) IsInstallable() bool {
203 return Bool(a.properties.Installable)
204}
205
Colin Crossab8d1382023-07-14 17:23:41 +0000206func (a *AndroidApp) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
207 return a.aapt.resourcesNodesDepSet
Colin Cross66f78822018-05-02 12:58:28 -0700208}
209
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900210func (a *AndroidApp) OutputFile() android.Path {
211 return a.outputFile
212}
213
Colin Cross503c1d02020-01-28 14:00:53 -0800214func (a *AndroidApp) Certificate() Certificate {
215 return a.certificate
216}
217
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700218func (a *AndroidApp) JniCoverageOutputs() android.Paths {
219 return a.jniCoverageOutputs
220}
221
Andrei Onea580636b2022-08-17 16:53:46 +0000222func (a *AndroidApp) PrivAppAllowlist() android.OptionalPath {
223 return a.privAppAllowlist
224}
225
Colin Crossa97c5d32018-03-28 14:58:31 -0700226var _ AndroidLibraryDependency = (*AndroidApp)(nil)
227
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900228type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800229 Pem, Key android.Path
230 presigned bool
231}
232
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700233var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800234
235func (c Certificate) AndroidMkString() string {
236 if c.presigned {
237 return "PRESIGNED"
238 } else {
239 return c.Pem.String()
240 }
Colin Cross30e076a2015-04-13 13:58:27 -0700241}
242
Colin Cross46c9b8b2017-06-22 16:51:17 -0700243func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
244 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700245
Jiyong Park92315372021-04-02 08:45:46 +0900246 if String(a.appProperties.Stl) == "c++_shared" && !a.SdkVersion(ctx).Specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700247 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
248 }
249
Jiyong Parkf1691d22021-03-29 20:11:58 +0900250 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100251 if sdkDep.hasFrameworkLibs() {
252 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700253 }
Colin Crossa4f08812018-10-02 22:03:40 -0700254
Jiyong Park92315372021-04-02 08:45:46 +0900255 usesSDK := a.SdkVersion(ctx).Specified() && a.SdkVersion(ctx).Kind != android.SdkCorePlatform
Colin Cross3c007702020-05-08 11:20:24 -0700256
257 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
258 ctx.PropertyErrorf("jni_uses_sdk_apis",
259 "can only be set for modules that do not set sdk_version")
260 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
261 ctx.PropertyErrorf("jni_uses_platform_apis",
262 "can only be set for modules that set sdk_version")
263 }
264
Colin Crossa4f08812018-10-02 22:03:40 -0700265 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700266 variation := append(jniTarget.Variations(),
267 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000268
269 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
270 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700271 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
272 // have stable APIs through the VNDK.
273 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
274 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700275 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000276 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
277 }
Colin Crossde78d132020-10-09 18:59:49 -0700278 ctx.AddFarVariationDependencies(variation, jniLibTag, a.appProperties.Jni_libs...)
Colin Crossa4f08812018-10-02 22:03:40 -0700279 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700280
Paul Duffin250e6192019-06-07 10:44:37 +0100281 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700282}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700283
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700284func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800285 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700286 if cert != "" {
287 ctx.AddDependency(ctx.Module(), certificateTag, cert)
288 }
289
Andrei Onea580636b2022-08-17 16:53:46 +0000290 if a.appProperties.Privapp_allowlist != nil && !Bool(a.appProperties.Privileged) {
Anton Hanssone3f31cf2023-06-03 08:53:47 +0000291 // There are a few uids that are explicitly considered privileged regardless of their
292 // app's location. Bluetooth is one such app. It should arguably be moved to priv-app,
293 // but for now, allow it not to be in priv-app.
294 privilegedBecauseOfUid := ctx.ModuleName() == "Bluetooth"
295 if !privilegedBecauseOfUid {
296 ctx.PropertyErrorf("privapp_allowlist", "privileged must be set in order to use privapp_allowlist (with a few exceptions)")
297 }
Andrei Onea580636b2022-08-17 16:53:46 +0000298 }
299
Colin Crossbd01e2a2018-10-04 15:21:03 -0700300 for _, cert := range a.appProperties.Additional_certificates {
301 cert = android.SrcIsModule(cert)
302 if cert != "" {
303 ctx.AddDependency(ctx.Module(), certificateTag, cert)
304 } else {
305 ctx.PropertyErrorf("additional_certificates",
306 `must be names of android_app_certificate modules in the form ":module"`)
307 }
308 }
Colin Cross30e076a2015-04-13 13:58:27 -0700309}
310
Jeongik Cha538c0d02019-07-11 15:54:27 +0900311func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Alix96ea88452023-08-31 15:48:23 +0000312 applicationId := a.appTestHelperAppProperties.Manifest_values.ApplicationId
313 if applicationId != nil {
314 if a.overridableAppProperties.Package_name != nil {
315 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
316 }
317 a.aapt.manifestValues.applicationId = *applicationId
318 }
Jeongik Cha538c0d02019-07-11 15:54:27 +0900319 a.generateAndroidBuildActions(ctx)
320}
321
Colin Cross46c9b8b2017-06-22 16:51:17 -0700322func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100323 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700324 a.generateAndroidBuildActions(ctx)
Matt Banda8c801262022-04-01 17:48:31 +0000325 a.generateJavaUsedByApex(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700326}
327
Sam Delmerico0e0d96e2023-08-18 22:43:28 +0000328func (a *AndroidApp) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
329 defaultMinSdkVersion := a.Module.MinSdkVersion(ctx)
330 if proptools.Bool(a.appProperties.Updatable) {
331 overrideApiLevel := android.MinSdkVersionFromValue(ctx, ctx.DeviceConfig().ApexGlobalMinSdkVersionOverride())
332 if !overrideApiLevel.IsNone() && overrideApiLevel.CompareTo(defaultMinSdkVersion) > 0 {
333 return overrideApiLevel
334 }
335 }
336 return defaultMinSdkVersion
337}
338
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100339func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100340 if a.Updatable() {
Jiyong Park92315372021-04-02 08:45:46 +0900341 if !a.SdkVersion(ctx).Stable() {
342 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.SdkVersion(ctx))
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100343 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100344 if String(a.deviceProperties.Min_sdk_version) == "" {
345 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
346 }
Jooyung Han749dc692020-04-15 11:03:39 +0900347
Jiyong Park92315372021-04-02 08:45:46 +0900348 if minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx); err == nil {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900349 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
satayevb3fd4112021-12-02 13:59:35 +0000350 android.CheckMinSdkVersion(ctx, minSdkVersion, a.WalkPayloadDeps)
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900351 } else {
352 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
353 }
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000354
355 if !BoolDefault(a.appProperties.Enforce_default_target_sdk_version, true) {
356 ctx.PropertyErrorf("enforce_default_target_sdk_version", "Updatable apps must enforce default target sdk version")
357 }
358 // TODO(b/227460469) after all the modules removes the target sdk version, throw an error if the target sdk version is explicitly set.
359 if a.deviceProperties.Target_sdk_version == nil {
360 a.SetEnforceDefaultTargetSdkVersion(true)
361 }
362 }
363
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100364 a.checkPlatformAPI(ctx)
365 a.checkSdkVersions(ctx)
366}
367
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900368// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
369// This check is enforced for "updatable" APKs (including APK-in-APEX).
Jiyong Park54105c42021-03-31 18:17:53 +0900370func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion android.ApiLevel) {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900371 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
372 ctx.VisitDirectDeps(func(m android.Module) {
373 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
374 return
375 }
376 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900377 // The domain of cc.sdk_version is "current" and <number>
Jiyong Parkf1691d22021-03-29 20:11:58 +0900378 // We can rely on android.SdkSpec to convert it to <number> so that "current" is
379 // handled properly regardless of sdk finalization.
Spandan Das2e8c0442022-05-08 00:39:35 +0000380 jniSdkVersion, err := android.SdkSpecFrom(ctx, dep.MinSdkVersion()).EffectiveVersion(ctx)
Jiyong Park54105c42021-03-31 18:17:53 +0900381 if err != nil || minSdkVersion.LessThan(jniSdkVersion) {
Spandan Das2e8c0442022-05-08 00:39:35 +0000382 ctx.OtherModuleErrorf(dep, "min_sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
383 dep.MinSdkVersion(), minSdkVersion, ctx.ModuleName())
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900384 return
385 }
386
387 })
388}
389
Sasha Smundak6ad77252019-05-01 13:16:22 -0700390// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800391// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700392func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park92315372021-04-02 08:45:46 +0900393 minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800394 if err != nil {
Jiyong Park92315372021-04-02 08:45:46 +0900395 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.MinSdkVersion(ctx), err)
Colin Crosse4246ab2019-02-05 21:55:21 -0800396 }
397
Colin Cross56a83212020-09-15 18:30:11 -0700398 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Jiyong Park54105c42021-03-31 18:17:53 +0900399 return (minSdkVersion.FinalOrFutureInt() >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
Colin Cross56a83212020-09-15 18:30:11 -0700400 !apexInfo.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800401}
402
Colin Cross43f08db2018-11-12 10:13:39 -0800403// Returns whether this module should have the dex file stored uncompressed in the APK.
404func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800405 if Bool(a.appProperties.Use_embedded_dex) {
406 return true
407 }
408
Colin Cross53a87f52019-06-25 13:35:30 -0700409 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
410 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900411 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000412 return true
413 }
414
Colin Cross53a87f52019-06-25 13:35:30 -0700415 if ctx.Config().UnbundledBuild() {
416 return false
417 }
418
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700419 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700420}
421
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700422func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
Colin Cross56a83212020-09-15 18:30:11 -0700423 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700424 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Colin Cross56a83212020-09-15 18:30:11 -0700425 !apexInfo.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700426}
427
Liz Kammer9f9fd022020-06-18 19:44:06 +0000428func generateAaptRenamePackageFlags(packageName string, renameResourcesPackage bool) []string {
429 aaptFlags := []string{"--rename-manifest-package " + packageName}
430 if renameResourcesPackage {
431 // Required to rename the package name in the resources table.
432 aaptFlags = append(aaptFlags, "--rename-resources-package "+packageName)
433 }
434 return aaptFlags
435}
436
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900437func (a *AndroidApp) OverriddenManifestPackageName() string {
438 return a.overriddenManifestPackageName
439}
440
Liz Kammer9f9fd022020-06-18 19:44:06 +0000441func (a *AndroidApp) renameResourcesPackage() bool {
442 return proptools.BoolDefault(a.overridableAppProperties.Rename_resources_package, true)
443}
444
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800445func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900446 usePlatformAPI := proptools.Bool(a.Module.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900447 if ctx.Module().(android.SdkContext).SdkVersion(ctx).Kind == android.SdkModule {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900448 usePlatformAPI = true
449 }
450 a.aapt.usesNonSdkApis = usePlatformAPI
David Brazdild25060a2019-02-18 18:24:16 +0000451
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700452 // Ask manifest_fixer to add or update the application element indicating this app has no code.
453 a.aapt.hasNoCode = !a.hasCode(ctx)
454
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800455 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800456
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800457 // Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided.
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800458 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700459 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800460 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700461 }
462
Dan Willemsen72be5902018-10-24 20:24:57 -0700463 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
464 // Product AAPT config
465 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800466 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700467 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700468
Dan Willemsen72be5902018-10-24 20:24:57 -0700469 // Product AAPT preferred config
470 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800471 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700472 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700473 }
474
Jiyong Park7f67f482019-01-05 12:57:48 +0900475 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700476 if overridden || a.overridableAppProperties.Package_name != nil {
477 // The product override variable has a priority over the package_name property.
478 if !overridden {
479 manifestPackageName = *a.overridableAppProperties.Package_name
480 }
Liz Kammer9f9fd022020-06-18 19:44:06 +0000481 aaptLinkFlags = append(aaptLinkFlags, generateAaptRenamePackageFlags(manifestPackageName, a.renameResourcesPackage())...)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900482 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900483 }
484
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800485 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
486
Colin Crosse560c4a2019-03-19 16:03:11 -0700487 a.aapt.splitNames = a.appProperties.Package_splits
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800488 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Alexei Nicoara69cf0f32022-07-27 14:59:18 +0100489 if a.Updatable() {
490 a.aapt.defaultManifestVersion = android.DefaultUpdatableModuleVersion
491 }
Alixf7a10272023-09-27 16:47:56 +0000492 a.aapt.buildActions(ctx,
493 aaptBuildActionOptions{
494 android.SdkContext(a),
495 a.classLoaderContexts,
496 a.usesLibraryProperties.Exclude_uses_libs,
497 a.enforceDefaultTargetSdkVersion(),
498 aaptLinkFlags,
499 },
500 )
Colin Cross30e076a2015-04-13 13:58:27 -0700501
Colin Cross46c9b8b2017-06-22 16:51:17 -0700502 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700503 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800504}
Colin Cross30e076a2015-04-13 13:58:27 -0700505
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800506func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700507 var staticLibProguardFlagFiles android.Paths
508 ctx.VisitDirectDeps(func(m android.Module) {
Sam Delmerico95d70942023-08-02 18:00:35 -0400509 depProguardInfo := ctx.OtherModuleProvider(m, ProguardSpecInfoProvider).(ProguardSpecInfo)
510 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.UnconditionallyExportedProguardFlags.ToList()...)
511 if ctx.OtherModuleDependencyTag(m) == staticLibTag {
512 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.ProguardFlagsFiles.ToList()...)
Colin Cross89c31582018-04-30 15:55:11 -0700513 }
514 })
515
516 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
517
518 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
519 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800520}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800521
Colin Cross403cc152020-07-06 14:15:24 -0700522func (a *AndroidApp) installPath(ctx android.ModuleContext) android.InstallPath {
Colin Cross43f08db2018-11-12 10:13:39 -0800523 var installDir string
524 if ctx.ModuleName() == "framework-res" {
525 // framework-res.apk is installed as system/framework/framework-res.apk
526 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900527 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800528 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800529 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800530 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800531 }
Colin Cross403cc152020-07-06 14:15:24 -0700532
533 return android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
534}
535
Rico Winda9fd59a2023-11-03 10:26:38 +0000536func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross403cc152020-07-06 14:15:24 -0700537 a.dexpreopter.installPath = a.installPath(ctx)
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000538 a.dexpreopter.isApp = true
Liz Kammera7a64f32020-07-09 15:16:41 -0700539 if a.dexProperties.Uncompress_dex == nil {
David Srbeckye033cba2020-05-20 22:20:28 +0100540 // If the value was not force-set by the user, use reasonable default based on the module.
Liz Kammera7a64f32020-07-09 15:16:41 -0700541 a.dexProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
David Srbeckye033cba2020-05-20 22:20:28 +0100542 }
Liz Kammera7a64f32020-07-09 15:16:41 -0700543 a.dexpreopter.uncompressedDex = *a.dexProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700544 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100545 a.dexpreopter.classLoaderContexts = a.classLoaderContexts
Colin Cross50ddcc42019-05-16 12:28:22 -0700546 a.dexpreopter.manifestFile = a.mergedManifestFile
Colin Crossfa9bfcd2021-11-10 16:42:38 -0800547 a.dexpreopter.preventInstall = a.appProperties.PreventInstall
Colin Cross50ddcc42019-05-16 12:28:22 -0700548
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800549 if ctx.ModuleName() != "framework-res" {
Colin Cross4eae06d2023-06-20 22:40:02 -0700550 var extraSrcJars android.Paths
551 var extraClasspathJars android.Paths
552 var extraCombinedJars android.Paths
553 if a.useResourceProcessorBusyBox() {
554 // When building an app with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox has already
555 // created R.class files that provide IDs for resources in busybox/R.jar. Pass that file in the
556 // classpath when compiling everything else, and add it to the final classes jar.
557 extraClasspathJars = android.Paths{a.aapt.rJar}
558 extraCombinedJars = android.Paths{a.aapt.rJar}
559 } else {
560 // When building an app without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
561 // R.java files for the app's package and the packages from all transitive static android_library
562 // dependencies. Compile the srcjar alongside the rest of the sources.
563 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
564 }
565
566 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800567 }
Colin Cross30e076a2015-04-13 13:58:27 -0700568
Rico Winda9fd59a2023-11-03 10:26:38 +0000569 return a.dexJarFile.PathOrNil()
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800570}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800571
Sam Delmerico82602492022-06-10 17:05:42 +0000572func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, prebuiltJniPackages android.Paths, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700573 var jniJarFile android.WritablePath
Sam Delmerico82602492022-06-10 17:05:42 +0000574 if len(jniLibs) > 0 || len(prebuiltJniPackages) > 0 {
Colin Cross403cc152020-07-06 14:15:24 -0700575 a.jniLibs = jniLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700576 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700577 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Colin Crossc68db4b2021-11-11 18:59:15 -0800578 a.installPathForJNISymbols = a.installPath(ctx)
Sam Delmerico82602492022-06-10 17:05:42 +0000579 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, prebuiltJniPackages, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700580 for _, jni := range jniLibs {
581 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700582 // Only collect coverage for the first target arch if this is a multilib target.
583 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
584 // data file path collisions since the current coverage file path format doesn't contain
585 // arch-related strings. This is fine for now though; the code coverage team doesn't use
586 // multi-arch targets such as test_suite_* for coverage collections yet.
587 //
588 // Work with the team to come up with a new format that handles multilib modules properly
589 // and change this.
590 if len(ctx.Config().Targets[android.Android]) == 1 ||
Jaewoong Jung642916f2020-10-09 17:25:15 -0700591 ctx.Config().AndroidFirstDeviceTarget.Arch.ArchType == jni.target.Arch.ArchType {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700592 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
593 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700594 }
595 }
Colin Cross403cc152020-07-06 14:15:24 -0700596 a.embeddedJniLibs = true
Colin Crossa4f08812018-10-02 22:03:40 -0700597 }
598 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800599 return jniJarFile
600}
Colin Crossa4f08812018-10-02 22:03:40 -0700601
Colin Cross403cc152020-07-06 14:15:24 -0700602func (a *AndroidApp) JNISymbolsInstalls(installPath string) android.RuleBuilderInstalls {
603 var jniSymbols android.RuleBuilderInstalls
604 for _, jniLib := range a.jniLibs {
605 if jniLib.unstrippedFile != nil {
606 jniSymbols = append(jniSymbols, android.RuleBuilderInstall{
607 From: jniLib.unstrippedFile,
608 To: filepath.Join(installPath, targetToJniDir(jniLib.target), jniLib.unstrippedFile.Base()),
609 })
610 }
611 }
612 return jniSymbols
613}
614
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700615// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
616// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
Colin Crossbc2c8a72022-09-14 12:45:42 -0700617func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate,
618 ctx android.ModuleContext) (mainCertificate Certificate, allCertificates []Certificate) {
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700619 if android.SrcIsModule(certPropValue) == "" {
620 var mainCert Certificate
621 if certPropValue != "" {
622 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
623 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800624 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
625 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700626 }
627 } else {
628 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800629 mainCert = Certificate{
630 Pem: pem,
631 Key: key,
632 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700633 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700634 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700635 }
636
Colin Crossbc2c8a72022-09-14 12:45:42 -0700637 if len(certificates) > 0 {
638 mainCertificate = certificates[0]
639 } else {
640 // This can be reached with an empty certificate list if AllowMissingDependencies is set
641 // and the certificate property for this module is a module reference to a missing module.
642 if !ctx.Config().AllowMissingDependencies() && len(ctx.GetMissingDependencies()) > 0 {
643 panic("Should only get here if AllowMissingDependencies set and there are missing dependencies")
644 }
645 // Set a certificate to avoid panics later when accessing it.
646 mainCertificate = Certificate{
647 Key: android.PathForModuleOut(ctx, "missing.pk8"),
Colin Crossa54f4b52022-11-21 04:35:53 +0000648 Pem: android.PathForModuleOut(ctx, "missing.x509.pem"),
Colin Crossbc2c8a72022-09-14 12:45:42 -0700649 }
650 }
651
Zyan Wub7550aa2023-05-18 15:46:31 +0800652 if !m.Platform() {
653 certPath := mainCertificate.Pem.String()
654 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
655 if strings.HasPrefix(certPath, systemCertPath) {
656 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
657 allowed := ctx.Config().EnforceSystemCertificateAllowList()
658
659 if enforceSystemCert && !inList(m.Name(), allowed) {
660 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
661 }
662 }
663 }
664
Colin Crossbc2c8a72022-09-14 12:45:42 -0700665 return mainCertificate, certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800666}
667
Jooyung Han39ee1192020-03-23 20:21:11 +0900668func (a *AndroidApp) InstallApkName() string {
669 return a.installApkName
670}
671
Sam Delmerico15809f82023-05-15 17:21:47 -0400672func (a *AndroidApp) createPrivappAllowlist(ctx android.ModuleContext) android.Path {
Andrei Onea580636b2022-08-17 16:53:46 +0000673 if a.appProperties.Privapp_allowlist == nil {
674 return nil
675 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400676
677 isOverrideApp := a.GetOverriddenBy() != ""
678 if !isOverrideApp {
679 // if this is not an override, we don't need to rewrite the existing privapp allowlist
680 return android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist)
681 }
682
Andrei Onea580636b2022-08-17 16:53:46 +0000683 if a.overridableAppProperties.Package_name == nil {
684 ctx.PropertyErrorf("privapp_allowlist", "package_name must be set to use privapp_allowlist")
685 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400686
Andrei Onea580636b2022-08-17 16:53:46 +0000687 packageName := *a.overridableAppProperties.Package_name
688 fileName := "privapp_allowlist_" + packageName + ".xml"
689 outPath := android.PathForModuleOut(ctx, fileName).OutputPath
690 ctx.Build(pctx, android.BuildParams{
691 Rule: modifyAllowlist,
692 Input: android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist),
693 Output: outPath,
694 Args: map[string]string{
695 "packageName": packageName,
696 },
697 })
698 return &outPath
699}
700
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800701func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700702 var apkDeps android.Paths
703
Colin Cross56a83212020-09-15 18:30:11 -0700704 if !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform() {
705 a.hideApexVariantFromMake = true
706 }
707
Jeongik Cha538c0d02019-07-11 15:54:27 +0900708 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
709 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
710
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000711 // Unlike installApkName, a.stem should respect base module name for override_android_app.
712 // Therefore, use ctx.ModuleName() instead of a.Name().
713 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
714
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800715 // Check if the install APK name needs to be overridden.
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000716 // Both android_app and override_android_app module are expected to possess
717 // its module bound apk path. However, override_android_app inherits ctx.ModuleName()
718 // from the base module. Therefore, use a.Name() which represents
719 // the module name for both android_app and override_android_app.
720 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(
721 proptools.StringDefault(a.overridableDeviceProperties.Stem, a.Name()))
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800722
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700723 if ctx.ModuleName() == "framework-res" {
724 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700725 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900726 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700727 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
728 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800729 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700730 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700731 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700732 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700733 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700734
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100735 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000736
Colin Cross61fb62e2022-06-23 10:46:28 -0700737 var noticeAssetPath android.WritablePath
738 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
739 // The rule to create the notice file can't be generated yet, as the final output path
740 // for the apk isn't known yet. Add the path where the notice file will be generated to the
741 // aapt rules now before calling aaptBuildActions, the rule to create the notice file will
742 // be generated later.
743 noticeAssetPath = android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
744 a.aapt.noticeFile = android.OptionalPathForPath(noticeAssetPath)
745 }
746
Harshit Mahajan8f202ad2023-01-09 20:45:55 +0000747 // For apps targeting latest target_sdk_version
748 if Bool(a.appProperties.Enforce_default_target_sdk_version) {
749 a.SetEnforceDefaultTargetSdkVersion(true)
750 }
751
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800752 // Process all building blocks, from AAPT to certificates.
753 a.aaptBuildActions(ctx)
Rico Winda9fd59a2023-11-03 10:26:38 +0000754
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100755 // The decision to enforce <uses-library> checks is made before adding implicit SDK libraries.
756 a.usesLibrary.freezeEnforceUsesLibraries()
757
758 // Add implicit SDK libraries to <uses-library> list.
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100759 requiredUsesLibs, optionalUsesLibs := a.classLoaderContexts.UsesLibs()
760 for _, usesLib := range requiredUsesLibs {
761 a.usesLibrary.addLib(usesLib, false)
762 }
763 for _, usesLib := range optionalUsesLibs {
764 a.usesLibrary.addLib(usesLib, true)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100765 }
766
767 // Check that the <uses-library> list is coherent with the manifest.
Colin Cross50ddcc42019-05-16 12:28:22 -0700768 if a.usesLibrary.enforceUsesLibraries() {
769 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
770 apkDeps = append(apkDeps, manifestCheckFile)
771 }
772
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800773 a.proguardBuildActions(ctx)
774
Colin Cross014489c2020-06-02 20:09:13 -0700775 a.linter.mergedManifest = a.aapt.mergedManifestFile
776 a.linter.manifest = a.aapt.manifestPath
777 a.linter.resources = a.aapt.resourceFiles
Colin Crossc0efd1d2020-07-03 11:56:24 -0700778 a.linter.buildModuleReportZip = ctx.Config().UnbundledBuildApps()
Colin Cross014489c2020-06-02 20:09:13 -0700779
Rico Winda9fd59a2023-11-03 10:26:38 +0000780 dexJarFile := a.dexBuildActions(ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800781
Colin Crossbc2c8a72022-09-14 12:45:42 -0700782 jniLibs, prebuiltJniPackages, certificates := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Sam Delmerico82602492022-06-10 17:05:42 +0000783 jniJarFile := a.jniBuildActions(jniLibs, prebuiltJniPackages, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800784
785 if ctx.Failed() {
786 return
787 }
788
Colin Crossbc2c8a72022-09-14 12:45:42 -0700789 a.certificate, certificates = processMainCert(a.ModuleBase, a.getCertString(ctx), certificates, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800790
791 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800792 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700793 v4SigningRequested := Bool(a.Module.deviceProperties.V4_signature)
794 var v4SignatureFile android.WritablePath = nil
795 if v4SigningRequested {
796 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+".apk.idsig")
797 }
Liz Kammere2b27f42020-05-07 13:24:05 -0700798 var lineageFile android.Path
799 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
800 lineageFile = android.PathForModuleSrc(ctx, lineage)
801 }
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400802 rotationMinSdkVersion := String(a.overridableAppProperties.RotationMinSdkVersion)
803
Rico Winda9fd59a2023-11-03 10:26:38 +0000804 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion, Bool(a.dexProperties.Optimize.Shrink_resources))
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800805 a.outputFile = packageFile
Songchun Fan17d69e32020-03-24 20:32:24 -0700806 if v4SigningRequested {
807 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
808 }
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800809
Colin Cross61fb62e2022-06-23 10:46:28 -0700810 if a.aapt.noticeFile.Valid() {
811 // Generating the notice file rule has to be here after a.outputFile is known.
Bob Badoureef4c1c2022-05-16 12:20:04 -0700812 noticeFile := android.PathForModuleOut(ctx, "NOTICE.html.gz")
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700813 android.BuildNoticeHtmlOutputFromLicenseMetadata(
814 ctx, noticeFile, "", "",
815 []string{
816 a.installDir.String() + "/",
817 android.PathForModuleInstall(ctx).String() + "/",
818 a.outputFile.String(),
819 })
Bob Badoureef4c1c2022-05-16 12:20:04 -0700820 builder := android.NewRuleBuilder(pctx, ctx)
821 builder.Command().Text("cp").
822 Input(noticeFile).
823 Output(noticeAssetPath)
824 builder.Build("notice_dir", "Building notice dir")
Bob Badoureef4c1c2022-05-16 12:20:04 -0700825 }
826
Colin Crosse560c4a2019-03-19 16:03:11 -0700827 for _, split := range a.aapt.splits {
828 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800829 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700830 if v4SigningRequested {
831 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk.idsig")
832 }
Rico Winda9fd59a2023-11-03 10:26:38 +0000833 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion, false)
Colin Crosse560c4a2019-03-19 16:03:11 -0700834 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
Songchun Fan17d69e32020-03-24 20:32:24 -0700835 if v4SigningRequested {
836 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
837 }
Colin Crosse560c4a2019-03-19 16:03:11 -0700838 }
839
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800840 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700841 bundleFile := android.PathForModuleOut(ctx, "base.zip")
842 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
843 a.bundleFile = bundleFile
844
Andrei Onea580636b2022-08-17 16:53:46 +0000845 allowlist := a.createPrivappAllowlist(ctx)
846 if allowlist != nil {
847 a.privAppAllowlist = android.OptionalPathForPath(allowlist)
848 }
849
Colin Cross56a83212020-09-15 18:30:11 -0700850 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
851
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800852 // Install the app package.
Andrei Onea580636b2022-08-17 16:53:46 +0000853 shouldInstallAppPackage := (Bool(a.Module.properties.Installable) || ctx.Host()) && apexInfo.IsForPlatform() && !a.appProperties.PreventInstall
854 if shouldInstallAppPackage {
Sam Delmericob1daccd2023-05-25 14:45:30 -0400855 if a.privAppAllowlist.Valid() {
Anton Hansson0e486a42023-06-01 16:38:35 +0000856 allowlistInstallPath := android.PathForModuleInstall(ctx, "etc", "permissions")
857 allowlistInstallFilename := a.installApkName + ".xml"
858 ctx.InstallFile(allowlistInstallPath, allowlistInstallFilename, a.privAppAllowlist.Path())
Sam Delmericob1daccd2023-05-25 14:45:30 -0400859 }
860
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700861 var extraInstalledPaths android.Paths
Jiyong Park8ba50f92019-11-13 15:01:01 +0900862 for _, extra := range a.extraOutputFiles {
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700863 installed := ctx.InstallFile(a.installDir, extra.Base(), extra)
864 extraInstalledPaths = append(extraInstalledPaths, installed)
Jiyong Park8ba50f92019-11-13 15:01:01 +0900865 }
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700866 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile, extraInstalledPaths...)
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800867 }
Artur Satayev1111b842020-04-27 19:05:28 +0100868
869 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700870}
871
Colin Crossc2d24052020-05-13 11:05:02 -0700872type appDepsInterface interface {
Jiyong Park92315372021-04-02 08:45:46 +0900873 SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000874 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Colin Crossc2d24052020-05-13 11:05:02 -0700875 RequiresStableAPIs(ctx android.BaseModuleContext) bool
876}
877
878func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
879 shouldCollectRecursiveNativeDeps bool,
Sam Delmerico82602492022-06-10 17:05:42 +0000880 checkNativeSdkVersion bool) ([]jniLib, android.Paths, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700881
Colin Crossa4f08812018-10-02 22:03:40 -0700882 var jniLibs []jniLib
Sam Delmerico82602492022-06-10 17:05:42 +0000883 var prebuiltJniPackages android.Paths
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900884 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800885 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700886
Colin Crossc2d24052020-05-13 11:05:02 -0700887 if checkNativeSdkVersion {
Jiyong Park92315372021-04-02 08:45:46 +0900888 checkNativeSdkVersion = app.SdkVersion(ctx).Specified() &&
889 app.SdkVersion(ctx).Kind != android.SdkCorePlatform && !app.RequiresStableAPIs(ctx)
Colin Crossc2d24052020-05-13 11:05:02 -0700890 }
891
Peter Collingbournead84f972019-12-17 16:46:18 -0800892 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700893 otherName := ctx.OtherModuleName(module)
894 tag := ctx.OtherModuleDependencyTag(module)
895
Colin Crossf0913fb2020-07-29 12:59:39 -0700896 if IsJniDepTag(tag) || cc.IsSharedDepTag(tag) {
Ivan Lozano7f67c2a2022-06-27 16:00:26 -0400897 if dep, ok := module.(cc.LinkableInterface); ok {
Colin Cross95f1ca02020-10-29 20:47:22 -0700898 if dep.IsNdk(ctx.Config()) || dep.IsStubs() {
Peter Collingbournead84f972019-12-17 16:46:18 -0800899 return false
900 }
901
Colin Crossa4f08812018-10-02 22:03:40 -0700902 lib := dep.OutputFile()
903 if lib.Valid() {
Cole Faust64cb7c92021-09-14 17:32:49 -0700904 path := lib.Path()
905 if seenModulePaths[path.String()] {
906 return false
907 }
908 seenModulePaths[path.String()] = true
909
910 if checkNativeSdkVersion && dep.SdkVersion() == "" {
911 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
912 otherName)
913 }
914
Colin Crossa4f08812018-10-02 22:03:40 -0700915 jniLibs = append(jniLibs, jniLib{
Colin Cross403cc152020-07-06 14:15:24 -0700916 name: ctx.OtherModuleName(module),
917 path: path,
918 target: module.Target(),
919 coverageFile: dep.CoverageOutputFile(),
920 unstrippedFile: dep.UnstrippedOutputFile(),
Jihoon Kangf78a8902022-09-01 22:47:07 +0000921 partition: dep.Partition(),
Colin Crossa4f08812018-10-02 22:03:40 -0700922 })
Colin Crossdd5261c2022-12-19 12:26:43 -0800923 } else if ctx.Config().AllowMissingDependencies() {
924 ctx.AddMissingDependencies([]string{otherName})
Colin Crossa4f08812018-10-02 22:03:40 -0700925 } else {
926 ctx.ModuleErrorf("dependency %q missing output file", otherName)
927 }
928 } else {
929 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700930 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800931
932 return shouldCollectRecursiveNativeDeps
933 }
934
Sam Delmerico82602492022-06-10 17:05:42 +0000935 if info, ok := ctx.OtherModuleProvider(module, JniPackageProvider).(JniPackageInfo); ok {
936 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
937 }
938
Peter Collingbournead84f972019-12-17 16:46:18 -0800939 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700940 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900941 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700942 } else {
943 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
944 }
Colin Crossa4f08812018-10-02 22:03:40 -0700945 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800946
947 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700948 })
949
Sam Delmerico82602492022-06-10 17:05:42 +0000950 return jniLibs, prebuiltJniPackages, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700951}
952
Jooyung Han749dc692020-04-15 11:03:39 +0900953func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +0100954 ctx.WalkDeps(func(child, parent android.Module) bool {
955 isExternal := !a.DepIsInSameApex(ctx, child)
956 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +0900957 if !do(ctx, parent, am, isExternal) {
958 return false
959 }
Artur Satayev1111b842020-04-27 19:05:28 +0100960 }
961 return !isExternal
962 })
963}
964
965func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
966 if ctx.Host() {
967 return
968 }
969
970 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +0900971 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +0100972 depName := to.Name()
Artur Satayev533b98c2021-03-11 18:03:42 +0000973
974 // Skip dependencies that are only available to APEXes; they are developed with updatability
975 // in mind and don't need manual approval.
976 if to.(android.ApexModule).NotAvailableForPlatform() {
977 return true
978 }
979
Artur Satayev1111b842020-04-27 19:05:28 +0100980 if info, exist := depsInfo[depName]; exist {
981 info.From = append(info.From, from.Name())
982 info.IsExternal = info.IsExternal && externalDep
983 depsInfo[depName] = info
984 } else {
985 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +0900986 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000987 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +0900988 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000989 if v := m.MinSdkVersion(ctx); !v.IsNone() {
990 toMinSdkVersion = v.String()
Artur Satayev1111b842020-04-27 19:05:28 +0100991 }
Jiyong Park92315372021-04-02 08:45:46 +0900992 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
993 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
994 // string
995 if v := m.MinSdkVersion(); v != "" {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900996 toMinSdkVersion = v
997 }
Artur Satayev1111b842020-04-27 19:05:28 +0100998 }
999 depsInfo[depName] = android.ApexModuleDepInfo{
1000 To: depName,
1001 From: []string{from.Name()},
1002 IsExternal: externalDep,
1003 MinSdkVersion: toMinSdkVersion,
1004 }
1005 }
Jooyung Han749dc692020-04-15 11:03:39 +09001006 return true
Artur Satayev1111b842020-04-27 19:05:28 +01001007 })
1008
Jiyong Park92315372021-04-02 08:45:46 +09001009 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depsInfo)
Artur Satayev1111b842020-04-27 19:05:28 +01001010}
1011
Harshit Mahajan5b8b7302022-06-10 11:24:05 +00001012func (a *AndroidApp) enforceDefaultTargetSdkVersion() bool {
1013 return a.appProperties.EnforceDefaultTargetSdkVersion
1014}
1015
1016func (a *AndroidApp) SetEnforceDefaultTargetSdkVersion(val bool) {
1017 a.appProperties.EnforceDefaultTargetSdkVersion = val
1018}
1019
Artur Satayev849f8442020-04-28 14:57:42 +01001020func (a *AndroidApp) Updatable() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001021 return Bool(a.appProperties.Updatable)
Artur Satayev849f8442020-04-28 14:57:42 +01001022}
1023
Spandan Das42e89502022-05-06 22:12:55 +00001024func (a *AndroidApp) SetUpdatable(val bool) {
1025 a.appProperties.Updatable = &val
1026}
1027
Colin Cross0ea8ba82019-06-06 14:33:29 -07001028func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001029 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
1030 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001031 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001032 }
Jaewoong Jung525443a2019-02-28 15:35:54 -08001033 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001034}
1035
Jiyong Park0f80c182020-01-31 02:49:53 +09001036func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1037 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
1038 return true
1039 }
1040 return a.Library.DepIsInSameApex(ctx, dep)
1041}
1042
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001043// For OutputFileProducer interface
1044func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
1045 switch tag {
Jared Duke34b080d2023-03-30 16:40:24 -07001046 // In some instances, it can be useful to reference the aapt-generated flags from another
1047 // target, e.g., system server implements services declared in the framework-res manifest.
1048 case ".aapt.proguardOptionsFile":
1049 return []android.Path{a.proguardOptionsFile}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001050 case ".aapt.srcjar":
Colin Crossf3b7bad2023-08-02 15:49:00 -07001051 if a.aaptSrcJar != nil {
1052 return []android.Path{a.aaptSrcJar}, nil
1053 }
1054 case ".aapt.jar":
1055 if a.rJar != nil {
1056 return []android.Path{a.rJar}, nil
1057 }
Anton Hansson092aca42020-08-13 19:37:22 +01001058 case ".export-package.apk":
1059 return []android.Path{a.exportPackage}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001060 }
1061 return a.Library.OutputFiles(tag)
1062}
1063
Jiyong Parkf7487312019-10-17 12:54:30 +09001064func (a *AndroidApp) Privileged() bool {
1065 return Bool(a.appProperties.Privileged)
1066}
1067
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001068func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001069 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001070}
1071
Ivan Lozanod7586b62021-04-01 09:49:36 -04001072func (a *AndroidApp) SetPreventInstall() {
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001073 a.appProperties.PreventInstall = true
1074}
1075
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001076func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
1077 a.appProperties.IsCoverageVariant = coverage
1078}
1079
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001080func (a *AndroidApp) EnableCoverageIfNeeded() {}
1081
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001082var _ cc.Coverage = (*AndroidApp)(nil)
1083
Colin Cross95b53b82023-10-17 13:21:02 -07001084func (a *AndroidApp) IDEInfo(dpInfo *android.IdeInfo) {
1085 a.Library.IDEInfo(dpInfo)
1086 a.aapt.IDEInfo(dpInfo)
1087}
1088
Colin Cross1b16b0e2019-02-12 14:41:32 -08001089// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -07001090func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -07001091 module := &AndroidApp{}
1092
Liz Kammera7a64f32020-07-09 15:16:41 -07001093 module.Module.dexProperties.Optimize.EnabledByDefault = true
1094 module.Module.dexProperties.Optimize.Shrink = proptools.BoolPtr(true)
Jared Dukeaa88b3d2023-08-29 17:07:20 +00001095 module.Module.dexProperties.Optimize.Proguard_compatibility = proptools.BoolPtr(false)
Colin Cross66dbc0b2017-12-28 12:23:20 -08001096
Colin Crossae5caf52018-05-22 11:11:52 -07001097 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001098 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001099 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001100
Colin Crossce6734e2020-06-15 16:09:53 -07001101 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -07001102 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -07001103 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001104 &module.appProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001105 &module.overridableAppProperties)
Colin Cross36242852017-06-23 15:06:31 -07001106
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001107 module.usesLibrary.enforce = true
1108
Colin Crossa4f08812018-10-02 22:03:40 -07001109 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1110 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001111 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +09001112 android.InitApexModule(module)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001113 android.InitBazelModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -07001114
Colin Cross36242852017-06-23 15:06:31 -07001115 return module
Colin Cross30e076a2015-04-13 13:58:27 -07001116}
Colin Crossae5caf52018-05-22 11:11:52 -07001117
Alix96ea88452023-08-31 15:48:23 +00001118// A dictionary of values to be overridden in the manifest.
1119type Manifest_values struct {
1120 // Overrides the value of package_name in the manifest
1121 ApplicationId *string
1122}
1123
Colin Crossae5caf52018-05-22 11:11:52 -07001124type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -07001125 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -07001126 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001127
Seth Moorec6f4b532023-02-02 13:22:26 -08001128 // If specified, the instrumentation target package name in the manifest is overwritten by it.
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001129 Instrumentation_target_package *string
Seth Moorec6f4b532023-02-02 13:22:26 -08001130
1131 // If specified, the mainline module package name in the test config is overwritten by it.
1132 Mainline_package_name *string
Alix96ea88452023-08-31 15:48:23 +00001133
1134 Manifest_values Manifest_values
Colin Crossae5caf52018-05-22 11:11:52 -07001135}
1136
1137type AndroidTest struct {
1138 AndroidApp
1139
1140 appTestProperties appTestProperties
1141
1142 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001143
Dan Shi95d19422020-08-15 12:24:26 -07001144 testConfig android.Path
1145 extraTestConfigs android.Paths
1146 data android.Paths
Jingwen Chene12c0832023-08-25 09:00:16 +00001147
1148 android.BazelModuleBase
Colin Crossae5caf52018-05-22 11:11:52 -07001149}
1150
Jaewoong Jung0949f312019-09-11 10:25:18 -07001151func (a *AndroidTest) InstallInTestcases() bool {
1152 return true
1153}
1154
Spandan Das9f7ae7f2022-07-25 00:34:18 +00001155type androidTestApp interface {
1156 includedInTestSuite(searchPrefix string) bool
1157}
1158
1159func (a *AndroidTest) includedInTestSuite(searchPrefix string) bool {
1160 return android.PrefixInList(a.testProperties.Test_suites, searchPrefix)
1161}
1162
1163func (a *AndroidTestHelperApp) includedInTestSuite(searchPrefix string) bool {
1164 return android.PrefixInList(a.appTestHelperAppProperties.Test_suites, searchPrefix)
1165}
1166
Colin Crossae5caf52018-05-22 11:11:52 -07001167func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001168 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001169 if a.appTestProperties.Instrumentation_target_package != nil {
1170 a.additionalAaptFlags = append(a.additionalAaptFlags,
1171 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1172 } else if a.appTestProperties.Instrumentation_for != nil {
1173 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001174 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1175 if overridden {
1176 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1177 }
1178 }
Alix96ea88452023-08-31 15:48:23 +00001179 applicationId := a.appTestProperties.Manifest_values.ApplicationId
1180 if applicationId != nil {
1181 if a.overridableAppProperties.Package_name != nil {
1182 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
1183 }
1184 a.aapt.manifestValues.applicationId = *applicationId
1185 }
Colin Crossae5caf52018-05-22 11:11:52 -07001186 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001187
easoncylee5bcff5d2020-04-30 14:57:06 +08001188 for _, module := range a.testProperties.Test_mainline_modules {
1189 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1190 }
1191
Jaewoong Jung39982342020-01-14 10:27:18 -08001192 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001193 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001194 a.testConfig = a.FixTestConfig(ctx, testConfig)
Dan Shi95d19422020-08-15 12:24:26 -07001195 a.extraTestConfigs = android.PathsForModuleSrc(ctx, a.testProperties.Test_options.Extra_test_configs)
Colin Cross8a497952019-03-05 22:25:09 -08001196 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Aditya Choudhary9b593522023-10-06 19:54:58 +00001197 ctx.SetProvider(testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Colin Cross303e21f2018-08-07 16:49:25 -07001198}
1199
Jaewoong Jung39982342020-01-14 10:27:18 -08001200func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1201 if testConfig == nil {
1202 return nil
1203 }
1204
1205 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
Colin Crossf1a035e2020-11-16 17:32:30 -08001206 rule := android.NewRuleBuilder(pctx, ctx)
1207 command := rule.Command().BuiltTool("test_config_fixer").Input(testConfig).Output(fixedConfig)
Jaewoong Jung39982342020-01-14 10:27:18 -08001208 fixNeeded := false
1209
Jooyung Han29e2f6d2022-01-08 12:13:59 +09001210 // Auto-generated test config uses `ModuleName` as the APK name. So fix it if it is not the case.
Jaewoong Jung39982342020-01-14 10:27:18 -08001211 if ctx.ModuleName() != a.installApkName {
1212 fixNeeded = true
1213 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1214 }
1215
1216 if a.overridableAppProperties.Package_name != nil {
1217 fixNeeded = true
1218 command.FlagWithInput("--manifest ", a.manifestPath).
1219 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1220 }
1221
Seth Moorec6f4b532023-02-02 13:22:26 -08001222 if a.appTestProperties.Mainline_package_name != nil {
1223 fixNeeded = true
1224 command.FlagWithArg("--mainline-package-name ", *a.appTestProperties.Mainline_package_name)
1225 }
1226
Jaewoong Jung39982342020-01-14 10:27:18 -08001227 if fixNeeded {
Colin Crossf1a035e2020-11-16 17:32:30 -08001228 rule.Build("fix_test_config", "fix test config")
Jaewoong Jung39982342020-01-14 10:27:18 -08001229 return fixedConfig
1230 }
1231 return testConfig
1232}
1233
Colin Cross303e21f2018-08-07 16:49:25 -07001234func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001235 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001236}
1237
1238func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1239 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001240 if a.appTestProperties.Instrumentation_for != nil {
1241 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1242 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1243 // use instrumentationForTag instead of libTag.
1244 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1245 }
Colin Crossae5caf52018-05-22 11:11:52 -07001246}
1247
Colin Cross1b16b0e2019-02-12 14:41:32 -08001248// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1249// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001250func AndroidTestFactory() android.Module {
1251 module := &AndroidTest{}
1252
Jared Duke63a3da92022-06-02 19:11:14 +00001253 module.Module.dexProperties.Optimize.EnabledByDefault = false
Colin Cross5067db92018-09-17 16:46:35 -07001254
1255 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001256 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001257 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001258 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001259 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001260 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001261 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001262
Colin Crossce6734e2020-06-15 16:09:53 -07001263 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001264 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001265 &module.aaptProperties,
1266 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001267 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001268 &module.overridableAppProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001269 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001270
Colin Crossa4f08812018-10-02 22:03:40 -07001271 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1272 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001273 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jingwen Chene12c0832023-08-25 09:00:16 +00001274
1275 android.InitBazelModule(module)
Colin Crossae5caf52018-05-22 11:11:52 -07001276 return module
1277}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001278
Colin Cross252fc6f2018-10-04 15:22:03 -07001279type appTestHelperAppProperties struct {
1280 // list of compatibility suites (for example "cts", "vts") that the module should be
1281 // installed into.
1282 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001283
1284 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1285 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1286 // explicitly.
1287 Auto_gen_config *bool
Colin Crosscfb0f5e2021-09-24 15:47:17 -07001288
1289 // Install the test into a folder named for the module in all test suites.
1290 Per_testcase_directory *bool
Alix96ea88452023-08-31 15:48:23 +00001291
1292 Manifest_values Manifest_values
Colin Cross252fc6f2018-10-04 15:22:03 -07001293}
1294
1295type AndroidTestHelperApp struct {
1296 AndroidApp
1297
1298 appTestHelperAppProperties appTestHelperAppProperties
Jingwen Chen65289992023-09-21 15:15:47 +00001299
1300 android.BazelModuleBase
Colin Cross252fc6f2018-10-04 15:22:03 -07001301}
1302
Jaewoong Jung326a9412019-11-21 10:41:00 -08001303func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1304 return true
1305}
1306
Colin Cross1b16b0e2019-02-12 14:41:32 -08001307// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1308// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1309// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001310func AndroidTestHelperAppFactory() android.Module {
1311 module := &AndroidTestHelperApp{}
1312
Jared Duke63a3da92022-06-02 19:11:14 +00001313 // TODO(b/192032291): Disable by default after auditing downstream usage.
Liz Kammera7a64f32020-07-09 15:16:41 -07001314 module.Module.dexProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001315
1316 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001317 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001318 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001319 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001320 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross252fc6f2018-10-04 15:22:03 -07001321
Colin Crossce6734e2020-06-15 16:09:53 -07001322 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001323 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001324 &module.aaptProperties,
1325 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001326 &module.appTestHelperAppProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001327 &module.overridableAppProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001328
1329 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1330 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001331 android.InitApexModule(module)
Jingwen Chen65289992023-09-21 15:15:47 +00001332 android.InitBazelModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001333 return module
1334}
1335
Colin Crossbd01e2a2018-10-04 15:21:03 -07001336type AndroidAppCertificate struct {
1337 android.ModuleBase
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04001338 android.BazelModuleBase
1339
Colin Crossbd01e2a2018-10-04 15:21:03 -07001340 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001341 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001342}
1343
1344type AndroidAppCertificateProperties struct {
1345 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1346 Certificate *string
1347}
1348
Colin Cross1b16b0e2019-02-12 14:41:32 -08001349// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1350// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001351func AndroidAppCertificateFactory() android.Module {
1352 module := &AndroidAppCertificate{}
1353 module.AddProperties(&module.properties)
1354 android.InitAndroidModule(module)
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04001355 android.InitBazelModule(module)
Colin Crossbd01e2a2018-10-04 15:21:03 -07001356 return module
1357}
1358
Colin Crossbd01e2a2018-10-04 15:21:03 -07001359func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1360 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001361 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001362 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1363 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001364 }
1365}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001366
1367type OverrideAndroidApp struct {
1368 android.ModuleBase
1369 android.OverrideModuleBase
1370}
1371
Sasha Smundak613cbb12020-06-05 10:27:23 -07001372func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001373 // All the overrides happen in the base module.
1374 // TODO(jungjw): Check the base module type.
1375}
1376
1377// override_android_app is used to create an android_app module based on another android_app by overriding
1378// some of its properties.
1379func OverrideAndroidAppModuleFactory() android.Module {
1380 m := &OverrideAndroidApp{}
Jooyung Han01d80d82022-01-08 12:16:32 +09001381 m.AddProperties(
1382 &OverridableDeviceProperties{},
1383 &overridableAppProperties{},
1384 )
Jaewoong Jung525443a2019-02-28 15:35:54 -08001385
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001386 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001387 android.InitOverrideModule(m)
1388 return m
1389}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001390
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001391type OverrideAndroidTest struct {
1392 android.ModuleBase
1393 android.OverrideModuleBase
1394}
1395
Sasha Smundak613cbb12020-06-05 10:27:23 -07001396func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001397 // All the overrides happen in the base module.
1398 // TODO(jungjw): Check the base module type.
1399}
1400
1401// override_android_test is used to create an android_app module based on another android_test by overriding
1402// some of its properties.
1403func OverrideAndroidTestModuleFactory() android.Module {
1404 m := &OverrideAndroidTest{}
1405 m.AddProperties(&overridableAppProperties{})
1406 m.AddProperties(&appTestProperties{})
1407
1408 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1409 android.InitOverrideModule(m)
1410 return m
1411}
1412
Colin Cross50ddcc42019-05-16 12:28:22 -07001413type UsesLibraryProperties struct {
1414 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1415 Uses_libs []string
1416
1417 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1418 // required=false.
1419 Optional_uses_libs []string
1420
1421 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1422 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1423 Enforce_uses_libs *bool
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001424
Ulya Trafimovich54027b52020-09-09 14:08:23 +01001425 // Optional name of the <uses-library> provided by this module. This is needed for non-SDK
1426 // libraries, because SDK ones are automatically picked up by Soong. The <uses-library> name
1427 // normally is the same as the module name, but there are exceptions.
1428 Provides_uses_lib *string
Paul Duffin06530572022-02-03 17:54:15 +00001429
1430 // A list of shared library names to exclude from the classpath of the APK. Adding a library here
1431 // will prevent it from being used when precompiling the APK and prevent it from being implicitly
1432 // added to the APK's manifest's <uses-library> elements.
1433 //
1434 // Care must be taken when using this as it could result in runtime errors if the APK actually
1435 // uses classes provided by the library and which are not provided in any other way.
1436 //
1437 // This is primarily intended for use by various CTS tests that check the runtime handling of the
1438 // android.test.base shared library (and related libraries) but which depend on some common
1439 // libraries that depend on the android.test.base library. Without this those tests will end up
1440 // with a <uses-library android:name="android.test.base"/> in their manifest which would either
1441 // render the tests worthless (as they would be testing the wrong behavior), or would break the
1442 // test altogether by providing access to classes that the tests were not expecting. Those tests
1443 // provide the android.test.base statically and use jarjar to rename them so they do not collide
1444 // with the classes provided by the android.test.base library.
1445 Exclude_uses_libs []string
Colin Cross50ddcc42019-05-16 12:28:22 -07001446}
1447
1448// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1449// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1450// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1451// with knowledge of their shared libraries.
1452type usesLibrary struct {
1453 usesLibraryProperties UsesLibraryProperties
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001454
1455 // Whether to enforce verify_uses_library check.
1456 enforce bool
Colin Cross50ddcc42019-05-16 12:28:22 -07001457}
1458
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001459func (u *usesLibrary) addLib(lib string, optional bool) {
1460 if !android.InList(lib, u.usesLibraryProperties.Uses_libs) && !android.InList(lib, u.usesLibraryProperties.Optional_uses_libs) {
1461 if optional {
1462 u.usesLibraryProperties.Optional_uses_libs = append(u.usesLibraryProperties.Optional_uses_libs, lib)
1463 } else {
1464 u.usesLibraryProperties.Uses_libs = append(u.usesLibraryProperties.Uses_libs, lib)
1465 }
1466 }
1467}
1468
Colin Cross4a80a152022-12-21 21:51:52 -08001469func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, addCompatDeps bool) {
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001470 if !ctx.Config().UnbundledBuild() || ctx.Config().UnbundledBuildImage() {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001471 ctx.AddVariationDependencies(nil, usesLibReqTag, u.usesLibraryProperties.Uses_libs...)
1472 ctx.AddVariationDependencies(nil, usesLibOptTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross4a80a152022-12-21 21:51:52 -08001473 // Only add these extra dependencies if the module is an app that depends on framework
1474 // libs. This avoids creating a cyclic dependency:
Paul Duffin250e6192019-06-07 10:44:37 +01001475 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
Colin Cross4a80a152022-12-21 21:51:52 -08001476 if addCompatDeps {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001477 // Dexpreopt needs paths to the dex jars of these libraries in order to construct
1478 // class loader context for dex2oat. Add them as a dependency with a special tag.
1479 ctx.AddVariationDependencies(nil, usesLibCompat29ReqTag, dexpreopt.CompatUsesLibs29...)
1480 ctx.AddVariationDependencies(nil, usesLibCompat28OptTag, dexpreopt.OptionalCompatUsesLibs28...)
1481 ctx.AddVariationDependencies(nil, usesLibCompat30OptTag, dexpreopt.OptionalCompatUsesLibs30...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001482 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001483 } else {
1484 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.usesLibraryProperties.Uses_libs...)
1485 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross50ddcc42019-05-16 12:28:22 -07001486 }
1487}
1488
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001489// presentOptionalUsesLibs returns optional_uses_libs after filtering out libraries that don't exist in the source tree.
Colin Cross50ddcc42019-05-16 12:28:22 -07001490func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001491 optionalUsesLibs := android.FilterListPred(u.usesLibraryProperties.Optional_uses_libs, func(s string) bool {
1492 exists := ctx.OtherModuleExists(s)
Jiakai Zhang48203e32023-06-02 23:42:21 +01001493 if !exists && !android.InList(ctx.ModuleName(), ctx.Config().BuildWarningBadOptionalUsesLibsAllowlist()) {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001494 fmt.Printf("Warning: Module '%s' depends on non-existing optional_uses_libs '%s'\n", ctx.ModuleName(), s)
1495 }
1496 return exists
1497 })
Colin Cross50ddcc42019-05-16 12:28:22 -07001498 return optionalUsesLibs
1499}
1500
Ulya Trafimovicheea486a2021-02-26 11:38:21 +00001501// Helper function to replace string in a list.
1502func replaceInList(list []string, oldstr, newstr string) {
1503 for i, str := range list {
1504 if str == oldstr {
1505 list[i] = newstr
1506 }
1507 }
1508}
1509
Ulya Trafimovich24446712021-07-15 14:59:34 +01001510// Returns a map of module names of shared library dependencies to the paths to their dex jars on
1511// host and on device.
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001512func (u *usesLibrary) classLoaderContextForUsesLibDeps(ctx android.ModuleContext) dexpreopt.ClassLoaderContextMap {
1513 clcMap := make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich24446712021-07-15 14:59:34 +01001514
1515 // Skip when UnbundledBuild() is true, but UnbundledBuildImage() is false. With
1516 // UnbundledBuildImage() it is necessary to generate dexpreopt.config for post-dexpreopting.
1517 if ctx.Config().UnbundledBuild() && !ctx.Config().UnbundledBuildImage() {
1518 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001519 }
1520
Ulya Trafimovich24446712021-07-15 14:59:34 +01001521 ctx.VisitDirectDeps(func(m android.Module) {
1522 tag, isUsesLibTag := ctx.OtherModuleDependencyTag(m).(usesLibraryDependencyTag)
1523 if !isUsesLibTag {
1524 return
1525 }
1526
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001527 dep := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(m))
Ulya Trafimovich24446712021-07-15 14:59:34 +01001528
Ulya Trafimovich840efb62021-07-15 14:34:40 +01001529 // Skip stub libraries. A dependency on the implementation library has been added earlier,
1530 // so it will be added to CLC, but the stub shouldn't be. Stub libraries can be distingushed
1531 // from implementation libraries by their name, which is different as it has a suffix.
1532 if comp, ok := m.(SdkLibraryComponentDependency); ok {
1533 if impl := comp.OptionalSdkLibraryImplementation(); impl != nil && *impl != dep {
1534 return
1535 }
1536 }
1537
Ulya Trafimovich24446712021-07-15 14:59:34 +01001538 if lib, ok := m.(UsesLibraryDependency); ok {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001539 libName := dep
Ulya Trafimovich24446712021-07-15 14:59:34 +01001540 if ulib, ok := m.(ProvidesUsesLib); ok && ulib.ProvidesUsesLib() != nil {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001541 libName = *ulib.ProvidesUsesLib()
Ulya Trafimovich24446712021-07-15 14:59:34 +01001542 // Replace module name with library name in `uses_libs`/`optional_uses_libs` in
1543 // order to pass verify_uses_libraries check (which compares these properties
1544 // against library names written in the manifest).
1545 replaceInList(u.usesLibraryProperties.Uses_libs, dep, libName)
1546 replaceInList(u.usesLibraryProperties.Optional_uses_libs, dep, libName)
1547 }
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001548 clcMap.AddContext(ctx, tag.sdkVersion, libName, tag.optional,
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001549 lib.DexJarBuildPath().PathOrNil(), lib.DexJarInstallPath(),
1550 lib.ClassLoaderContexts())
Ulya Trafimovich24446712021-07-15 14:59:34 +01001551 } else if ctx.Config().AllowMissingDependencies() {
1552 ctx.AddMissingDependencies([]string{dep})
1553 } else {
1554 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library", dep)
1555 }
1556 })
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001557 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001558}
1559
1560// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1561// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1562// unconditionally in the future.
1563func (u *usesLibrary) enforceUsesLibraries() bool {
1564 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1565 len(u.usesLibraryProperties.Optional_uses_libs) > 0
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001566 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, u.enforce || defaultEnforceUsesLibs)
Colin Cross50ddcc42019-05-16 12:28:22 -07001567}
1568
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001569// Freeze the value of `enforce_uses_libs` based on the current values of `uses_libs` and `optional_uses_libs`.
1570func (u *usesLibrary) freezeEnforceUsesLibraries() {
1571 enforce := u.enforceUsesLibraries()
1572 u.usesLibraryProperties.Enforce_uses_libs = &enforce
1573}
1574
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001575// verifyUsesLibraries checks the <uses-library> tags in the manifest against the ones specified
1576// in the `uses_libs`/`optional_uses_libs` properties. The input can be either an XML manifest, or
1577// an APK with the manifest embedded in it (manifest_check will know which one it is by the file
1578// extension: APKs are supposed to end with '.apk').
1579func (u *usesLibrary) verifyUsesLibraries(ctx android.ModuleContext, inputFile android.Path,
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001580 outputFile android.WritablePath) android.Path {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001581
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001582 statusFile := dexpreopt.UsesLibrariesStatusFile(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001583
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001584 // Disable verify_uses_libraries check if dexpreopt is globally disabled. Without dexpreopt the
1585 // check is not necessary, and although it is good to have, it is difficult to maintain on
1586 // non-linux build platforms where dexpreopt is generally disabled (the check may fail due to
1587 // various unrelated reasons, such as a failure to get manifest from an APK).
Ulya Trafimovich39dd0a42021-03-29 14:57:34 +01001588 global := dexpreopt.GetGlobalConfig(ctx)
1589 if global.DisablePreopt || global.OnlyPreoptBootImageAndSystemServer {
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001590 return inputFile
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001591 }
1592
Colin Crossf1a035e2020-11-16 17:32:30 -08001593 rule := android.NewRuleBuilder(pctx, ctx)
1594 cmd := rule.Command().BuiltTool("manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001595 Flag("--enforce-uses-libraries").
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001596 Input(inputFile).
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001597 FlagWithOutput("--enforce-uses-libraries-status ", statusFile).
Saeid Farivar Asanjanfd27c7c2022-08-08 20:21:26 +00001598 FlagWithInput("--aapt ", ctx.Config().HostToolPath(ctx, "aapt2"))
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001599
1600 if outputFile != nil {
1601 cmd.FlagWithOutput("-o ", outputFile)
1602 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001603
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001604 if dexpreopt.GetGlobalConfig(ctx).RelaxUsesLibraryCheck {
1605 cmd.Flag("--enforce-uses-libraries-relax")
1606 }
1607
Colin Cross50ddcc42019-05-16 12:28:22 -07001608 for _, lib := range u.usesLibraryProperties.Uses_libs {
1609 cmd.FlagWithArg("--uses-library ", lib)
1610 }
1611
1612 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1613 cmd.FlagWithArg("--optional-uses-library ", lib)
1614 }
1615
Colin Crossf1a035e2020-11-16 17:32:30 -08001616 rule.Build("verify_uses_libraries", "verify <uses-library>")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001617 return outputFile
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001618}
Colin Cross50ddcc42019-05-16 12:28:22 -07001619
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001620// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against
1621// the build system and returns the path to a copy of the manifest.
1622func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1623 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001624 return u.verifyUsesLibraries(ctx, manifest, outputFile)
Colin Cross50ddcc42019-05-16 12:28:22 -07001625}
1626
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001627// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the build
1628// system and returns the path to a copy of the APK.
Cole Faust2f1da162023-04-17 15:06:56 -07001629func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001630 u.verifyUsesLibraries(ctx, apk, nil) // for APKs manifest_check does not write output file
Colin Cross50ddcc42019-05-16 12:28:22 -07001631}
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001632
1633// For Bazel / bp2build
1634
1635type bazelAndroidAppCertificateAttributes struct {
1636 Certificate string
1637}
1638
Chris Parsons637458d2023-09-19 20:09:00 +00001639func (m *AndroidAppCertificate) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001640 androidAppCertificateBp2Build(ctx, m)
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001641}
1642
Chris Parsons637458d2023-09-19 20:09:00 +00001643func androidAppCertificateBp2Build(ctx android.Bp2buildMutatorContext, module *AndroidAppCertificate) {
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001644 var certificate string
1645 if module.properties.Certificate != nil {
1646 certificate = *module.properties.Certificate
1647 }
1648
1649 attrs := &bazelAndroidAppCertificateAttributes{
1650 Certificate: certificate,
1651 }
1652
1653 props := bazel.BazelTargetModuleProperties{
1654 Rule_class: "android_app_certificate",
Alixa381cd12023-05-10 14:49:38 +00001655 Bzl_load_location: "//build/bazel/rules/android:android_app_certificate.bzl",
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001656 }
1657
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +00001658 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: module.Name()}, attrs)
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001659}
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001660
Alixe5085eb2023-01-31 19:38:41 +00001661type manifestValueAttribute struct {
Romain Jobredeaux496660d2023-07-10 11:50:00 -04001662 MinSdkVersion *string
Romain Jobredeaux496660d2023-07-10 11:50:00 -04001663 TargetSdkVersion *string
Alixe5085eb2023-01-31 19:38:41 +00001664}
1665
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001666type bazelAndroidAppAttributes struct {
Sam Delmericoc0161432022-02-25 21:34:51 +00001667 *javaCommonAttributes
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001668 *bazelAapt
Sam Delmericoc0161432022-02-25 21:34:51 +00001669 Deps bazel.LabelListAttribute
Sam Delmerico9dfb1392022-02-10 21:11:59 +00001670 Custom_package *string
Jingwen Chen6817bbb2022-10-14 09:56:07 +00001671 Certificate bazel.LabelAttribute
1672 Certificate_name bazel.StringAttribute
Alixe5085eb2023-01-31 19:38:41 +00001673 Manifest_values *manifestValueAttribute
Romain Jobredeaux9973ace2023-08-30 00:27:09 -04001674 Optimize *bool
1675 Proguard_specs bazel.LabelListAttribute
Romain Jobredeaux3132f842023-09-15 10:06:16 -04001676 Updatable *bool
Jingwen Chenbea58092022-09-29 16:56:02 +00001677}
1678
Alixee51bd62023-08-29 16:01:46 +00001679func (b bazelAapt) ConvertJavaResources(ctx android.Bp2buildMutatorContext, javaAttrs *javaCommonAttributes) bool {
1680 // TODO (b/300470246) bp2build support for java_resources & java_resource_dirs in android rules
1681 hasJavaResources := !javaAttrs.javaResourcesAttributes.Resources.IsEmpty()
1682 if hasJavaResources {
1683 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_UNSUPPORTED, "(b/300470246) java resources in android_* module")
1684 }
1685 return hasJavaResources
1686}
1687
Chris Parsons637458d2023-09-19 20:09:00 +00001688func convertWithBp2build(ctx android.Bp2buildMutatorContext, a *AndroidApp) (bool, android.CommonAttributes, *bazelAndroidAppAttributes) {
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001689 aapt, supported := a.convertAaptAttrsWithBp2Build(ctx)
1690 if !supported {
Jingwen Chene12c0832023-08-25 09:00:16 +00001691 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001692 }
Spandan Das0e0a8802023-09-20 19:53:30 +00001693 if a.appProperties.Jni_uses_platform_apis != nil {
1694 ctx.MarkBp2buildUnconvertible(
1695 bp2build_metrics_proto.UnconvertedReasonType_UNSUPPORTED,
1696 "TODO - b/299360988: Add bp2build support for jni_uses_platform_apis",
1697 )
1698 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
1699 }
1700 if a.appProperties.Jni_uses_sdk_apis != nil {
1701 ctx.MarkBp2buildUnconvertible(
1702 bp2build_metrics_proto.UnconvertedReasonType_UNSUPPORTED,
1703 "TODO - b/299360988: Add bp2build support for jni_uses_sdk_apis",
1704 )
1705 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
1706 }
1707
Jingwen Chen6817bbb2022-10-14 09:56:07 +00001708 certificate, certificateName := android.BazelStringOrLabelFromProp(ctx, a.overridableAppProperties.Certificate)
1709
Romain Jobredeaux3132f842023-09-15 10:06:16 -04001710 manifestValues := &manifestValueAttribute{
1711 MinSdkVersion: a.deviceProperties.Min_sdk_version,
1712 TargetSdkVersion: a.deviceProperties.Target_sdk_version,
Romain Jobredeaux496660d2023-07-10 11:50:00 -04001713 }
1714
Alix0856f9e2023-01-20 22:15:30 +00001715 appAttrs := &bazelAndroidAppAttributes{
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001716 // TODO(b/209576404): handle package name override by product variable PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
Alix0856f9e2023-01-20 22:15:30 +00001717 Custom_package: a.overridableAppProperties.Package_name,
1718 Certificate: certificate,
1719 Certificate_name: certificateName,
Alixe5085eb2023-01-31 19:38:41 +00001720 Manifest_values: manifestValues,
Romain Jobredeaux3132f842023-09-15 10:06:16 -04001721 Updatable: a.appProperties.Updatable,
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001722 }
Sam Delmerico9dfb1392022-02-10 21:11:59 +00001723
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001724 // As framework-res has no sources, no deps in the Bazel sense, and java compilation, dexing and optimization is skipped by
1725 // Soong specifically for it, return early here before any of the conversion work for the above is attempted.
1726 if ctx.ModuleName() == "framework-res" {
1727 appAttrs.bazelAapt = aapt
1728 return true, android.CommonAttributes{Name: a.Name(), SkipData: proptools.BoolPtr(true)}, appAttrs
1729 }
1730
Jingwen Chen65229202023-09-20 13:34:16 +00001731 // Optimization is..
1732 // - enabled by default for android_app, android_test_helper_app
1733 // - disabled by default for android_test
1734 //
1735 // TODO(b/192032291): Disable android_test_helper_app optimization by
1736 // default after auditing downstream usage.
Jingwen Chen256c3892023-09-26 05:51:40 +00001737 if a.dexProperties.Optimize.EnabledByDefault != a.dexer.effectiveOptimizeEnabled() {
1738 // Property is explicitly defined by default from default, so emit the Bazel attribute.
1739 appAttrs.Optimize = proptools.BoolPtr(a.dexer.effectiveOptimizeEnabled())
Jingwen Chen65229202023-09-20 13:34:16 +00001740 }
Jingwen Chen65229202023-09-20 13:34:16 +00001741
Jingwen Chen256c3892023-09-26 05:51:40 +00001742 if a.dexer.effectiveOptimizeEnabled() {
Romain Jobredeaux9973ace2023-08-30 00:27:09 -04001743 handCraftedFlags := ""
1744 if Bool(a.dexProperties.Optimize.Ignore_warnings) {
1745 handCraftedFlags += "-ignorewarning "
1746 }
1747 if !Bool(a.dexProperties.Optimize.Shrink) {
1748 handCraftedFlags += "-dontshrink "
1749 }
1750 if !Bool(a.dexProperties.Optimize.Optimize) {
1751 handCraftedFlags += "-dontoptimize "
1752 }
1753 if !Bool(a.dexProperties.Optimize.Obfuscate) {
1754 handCraftedFlags += "-dontobfuscate "
1755 }
1756 appAttrs.Proguard_specs = bazel.MakeLabelListAttribute(android.BazelLabelForModuleSrc(ctx, a.dexProperties.Optimize.Proguard_flags_files))
1757 if handCraftedFlags != "" {
1758 generatedFlagFileRuleName := a.Name() + "_proguard_flags"
1759 ctx.CreateBazelTargetModule(bazel.BazelTargetModuleProperties{
1760 Rule_class: "genrule",
1761 }, android.CommonAttributes{
1762 Name: generatedFlagFileRuleName,
1763 SkipData: proptools.BoolPtr(true),
1764 }, &genrule.BazelGenruleAttributes{
1765 Outs: []string{a.Name() + "_proguard.flags"},
1766 Cmd: bazel.StringAttribute{
1767 Value: proptools.StringPtr("echo " + handCraftedFlags + "> $(OUTS)"),
1768 },
1769 })
1770 appAttrs.Proguard_specs.Add(bazel.MakeLabelAttribute(":" + generatedFlagFileRuleName))
1771 }
Romain Jobredeaux9973ace2023-08-30 00:27:09 -04001772 }
1773
Romain Jobredeauxd2cc5032023-09-11 16:37:50 -04001774 commonAttrs, bp2BuildInfo, supported := a.convertLibraryAttrsBp2Build(ctx)
1775 if !supported {
Jingwen Chene12c0832023-08-25 09:00:16 +00001776 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
Romain Jobredeauxd2cc5032023-09-11 16:37:50 -04001777 }
Alixee51bd62023-08-29 16:01:46 +00001778 if hasJavaResources := aapt.ConvertJavaResources(ctx, commonAttrs); hasJavaResources {
1779 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
1780 }
1781
Romain Jobredeauxd2cc5032023-09-11 16:37:50 -04001782 depLabels := bp2BuildInfo.DepLabels
1783
1784 deps := depLabels.Deps
1785 deps.Append(depLabels.StaticDeps)
1786
Romain Jobredeaux947dfa72023-06-12 15:40:35 -04001787 var jniDeps bazel.LabelListAttribute
1788 archVariantProps := a.GetArchVariantProperties(ctx, &appProperties{})
1789 for axis, configToProps := range archVariantProps {
1790 for config, _props := range configToProps {
1791 if archProps, ok := _props.(*appProperties); ok {
1792 archJniLibs := android.BazelLabelForModuleDeps(
1793 ctx,
1794 android.LastUniqueStrings(android.CopyOf(archProps.Jni_libs)))
1795 jniDeps.SetSelectValue(axis, config, archJniLibs)
1796 }
1797 }
1798 }
1799 deps.Append(jniDeps)
1800
Alix75db7842023-03-06 22:08:49 +00001801 if !bp2BuildInfo.hasKotlin {
Alix0856f9e2023-01-20 22:15:30 +00001802 appAttrs.javaCommonAttributes = commonAttrs
1803 appAttrs.bazelAapt = aapt
1804 appAttrs.Deps = deps
Alix0856f9e2023-01-20 22:15:30 +00001805 } else {
1806 ktName := a.Name() + "_kt"
Alix0856f9e2023-01-20 22:15:30 +00001807 ctx.CreateBazelTargetModule(
Alix32540022023-03-16 21:06:13 +00001808 AndroidLibraryBazelTargetModuleProperties(),
Alix0856f9e2023-01-20 22:15:30 +00001809 android.CommonAttributes{Name: ktName},
1810 &bazelAndroidLibrary{
1811 javaLibraryAttributes: &javaLibraryAttributes{
1812 javaCommonAttributes: commonAttrs,
1813 Deps: deps,
1814 },
1815 bazelAapt: aapt,
1816 },
1817 )
1818
1819 appAttrs.bazelAapt = &bazelAapt{Manifest: aapt.Manifest}
1820 appAttrs.Deps = bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + ktName})
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001821 appAttrs.javaCommonAttributes = &javaCommonAttributes{
1822 Sdk_version: commonAttrs.Sdk_version,
1823 }
Alix0856f9e2023-01-20 22:15:30 +00001824 }
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001825
Jingwen Chene12c0832023-08-25 09:00:16 +00001826 return true, android.CommonAttributes{Name: a.Name(), SkipData: proptools.BoolPtr(true)}, appAttrs
1827}
1828
1829// ConvertWithBp2build is used to convert android_app to Bazel.
Chris Parsons637458d2023-09-19 20:09:00 +00001830func (a *AndroidApp) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Jingwen Chene12c0832023-08-25 09:00:16 +00001831 if ok, commonAttrs, appAttrs := convertWithBp2build(ctx, a); ok {
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001832 var props bazel.BazelTargetModuleProperties
1833 if ctx.ModuleName() == "framework-res" {
1834 props = bazel.BazelTargetModuleProperties{
1835 Rule_class: "framework_resources",
1836 Bzl_load_location: "//build/bazel/rules/android:framework_resources.bzl",
1837 }
1838 } else {
1839 props = bazel.BazelTargetModuleProperties{
1840 Rule_class: "android_binary",
1841 Bzl_load_location: "//build/bazel/rules/android:android_binary.bzl",
1842 }
Jingwen Chene12c0832023-08-25 09:00:16 +00001843 }
Jingwen Chene12c0832023-08-25 09:00:16 +00001844 ctx.CreateBazelTargetModule(props, commonAttrs, appAttrs)
1845 }
1846
1847}
1848
1849// ConvertWithBp2build is used to convert android_test to Bazel.
Chris Parsons637458d2023-09-19 20:09:00 +00001850func (at *AndroidTest) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Jingwen Chene12c0832023-08-25 09:00:16 +00001851 if ok, commonAttrs, appAttrs := convertWithBp2build(ctx, &at.AndroidApp); ok {
1852 props := bazel.BazelTargetModuleProperties{
1853 Rule_class: "android_test",
1854 Bzl_load_location: "//build/bazel/rules/android:android_test.bzl",
1855 }
1856
1857 ctx.CreateBazelTargetModule(props, commonAttrs, appAttrs)
1858 }
Alix733110e2023-02-06 14:53:10 +00001859
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001860}
Jingwen Chen65289992023-09-21 15:15:47 +00001861
1862func (atha *AndroidTestHelperApp) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
1863 if ok, commonAttrs, appAttrs := convertWithBp2build(ctx, &atha.AndroidApp); ok {
1864 // an android_test_helper_app is an android_binary with testonly = True
1865 commonAttrs.Testonly = proptools.BoolPtr(true)
1866
Jingwen Chen65229202023-09-20 13:34:16 +00001867 // android_test_helper_app sets default values differently to android_app,
Jingwen Chen65289992023-09-21 15:15:47 +00001868 // https://cs.android.com/android/platform/superproject/main/+/main:build/soong/java/app.go;l=1273-1279;drc=e12c083198403ec694af6c625aed11327eb2bf7f
1869 //
1870 // installable: true (settable prop)
1871 // use_embedded_native_libs: true (settable prop)
1872 // lint.test: true (settable prop)
Jingwen Chen65289992023-09-21 15:15:47 +00001873 // AlwaysPackageNativeLibs: true (blueprint mutated prop)
1874 // dexpreopt isTest: true (not prop)
1875
1876 props := bazel.BazelTargetModuleProperties{
1877 Rule_class: "android_binary",
1878 Bzl_load_location: "//build/bazel/rules/android:android_binary.bzl",
1879 }
1880
1881 ctx.CreateBazelTargetModule(props, commonAttrs, appAttrs)
1882 }
1883}