blob: c1396a680e931c6523eb58a33d4757625d607dfb [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
17// This file contains the module types for compiling Android apps.
18
19import (
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070020 "path/filepath"
21 "reflect"
Jaewoong Jung5b425e22019-06-17 17:40:56 -070022 "sort"
Sasha Smundaka7856c02020-04-23 09:49:59 -070023 "strconv"
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070024 "strings"
Colin Cross30e076a2015-04-13 13:58:27 -070025
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"
Colin Crossa4f08812018-10-02 22:03:40 -070030 "android/soong/cc"
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +010031 "android/soong/dexpreopt"
Colin Cross303e21f2018-08-07 16:49:25 -070032 "android/soong/tradefed"
Colin Cross30e076a2015-04-13 13:58:27 -070033)
34
Jaewoong Jung3e18b192019-06-11 12:25:34 -070035var supportedDpis = []string{"ldpi", "mdpi", "hdpi", "xhdpi", "xxhdpi", "xxxhdpi"}
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070036
Colin Cross3bc7ffa2017-11-22 16:19:37 -080037func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000038 RegisterAppBuildComponents(android.InitRegistrationContext)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -070039
40 initAndroidAppImportVariantGroupTypes()
Colin Cross3bc7ffa2017-11-22 16:19:37 -080041}
42
Paul Duffinf9b1da02019-12-18 19:51:55 +000043func RegisterAppBuildComponents(ctx android.RegistrationContext) {
44 ctx.RegisterModuleType("android_app", AndroidAppFactory)
45 ctx.RegisterModuleType("android_test", AndroidTestFactory)
46 ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory)
47 ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory)
48 ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory)
49 ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory)
Roshan Piusb8307962020-04-27 09:42:27 -070050 ctx.RegisterModuleType("override_runtime_resource_overlay", OverrideRuntimeResourceOverlayModuleFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000051 ctx.RegisterModuleType("android_app_import", AndroidAppImportFactory)
52 ctx.RegisterModuleType("android_test_import", AndroidTestImportFactory)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -080053 ctx.RegisterModuleType("runtime_resource_overlay", RuntimeResourceOverlayFactory)
Sasha Smundaka7856c02020-04-23 09:49:59 -070054 ctx.RegisterModuleType("android_app_set", AndroidApkSetFactory)
55}
56
57type AndroidAppSetProperties struct {
58 // APK Set path
59 Set *string
60
61 // Specifies that this app should be installed to the priv-app directory,
62 // where the system will grant it additional privileges not available to
63 // normal apps.
64 Privileged *bool
65
66 // APKs in this set use prerelease SDK version
67 Prerelease *bool
68
69 // Names of modules to be overridden. Listed modules can only be other apps
70 // (in Make or Soong).
71 Overrides []string
72}
73
74type AndroidAppSet struct {
75 android.ModuleBase
76 android.DefaultableModuleBase
77 prebuilt android.Prebuilt
78
79 properties AndroidAppSetProperties
80 packedOutput android.WritablePath
81 masterFile string
82}
83
84func (as *AndroidAppSet) Name() string {
85 return as.prebuilt.Name(as.ModuleBase.Name())
86}
87
88func (as *AndroidAppSet) IsInstallable() bool {
89 return true
90}
91
92func (as *AndroidAppSet) Prebuilt() *android.Prebuilt {
93 return &as.prebuilt
94}
95
96func (as *AndroidAppSet) Privileged() bool {
97 return Bool(as.properties.Privileged)
98}
99
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700100func (as *AndroidAppSet) OutputFile() android.Path {
101 return as.packedOutput
102}
103
104func (as *AndroidAppSet) MasterFile() string {
105 return as.masterFile
106}
107
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700108var TargetCpuAbi = map[string]string{
Sasha Smundaka7856c02020-04-23 09:49:59 -0700109 "arm": "ARMEABI_V7A",
110 "arm64": "ARM64_V8A",
111 "x86": "X86",
112 "x86_64": "X86_64",
113}
114
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700115func SupportedAbis(ctx android.ModuleContext) []string {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700116 abiName := func(archVar string, deviceArch string) string {
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700117 if abi, found := TargetCpuAbi[deviceArch]; found {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700118 return abi
119 }
120 ctx.ModuleErrorf("Invalid %s: %s", archVar, deviceArch)
121 return "BAD_ABI"
122 }
123
124 result := []string{abiName("TARGET_ARCH", ctx.DeviceConfig().DeviceArch())}
125 if s := ctx.DeviceConfig().DeviceSecondaryArch(); s != "" {
126 result = append(result, abiName("TARGET_2ND_ARCH", s))
127 }
128 return result
129}
130
131func (as *AndroidAppSet) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700132 as.packedOutput = android.PathForModuleOut(ctx, ctx.ModuleName()+".zip")
Sasha Smundaka7856c02020-04-23 09:49:59 -0700133 // We are assuming here that the master file in the APK
134 // set has `.apk` suffix. If it doesn't the build will fail.
135 // APK sets containing APEX files are handled elsewhere.
136 as.masterFile = ctx.ModuleName() + ".apk"
137 screenDensities := "all"
138 if dpis := ctx.Config().ProductAAPTPrebuiltDPI(); len(dpis) > 0 {
139 screenDensities = strings.ToUpper(strings.Join(dpis, ","))
140 }
141 // TODO(asmundak): handle locales.
142 // TODO(asmundak): do we support device features
143 ctx.Build(pctx,
144 android.BuildParams{
145 Rule: extractMatchingApks,
146 Description: "Extract APKs from APK set",
147 Output: as.packedOutput,
148 Inputs: android.Paths{as.prebuilt.SingleSourcePath(ctx)},
149 Args: map[string]string{
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700150 "abis": strings.Join(SupportedAbis(ctx), ","),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700151 "allow-prereleased": strconv.FormatBool(proptools.Bool(as.properties.Prerelease)),
152 "screen-densities": screenDensities,
153 "sdk-version": ctx.Config().PlatformSdkVersion(),
154 "stem": ctx.ModuleName(),
155 },
156 })
Sasha Smundaka7856c02020-04-23 09:49:59 -0700157}
158
159// android_app_set extracts a set of APKs based on the target device
160// configuration and installs this set as "split APKs".
Sasha Smundak613cbb12020-06-05 10:27:23 -0700161// The extracted set always contains 'master' APK whose name is
162// _module_name_.apk and every split APK matching target device.
163// The extraction of the density-specific splits depends on
164// PRODUCT_AAPT_PREBUILT_DPI variable. If present (its value should
165// be a list density names: LDPI, MDPI, HDPI, etc.), only listed
166// splits will be extracted. Otherwise all density-specific splits
167// will be extracted.
Sasha Smundaka7856c02020-04-23 09:49:59 -0700168func AndroidApkSetFactory() android.Module {
169 module := &AndroidAppSet{}
170 module.AddProperties(&module.properties)
171 InitJavaModule(module, android.DeviceSupported)
172 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set")
173 return module
Paul Duffinf9b1da02019-12-18 19:51:55 +0000174}
175
Colin Cross30e076a2015-04-13 13:58:27 -0700176// AndroidManifest.xml merging
177// package splits
178
Colin Crossfabb6082018-02-20 17:22:23 -0800179type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700180 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -0700181 Additional_certificates []string
182
183 // If set, create package-export.apk, which other packages can
184 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -0800185 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700186
Colin Cross16056062017-12-13 22:46:28 -0800187 // Specifies that this app should be installed to the priv-app directory,
188 // where the system will grant it additional privileges not available to
189 // normal apps.
190 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -0700191
192 // list of resource labels to generate individual resource packages
193 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -0400194
195 // Names of modules to be overridden. Listed modules can only be other binaries
196 // (in Make or Soong).
197 // This does not completely prevent installation of the overridden binaries, but if both
198 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
199 // from PRODUCT_PACKAGES.
200 Overrides []string
Colin Crossa4f08812018-10-02 22:03:40 -0700201
202 // list of native libraries that will be provided in or alongside the resulting jar
203 Jni_libs []string `android:"arch_variant"`
204
Colin Cross76583a42020-05-06 17:51:39 -0700205 // if true, use JNI libraries that link against platform APIs even if this module sets
Colin Crossee87c602020-02-19 16:57:15 -0800206 // sdk_version.
207 Jni_uses_platform_apis *bool
208
Colin Cross76583a42020-05-06 17:51:39 -0700209 // if true, use JNI libraries that link against SDK APIs even if this module does not set
210 // sdk_version.
211 Jni_uses_sdk_apis *bool
212
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700213 // STL library to use for JNI libraries.
214 Stl *string `android:"arch_variant"`
215
Colin Crosse4246ab2019-02-05 21:55:21 -0800216 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
217 // 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 +0900218 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
219 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
220 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -0800221 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -0800222
223 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
224 // they are used from inside the APK at runtime.
225 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700226
227 // Forces native libraries to always be packaged into the APK,
228 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
229 // True for android_test* modules.
230 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700231
232 // If set, find and merge all NOTICE files that this module and its dependencies have and store
233 // it in the APK as an asset.
234 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700235
236 // cc.Coverage related properties
237 PreventInstall bool `blueprint:"mutated"`
238 HideFromMake bool `blueprint:"mutated"`
239 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100240
241 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100242 // additional rules to make sure an app can safely be updated. Default is false.
243 // Prefer using other specific properties if build behaviour must be changed; avoid using this
244 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100245 Updatable *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700246}
247
Jaewoong Jung525443a2019-02-28 15:35:54 -0800248// android_app properties that can be overridden by override_android_app
249type overridableAppProperties struct {
250 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
251 // or an android_app_certificate module name in the form ":module".
252 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700253
Liz Kammer70dd74d2020-05-07 13:24:05 -0700254 // Name of the signing certificate lineage file.
255 Lineage *string
256
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700257 // the package name of this app. The package name in the manifest file is used if one was not given.
258 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800259
260 // the logging parent of this app.
261 Logging_parent *string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800262}
263
Roshan Piusb8307962020-04-27 09:42:27 -0700264// runtime_resource_overlay properties that can be overridden by override_runtime_resource_overlay
265type OverridableRuntimeResourceOverlayProperties struct {
266 // the package name of this app. The package name in the manifest file is used if one was not given.
267 Package_name *string
268
269 // the target package name of this overlay app. The target package name in the manifest file is used if one was not given.
270 Target_package_name *string
271}
272
Colin Cross30e076a2015-04-13 13:58:27 -0700273type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700274 Library
275 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800276 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700277
Colin Cross50ddcc42019-05-16 12:28:22 -0700278 usesLibrary usesLibrary
279
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900280 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700281
Colin Crossfabb6082018-02-20 17:22:23 -0800282 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700283
Jaewoong Jung525443a2019-02-28 15:35:54 -0800284 overridableAppProperties overridableAppProperties
285
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700286 installJniLibs []jniLib
287 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700288
289 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800290
291 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
292 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800293
Colin Cross70dda7e2019-10-01 22:05:35 -0700294 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700295
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700296 onDeviceDir string
297
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800298 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700299
300 noticeOutputs android.NoticeOutputs
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900301
302 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100303
304 android.ApexBundleDepsInfo
Colin Crosse1731a52017-12-14 11:22:55 -0800305}
306
Martin Stjernholm6d415272020-01-31 17:10:36 +0000307func (a *AndroidApp) IsInstallable() bool {
308 return Bool(a.properties.Installable)
309}
310
Colin Cross89c31582018-04-30 15:55:11 -0700311func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths {
312 return nil
313}
314
Colin Cross66f78822018-05-02 12:58:28 -0700315func (a *AndroidApp) ExportedStaticPackages() android.Paths {
316 return nil
317}
318
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900319func (a *AndroidApp) OutputFile() android.Path {
320 return a.outputFile
321}
322
Colin Cross503c1d02020-01-28 14:00:53 -0800323func (a *AndroidApp) Certificate() Certificate {
324 return a.certificate
325}
326
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700327func (a *AndroidApp) JniCoverageOutputs() android.Paths {
328 return a.jniCoverageOutputs
329}
330
Colin Crossa97c5d32018-03-28 14:58:31 -0700331var _ AndroidLibraryDependency = (*AndroidApp)(nil)
332
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900333type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800334 Pem, Key android.Path
335 presigned bool
336}
337
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700338var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800339
340func (c Certificate) AndroidMkString() string {
341 if c.presigned {
342 return "PRESIGNED"
343 } else {
344 return c.Pem.String()
345 }
Colin Cross30e076a2015-04-13 13:58:27 -0700346}
347
Colin Cross46c9b8b2017-06-22 16:51:17 -0700348func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
349 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700350
Jiyong Park6a927c42020-01-21 02:03:43 +0900351 if String(a.appProperties.Stl) == "c++_shared" && !a.sdkVersion().specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700352 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
353 }
354
Paul Duffin250e6192019-06-07 10:44:37 +0100355 sdkDep := decodeSdkDep(ctx, sdkContext(a))
356 if sdkDep.hasFrameworkLibs() {
357 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700358 }
Colin Crossa4f08812018-10-02 22:03:40 -0700359
Colin Cross3c007702020-05-08 11:20:24 -0700360 usesSDK := a.sdkVersion().specified() && a.sdkVersion().kind != sdkCorePlatform
361
362 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
363 ctx.PropertyErrorf("jni_uses_sdk_apis",
364 "can only be set for modules that do not set sdk_version")
365 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
366 ctx.PropertyErrorf("jni_uses_platform_apis",
367 "can only be set for modules that set sdk_version")
368 }
369
Peter Collingbournead84f972019-12-17 16:46:18 -0800370 tag := &jniDependencyTag{}
Colin Crossa4f08812018-10-02 22:03:40 -0700371 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700372 variation := append(jniTarget.Variations(),
373 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000374
375 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
376 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700377 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
378 // have stable APIs through the VNDK.
379 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
380 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross76583a42020-05-06 17:51:39 -0700381 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000382 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
383 }
Colin Crossa4f08812018-10-02 22:03:40 -0700384 ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...)
385 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700386
Paul Duffin250e6192019-06-07 10:44:37 +0100387 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700388}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700389
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700390func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800391 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700392 if cert != "" {
393 ctx.AddDependency(ctx.Module(), certificateTag, cert)
394 }
395
396 for _, cert := range a.appProperties.Additional_certificates {
397 cert = android.SrcIsModule(cert)
398 if cert != "" {
399 ctx.AddDependency(ctx.Module(), certificateTag, cert)
400 } else {
401 ctx.PropertyErrorf("additional_certificates",
402 `must be names of android_app_certificate modules in the form ":module"`)
403 }
404 }
Colin Cross30e076a2015-04-13 13:58:27 -0700405}
406
Jeongik Cha538c0d02019-07-11 15:54:27 +0900407func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
408 a.generateAndroidBuildActions(ctx)
409}
410
Colin Cross46c9b8b2017-06-22 16:51:17 -0700411func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100412 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700413 a.generateAndroidBuildActions(ctx)
414}
415
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100416func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100417 if a.Updatable() {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100418 if !a.sdkVersion().stable() {
419 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.sdkVersion())
420 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100421 if String(a.deviceProperties.Min_sdk_version) == "" {
422 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
423 }
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900424 if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil {
425 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
426 } else {
427 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
428 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100429 }
430
431 a.checkPlatformAPI(ctx)
432 a.checkSdkVersions(ctx)
433}
434
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900435// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
436// This check is enforced for "updatable" APKs (including APK-in-APEX).
437// b/155209650: until min_sdk_version is properly supported, use sdk_version instead.
438// because, sdk_version is overridden by min_sdk_version (if set as smaller)
439// and linkType is checked with dependencies so we can be sure that the whole dependency tree
440// will meet the requirements.
441func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) {
442 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
443 ctx.VisitDirectDeps(func(m android.Module) {
444 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
445 return
446 }
447 dep, _ := m.(*cc.Module)
Jooyung Han9d2c0f72020-05-20 17:12:13 +0900448 // The domain of cc.sdk_version is "current" and <number>
449 // We can rely on sdkSpec to convert it to <number> so that "current" is handled
450 // properly regardless of sdk finalization.
451 jniSdkVersion, err := sdkSpecFrom(dep.SdkVersion()).effectiveVersion(ctx)
452 if err != nil || minSdkVersion < jniSdkVersion {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900453 ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
454 dep.SdkVersion(), minSdkVersion, ctx.ModuleName())
455 return
456 }
457
458 })
459}
460
Sasha Smundak6ad77252019-05-01 13:16:22 -0700461// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800462// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700463func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park6a927c42020-01-21 02:03:43 +0900464 minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800465 if err != nil {
466 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
467 }
468
Jiyong Park52cd06f2019-11-11 10:14:32 +0900469 return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
470 !a.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800471}
472
Colin Cross43f08db2018-11-12 10:13:39 -0800473// Returns whether this module should have the dex file stored uncompressed in the APK.
474func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800475 if Bool(a.appProperties.Use_embedded_dex) {
476 return true
477 }
478
Colin Cross53a87f52019-06-25 13:35:30 -0700479 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
480 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900481 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000482 return true
483 }
484
Colin Cross53a87f52019-06-25 13:35:30 -0700485 if ctx.Config().UnbundledBuild() {
486 return false
487 }
488
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700489 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700490}
491
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700492func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
493 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Jiyong Park52cd06f2019-11-11 10:14:32 +0900494 !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700495}
496
Liz Kammer760c3352020-05-04 15:40:52 -0700497func generateAaptRenamePackageFlags(packageName string) []string {
498 aaptFlags := []string{}
499 aaptFlags = append(aaptFlags, "--rename-manifest-package "+packageName)
500 // Required to rename the package name in the resources table.
501 aaptFlags = append(aaptFlags, "--rename-resources-package "+packageName)
502 return aaptFlags
503}
504
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900505func (a *AndroidApp) OverriddenManifestPackageName() string {
506 return a.overriddenManifestPackageName
507}
508
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800509func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
David Brazdild25060a2019-02-18 18:24:16 +0000510 a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
511
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700512 // Ask manifest_fixer to add or update the application element indicating this app has no code.
513 a.aapt.hasNoCode = !a.hasCode(ctx)
514
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800515 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800516
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800517 // 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 -0800518 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700519 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800520 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700521 }
522
Dan Willemsen72be5902018-10-24 20:24:57 -0700523 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
524 // Product AAPT config
525 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800526 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700527 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700528
Dan Willemsen72be5902018-10-24 20:24:57 -0700529 // Product AAPT preferred config
530 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800531 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700532 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700533 }
534
Jiyong Park7f67f482019-01-05 12:57:48 +0900535 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700536 if overridden || a.overridableAppProperties.Package_name != nil {
537 // The product override variable has a priority over the package_name property.
538 if !overridden {
539 manifestPackageName = *a.overridableAppProperties.Package_name
540 }
Liz Kammer760c3352020-05-04 15:40:52 -0700541 aaptLinkFlags = append(aaptLinkFlags, generateAaptRenamePackageFlags(manifestPackageName)...)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900542 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900543 }
544
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800545 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
546
Colin Crosse560c4a2019-03-19 16:03:11 -0700547 a.aapt.splitNames = a.appProperties.Package_splits
Colin Cross50ddcc42019-05-16 12:28:22 -0700548 a.aapt.sdkLibraries = a.exportedSdkLibs
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800549 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800550 a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
Colin Cross30e076a2015-04-13 13:58:27 -0700551
Colin Cross46c9b8b2017-06-22 16:51:17 -0700552 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700553 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800554}
Colin Cross30e076a2015-04-13 13:58:27 -0700555
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800556func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700557 var staticLibProguardFlagFiles android.Paths
558 ctx.VisitDirectDeps(func(m android.Module) {
559 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
560 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
561 }
562 })
563
564 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
565
566 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
567 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800568}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800569
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800570func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross43f08db2018-11-12 10:13:39 -0800571
572 var installDir string
573 if ctx.ModuleName() == "framework-res" {
574 // framework-res.apk is installed as system/framework/framework-res.apk
575 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900576 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800577 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800578 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800579 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800580 }
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800581 a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
David Srbecky98c71222020-05-20 22:20:28 +0100582 if a.deviceProperties.Uncompress_dex == nil {
583 // If the value was not force-set by the user, use reasonable default based on the module.
584 a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
585 }
586 a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700587 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
588 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
589 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
590 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
591 a.dexpreopter.manifestFile = a.mergedManifestFile
592
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800593 if ctx.ModuleName() != "framework-res" {
594 a.Module.compile(ctx, a.aaptSrcJar)
595 }
Colin Cross30e076a2015-04-13 13:58:27 -0700596
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800597 return a.maybeStrippedDexJarFile
598}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800599
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800600func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700601 var jniJarFile android.WritablePath
Colin Crossa4f08812018-10-02 22:03:40 -0700602 if len(jniLibs) > 0 {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700603 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700604 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Sasha Smundak6ad77252019-05-01 13:16:22 -0700605 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700606 for _, jni := range jniLibs {
607 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700608 // Only collect coverage for the first target arch if this is a multilib target.
609 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
610 // data file path collisions since the current coverage file path format doesn't contain
611 // arch-related strings. This is fine for now though; the code coverage team doesn't use
612 // multi-arch targets such as test_suite_* for coverage collections yet.
613 //
614 // Work with the team to come up with a new format that handles multilib modules properly
615 // and change this.
616 if len(ctx.Config().Targets[android.Android]) == 1 ||
617 ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType {
618 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
619 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700620 }
621 }
Colin Crossa4f08812018-10-02 22:03:40 -0700622 } else {
623 a.installJniLibs = jniLibs
624 }
625 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800626 return jniJarFile
627}
Colin Crossa4f08812018-10-02 22:03:40 -0700628
Jaewoong Jung0949f312019-09-11 10:25:18 -0700629func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700630 // Collect NOTICE files from all dependencies.
631 seenModules := make(map[android.Module]bool)
632 noticePathSet := make(map[android.Path]bool)
633
634 ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
635 // Have we already seen this?
636 if _, ok := seenModules[child]; ok {
637 return false
638 }
639 seenModules[child] = true
640
641 // Skip host modules.
642 if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
643 return false
644 }
645
Bob Badoura75b0572020-02-18 20:21:55 -0800646 paths := child.(android.Module).NoticeFiles()
647 if len(paths) > 0 {
648 for _, path := range paths {
649 noticePathSet[path] = true
650 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700651 }
652 return true
653 })
654
655 // If the app has one, add it too.
Bob Badoura75b0572020-02-18 20:21:55 -0800656 if len(a.NoticeFiles()) > 0 {
657 for _, path := range a.NoticeFiles() {
658 noticePathSet[path] = true
659 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700660 }
661
662 if len(noticePathSet) == 0 {
Jaewoong Jung98772792019-07-01 17:15:13 -0700663 return
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700664 }
665 var noticePaths []android.Path
666 for path := range noticePathSet {
667 noticePaths = append(noticePaths, path)
668 }
669 sort.Slice(noticePaths, func(i, j int) bool {
670 return noticePaths[i].String() < noticePaths[j].String()
671 })
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700672
Jaewoong Jung0949f312019-09-11 10:25:18 -0700673 a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700674}
675
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700676// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
677// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
678func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
679 if android.SrcIsModule(certPropValue) == "" {
680 var mainCert Certificate
681 if certPropValue != "" {
682 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
683 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800684 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
685 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700686 }
687 } else {
688 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800689 mainCert = Certificate{
690 Pem: pem,
691 Key: key,
692 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700693 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700694 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700695 }
696
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700697 if !m.Platform() {
698 certPath := certificates[0].Pem.String()
Jeongik Chac9464142019-01-07 12:07:27 +0900699 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
700 if strings.HasPrefix(certPath, systemCertPath) {
701 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
702 whitelist := ctx.Config().EnforceSystemCertificateWhitelist()
703
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700704 if enforceSystemCert && !inList(m.Name(), whitelist) {
Jeongik Chac9464142019-01-07 12:07:27 +0900705 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
706 }
707 }
708 }
709
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700710 return certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800711}
712
Jooyung Han39ee1192020-03-23 20:21:11 +0900713func (a *AndroidApp) InstallApkName() string {
714 return a.installApkName
715}
716
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800717func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700718 var apkDeps android.Paths
719
Jeongik Cha538c0d02019-07-11 15:54:27 +0900720 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
721 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
722
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800723 // Check if the install APK name needs to be overridden.
Jaewoong Jung525443a2019-02-28 15:35:54 -0800724 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800725
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700726 if ctx.ModuleName() == "framework-res" {
727 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700728 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900729 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700730 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
731 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800732 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700733 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700734 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700735 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700736 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700737
Jaewoong Jung0949f312019-09-11 10:25:18 -0700738 a.noticeBuildActions(ctx)
Jaewoong Jung98772792019-07-01 17:15:13 -0700739 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
740 a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
741 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700742
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800743 // Process all building blocks, from AAPT to certificates.
744 a.aaptBuildActions(ctx)
745
Colin Cross50ddcc42019-05-16 12:28:22 -0700746 if a.usesLibrary.enforceUsesLibraries() {
747 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
748 apkDeps = append(apkDeps, manifestCheckFile)
749 }
750
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800751 a.proguardBuildActions(ctx)
752
753 dexJarFile := a.dexBuildActions(ctx)
754
Colin Crossc2d24052020-05-13 11:05:02 -0700755 jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800756 jniJarFile := a.jniBuildActions(jniLibs, ctx)
757
758 if ctx.Failed() {
759 return
760 }
761
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700762 certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
763 a.certificate = certificates[0]
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800764
765 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800766 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700767 v4SigningRequested := Bool(a.Module.deviceProperties.V4_signature)
768 var v4SignatureFile android.WritablePath = nil
769 if v4SigningRequested {
770 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+".apk.idsig")
771 }
Liz Kammer70dd74d2020-05-07 13:24:05 -0700772 var lineageFile android.Path
773 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
774 lineageFile = android.PathForModuleSrc(ctx, lineage)
775 }
776 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, v4SignatureFile, lineageFile)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800777 a.outputFile = packageFile
Songchun Fan17d69e32020-03-24 20:32:24 -0700778 if v4SigningRequested {
779 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
780 }
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800781
Colin Crosse560c4a2019-03-19 16:03:11 -0700782 for _, split := range a.aapt.splits {
783 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800784 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700785 if v4SigningRequested {
786 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk.idsig")
787 }
Liz Kammer70dd74d2020-05-07 13:24:05 -0700788 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, v4SignatureFile, lineageFile)
Colin Crosse560c4a2019-03-19 16:03:11 -0700789 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
Songchun Fan17d69e32020-03-24 20:32:24 -0700790 if v4SigningRequested {
791 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
792 }
Colin Crosse560c4a2019-03-19 16:03:11 -0700793 }
794
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800795 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700796 bundleFile := android.PathForModuleOut(ctx, "base.zip")
797 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
798 a.bundleFile = bundleFile
799
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800800 // Install the app package.
Jiyong Park8ba50f92019-11-13 15:01:01 +0900801 if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
802 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
803 for _, extra := range a.extraOutputFiles {
804 ctx.InstallFile(a.installDir, extra.Base(), extra)
805 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800806 }
Artur Satayev1111b842020-04-27 19:05:28 +0100807
808 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700809}
810
Colin Crossc2d24052020-05-13 11:05:02 -0700811type appDepsInterface interface {
812 sdkVersion() sdkSpec
813 minSdkVersion() sdkSpec
814 RequiresStableAPIs(ctx android.BaseModuleContext) bool
815}
816
817func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
818 shouldCollectRecursiveNativeDeps bool,
Colin Cross094cde42020-02-15 10:38:00 -0800819 checkNativeSdkVersion bool) ([]jniLib, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700820
Colin Crossa4f08812018-10-02 22:03:40 -0700821 var jniLibs []jniLib
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900822 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800823 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700824
Colin Crossc2d24052020-05-13 11:05:02 -0700825 if checkNativeSdkVersion {
826 checkNativeSdkVersion = app.sdkVersion().specified() &&
827 app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx)
828 }
829
Peter Collingbournead84f972019-12-17 16:46:18 -0800830 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700831 otherName := ctx.OtherModuleName(module)
832 tag := ctx.OtherModuleDependencyTag(module)
833
Peter Collingbournead84f972019-12-17 16:46:18 -0800834 if IsJniDepTag(tag) || tag == cc.SharedDepTag {
Colin Crossa4f08812018-10-02 22:03:40 -0700835 if dep, ok := module.(*cc.Module); ok {
Peter Collingbournead84f972019-12-17 16:46:18 -0800836 if dep.IsNdk() || dep.IsStubs() {
837 return false
838 }
839
Colin Crossa4f08812018-10-02 22:03:40 -0700840 lib := dep.OutputFile()
Peter Collingbournead84f972019-12-17 16:46:18 -0800841 path := lib.Path()
842 if seenModulePaths[path.String()] {
843 return false
844 }
845 seenModulePaths[path.String()] = true
846
Colin Crossc2d24052020-05-13 11:05:02 -0700847 if checkNativeSdkVersion && dep.SdkVersion() == "" {
848 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
849 otherName)
Colin Cross094cde42020-02-15 10:38:00 -0800850 }
851
Colin Crossa4f08812018-10-02 22:03:40 -0700852 if lib.Valid() {
853 jniLibs = append(jniLibs, jniLib{
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700854 name: ctx.OtherModuleName(module),
855 path: path,
856 target: module.Target(),
857 coverageFile: dep.CoverageOutputFile(),
Colin Crossa4f08812018-10-02 22:03:40 -0700858 })
859 } else {
860 ctx.ModuleErrorf("dependency %q missing output file", otherName)
861 }
862 } else {
863 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700864 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800865
866 return shouldCollectRecursiveNativeDeps
867 }
868
869 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700870 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900871 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700872 } else {
873 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
874 }
Colin Crossa4f08812018-10-02 22:03:40 -0700875 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800876
877 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700878 })
879
Colin Crossbd01e2a2018-10-04 15:21:03 -0700880 return jniLibs, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700881}
882
Artur Satayev1111b842020-04-27 19:05:28 +0100883func (a *AndroidApp) walkPayloadDeps(ctx android.ModuleContext,
884 do func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool)) {
885
886 ctx.WalkDeps(func(child, parent android.Module) bool {
887 isExternal := !a.DepIsInSameApex(ctx, child)
888 if am, ok := child.(android.ApexModule); ok {
889 do(ctx, parent, am, isExternal)
890 }
891 return !isExternal
892 })
893}
894
895func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
896 if ctx.Host() {
897 return
898 }
899
900 depsInfo := android.DepNameToDepInfoMap{}
901 a.walkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) {
902 depName := to.Name()
903 if info, exist := depsInfo[depName]; exist {
904 info.From = append(info.From, from.Name())
905 info.IsExternal = info.IsExternal && externalDep
906 depsInfo[depName] = info
907 } else {
908 toMinSdkVersion := "(no version)"
909 if m, ok := to.(interface{ MinSdkVersion() string }); ok {
910 if v := m.MinSdkVersion(); v != "" {
911 toMinSdkVersion = v
912 }
913 }
914 depsInfo[depName] = android.ApexModuleDepInfo{
915 To: depName,
916 From: []string{from.Name()},
917 IsExternal: externalDep,
918 MinSdkVersion: toMinSdkVersion,
919 }
920 }
921 })
922
923 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo)
924}
925
Artur Satayev849f8442020-04-28 14:57:42 +0100926func (a *AndroidApp) Updatable() bool {
927 return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable()
928}
929
Colin Cross0ea8ba82019-06-06 14:33:29 -0700930func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800931 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
932 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000933 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800934 }
Jaewoong Jung525443a2019-02-28 15:35:54 -0800935 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800936}
937
Jiyong Park0f80c182020-01-31 02:49:53 +0900938func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
939 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
940 return true
941 }
942 return a.Library.DepIsInSameApex(ctx, dep)
943}
944
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900945// For OutputFileProducer interface
946func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
947 switch tag {
948 case ".aapt.srcjar":
949 return []android.Path{a.aaptSrcJar}, nil
950 }
951 return a.Library.OutputFiles(tag)
952}
953
Jiyong Parkf7487312019-10-17 12:54:30 +0900954func (a *AndroidApp) Privileged() bool {
955 return Bool(a.appProperties.Privileged)
956}
957
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700958func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
959 return ctx.Device() && (ctx.DeviceConfig().NativeCoverageEnabled() || ctx.DeviceConfig().ClangCoverageEnabled())
960}
961
962func (a *AndroidApp) PreventInstall() {
963 a.appProperties.PreventInstall = true
964}
965
966func (a *AndroidApp) HideFromMake() {
967 a.appProperties.HideFromMake = true
968}
969
970func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
971 a.appProperties.IsCoverageVariant = coverage
972}
973
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400974func (a *AndroidApp) EnableCoverageIfNeeded() {}
975
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700976var _ cc.Coverage = (*AndroidApp)(nil)
977
Colin Cross1b16b0e2019-02-12 14:41:32 -0800978// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -0700979func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -0700980 module := &AndroidApp{}
981
Sasha Smundak2057f822019-04-16 17:16:58 -0700982 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross66dbc0b2017-12-28 12:23:20 -0800983 module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
984
Colin Crossae5caf52018-05-22 11:11:52 -0700985 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700986 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -0700987
Colin Cross36242852017-06-23 15:06:31 -0700988 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -0700989 &module.Module.properties,
990 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800991 &module.Module.dexpreoptProperties,
Colin Crossa97c5d32018-03-28 14:58:31 -0700992 &module.Module.protoProperties,
993 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800994 &module.appProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700995 &module.overridableAppProperties,
996 &module.usesLibrary.usesLibraryProperties)
Colin Cross36242852017-06-23 15:06:31 -0700997
Colin Crossa9d8bee2018-10-02 13:59:46 -0700998 module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool {
999 return class == android.Device && ctx.Config().DevicePrefer32BitApps()
1000 })
1001
Colin Crossa4f08812018-10-02 22:03:40 -07001002 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1003 android.InitDefaultableModule(module)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001004 android.InitOverridableModule(module, &module.appProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +09001005 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -07001006
Colin Cross36242852017-06-23 15:06:31 -07001007 return module
Colin Cross30e076a2015-04-13 13:58:27 -07001008}
Colin Crossae5caf52018-05-22 11:11:52 -07001009
1010type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -07001011 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -07001012 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001013
1014 // if specified, the instrumentation target package name in the manifest is overwritten by it.
1015 Instrumentation_target_package *string
Colin Crossae5caf52018-05-22 11:11:52 -07001016}
1017
1018type AndroidTest struct {
1019 AndroidApp
1020
1021 appTestProperties appTestProperties
1022
1023 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001024
1025 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001026 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -07001027}
1028
Jaewoong Jung0949f312019-09-11 10:25:18 -07001029func (a *AndroidTest) InstallInTestcases() bool {
1030 return true
1031}
1032
Colin Crossae5caf52018-05-22 11:11:52 -07001033func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001034 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001035 if a.appTestProperties.Instrumentation_target_package != nil {
1036 a.additionalAaptFlags = append(a.additionalAaptFlags,
1037 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1038 } else if a.appTestProperties.Instrumentation_for != nil {
1039 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001040 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1041 if overridden {
1042 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1043 }
1044 }
Colin Crossae5caf52018-05-22 11:11:52 -07001045 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001046
easoncylee5bcff5d2020-04-30 14:57:06 +08001047 for _, module := range a.testProperties.Test_mainline_modules {
1048 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1049 }
1050
Jaewoong Jung39982342020-01-14 10:27:18 -08001051 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001052 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001053 a.testConfig = a.FixTestConfig(ctx, testConfig)
Colin Cross8a497952019-03-05 22:25:09 -08001054 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001055}
1056
Jaewoong Jung39982342020-01-14 10:27:18 -08001057func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1058 if testConfig == nil {
1059 return nil
1060 }
1061
1062 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
1063 rule := android.NewRuleBuilder()
1064 command := rule.Command().BuiltTool(ctx, "test_config_fixer").Input(testConfig).Output(fixedConfig)
1065 fixNeeded := false
1066
1067 if ctx.ModuleName() != a.installApkName {
1068 fixNeeded = true
1069 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1070 }
1071
1072 if a.overridableAppProperties.Package_name != nil {
1073 fixNeeded = true
1074 command.FlagWithInput("--manifest ", a.manifestPath).
1075 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1076 }
1077
1078 if fixNeeded {
1079 rule.Build(pctx, ctx, "fix_test_config", "fix test config")
1080 return fixedConfig
1081 }
1082 return testConfig
1083}
1084
Colin Cross303e21f2018-08-07 16:49:25 -07001085func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001086 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001087}
1088
1089func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1090 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001091 if a.appTestProperties.Instrumentation_for != nil {
1092 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1093 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1094 // use instrumentationForTag instead of libTag.
1095 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1096 }
Colin Crossae5caf52018-05-22 11:11:52 -07001097}
1098
Colin Cross1b16b0e2019-02-12 14:41:32 -08001099// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1100// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001101func AndroidTestFactory() android.Module {
1102 module := &AndroidTest{}
1103
Sasha Smundak2057f822019-04-16 17:16:58 -07001104 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross5067db92018-09-17 16:46:35 -07001105
1106 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001107 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001108 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001109 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001110 module.Module.dexpreopter.isTest = true
Colin Crossae5caf52018-05-22 11:11:52 -07001111
1112 module.AddProperties(
1113 &module.Module.properties,
1114 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001115 &module.Module.dexpreoptProperties,
Colin Crossae5caf52018-05-22 11:11:52 -07001116 &module.Module.protoProperties,
1117 &module.aaptProperties,
1118 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001119 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001120 &module.overridableAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001121 &module.usesLibrary.usesLibraryProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001122 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001123
Colin Crossa4f08812018-10-02 22:03:40 -07001124 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1125 android.InitDefaultableModule(module)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001126 android.InitOverridableModule(module, &module.appProperties.Overrides)
Colin Crossae5caf52018-05-22 11:11:52 -07001127 return module
1128}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001129
Colin Cross252fc6f2018-10-04 15:22:03 -07001130type appTestHelperAppProperties struct {
1131 // list of compatibility suites (for example "cts", "vts") that the module should be
1132 // installed into.
1133 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001134
1135 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1136 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1137 // explicitly.
1138 Auto_gen_config *bool
Colin Cross252fc6f2018-10-04 15:22:03 -07001139}
1140
1141type AndroidTestHelperApp struct {
1142 AndroidApp
1143
1144 appTestHelperAppProperties appTestHelperAppProperties
1145}
1146
Jaewoong Jung326a9412019-11-21 10:41:00 -08001147func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1148 return true
1149}
1150
Colin Cross1b16b0e2019-02-12 14:41:32 -08001151// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1152// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1153// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001154func AndroidTestHelperAppFactory() android.Module {
1155 module := &AndroidTestHelperApp{}
1156
Sasha Smundak2057f822019-04-16 17:16:58 -07001157 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001158
1159 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001160 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001161 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001162 module.Module.dexpreopter.isTest = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001163
1164 module.AddProperties(
1165 &module.Module.properties,
1166 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001167 &module.Module.dexpreoptProperties,
Colin Cross252fc6f2018-10-04 15:22:03 -07001168 &module.Module.protoProperties,
1169 &module.aaptProperties,
1170 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001171 &module.appTestHelperAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001172 &module.overridableAppProperties,
1173 &module.usesLibrary.usesLibraryProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001174
1175 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1176 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001177 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001178 return module
1179}
1180
Colin Crossbd01e2a2018-10-04 15:21:03 -07001181type AndroidAppCertificate struct {
1182 android.ModuleBase
1183 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001184 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001185}
1186
1187type AndroidAppCertificateProperties struct {
1188 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1189 Certificate *string
1190}
1191
Colin Cross1b16b0e2019-02-12 14:41:32 -08001192// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1193// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001194func AndroidAppCertificateFactory() android.Module {
1195 module := &AndroidAppCertificate{}
1196 module.AddProperties(&module.properties)
1197 android.InitAndroidModule(module)
1198 return module
1199}
1200
Colin Crossbd01e2a2018-10-04 15:21:03 -07001201func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1202 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001203 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001204 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1205 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001206 }
1207}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001208
1209type OverrideAndroidApp struct {
1210 android.ModuleBase
1211 android.OverrideModuleBase
1212}
1213
Sasha Smundak613cbb12020-06-05 10:27:23 -07001214func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001215 // All the overrides happen in the base module.
1216 // TODO(jungjw): Check the base module type.
1217}
1218
1219// override_android_app is used to create an android_app module based on another android_app by overriding
1220// some of its properties.
1221func OverrideAndroidAppModuleFactory() android.Module {
1222 m := &OverrideAndroidApp{}
1223 m.AddProperties(&overridableAppProperties{})
1224
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001225 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001226 android.InitOverrideModule(m)
1227 return m
1228}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001229
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001230type OverrideAndroidTest struct {
1231 android.ModuleBase
1232 android.OverrideModuleBase
1233}
1234
Sasha Smundak613cbb12020-06-05 10:27:23 -07001235func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001236 // All the overrides happen in the base module.
1237 // TODO(jungjw): Check the base module type.
1238}
1239
1240// override_android_test is used to create an android_app module based on another android_test by overriding
1241// some of its properties.
1242func OverrideAndroidTestModuleFactory() android.Module {
1243 m := &OverrideAndroidTest{}
1244 m.AddProperties(&overridableAppProperties{})
1245 m.AddProperties(&appTestProperties{})
1246
1247 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1248 android.InitOverrideModule(m)
1249 return m
1250}
1251
Roshan Piusb8307962020-04-27 09:42:27 -07001252type OverrideRuntimeResourceOverlay struct {
1253 android.ModuleBase
1254 android.OverrideModuleBase
1255}
1256
Sasha Smundak613cbb12020-06-05 10:27:23 -07001257func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(_ android.ModuleContext) {
Roshan Piusb8307962020-04-27 09:42:27 -07001258 // All the overrides happen in the base module.
1259 // TODO(jungjw): Check the base module type.
1260}
1261
1262// override_runtime_resource_overlay is used to create a module based on another
1263// runtime_resource_overlay module by overriding some of its properties.
1264func OverrideRuntimeResourceOverlayModuleFactory() android.Module {
1265 m := &OverrideRuntimeResourceOverlay{}
1266 m.AddProperties(&OverridableRuntimeResourceOverlayProperties{})
1267
1268 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1269 android.InitOverrideModule(m)
1270 return m
1271}
1272
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001273type AndroidAppImport struct {
1274 android.ModuleBase
1275 android.DefaultableModuleBase
Jiyong Park592a6a42020-04-21 22:34:28 +09001276 android.ApexModuleBase
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001277 prebuilt android.Prebuilt
1278
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001279 properties AndroidAppImportProperties
1280 dpiVariants interface{}
1281 archVariants interface{}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001282
1283 outputFile android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001284 certificate Certificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001285
1286 dexpreopter
Colin Cross50ddcc42019-05-16 12:28:22 -07001287
1288 usesLibrary usesLibrary
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001289
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001290 preprocessed bool
1291
Colin Cross70dda7e2019-10-01 22:05:35 -07001292 installPath android.InstallPath
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001293}
1294
1295type AndroidAppImportProperties struct {
1296 // A prebuilt apk to import
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001297 Apk *string
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001298
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001299 // The name of a certificate in the default certificate directory or an android_app_certificate
1300 // module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001301 Certificate *string
1302
1303 // Set this flag to true if the prebuilt apk is already signed. The certificate property must not
1304 // be set for presigned modules.
1305 Presigned *bool
1306
Liz Kammer2bc57f62020-05-13 15:49:21 -07001307 // Name of the signing certificate lineage file.
1308 Lineage *string
1309
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001310 // Sign with the default system dev certificate. Must be used judiciously. Most imported apps
1311 // need to either specify a specific certificate or be presigned.
1312 Default_dev_cert *bool
1313
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001314 // Specifies that this app should be installed to the priv-app directory,
1315 // where the system will grant it additional privileges not available to
1316 // normal apps.
1317 Privileged *bool
1318
1319 // Names of modules to be overridden. Listed modules can only be other binaries
1320 // (in Make or Soong).
1321 // This does not completely prevent installation of the overridden binaries, but if both
1322 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
1323 // from PRODUCT_PACKAGES.
1324 Overrides []string
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001325
1326 // Optional name for the installed app. If unspecified, it is derived from the module name.
1327 Filename *string
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001328}
1329
Martin Stjernholm6d415272020-01-31 17:10:36 +00001330func (a *AndroidAppImport) IsInstallable() bool {
1331 return true
1332}
1333
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001334// Updates properties with variant-specific values.
1335func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001336 config := ctx.Config()
1337
1338 dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
1339 // Try DPI variant matches in the reverse-priority order so that the highest priority match
1340 // overwrites everything else.
1341 // TODO(jungjw): Can we optimize this by making it priority order?
1342 for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001343 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001344 }
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001345 if config.ProductAAPTPreferredConfig() != "" {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001346 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001347 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001348
1349 archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
1350 archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
1351 MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001352}
1353
Colin Cross1184b642019-12-30 18:43:07 -08001354func MergePropertiesFromVariant(ctx android.EarlyModuleContext,
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001355 dst interface{}, variantGroup reflect.Value, variant string) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001356 src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
1357 if !src.IsValid() {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001358 return
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001359 }
1360
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001361 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
1362 if err != nil {
1363 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1364 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1365 } else {
1366 panic(err)
1367 }
1368 }
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001369}
1370
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001371func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
1372 cert := android.SrcIsModule(String(a.properties.Certificate))
1373 if cert != "" {
1374 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1375 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001376
Paul Duffin250e6192019-06-07 10:44:37 +01001377 a.usesLibrary.deps(ctx, true)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001378}
1379
1380func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
1381 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001382 // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing
1383 // with them may invalidate pre-existing signature data.
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001384 if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001385 ctx.Build(pctx, android.BuildParams{
1386 Rule: android.Cp,
1387 Output: outputPath,
1388 Input: inputPath,
1389 })
1390 return
1391 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001392 rule := android.NewRuleBuilder()
1393 rule.Command().
1394 Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001395 BuiltTool(ctx, "zip2zip").
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001396 FlagWithInput("-i ", inputPath).
1397 FlagWithOutput("-o ", outputPath).
1398 FlagWithArg("-0 ", "'lib/**/*.so'").
1399 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1400 rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
1401}
1402
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001403// Returns whether this module should have the dex file stored uncompressed in the APK.
1404func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001405 if ctx.Config().UnbundledBuild() || a.preprocessed {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001406 return false
1407 }
1408
1409 // Uncompress dex in APKs of privileged apps
Jiyong Parkf7487312019-10-17 12:54:30 +09001410 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001411 return true
1412 }
1413
1414 return shouldUncompressDex(ctx, &a.dexpreopter)
1415}
1416
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001417func (a *AndroidAppImport) uncompressDex(
1418 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
1419 rule := android.NewRuleBuilder()
1420 rule.Command().
1421 Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001422 BuiltTool(ctx, "zip2zip").
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001423 FlagWithInput("-i ", inputPath).
1424 FlagWithOutput("-o ", outputPath).
1425 FlagWithArg("-0 ", "'classes*.dex'").
1426 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1427 rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
1428}
1429
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001430func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001431 a.generateAndroidBuildActions(ctx)
1432}
1433
Jooyung Han39ee1192020-03-23 20:21:11 +09001434func (a *AndroidAppImport) InstallApkName() string {
1435 return a.BaseModuleName()
1436}
1437
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001438func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001439 numCertPropsSet := 0
1440 if String(a.properties.Certificate) != "" {
1441 numCertPropsSet++
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001442 }
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001443 if Bool(a.properties.Presigned) {
1444 numCertPropsSet++
1445 }
1446 if Bool(a.properties.Default_dev_cert) {
1447 numCertPropsSet++
1448 }
1449 if numCertPropsSet != 1 {
1450 ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001451 }
1452
Colin Crossc2d24052020-05-13 11:05:02 -07001453 _, certificates := collectAppDeps(ctx, a, false, false)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001454
1455 // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001456 // TODO: LOCAL_PACKAGE_SPLITS
1457
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001458 srcApk := a.prebuilt.SingleSourcePath(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001459
1460 if a.usesLibrary.enforceUsesLibraries() {
1461 srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
1462 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001463
1464 // TODO: Install or embed JNI libraries
1465
1466 // Uncompress JNI libraries in the apk
1467 jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
1468 a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
1469
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001470 var installDir android.InstallPath
1471 if Bool(a.properties.Privileged) {
1472 installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001473 } else if ctx.InstallInTestcases() {
1474 installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch())
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001475 } else {
1476 installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
1477 }
1478
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001479 a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001480 a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001481 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001482
1483 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
1484 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
1485 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
1486 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
1487
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001488 dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001489 if a.dexpreopter.uncompressedDex {
1490 dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
1491 a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
1492 dexOutput = dexUncompressed
1493 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001494
Jooyung Han39ee1192020-03-23 20:21:11 +09001495 apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk")
1496
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001497 // TODO: Handle EXTERNAL
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001498
1499 // Sign or align the package if package has not been preprocessed
1500 if a.preprocessed {
1501 a.outputFile = srcApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001502 a.certificate = PresignedCertificate
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001503 } else if !Bool(a.properties.Presigned) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001504 // If the certificate property is empty at this point, default_dev_cert must be set to true.
1505 // Which makes processMainCert's behavior for the empty cert string WAI.
1506 certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001507 if len(certificates) != 1 {
1508 ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
1509 }
Colin Cross503c1d02020-01-28 14:00:53 -08001510 a.certificate = certificates[0]
Jooyung Han39ee1192020-03-23 20:21:11 +09001511 signed := android.PathForModuleOut(ctx, "signed", apkFilename)
Liz Kammer2bc57f62020-05-13 15:49:21 -07001512 var lineageFile android.Path
1513 if lineage := String(a.properties.Lineage); lineage != "" {
1514 lineageFile = android.PathForModuleSrc(ctx, lineage)
1515 }
1516 SignAppPackage(ctx, signed, dexOutput, certificates, nil, lineageFile)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001517 a.outputFile = signed
1518 } else {
Jooyung Han39ee1192020-03-23 20:21:11 +09001519 alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001520 TransformZipAlign(ctx, alignedApk, dexOutput)
1521 a.outputFile = alignedApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001522 a.certificate = PresignedCertificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001523 }
1524
1525 // TODO: Optionally compress the output apk.
1526
Jiyong Park592a6a42020-04-21 22:34:28 +09001527 if a.IsForPlatform() {
1528 a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile)
1529 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001530
1531 // TODO: androidmk converter jni libs
1532}
1533
1534func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
1535 return &a.prebuilt
1536}
1537
1538func (a *AndroidAppImport) Name() string {
1539 return a.prebuilt.Name(a.ModuleBase.Name())
1540}
1541
Dario Frenicde2a032019-10-27 00:29:22 +01001542func (a *AndroidAppImport) OutputFile() android.Path {
1543 return a.outputFile
1544}
1545
Jiyong Park618922e2020-01-08 13:35:43 +09001546func (a *AndroidAppImport) JacocoReportClassesFile() android.Path {
1547 return nil
1548}
1549
Colin Cross503c1d02020-01-28 14:00:53 -08001550func (a *AndroidAppImport) Certificate() Certificate {
1551 return a.certificate
1552}
1553
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001554var dpiVariantGroupType reflect.Type
1555var archVariantGroupType reflect.Type
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001556
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001557func initAndroidAppImportVariantGroupTypes() {
1558 dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
1559
1560 archNames := make([]string, len(android.ArchTypeList()))
1561 for i, archType := range android.ArchTypeList() {
1562 archNames[i] = archType.Name
1563 }
1564 archVariantGroupType = createVariantGroupType(archNames, "Arch")
1565}
1566
1567// Populates all variant struct properties at creation time.
1568func (a *AndroidAppImport) populateAllVariantStructs() {
1569 a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
1570 a.AddProperties(a.dpiVariants)
1571
1572 a.archVariants = reflect.New(archVariantGroupType).Interface()
1573 a.AddProperties(a.archVariants)
1574}
1575
Jiyong Parkf7487312019-10-17 12:54:30 +09001576func (a *AndroidAppImport) Privileged() bool {
1577 return Bool(a.properties.Privileged)
1578}
1579
Sasha Smundak613cbb12020-06-05 10:27:23 -07001580func (a *AndroidAppImport) DepIsInSameApex(_ android.BaseModuleContext, _ android.Module) bool {
Jiyong Park592a6a42020-04-21 22:34:28 +09001581 // android_app_import might have extra dependencies via uses_libs property.
1582 // Don't track the dependency as we don't automatically add those libraries
1583 // to the classpath. It should be explicitly added to java_libs property of APEX
1584 return false
1585}
1586
Colin Crossc2d24052020-05-13 11:05:02 -07001587func (a *AndroidAppImport) sdkVersion() sdkSpec {
1588 return sdkSpecFrom("")
1589}
1590
1591func (a *AndroidAppImport) minSdkVersion() sdkSpec {
1592 return sdkSpecFrom("")
1593}
1594
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001595func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
1596 props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
1597
1598 variantFields := make([]reflect.StructField, len(variants))
1599 for i, variant := range variants {
1600 variantFields[i] = reflect.StructField{
1601 Name: proptools.FieldNameForProperty(variant),
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001602 Type: props,
1603 }
1604 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001605
1606 variantGroupStruct := reflect.StructOf(variantFields)
1607 return reflect.StructOf([]reflect.StructField{
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001608 {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001609 Name: variantGroupName,
1610 Type: variantGroupStruct,
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001611 },
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001612 })
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001613}
1614
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001615// android_app_import imports a prebuilt apk with additional processing specified in the module.
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001616// DPI-specific apk source files can be specified using dpi_variants. Example:
1617//
1618// android_app_import {
1619// name: "example_import",
1620// apk: "prebuilts/example.apk",
1621// dpi_variants: {
1622// mdpi: {
1623// apk: "prebuilts/example_mdpi.apk",
1624// },
1625// xhdpi: {
1626// apk: "prebuilts/example_xhdpi.apk",
1627// },
1628// },
1629// certificate: "PRESIGNED",
1630// }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001631func AndroidAppImportFactory() android.Module {
1632 module := &AndroidAppImport{}
1633 module.AddProperties(&module.properties)
1634 module.AddProperties(&module.dexpreoptProperties)
Colin Cross50ddcc42019-05-16 12:28:22 -07001635 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001636 module.populateAllVariantStructs()
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001637 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001638 module.processVariants(ctx)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001639 })
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001640
Jiyong Park592a6a42020-04-21 22:34:28 +09001641 android.InitApexModule(module)
Jaewoong Jung6abfbf72020-05-26 20:10:08 -07001642 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1643 android.InitDefaultableModule(module)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001644 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001645
1646 return module
1647}
Colin Cross50ddcc42019-05-16 12:28:22 -07001648
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001649type androidTestImportProperties struct {
1650 // Whether the prebuilt apk can be installed without additional processing. Default is false.
1651 Preprocessed *bool
1652}
1653
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001654type AndroidTestImport struct {
1655 AndroidAppImport
1656
1657 testProperties testProperties
1658
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001659 testImportProperties androidTestImportProperties
1660
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001661 data android.Paths
1662}
1663
1664func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001665 a.preprocessed = Bool(a.testImportProperties.Preprocessed)
1666
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001667 a.generateAndroidBuildActions(ctx)
1668
1669 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
1670}
1671
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001672func (a *AndroidTestImport) InstallInTestcases() bool {
1673 return true
1674}
1675
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001676// android_test_import imports a prebuilt test apk with additional processing specified in the
1677// module. DPI or arch variant configurations can be made as with android_app_import.
1678func AndroidTestImportFactory() android.Module {
1679 module := &AndroidTestImport{}
1680 module.AddProperties(&module.properties)
1681 module.AddProperties(&module.dexpreoptProperties)
1682 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
1683 module.AddProperties(&module.testProperties)
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001684 module.AddProperties(&module.testImportProperties)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001685 module.populateAllVariantStructs()
1686 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1687 module.processVariants(ctx)
1688 })
1689
Colin Crossc80828d2020-05-06 22:29:10 -07001690 module.dexpreopter.isTest = true
1691
Jiyong Park592a6a42020-04-21 22:34:28 +09001692 android.InitApexModule(module)
Jaewoong Jung243688e2020-05-01 15:50:08 -07001693 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1694 android.InitDefaultableModule(module)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001695 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
1696
1697 return module
1698}
1699
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001700type RuntimeResourceOverlay struct {
1701 android.ModuleBase
1702 android.DefaultableModuleBase
Roshan Piusb8307962020-04-27 09:42:27 -07001703 android.OverridableModuleBase
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001704 aapt
1705
Roshan Piusb8307962020-04-27 09:42:27 -07001706 properties RuntimeResourceOverlayProperties
1707 overridableProperties OverridableRuntimeResourceOverlayProperties
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001708
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001709 certificate Certificate
1710
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001711 outputFile android.Path
1712 installDir android.InstallPath
1713}
1714
1715type RuntimeResourceOverlayProperties struct {
1716 // the name of a certificate in the default certificate directory or an android_app_certificate
1717 // module name in the form ":module".
1718 Certificate *string
1719
Liz Kammer7fe241f2020-05-19 16:15:25 -07001720 // Name of the signing certificate lineage file.
1721 Lineage *string
1722
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001723 // optional theme name. If specified, the overlay package will be applied
1724 // only when the ro.boot.vendor.overlay.theme system property is set to the same value.
1725 Theme *string
1726
1727 // if not blank, set to the version of the sdk to compile against.
1728 // Defaults to compiling against the current platform.
1729 Sdk_version *string
1730
1731 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
1732 // Defaults to sdk_version if not set.
1733 Min_sdk_version *string
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001734
1735 // list of android_library modules whose resources are extracted and linked against statically
1736 Static_libs []string
1737
1738 // list of android_app modules whose resources are extracted and linked against
1739 Resource_libs []string
Jaewoong Jungad0177b2020-04-24 15:22:40 -07001740
1741 // Names of modules to be overridden. Listed modules can only be other overlays
1742 // (in Make or Soong).
1743 // This does not completely prevent installation of the overridden overlays, but if both
1744 // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed
1745 // from PRODUCT_PACKAGES.
1746 Overrides []string
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001747}
1748
Jiyong Park69aeba92020-04-24 21:16:36 +09001749// RuntimeResourceOverlayModule interface is used by the apex package to gather information from
1750// a RuntimeResourceOverlay module.
1751type RuntimeResourceOverlayModule interface {
1752 android.Module
1753 OutputFile() android.Path
1754 Certificate() Certificate
1755 Theme() string
1756}
1757
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001758func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) {
1759 sdkDep := decodeSdkDep(ctx, sdkContext(r))
1760 if sdkDep.hasFrameworkLibs() {
1761 r.aapt.deps(ctx, sdkDep)
1762 }
1763
1764 cert := android.SrcIsModule(String(r.properties.Certificate))
1765 if cert != "" {
1766 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1767 }
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001768
1769 ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...)
1770 ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001771}
1772
1773func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1774 // Compile and link resources
1775 r.aapt.hasNoCode = true
Jaewoong Jungf0f747c2020-01-24 10:30:02 -08001776 // Do not remove resources without default values nor dedupe resource configurations with the same value
Roshan Piusb8307962020-04-27 09:42:27 -07001777 aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"}
1778 // Allow the override of "package name" and "overlay target package name"
1779 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
1780 if overridden || r.overridableProperties.Package_name != nil {
1781 // The product override variable has a priority over the package_name property.
1782 if !overridden {
1783 manifestPackageName = *r.overridableProperties.Package_name
1784 }
1785 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
1786 }
1787 if r.overridableProperties.Target_package_name != nil {
1788 aaptLinkFlags = append(aaptLinkFlags,
1789 "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name)
1790 }
1791 r.aapt.buildActions(ctx, r, aaptLinkFlags...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001792
1793 // Sign the built package
Colin Crossc2d24052020-05-13 11:05:02 -07001794 _, certificates := collectAppDeps(ctx, r, false, false)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001795 certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx)
1796 signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk")
Liz Kammer7fe241f2020-05-19 16:15:25 -07001797 var lineageFile android.Path
1798 if lineage := String(r.properties.Lineage); lineage != "" {
1799 lineageFile = android.PathForModuleSrc(ctx, lineage)
1800 }
1801 SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, nil, lineageFile)
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001802 r.certificate = certificates[0]
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001803
1804 r.outputFile = signed
1805 r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme))
1806 ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile)
1807}
1808
Jiyong Park6a927c42020-01-21 02:03:43 +09001809func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec {
1810 return sdkSpecFrom(String(r.properties.Sdk_version))
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001811}
1812
1813func (r *RuntimeResourceOverlay) systemModules() string {
1814 return ""
1815}
1816
Jiyong Park6a927c42020-01-21 02:03:43 +09001817func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001818 if r.properties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +09001819 return sdkSpecFrom(*r.properties.Min_sdk_version)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001820 }
1821 return r.sdkVersion()
1822}
1823
Jiyong Park6a927c42020-01-21 02:03:43 +09001824func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001825 return r.sdkVersion()
1826}
1827
Jiyong Park69aeba92020-04-24 21:16:36 +09001828func (r *RuntimeResourceOverlay) Certificate() Certificate {
1829 return r.certificate
1830}
1831
1832func (r *RuntimeResourceOverlay) OutputFile() android.Path {
1833 return r.outputFile
1834}
1835
1836func (r *RuntimeResourceOverlay) Theme() string {
1837 return String(r.properties.Theme)
1838}
1839
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001840// runtime_resource_overlay generates a resource-only apk file that can overlay application and
1841// system resources at run time.
1842func RuntimeResourceOverlayFactory() android.Module {
1843 module := &RuntimeResourceOverlay{}
1844 module.AddProperties(
1845 &module.properties,
Roshan Piusb8307962020-04-27 09:42:27 -07001846 &module.aaptProperties,
1847 &module.overridableProperties)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001848
Roshan Piusb8307962020-04-27 09:42:27 -07001849 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1850 android.InitDefaultableModule(module)
1851 android.InitOverridableModule(module, &module.properties.Overrides)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001852 return module
1853}
1854
Colin Cross50ddcc42019-05-16 12:28:22 -07001855type UsesLibraryProperties struct {
1856 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1857 Uses_libs []string
1858
1859 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1860 // required=false.
1861 Optional_uses_libs []string
1862
1863 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1864 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1865 Enforce_uses_libs *bool
1866}
1867
1868// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1869// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1870// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1871// with knowledge of their shared libraries.
1872type usesLibrary struct {
1873 usesLibraryProperties UsesLibraryProperties
1874}
1875
Paul Duffin250e6192019-06-07 10:44:37 +01001876func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
Colin Cross3245b2c2019-06-07 13:18:09 -07001877 if !ctx.Config().UnbundledBuild() {
1878 ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
1879 ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
Paul Duffin250e6192019-06-07 10:44:37 +01001880 // Only add these extra dependencies if the module depends on framework libs. This avoids
1881 // creating a cyclic dependency:
1882 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
1883 if hasFrameworkLibs {
Colin Cross3245b2c2019-06-07 13:18:09 -07001884 // dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs
1885 // to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each
1886 // library to dexpreopt.
1887 ctx.AddVariationDependencies(nil, usesLibTag,
1888 "org.apache.http.legacy",
1889 "android.hidl.base-V1.0-java",
1890 "android.hidl.manager-V1.0-java")
Ulya Trafimovichc9af5382020-05-29 15:35:06 +01001891 ctx.AddVariationDependencies(nil, usesLibTag, optionalUsesLibs...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001892 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001893 }
1894}
1895
1896// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
1897// build.
1898func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
1899 optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
1900 return optionalUsesLibs
1901}
1902
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001903// usesLibraryPaths returns a map of module names of shared library dependencies to the paths
1904// to their dex jars on host and on device.
1905func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) dexpreopt.LibraryPaths {
1906 usesLibPaths := make(dexpreopt.LibraryPaths)
Colin Cross50ddcc42019-05-16 12:28:22 -07001907
1908 if !ctx.Config().UnbundledBuild() {
1909 ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001910 dep := ctx.OtherModuleName(m)
Colin Cross50ddcc42019-05-16 12:28:22 -07001911 if lib, ok := m.(Dependency); ok {
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00001912 if dexJar := lib.DexJarBuildPath(); dexJar != nil {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001913 usesLibPaths[dep] = &dexpreopt.LibraryPath{
1914 dexJar,
1915 // TODO(b/132357300): propagate actual install paths here.
1916 filepath.Join("/system/framework", dep+".jar"),
1917 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001918 } else {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001919 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must"+
1920 " produce a dex jar, does it have installable: true?", dep)
Colin Cross50ddcc42019-05-16 12:28:22 -07001921 }
1922 } else if ctx.Config().AllowMissingDependencies() {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001923 ctx.AddMissingDependencies([]string{dep})
Colin Cross50ddcc42019-05-16 12:28:22 -07001924 } else {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001925 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be "+
1926 "a java library", dep)
Colin Cross50ddcc42019-05-16 12:28:22 -07001927 }
1928 })
1929 }
1930
1931 return usesLibPaths
1932}
1933
1934// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1935// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1936// unconditionally in the future.
1937func (u *usesLibrary) enforceUsesLibraries() bool {
1938 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1939 len(u.usesLibraryProperties.Optional_uses_libs) > 0
1940 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
1941}
1942
1943// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
1944// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
1945func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1946 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
1947
1948 rule := android.NewRuleBuilder()
Colin Crossee94d6a2019-07-08 17:08:34 -07001949 cmd := rule.Command().BuiltTool(ctx, "manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001950 Flag("--enforce-uses-libraries").
1951 Input(manifest).
1952 FlagWithOutput("-o ", outputFile)
1953
1954 for _, lib := range u.usesLibraryProperties.Uses_libs {
1955 cmd.FlagWithArg("--uses-library ", lib)
1956 }
1957
1958 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1959 cmd.FlagWithArg("--optional-uses-library ", lib)
1960 }
1961
1962 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1963
1964 return outputFile
1965}
1966
1967// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
1968// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
1969func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
1970 outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
1971
1972 rule := android.NewRuleBuilder()
1973 aapt := ctx.Config().HostToolPath(ctx, "aapt")
1974 rule.Command().
1975 Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
1976 Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
1977 Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
1978 Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
1979 rule.Command().Text("cp -f").Input(apk).Output(outputFile)
1980
1981 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1982
1983 return outputFile
1984}