blob: 37a6453cdd8b33074ea31cd3ad1b2fb7849a65a7 [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 Pius4df2bc72020-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.
Sasha Smundak57f0ee12020-06-15 18:25:27 -0700136 as.masterFile = as.BaseModuleName() + ".apk"
Sasha Smundaka7856c02020-04-23 09:49:59 -0700137 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(),
Sasha Smundake88b4362020-06-22 16:53:33 -0700154 "stem": as.BaseModuleName(),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700155 },
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 Cross7204cf02020-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 Cross7204cf02020-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 Kammere2b27f42020-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 Pius4df2bc72020-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 Cross7204cf02020-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 Han749dc692020-04-15 11:03:39 +0900424
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900425 if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil {
426 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +0900427 android.CheckMinSdkVersion(a, ctx, int(minSdkVersion))
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900428 } else {
429 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
430 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100431 }
432
433 a.checkPlatformAPI(ctx)
434 a.checkSdkVersions(ctx)
435}
436
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900437// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
438// This check is enforced for "updatable" APKs (including APK-in-APEX).
439// b/155209650: until min_sdk_version is properly supported, use sdk_version instead.
440// because, sdk_version is overridden by min_sdk_version (if set as smaller)
441// and linkType is checked with dependencies so we can be sure that the whole dependency tree
442// will meet the requirements.
443func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) {
444 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
445 ctx.VisitDirectDeps(func(m android.Module) {
446 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
447 return
448 }
449 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900450 // The domain of cc.sdk_version is "current" and <number>
451 // We can rely on sdkSpec to convert it to <number> so that "current" is handled
452 // properly regardless of sdk finalization.
453 jniSdkVersion, err := sdkSpecFrom(dep.SdkVersion()).effectiveVersion(ctx)
454 if err != nil || minSdkVersion < jniSdkVersion {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900455 ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
456 dep.SdkVersion(), minSdkVersion, ctx.ModuleName())
457 return
458 }
459
460 })
461}
462
Sasha Smundak6ad77252019-05-01 13:16:22 -0700463// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800464// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700465func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park6a927c42020-01-21 02:03:43 +0900466 minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800467 if err != nil {
468 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
469 }
470
Jiyong Park52cd06f2019-11-11 10:14:32 +0900471 return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
472 !a.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800473}
474
Colin Cross43f08db2018-11-12 10:13:39 -0800475// Returns whether this module should have the dex file stored uncompressed in the APK.
476func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800477 if Bool(a.appProperties.Use_embedded_dex) {
478 return true
479 }
480
Colin Cross53a87f52019-06-25 13:35:30 -0700481 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
482 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900483 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000484 return true
485 }
486
Colin Cross53a87f52019-06-25 13:35:30 -0700487 if ctx.Config().UnbundledBuild() {
488 return false
489 }
490
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700491 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700492}
493
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700494func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
495 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Jiyong Park52cd06f2019-11-11 10:14:32 +0900496 !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700497}
498
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900499func (a *AndroidApp) OverriddenManifestPackageName() string {
500 return a.overriddenManifestPackageName
501}
502
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800503func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
David Brazdild25060a2019-02-18 18:24:16 +0000504 a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
505
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700506 // Ask manifest_fixer to add or update the application element indicating this app has no code.
507 a.aapt.hasNoCode = !a.hasCode(ctx)
508
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800509 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800510
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800511 // 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 -0800512 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700513 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800514 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700515 }
516
Dan Willemsen72be5902018-10-24 20:24:57 -0700517 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
518 // Product AAPT config
519 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800520 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700521 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700522
Dan Willemsen72be5902018-10-24 20:24:57 -0700523 // Product AAPT preferred config
524 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800525 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700526 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700527 }
528
Jiyong Park7f67f482019-01-05 12:57:48 +0900529 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700530 if overridden || a.overridableAppProperties.Package_name != nil {
531 // The product override variable has a priority over the package_name property.
532 if !overridden {
533 manifestPackageName = *a.overridableAppProperties.Package_name
534 }
Liz Kammer1d5983b2020-05-19 19:15:37 +0000535 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900536 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900537 }
538
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800539 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
540
Colin Crosse560c4a2019-03-19 16:03:11 -0700541 a.aapt.splitNames = a.appProperties.Package_splits
Colin Cross50ddcc42019-05-16 12:28:22 -0700542 a.aapt.sdkLibraries = a.exportedSdkLibs
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800543 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800544 a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
Colin Cross30e076a2015-04-13 13:58:27 -0700545
Colin Cross46c9b8b2017-06-22 16:51:17 -0700546 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700547 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800548}
Colin Cross30e076a2015-04-13 13:58:27 -0700549
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800550func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700551 var staticLibProguardFlagFiles android.Paths
552 ctx.VisitDirectDeps(func(m android.Module) {
553 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
554 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
555 }
556 })
557
558 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
559
560 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
561 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800562}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800563
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800564func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross43f08db2018-11-12 10:13:39 -0800565
566 var installDir string
567 if ctx.ModuleName() == "framework-res" {
568 // framework-res.apk is installed as system/framework/framework-res.apk
569 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900570 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800571 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800572 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800573 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800574 }
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800575 a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
David Srbeckye033cba2020-05-20 22:20:28 +0100576 if a.deviceProperties.Uncompress_dex == nil {
577 // If the value was not force-set by the user, use reasonable default based on the module.
578 a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
579 }
580 a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700581 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
582 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
583 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
584 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
585 a.dexpreopter.manifestFile = a.mergedManifestFile
586
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800587 if ctx.ModuleName() != "framework-res" {
588 a.Module.compile(ctx, a.aaptSrcJar)
589 }
Colin Cross30e076a2015-04-13 13:58:27 -0700590
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800591 return a.maybeStrippedDexJarFile
592}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800593
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800594func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700595 var jniJarFile android.WritablePath
Colin Crossa4f08812018-10-02 22:03:40 -0700596 if len(jniLibs) > 0 {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700597 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700598 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Sasha Smundak6ad77252019-05-01 13:16:22 -0700599 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700600 for _, jni := range jniLibs {
601 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700602 // Only collect coverage for the first target arch if this is a multilib target.
603 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
604 // data file path collisions since the current coverage file path format doesn't contain
605 // arch-related strings. This is fine for now though; the code coverage team doesn't use
606 // multi-arch targets such as test_suite_* for coverage collections yet.
607 //
608 // Work with the team to come up with a new format that handles multilib modules properly
609 // and change this.
610 if len(ctx.Config().Targets[android.Android]) == 1 ||
611 ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType {
612 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
613 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700614 }
615 }
Colin Crossa4f08812018-10-02 22:03:40 -0700616 } else {
617 a.installJniLibs = jniLibs
618 }
619 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800620 return jniJarFile
621}
Colin Crossa4f08812018-10-02 22:03:40 -0700622
Jaewoong Jung0949f312019-09-11 10:25:18 -0700623func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700624 // Collect NOTICE files from all dependencies.
625 seenModules := make(map[android.Module]bool)
626 noticePathSet := make(map[android.Path]bool)
627
628 ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
629 // Have we already seen this?
630 if _, ok := seenModules[child]; ok {
631 return false
632 }
633 seenModules[child] = true
634
635 // Skip host modules.
636 if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
637 return false
638 }
639
Bob Badoura75b0572020-02-18 20:21:55 -0800640 paths := child.(android.Module).NoticeFiles()
641 if len(paths) > 0 {
642 for _, path := range paths {
643 noticePathSet[path] = true
644 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700645 }
646 return true
647 })
648
649 // If the app has one, add it too.
Bob Badoura75b0572020-02-18 20:21:55 -0800650 if len(a.NoticeFiles()) > 0 {
651 for _, path := range a.NoticeFiles() {
652 noticePathSet[path] = true
653 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700654 }
655
656 if len(noticePathSet) == 0 {
Jaewoong Jung98772792019-07-01 17:15:13 -0700657 return
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700658 }
659 var noticePaths []android.Path
660 for path := range noticePathSet {
661 noticePaths = append(noticePaths, path)
662 }
663 sort.Slice(noticePaths, func(i, j int) bool {
664 return noticePaths[i].String() < noticePaths[j].String()
665 })
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700666
Jaewoong Jung0949f312019-09-11 10:25:18 -0700667 a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700668}
669
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700670// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
671// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
672func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
673 if android.SrcIsModule(certPropValue) == "" {
674 var mainCert Certificate
675 if certPropValue != "" {
676 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
677 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800678 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
679 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700680 }
681 } else {
682 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800683 mainCert = Certificate{
684 Pem: pem,
685 Key: key,
686 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700687 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700688 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700689 }
690
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700691 if !m.Platform() {
692 certPath := certificates[0].Pem.String()
Jeongik Chac9464142019-01-07 12:07:27 +0900693 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
694 if strings.HasPrefix(certPath, systemCertPath) {
695 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
Colin Cross440e0d02020-06-11 11:32:11 -0700696 allowed := ctx.Config().EnforceSystemCertificateAllowList()
Jeongik Chac9464142019-01-07 12:07:27 +0900697
Colin Cross440e0d02020-06-11 11:32:11 -0700698 if enforceSystemCert && !inList(m.Name(), allowed) {
Jeongik Chac9464142019-01-07 12:07:27 +0900699 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
700 }
701 }
702 }
703
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700704 return certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800705}
706
Jooyung Han39ee1192020-03-23 20:21:11 +0900707func (a *AndroidApp) InstallApkName() string {
708 return a.installApkName
709}
710
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800711func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700712 var apkDeps android.Paths
713
Jeongik Cha538c0d02019-07-11 15:54:27 +0900714 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
715 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
716
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800717 // Check if the install APK name needs to be overridden.
Jaewoong Jung525443a2019-02-28 15:35:54 -0800718 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800719
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700720 if ctx.ModuleName() == "framework-res" {
721 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700722 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900723 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700724 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
725 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800726 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700727 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700728 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700729 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700730 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700731
Jaewoong Jung0949f312019-09-11 10:25:18 -0700732 a.noticeBuildActions(ctx)
Jaewoong Jung98772792019-07-01 17:15:13 -0700733 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
734 a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
735 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700736
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800737 // Process all building blocks, from AAPT to certificates.
738 a.aaptBuildActions(ctx)
739
Colin Cross50ddcc42019-05-16 12:28:22 -0700740 if a.usesLibrary.enforceUsesLibraries() {
741 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
742 apkDeps = append(apkDeps, manifestCheckFile)
743 }
744
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800745 a.proguardBuildActions(ctx)
746
Colin Cross014489c2020-06-02 20:09:13 -0700747 a.linter.mergedManifest = a.aapt.mergedManifestFile
748 a.linter.manifest = a.aapt.manifestPath
749 a.linter.resources = a.aapt.resourceFiles
750
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800751 dexJarFile := a.dexBuildActions(ctx)
752
Colin Crossc2d24052020-05-13 11:05:02 -0700753 jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800754 jniJarFile := a.jniBuildActions(jniLibs, ctx)
755
756 if ctx.Failed() {
757 return
758 }
759
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700760 certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
761 a.certificate = certificates[0]
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800762
763 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800764 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700765 var lineageFile android.Path
766 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
767 lineageFile = android.PathForModuleSrc(ctx, lineage)
768 }
769 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, lineageFile)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800770 a.outputFile = packageFile
771
Colin Crosse560c4a2019-03-19 16:03:11 -0700772 for _, split := range a.aapt.splits {
773 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800774 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700775 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, lineageFile)
Colin Crosse560c4a2019-03-19 16:03:11 -0700776 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
777 }
778
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800779 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700780 bundleFile := android.PathForModuleOut(ctx, "base.zip")
781 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
782 a.bundleFile = bundleFile
783
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800784 // Install the app package.
Jiyong Park8ba50f92019-11-13 15:01:01 +0900785 if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
786 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
787 for _, extra := range a.extraOutputFiles {
788 ctx.InstallFile(a.installDir, extra.Base(), extra)
789 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800790 }
Artur Satayev1111b842020-04-27 19:05:28 +0100791
792 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700793}
794
Colin Crossc2d24052020-05-13 11:05:02 -0700795type appDepsInterface interface {
796 sdkVersion() sdkSpec
797 minSdkVersion() sdkSpec
798 RequiresStableAPIs(ctx android.BaseModuleContext) bool
799}
800
801func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
802 shouldCollectRecursiveNativeDeps bool,
Colin Cross094cde42020-02-15 10:38:00 -0800803 checkNativeSdkVersion bool) ([]jniLib, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700804
Colin Crossa4f08812018-10-02 22:03:40 -0700805 var jniLibs []jniLib
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900806 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800807 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700808
Colin Crossc2d24052020-05-13 11:05:02 -0700809 if checkNativeSdkVersion {
810 checkNativeSdkVersion = app.sdkVersion().specified() &&
811 app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx)
812 }
813
Peter Collingbournead84f972019-12-17 16:46:18 -0800814 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700815 otherName := ctx.OtherModuleName(module)
816 tag := ctx.OtherModuleDependencyTag(module)
817
Peter Collingbournead84f972019-12-17 16:46:18 -0800818 if IsJniDepTag(tag) || tag == cc.SharedDepTag {
Colin Crossa4f08812018-10-02 22:03:40 -0700819 if dep, ok := module.(*cc.Module); ok {
Peter Collingbournead84f972019-12-17 16:46:18 -0800820 if dep.IsNdk() || dep.IsStubs() {
821 return false
822 }
823
Colin Crossa4f08812018-10-02 22:03:40 -0700824 lib := dep.OutputFile()
Peter Collingbournead84f972019-12-17 16:46:18 -0800825 path := lib.Path()
826 if seenModulePaths[path.String()] {
827 return false
828 }
829 seenModulePaths[path.String()] = true
830
Colin Crossc2d24052020-05-13 11:05:02 -0700831 if checkNativeSdkVersion && dep.SdkVersion() == "" {
832 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
833 otherName)
Colin Cross094cde42020-02-15 10:38:00 -0800834 }
835
Colin Crossa4f08812018-10-02 22:03:40 -0700836 if lib.Valid() {
837 jniLibs = append(jniLibs, jniLib{
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700838 name: ctx.OtherModuleName(module),
839 path: path,
840 target: module.Target(),
841 coverageFile: dep.CoverageOutputFile(),
Colin Crossa4f08812018-10-02 22:03:40 -0700842 })
843 } else {
844 ctx.ModuleErrorf("dependency %q missing output file", otherName)
845 }
846 } else {
847 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700848 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800849
850 return shouldCollectRecursiveNativeDeps
851 }
852
853 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700854 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900855 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700856 } else {
857 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
858 }
Colin Crossa4f08812018-10-02 22:03:40 -0700859 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800860
861 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700862 })
863
Colin Crossbd01e2a2018-10-04 15:21:03 -0700864 return jniLibs, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700865}
866
Jooyung Han749dc692020-04-15 11:03:39 +0900867func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +0100868 ctx.WalkDeps(func(child, parent android.Module) bool {
869 isExternal := !a.DepIsInSameApex(ctx, child)
870 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +0900871 if !do(ctx, parent, am, isExternal) {
872 return false
873 }
Artur Satayev1111b842020-04-27 19:05:28 +0100874 }
875 return !isExternal
876 })
877}
878
879func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
880 if ctx.Host() {
881 return
882 }
883
884 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +0900885 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +0100886 depName := to.Name()
887 if info, exist := depsInfo[depName]; exist {
888 info.From = append(info.From, from.Name())
889 info.IsExternal = info.IsExternal && externalDep
890 depsInfo[depName] = info
891 } else {
892 toMinSdkVersion := "(no version)"
893 if m, ok := to.(interface{ MinSdkVersion() string }); ok {
894 if v := m.MinSdkVersion(); v != "" {
895 toMinSdkVersion = v
896 }
897 }
898 depsInfo[depName] = android.ApexModuleDepInfo{
899 To: depName,
900 From: []string{from.Name()},
901 IsExternal: externalDep,
902 MinSdkVersion: toMinSdkVersion,
903 }
904 }
Jooyung Han749dc692020-04-15 11:03:39 +0900905 return true
Artur Satayev1111b842020-04-27 19:05:28 +0100906 })
907
908 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo)
909}
910
Artur Satayev849f8442020-04-28 14:57:42 +0100911func (a *AndroidApp) Updatable() bool {
912 return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable()
913}
914
Colin Cross0ea8ba82019-06-06 14:33:29 -0700915func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800916 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
917 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000918 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800919 }
Jaewoong Jung525443a2019-02-28 15:35:54 -0800920 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800921}
922
Jiyong Park0f80c182020-01-31 02:49:53 +0900923func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
924 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
925 return true
926 }
927 return a.Library.DepIsInSameApex(ctx, dep)
928}
929
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900930// For OutputFileProducer interface
931func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
932 switch tag {
933 case ".aapt.srcjar":
934 return []android.Path{a.aaptSrcJar}, nil
935 }
936 return a.Library.OutputFiles(tag)
937}
938
Jiyong Parkf7487312019-10-17 12:54:30 +0900939func (a *AndroidApp) Privileged() bool {
940 return Bool(a.appProperties.Privileged)
941}
942
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700943func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -0700944 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700945}
946
947func (a *AndroidApp) PreventInstall() {
948 a.appProperties.PreventInstall = true
949}
950
951func (a *AndroidApp) HideFromMake() {
952 a.appProperties.HideFromMake = true
953}
954
955func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
956 a.appProperties.IsCoverageVariant = coverage
957}
958
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400959func (a *AndroidApp) EnableCoverageIfNeeded() {}
960
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700961var _ cc.Coverage = (*AndroidApp)(nil)
962
Colin Cross1b16b0e2019-02-12 14:41:32 -0800963// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -0700964func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -0700965 module := &AndroidApp{}
966
Sasha Smundak2057f822019-04-16 17:16:58 -0700967 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross66dbc0b2017-12-28 12:23:20 -0800968 module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
969
Colin Crossae5caf52018-05-22 11:11:52 -0700970 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700971 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -0700972
Colin Crossce6734e2020-06-15 16:09:53 -0700973 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -0700974 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700975 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800976 &module.appProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700977 &module.overridableAppProperties,
978 &module.usesLibrary.usesLibraryProperties)
Colin Cross36242852017-06-23 15:06:31 -0700979
Colin Crossa4f08812018-10-02 22:03:40 -0700980 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
981 android.InitDefaultableModule(module)
Jaewoong Jung525443a2019-02-28 15:35:54 -0800982 android.InitOverridableModule(module, &module.appProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +0900983 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -0700984
Colin Cross36242852017-06-23 15:06:31 -0700985 return module
Colin Cross30e076a2015-04-13 13:58:27 -0700986}
Colin Crossae5caf52018-05-22 11:11:52 -0700987
988type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -0700989 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -0700990 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -0700991
992 // if specified, the instrumentation target package name in the manifest is overwritten by it.
993 Instrumentation_target_package *string
Colin Crossae5caf52018-05-22 11:11:52 -0700994}
995
996type AndroidTest struct {
997 AndroidApp
998
999 appTestProperties appTestProperties
1000
1001 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001002
1003 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001004 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -07001005}
1006
Jaewoong Jung0949f312019-09-11 10:25:18 -07001007func (a *AndroidTest) InstallInTestcases() bool {
1008 return true
1009}
1010
Colin Crossae5caf52018-05-22 11:11:52 -07001011func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001012 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001013 if a.appTestProperties.Instrumentation_target_package != nil {
1014 a.additionalAaptFlags = append(a.additionalAaptFlags,
1015 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1016 } else if a.appTestProperties.Instrumentation_for != nil {
1017 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001018 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1019 if overridden {
1020 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1021 }
1022 }
Colin Crossae5caf52018-05-22 11:11:52 -07001023 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001024
easoncylee5bcff5d2020-04-30 14:57:06 +08001025 for _, module := range a.testProperties.Test_mainline_modules {
1026 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1027 }
1028
Jaewoong Jung39982342020-01-14 10:27:18 -08001029 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001030 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001031 a.testConfig = a.FixTestConfig(ctx, testConfig)
Colin Cross8a497952019-03-05 22:25:09 -08001032 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001033}
1034
Jaewoong Jung39982342020-01-14 10:27:18 -08001035func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1036 if testConfig == nil {
1037 return nil
1038 }
1039
1040 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
1041 rule := android.NewRuleBuilder()
1042 command := rule.Command().BuiltTool(ctx, "test_config_fixer").Input(testConfig).Output(fixedConfig)
1043 fixNeeded := false
1044
1045 if ctx.ModuleName() != a.installApkName {
1046 fixNeeded = true
1047 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1048 }
1049
1050 if a.overridableAppProperties.Package_name != nil {
1051 fixNeeded = true
1052 command.FlagWithInput("--manifest ", a.manifestPath).
1053 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1054 }
1055
1056 if fixNeeded {
1057 rule.Build(pctx, ctx, "fix_test_config", "fix test config")
1058 return fixedConfig
1059 }
1060 return testConfig
1061}
1062
Colin Cross303e21f2018-08-07 16:49:25 -07001063func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001064 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001065}
1066
1067func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1068 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001069 if a.appTestProperties.Instrumentation_for != nil {
1070 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1071 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1072 // use instrumentationForTag instead of libTag.
1073 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1074 }
Colin Crossae5caf52018-05-22 11:11:52 -07001075}
1076
Colin Cross1b16b0e2019-02-12 14:41:32 -08001077// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1078// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001079func AndroidTestFactory() android.Module {
1080 module := &AndroidTest{}
1081
Sasha Smundak2057f822019-04-16 17:16:58 -07001082 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross5067db92018-09-17 16:46:35 -07001083
1084 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001085 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001086 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001087 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001088 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07001089 module.Module.linter.test = true
Colin Crossae5caf52018-05-22 11:11:52 -07001090
Colin Crossce6734e2020-06-15 16:09:53 -07001091 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001092 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001093 &module.aaptProperties,
1094 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001095 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001096 &module.overridableAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001097 &module.usesLibrary.usesLibraryProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001098 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001099
Colin Crossa4f08812018-10-02 22:03:40 -07001100 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1101 android.InitDefaultableModule(module)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001102 android.InitOverridableModule(module, &module.appProperties.Overrides)
Colin Crossae5caf52018-05-22 11:11:52 -07001103 return module
1104}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001105
Colin Cross252fc6f2018-10-04 15:22:03 -07001106type appTestHelperAppProperties struct {
1107 // list of compatibility suites (for example "cts", "vts") that the module should be
1108 // installed into.
1109 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001110
1111 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1112 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1113 // explicitly.
1114 Auto_gen_config *bool
Colin Cross252fc6f2018-10-04 15:22:03 -07001115}
1116
1117type AndroidTestHelperApp struct {
1118 AndroidApp
1119
1120 appTestHelperAppProperties appTestHelperAppProperties
1121}
1122
Jaewoong Jung326a9412019-11-21 10:41:00 -08001123func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1124 return true
1125}
1126
Colin Cross1b16b0e2019-02-12 14:41:32 -08001127// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1128// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1129// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001130func AndroidTestHelperAppFactory() android.Module {
1131 module := &AndroidTestHelperApp{}
1132
Sasha Smundak2057f822019-04-16 17:16:58 -07001133 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001134
1135 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001136 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001137 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001138 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07001139 module.Module.linter.test = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001140
Colin Crossce6734e2020-06-15 16:09:53 -07001141 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001142 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001143 &module.aaptProperties,
1144 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001145 &module.appTestHelperAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001146 &module.overridableAppProperties,
1147 &module.usesLibrary.usesLibraryProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001148
1149 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1150 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001151 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001152 return module
1153}
1154
Colin Crossbd01e2a2018-10-04 15:21:03 -07001155type AndroidAppCertificate struct {
1156 android.ModuleBase
1157 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001158 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001159}
1160
1161type AndroidAppCertificateProperties struct {
1162 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1163 Certificate *string
1164}
1165
Colin Cross1b16b0e2019-02-12 14:41:32 -08001166// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1167// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001168func AndroidAppCertificateFactory() android.Module {
1169 module := &AndroidAppCertificate{}
1170 module.AddProperties(&module.properties)
1171 android.InitAndroidModule(module)
1172 return module
1173}
1174
Colin Crossbd01e2a2018-10-04 15:21:03 -07001175func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1176 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001177 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001178 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1179 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001180 }
1181}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001182
1183type OverrideAndroidApp struct {
1184 android.ModuleBase
1185 android.OverrideModuleBase
1186}
1187
Sasha Smundak613cbb12020-06-05 10:27:23 -07001188func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001189 // All the overrides happen in the base module.
1190 // TODO(jungjw): Check the base module type.
1191}
1192
1193// override_android_app is used to create an android_app module based on another android_app by overriding
1194// some of its properties.
1195func OverrideAndroidAppModuleFactory() android.Module {
1196 m := &OverrideAndroidApp{}
1197 m.AddProperties(&overridableAppProperties{})
1198
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001199 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001200 android.InitOverrideModule(m)
1201 return m
1202}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001203
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001204type OverrideAndroidTest struct {
1205 android.ModuleBase
1206 android.OverrideModuleBase
1207}
1208
Sasha Smundak613cbb12020-06-05 10:27:23 -07001209func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001210 // All the overrides happen in the base module.
1211 // TODO(jungjw): Check the base module type.
1212}
1213
1214// override_android_test is used to create an android_app module based on another android_test by overriding
1215// some of its properties.
1216func OverrideAndroidTestModuleFactory() android.Module {
1217 m := &OverrideAndroidTest{}
1218 m.AddProperties(&overridableAppProperties{})
1219 m.AddProperties(&appTestProperties{})
1220
1221 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1222 android.InitOverrideModule(m)
1223 return m
1224}
1225
Roshan Pius4df2bc72020-04-27 09:42:27 -07001226type OverrideRuntimeResourceOverlay struct {
1227 android.ModuleBase
1228 android.OverrideModuleBase
1229}
1230
Sasha Smundak613cbb12020-06-05 10:27:23 -07001231func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(_ android.ModuleContext) {
Roshan Pius4df2bc72020-04-27 09:42:27 -07001232 // All the overrides happen in the base module.
1233 // TODO(jungjw): Check the base module type.
1234}
1235
1236// override_runtime_resource_overlay is used to create a module based on another
1237// runtime_resource_overlay module by overriding some of its properties.
1238func OverrideRuntimeResourceOverlayModuleFactory() android.Module {
1239 m := &OverrideRuntimeResourceOverlay{}
1240 m.AddProperties(&OverridableRuntimeResourceOverlayProperties{})
1241
1242 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1243 android.InitOverrideModule(m)
1244 return m
1245}
1246
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001247type AndroidAppImport struct {
1248 android.ModuleBase
1249 android.DefaultableModuleBase
Jiyong Park592a6a42020-04-21 22:34:28 +09001250 android.ApexModuleBase
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001251 prebuilt android.Prebuilt
1252
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001253 properties AndroidAppImportProperties
1254 dpiVariants interface{}
1255 archVariants interface{}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001256
1257 outputFile android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001258 certificate Certificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001259
1260 dexpreopter
Colin Cross50ddcc42019-05-16 12:28:22 -07001261
1262 usesLibrary usesLibrary
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001263
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001264 preprocessed bool
1265
Colin Cross70dda7e2019-10-01 22:05:35 -07001266 installPath android.InstallPath
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001267}
1268
1269type AndroidAppImportProperties struct {
1270 // A prebuilt apk to import
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001271 Apk *string
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001272
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001273 // The name of a certificate in the default certificate directory or an android_app_certificate
1274 // module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001275 Certificate *string
1276
1277 // Set this flag to true if the prebuilt apk is already signed. The certificate property must not
1278 // be set for presigned modules.
1279 Presigned *bool
1280
Liz Kammer24978992020-05-13 15:49:21 -07001281 // Name of the signing certificate lineage file.
1282 Lineage *string
1283
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001284 // Sign with the default system dev certificate. Must be used judiciously. Most imported apps
1285 // need to either specify a specific certificate or be presigned.
1286 Default_dev_cert *bool
1287
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001288 // Specifies that this app should be installed to the priv-app directory,
1289 // where the system will grant it additional privileges not available to
1290 // normal apps.
1291 Privileged *bool
1292
1293 // Names of modules to be overridden. Listed modules can only be other binaries
1294 // (in Make or Soong).
1295 // This does not completely prevent installation of the overridden binaries, but if both
1296 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
1297 // from PRODUCT_PACKAGES.
1298 Overrides []string
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001299
1300 // Optional name for the installed app. If unspecified, it is derived from the module name.
1301 Filename *string
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001302}
1303
Martin Stjernholm6d415272020-01-31 17:10:36 +00001304func (a *AndroidAppImport) IsInstallable() bool {
1305 return true
1306}
1307
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001308// Updates properties with variant-specific values.
1309func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001310 config := ctx.Config()
1311
1312 dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
1313 // Try DPI variant matches in the reverse-priority order so that the highest priority match
1314 // overwrites everything else.
1315 // TODO(jungjw): Can we optimize this by making it priority order?
1316 for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001317 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001318 }
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001319 if config.ProductAAPTPreferredConfig() != "" {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001320 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001321 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001322
1323 archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
1324 archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
1325 MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001326}
1327
Colin Cross1184b642019-12-30 18:43:07 -08001328func MergePropertiesFromVariant(ctx android.EarlyModuleContext,
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001329 dst interface{}, variantGroup reflect.Value, variant string) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001330 src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
1331 if !src.IsValid() {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001332 return
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001333 }
1334
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001335 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
1336 if err != nil {
1337 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1338 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1339 } else {
1340 panic(err)
1341 }
1342 }
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001343}
1344
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001345func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
1346 cert := android.SrcIsModule(String(a.properties.Certificate))
1347 if cert != "" {
1348 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1349 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001350
Paul Duffin250e6192019-06-07 10:44:37 +01001351 a.usesLibrary.deps(ctx, true)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001352}
1353
1354func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
1355 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001356 // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing
1357 // with them may invalidate pre-existing signature data.
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001358 if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001359 ctx.Build(pctx, android.BuildParams{
1360 Rule: android.Cp,
1361 Output: outputPath,
1362 Input: inputPath,
1363 })
1364 return
1365 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001366 rule := android.NewRuleBuilder()
1367 rule.Command().
1368 Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001369 BuiltTool(ctx, "zip2zip").
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001370 FlagWithInput("-i ", inputPath).
1371 FlagWithOutput("-o ", outputPath).
1372 FlagWithArg("-0 ", "'lib/**/*.so'").
1373 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1374 rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
1375}
1376
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001377// Returns whether this module should have the dex file stored uncompressed in the APK.
1378func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001379 if ctx.Config().UnbundledBuild() || a.preprocessed {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001380 return false
1381 }
1382
1383 // Uncompress dex in APKs of privileged apps
Jiyong Parkf7487312019-10-17 12:54:30 +09001384 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001385 return true
1386 }
1387
1388 return shouldUncompressDex(ctx, &a.dexpreopter)
1389}
1390
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001391func (a *AndroidAppImport) uncompressDex(
1392 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
1393 rule := android.NewRuleBuilder()
1394 rule.Command().
1395 Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001396 BuiltTool(ctx, "zip2zip").
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001397 FlagWithInput("-i ", inputPath).
1398 FlagWithOutput("-o ", outputPath).
1399 FlagWithArg("-0 ", "'classes*.dex'").
1400 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1401 rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
1402}
1403
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001404func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001405 a.generateAndroidBuildActions(ctx)
1406}
1407
Jooyung Han39ee1192020-03-23 20:21:11 +09001408func (a *AndroidAppImport) InstallApkName() string {
1409 return a.BaseModuleName()
1410}
1411
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001412func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001413 numCertPropsSet := 0
1414 if String(a.properties.Certificate) != "" {
1415 numCertPropsSet++
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001416 }
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001417 if Bool(a.properties.Presigned) {
1418 numCertPropsSet++
1419 }
1420 if Bool(a.properties.Default_dev_cert) {
1421 numCertPropsSet++
1422 }
1423 if numCertPropsSet != 1 {
1424 ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001425 }
1426
Colin Crossc2d24052020-05-13 11:05:02 -07001427 _, certificates := collectAppDeps(ctx, a, false, false)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001428
1429 // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001430 // TODO: LOCAL_PACKAGE_SPLITS
1431
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001432 srcApk := a.prebuilt.SingleSourcePath(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001433
1434 if a.usesLibrary.enforceUsesLibraries() {
1435 srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
1436 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001437
1438 // TODO: Install or embed JNI libraries
1439
1440 // Uncompress JNI libraries in the apk
1441 jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
1442 a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
1443
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001444 var installDir android.InstallPath
1445 if Bool(a.properties.Privileged) {
1446 installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001447 } else if ctx.InstallInTestcases() {
1448 installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch())
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001449 } else {
1450 installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
1451 }
1452
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001453 a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001454 a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001455 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001456
1457 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
1458 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
1459 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
1460 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
1461
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001462 dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001463 if a.dexpreopter.uncompressedDex {
1464 dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
1465 a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
1466 dexOutput = dexUncompressed
1467 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001468
Jooyung Han39ee1192020-03-23 20:21:11 +09001469 apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk")
1470
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001471 // TODO: Handle EXTERNAL
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001472
1473 // Sign or align the package if package has not been preprocessed
1474 if a.preprocessed {
1475 a.outputFile = srcApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001476 a.certificate = PresignedCertificate
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001477 } else if !Bool(a.properties.Presigned) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001478 // If the certificate property is empty at this point, default_dev_cert must be set to true.
1479 // Which makes processMainCert's behavior for the empty cert string WAI.
1480 certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001481 if len(certificates) != 1 {
1482 ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
1483 }
Colin Cross503c1d02020-01-28 14:00:53 -08001484 a.certificate = certificates[0]
Jooyung Han39ee1192020-03-23 20:21:11 +09001485 signed := android.PathForModuleOut(ctx, "signed", apkFilename)
Liz Kammer24978992020-05-13 15:49:21 -07001486 var lineageFile android.Path
1487 if lineage := String(a.properties.Lineage); lineage != "" {
1488 lineageFile = android.PathForModuleSrc(ctx, lineage)
1489 }
1490 SignAppPackage(ctx, signed, dexOutput, certificates, lineageFile)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001491 a.outputFile = signed
1492 } else {
Jooyung Han39ee1192020-03-23 20:21:11 +09001493 alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001494 TransformZipAlign(ctx, alignedApk, dexOutput)
1495 a.outputFile = alignedApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001496 a.certificate = PresignedCertificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001497 }
1498
1499 // TODO: Optionally compress the output apk.
1500
Jiyong Park592a6a42020-04-21 22:34:28 +09001501 if a.IsForPlatform() {
1502 a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile)
1503 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001504
1505 // TODO: androidmk converter jni libs
1506}
1507
1508func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
1509 return &a.prebuilt
1510}
1511
1512func (a *AndroidAppImport) Name() string {
1513 return a.prebuilt.Name(a.ModuleBase.Name())
1514}
1515
Dario Frenicde2a032019-10-27 00:29:22 +01001516func (a *AndroidAppImport) OutputFile() android.Path {
1517 return a.outputFile
1518}
1519
Jiyong Park618922e2020-01-08 13:35:43 +09001520func (a *AndroidAppImport) JacocoReportClassesFile() android.Path {
1521 return nil
1522}
1523
Colin Cross503c1d02020-01-28 14:00:53 -08001524func (a *AndroidAppImport) Certificate() Certificate {
1525 return a.certificate
1526}
1527
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001528var dpiVariantGroupType reflect.Type
1529var archVariantGroupType reflect.Type
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001530
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001531func initAndroidAppImportVariantGroupTypes() {
1532 dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
1533
1534 archNames := make([]string, len(android.ArchTypeList()))
1535 for i, archType := range android.ArchTypeList() {
1536 archNames[i] = archType.Name
1537 }
1538 archVariantGroupType = createVariantGroupType(archNames, "Arch")
1539}
1540
1541// Populates all variant struct properties at creation time.
1542func (a *AndroidAppImport) populateAllVariantStructs() {
1543 a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
1544 a.AddProperties(a.dpiVariants)
1545
1546 a.archVariants = reflect.New(archVariantGroupType).Interface()
1547 a.AddProperties(a.archVariants)
1548}
1549
Jiyong Parkf7487312019-10-17 12:54:30 +09001550func (a *AndroidAppImport) Privileged() bool {
1551 return Bool(a.properties.Privileged)
1552}
1553
Sasha Smundak613cbb12020-06-05 10:27:23 -07001554func (a *AndroidAppImport) DepIsInSameApex(_ android.BaseModuleContext, _ android.Module) bool {
Jiyong Park592a6a42020-04-21 22:34:28 +09001555 // android_app_import might have extra dependencies via uses_libs property.
1556 // Don't track the dependency as we don't automatically add those libraries
1557 // to the classpath. It should be explicitly added to java_libs property of APEX
1558 return false
1559}
1560
Colin Crossc2d24052020-05-13 11:05:02 -07001561func (a *AndroidAppImport) sdkVersion() sdkSpec {
1562 return sdkSpecFrom("")
1563}
1564
1565func (a *AndroidAppImport) minSdkVersion() sdkSpec {
1566 return sdkSpecFrom("")
1567}
1568
Jooyung Han749dc692020-04-15 11:03:39 +09001569func (j *AndroidAppImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion int) error {
1570 // Do not check for prebuilts against the min_sdk_version of enclosing APEX
1571 return nil
1572}
1573
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001574func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
1575 props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
1576
1577 variantFields := make([]reflect.StructField, len(variants))
1578 for i, variant := range variants {
1579 variantFields[i] = reflect.StructField{
1580 Name: proptools.FieldNameForProperty(variant),
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001581 Type: props,
1582 }
1583 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001584
1585 variantGroupStruct := reflect.StructOf(variantFields)
1586 return reflect.StructOf([]reflect.StructField{
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001587 {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001588 Name: variantGroupName,
1589 Type: variantGroupStruct,
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001590 },
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001591 })
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001592}
1593
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001594// android_app_import imports a prebuilt apk with additional processing specified in the module.
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001595// DPI-specific apk source files can be specified using dpi_variants. Example:
1596//
1597// android_app_import {
1598// name: "example_import",
1599// apk: "prebuilts/example.apk",
1600// dpi_variants: {
1601// mdpi: {
1602// apk: "prebuilts/example_mdpi.apk",
1603// },
1604// xhdpi: {
1605// apk: "prebuilts/example_xhdpi.apk",
1606// },
1607// },
1608// certificate: "PRESIGNED",
1609// }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001610func AndroidAppImportFactory() android.Module {
1611 module := &AndroidAppImport{}
1612 module.AddProperties(&module.properties)
1613 module.AddProperties(&module.dexpreoptProperties)
Colin Cross50ddcc42019-05-16 12:28:22 -07001614 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001615 module.populateAllVariantStructs()
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001616 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001617 module.processVariants(ctx)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001618 })
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001619
Jiyong Park592a6a42020-04-21 22:34:28 +09001620 android.InitApexModule(module)
Jaewoong Jung6abfbf72020-05-26 20:10:08 -07001621 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1622 android.InitDefaultableModule(module)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001623 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001624
1625 return module
1626}
Colin Cross50ddcc42019-05-16 12:28:22 -07001627
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001628type androidTestImportProperties struct {
1629 // Whether the prebuilt apk can be installed without additional processing. Default is false.
1630 Preprocessed *bool
1631}
1632
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001633type AndroidTestImport struct {
1634 AndroidAppImport
1635
1636 testProperties testProperties
1637
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001638 testImportProperties androidTestImportProperties
1639
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001640 data android.Paths
1641}
1642
1643func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001644 a.preprocessed = Bool(a.testImportProperties.Preprocessed)
1645
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001646 a.generateAndroidBuildActions(ctx)
1647
1648 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
1649}
1650
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001651func (a *AndroidTestImport) InstallInTestcases() bool {
1652 return true
1653}
1654
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001655// android_test_import imports a prebuilt test apk with additional processing specified in the
1656// module. DPI or arch variant configurations can be made as with android_app_import.
1657func AndroidTestImportFactory() android.Module {
1658 module := &AndroidTestImport{}
1659 module.AddProperties(&module.properties)
1660 module.AddProperties(&module.dexpreoptProperties)
1661 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
1662 module.AddProperties(&module.testProperties)
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001663 module.AddProperties(&module.testImportProperties)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001664 module.populateAllVariantStructs()
1665 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1666 module.processVariants(ctx)
1667 })
1668
Colin Crossc80828d2020-05-06 22:29:10 -07001669 module.dexpreopter.isTest = true
1670
Jiyong Park592a6a42020-04-21 22:34:28 +09001671 android.InitApexModule(module)
Jaewoong Jung243688e2020-05-01 15:50:08 -07001672 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1673 android.InitDefaultableModule(module)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001674 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
1675
1676 return module
1677}
1678
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001679type RuntimeResourceOverlay struct {
1680 android.ModuleBase
1681 android.DefaultableModuleBase
Roshan Pius4df2bc72020-04-27 09:42:27 -07001682 android.OverridableModuleBase
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001683 aapt
1684
Roshan Pius4df2bc72020-04-27 09:42:27 -07001685 properties RuntimeResourceOverlayProperties
1686 overridableProperties OverridableRuntimeResourceOverlayProperties
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001687
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001688 certificate Certificate
1689
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001690 outputFile android.Path
1691 installDir android.InstallPath
1692}
1693
1694type RuntimeResourceOverlayProperties struct {
1695 // the name of a certificate in the default certificate directory or an android_app_certificate
1696 // module name in the form ":module".
1697 Certificate *string
1698
Liz Kammer966b2f02020-05-19 16:15:25 -07001699 // Name of the signing certificate lineage file.
1700 Lineage *string
1701
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001702 // optional theme name. If specified, the overlay package will be applied
1703 // only when the ro.boot.vendor.overlay.theme system property is set to the same value.
1704 Theme *string
1705
1706 // if not blank, set to the version of the sdk to compile against.
1707 // Defaults to compiling against the current platform.
1708 Sdk_version *string
1709
1710 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
1711 // Defaults to sdk_version if not set.
1712 Min_sdk_version *string
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001713
1714 // list of android_library modules whose resources are extracted and linked against statically
1715 Static_libs []string
1716
1717 // list of android_app modules whose resources are extracted and linked against
1718 Resource_libs []string
Jaewoong Jungad0177b2020-04-24 15:22:40 -07001719
1720 // Names of modules to be overridden. Listed modules can only be other overlays
1721 // (in Make or Soong).
1722 // This does not completely prevent installation of the overridden overlays, but if both
1723 // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed
1724 // from PRODUCT_PACKAGES.
1725 Overrides []string
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001726}
1727
Jiyong Park69aeba92020-04-24 21:16:36 +09001728// RuntimeResourceOverlayModule interface is used by the apex package to gather information from
1729// a RuntimeResourceOverlay module.
1730type RuntimeResourceOverlayModule interface {
1731 android.Module
1732 OutputFile() android.Path
1733 Certificate() Certificate
1734 Theme() string
1735}
1736
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001737func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) {
1738 sdkDep := decodeSdkDep(ctx, sdkContext(r))
1739 if sdkDep.hasFrameworkLibs() {
1740 r.aapt.deps(ctx, sdkDep)
1741 }
1742
1743 cert := android.SrcIsModule(String(r.properties.Certificate))
1744 if cert != "" {
1745 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1746 }
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001747
1748 ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...)
1749 ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001750}
1751
1752func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1753 // Compile and link resources
1754 r.aapt.hasNoCode = true
Jaewoong Jungf0f747c2020-01-24 10:30:02 -08001755 // Do not remove resources without default values nor dedupe resource configurations with the same value
Roshan Pius4df2bc72020-04-27 09:42:27 -07001756 aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"}
1757 // Allow the override of "package name" and "overlay target package name"
1758 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
1759 if overridden || r.overridableProperties.Package_name != nil {
1760 // The product override variable has a priority over the package_name property.
1761 if !overridden {
1762 manifestPackageName = *r.overridableProperties.Package_name
1763 }
1764 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
1765 }
1766 if r.overridableProperties.Target_package_name != nil {
1767 aaptLinkFlags = append(aaptLinkFlags,
1768 "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name)
1769 }
1770 r.aapt.buildActions(ctx, r, aaptLinkFlags...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001771
1772 // Sign the built package
Colin Crossc2d24052020-05-13 11:05:02 -07001773 _, certificates := collectAppDeps(ctx, r, false, false)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001774 certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx)
1775 signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk")
Liz Kammer966b2f02020-05-19 16:15:25 -07001776 var lineageFile android.Path
1777 if lineage := String(r.properties.Lineage); lineage != "" {
1778 lineageFile = android.PathForModuleSrc(ctx, lineage)
1779 }
1780 SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, lineageFile)
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001781 r.certificate = certificates[0]
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001782
1783 r.outputFile = signed
1784 r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme))
1785 ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile)
1786}
1787
Jiyong Park6a927c42020-01-21 02:03:43 +09001788func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec {
1789 return sdkSpecFrom(String(r.properties.Sdk_version))
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001790}
1791
1792func (r *RuntimeResourceOverlay) systemModules() string {
1793 return ""
1794}
1795
Jiyong Park6a927c42020-01-21 02:03:43 +09001796func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001797 if r.properties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +09001798 return sdkSpecFrom(*r.properties.Min_sdk_version)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001799 }
1800 return r.sdkVersion()
1801}
1802
Jiyong Park6a927c42020-01-21 02:03:43 +09001803func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001804 return r.sdkVersion()
1805}
1806
Jiyong Park69aeba92020-04-24 21:16:36 +09001807func (r *RuntimeResourceOverlay) Certificate() Certificate {
1808 return r.certificate
1809}
1810
1811func (r *RuntimeResourceOverlay) OutputFile() android.Path {
1812 return r.outputFile
1813}
1814
1815func (r *RuntimeResourceOverlay) Theme() string {
1816 return String(r.properties.Theme)
1817}
1818
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001819// runtime_resource_overlay generates a resource-only apk file that can overlay application and
1820// system resources at run time.
1821func RuntimeResourceOverlayFactory() android.Module {
1822 module := &RuntimeResourceOverlay{}
1823 module.AddProperties(
1824 &module.properties,
Roshan Pius4df2bc72020-04-27 09:42:27 -07001825 &module.aaptProperties,
1826 &module.overridableProperties)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001827
Roshan Pius4df2bc72020-04-27 09:42:27 -07001828 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1829 android.InitDefaultableModule(module)
1830 android.InitOverridableModule(module, &module.properties.Overrides)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001831 return module
1832}
1833
Colin Cross50ddcc42019-05-16 12:28:22 -07001834type UsesLibraryProperties struct {
1835 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1836 Uses_libs []string
1837
1838 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1839 // required=false.
1840 Optional_uses_libs []string
1841
1842 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1843 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1844 Enforce_uses_libs *bool
1845}
1846
1847// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1848// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1849// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1850// with knowledge of their shared libraries.
1851type usesLibrary struct {
1852 usesLibraryProperties UsesLibraryProperties
1853}
1854
Paul Duffin250e6192019-06-07 10:44:37 +01001855func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
Colin Cross3245b2c2019-06-07 13:18:09 -07001856 if !ctx.Config().UnbundledBuild() {
1857 ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
1858 ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
Paul Duffin250e6192019-06-07 10:44:37 +01001859 // Only add these extra dependencies if the module depends on framework libs. This avoids
1860 // creating a cyclic dependency:
1861 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
1862 if hasFrameworkLibs {
Colin Cross3245b2c2019-06-07 13:18:09 -07001863 // dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs
1864 // to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each
1865 // library to dexpreopt.
1866 ctx.AddVariationDependencies(nil, usesLibTag,
1867 "org.apache.http.legacy",
1868 "android.hidl.base-V1.0-java",
1869 "android.hidl.manager-V1.0-java")
Ulya Trafimovichc9af5382020-05-29 15:35:06 +01001870 ctx.AddVariationDependencies(nil, usesLibTag, optionalUsesLibs...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001871 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001872 }
1873}
1874
1875// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
1876// build.
1877func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
1878 optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
1879 return optionalUsesLibs
1880}
1881
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001882// usesLibraryPaths returns a map of module names of shared library dependencies to the paths
1883// to their dex jars on host and on device.
1884func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) dexpreopt.LibraryPaths {
1885 usesLibPaths := make(dexpreopt.LibraryPaths)
Colin Cross50ddcc42019-05-16 12:28:22 -07001886
1887 if !ctx.Config().UnbundledBuild() {
1888 ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001889 dep := ctx.OtherModuleName(m)
Colin Cross50ddcc42019-05-16 12:28:22 -07001890 if lib, ok := m.(Dependency); ok {
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001891 buildPath := lib.DexJarBuildPath()
1892 if buildPath == nil {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001893 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must"+
1894 " produce a dex jar, does it have installable: true?", dep)
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001895 return
Colin Cross50ddcc42019-05-16 12:28:22 -07001896 }
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001897
1898 var devicePath string
1899 installPath := lib.DexJarInstallPath()
1900 if installPath == nil {
1901 devicePath = filepath.Join("/system/framework", dep+".jar")
1902 } else {
1903 devicePath = android.InstallPathToOnDevicePath(ctx, installPath.(android.InstallPath))
1904 }
1905
1906 usesLibPaths[dep] = &dexpreopt.LibraryPath{buildPath, devicePath}
Colin Cross50ddcc42019-05-16 12:28:22 -07001907 } else if ctx.Config().AllowMissingDependencies() {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001908 ctx.AddMissingDependencies([]string{dep})
Colin Cross50ddcc42019-05-16 12:28:22 -07001909 } else {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001910 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be "+
1911 "a java library", dep)
Colin Cross50ddcc42019-05-16 12:28:22 -07001912 }
1913 })
1914 }
1915
1916 return usesLibPaths
1917}
1918
1919// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1920// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1921// unconditionally in the future.
1922func (u *usesLibrary) enforceUsesLibraries() bool {
1923 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1924 len(u.usesLibraryProperties.Optional_uses_libs) > 0
1925 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
1926}
1927
1928// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
1929// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
1930func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1931 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
1932
1933 rule := android.NewRuleBuilder()
Colin Crossee94d6a2019-07-08 17:08:34 -07001934 cmd := rule.Command().BuiltTool(ctx, "manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001935 Flag("--enforce-uses-libraries").
1936 Input(manifest).
1937 FlagWithOutput("-o ", outputFile)
1938
1939 for _, lib := range u.usesLibraryProperties.Uses_libs {
1940 cmd.FlagWithArg("--uses-library ", lib)
1941 }
1942
1943 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1944 cmd.FlagWithArg("--optional-uses-library ", lib)
1945 }
1946
1947 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1948
1949 return outputFile
1950}
1951
1952// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
1953// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
1954func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
1955 outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
1956
1957 rule := android.NewRuleBuilder()
1958 aapt := ctx.Config().HostToolPath(ctx, "aapt")
1959 rule.Command().
1960 Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
1961 Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
1962 Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
1963 Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
1964 rule.Command().Text("cp -f").Input(apk).Output(outputFile)
1965
1966 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1967
1968 return outputFile
1969}