blob: 5c0a83b9db5cc4ce8a753a6500ce0535fb25db53 [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.
136 as.masterFile = ctx.ModuleName() + ".apk"
137 screenDensities := "all"
138 if dpis := ctx.Config().ProductAAPTPrebuiltDPI(); len(dpis) > 0 {
139 screenDensities = strings.ToUpper(strings.Join(dpis, ","))
140 }
141 // TODO(asmundak): handle locales.
142 // TODO(asmundak): do we support device features
143 ctx.Build(pctx,
144 android.BuildParams{
145 Rule: extractMatchingApks,
146 Description: "Extract APKs from APK set",
147 Output: as.packedOutput,
148 Inputs: android.Paths{as.prebuilt.SingleSourcePath(ctx)},
149 Args: map[string]string{
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700150 "abis": strings.Join(SupportedAbis(ctx), ","),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700151 "allow-prereleased": strconv.FormatBool(proptools.Bool(as.properties.Prerelease)),
152 "screen-densities": screenDensities,
153 "sdk-version": ctx.Config().PlatformSdkVersion(),
154 "stem": ctx.ModuleName(),
155 },
156 })
Sasha Smundaka7856c02020-04-23 09:49:59 -0700157}
158
159// android_app_set extracts a set of APKs based on the target device
160// configuration and installs this set as "split APKs".
Sasha Smundak613cbb12020-06-05 10:27:23 -0700161// The extracted set always contains 'master' APK whose name is
162// _module_name_.apk and every split APK matching target device.
163// The extraction of the density-specific splits depends on
164// PRODUCT_AAPT_PREBUILT_DPI variable. If present (its value should
165// be a list density names: LDPI, MDPI, HDPI, etc.), only listed
166// splits will be extracted. Otherwise all density-specific splits
167// will be extracted.
Sasha Smundaka7856c02020-04-23 09:49:59 -0700168func AndroidApkSetFactory() android.Module {
169 module := &AndroidAppSet{}
170 module.AddProperties(&module.properties)
171 InitJavaModule(module, android.DeviceSupported)
172 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set")
173 return module
Paul Duffinf9b1da02019-12-18 19:51:55 +0000174}
175
Colin Cross30e076a2015-04-13 13:58:27 -0700176// AndroidManifest.xml merging
177// package splits
178
Colin Crossfabb6082018-02-20 17:22:23 -0800179type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700180 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -0700181 Additional_certificates []string
182
183 // If set, create package-export.apk, which other packages can
184 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -0800185 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700186
Colin Cross16056062017-12-13 22:46:28 -0800187 // Specifies that this app should be installed to the priv-app directory,
188 // where the system will grant it additional privileges not available to
189 // normal apps.
190 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -0700191
192 // list of resource labels to generate individual resource packages
193 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -0400194
195 // Names of modules to be overridden. Listed modules can only be other binaries
196 // (in Make or Soong).
197 // This does not completely prevent installation of the overridden binaries, but if both
198 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
199 // from PRODUCT_PACKAGES.
200 Overrides []string
Colin Crossa4f08812018-10-02 22:03:40 -0700201
202 // list of native libraries that will be provided in or alongside the resulting jar
203 Jni_libs []string `android:"arch_variant"`
204
Colin 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 Hanbbc3fb72020-04-29 14:01:06 +0900424 if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil {
425 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
426 } else {
427 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
428 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100429 }
430
431 a.checkPlatformAPI(ctx)
432 a.checkSdkVersions(ctx)
433}
434
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900435// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
436// This check is enforced for "updatable" APKs (including APK-in-APEX).
437// b/155209650: until min_sdk_version is properly supported, use sdk_version instead.
438// because, sdk_version is overridden by min_sdk_version (if set as smaller)
439// and linkType is checked with dependencies so we can be sure that the whole dependency tree
440// will meet the requirements.
441func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) {
442 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
443 ctx.VisitDirectDeps(func(m android.Module) {
444 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
445 return
446 }
447 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900448 // The domain of cc.sdk_version is "current" and <number>
449 // We can rely on sdkSpec to convert it to <number> so that "current" is handled
450 // properly regardless of sdk finalization.
451 jniSdkVersion, err := sdkSpecFrom(dep.SdkVersion()).effectiveVersion(ctx)
452 if err != nil || minSdkVersion < jniSdkVersion {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900453 ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
454 dep.SdkVersion(), minSdkVersion, ctx.ModuleName())
455 return
456 }
457
458 })
459}
460
Sasha Smundak6ad77252019-05-01 13:16:22 -0700461// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800462// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700463func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park6a927c42020-01-21 02:03:43 +0900464 minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800465 if err != nil {
466 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
467 }
468
Jiyong Park52cd06f2019-11-11 10:14:32 +0900469 return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
470 !a.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800471}
472
Colin Cross43f08db2018-11-12 10:13:39 -0800473// Returns whether this module should have the dex file stored uncompressed in the APK.
474func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800475 if Bool(a.appProperties.Use_embedded_dex) {
476 return true
477 }
478
Colin Cross53a87f52019-06-25 13:35:30 -0700479 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
480 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900481 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000482 return true
483 }
484
Colin Cross53a87f52019-06-25 13:35:30 -0700485 if ctx.Config().UnbundledBuild() {
486 return false
487 }
488
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700489 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700490}
491
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700492func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
493 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Jiyong Park52cd06f2019-11-11 10:14:32 +0900494 !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700495}
496
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900497func (a *AndroidApp) OverriddenManifestPackageName() string {
498 return a.overriddenManifestPackageName
499}
500
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800501func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
David Brazdild25060a2019-02-18 18:24:16 +0000502 a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
503
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700504 // Ask manifest_fixer to add or update the application element indicating this app has no code.
505 a.aapt.hasNoCode = !a.hasCode(ctx)
506
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800507 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800508
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800509 // 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 -0800510 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700511 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800512 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700513 }
514
Dan Willemsen72be5902018-10-24 20:24:57 -0700515 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
516 // Product AAPT config
517 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800518 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700519 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700520
Dan Willemsen72be5902018-10-24 20:24:57 -0700521 // Product AAPT preferred config
522 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800523 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700524 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700525 }
526
Jiyong Park7f67f482019-01-05 12:57:48 +0900527 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700528 if overridden || a.overridableAppProperties.Package_name != nil {
529 // The product override variable has a priority over the package_name property.
530 if !overridden {
531 manifestPackageName = *a.overridableAppProperties.Package_name
532 }
Liz Kammer1d5983b2020-05-19 19:15:37 +0000533 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900534 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900535 }
536
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800537 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
538
Colin Crosse560c4a2019-03-19 16:03:11 -0700539 a.aapt.splitNames = a.appProperties.Package_splits
Colin Cross50ddcc42019-05-16 12:28:22 -0700540 a.aapt.sdkLibraries = a.exportedSdkLibs
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800541 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800542 a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
Colin Cross30e076a2015-04-13 13:58:27 -0700543
Colin Cross46c9b8b2017-06-22 16:51:17 -0700544 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700545 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800546}
Colin Cross30e076a2015-04-13 13:58:27 -0700547
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800548func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700549 var staticLibProguardFlagFiles android.Paths
550 ctx.VisitDirectDeps(func(m android.Module) {
551 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
552 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
553 }
554 })
555
556 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
557
558 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
559 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800560}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800561
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800562func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross43f08db2018-11-12 10:13:39 -0800563
564 var installDir string
565 if ctx.ModuleName() == "framework-res" {
566 // framework-res.apk is installed as system/framework/framework-res.apk
567 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900568 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800569 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800570 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800571 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800572 }
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800573 a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
David Srbeckye033cba2020-05-20 22:20:28 +0100574 if a.deviceProperties.Uncompress_dex == nil {
575 // If the value was not force-set by the user, use reasonable default based on the module.
576 a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
577 }
578 a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700579 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
580 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
581 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
582 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
583 a.dexpreopter.manifestFile = a.mergedManifestFile
584
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800585 if ctx.ModuleName() != "framework-res" {
586 a.Module.compile(ctx, a.aaptSrcJar)
587 }
Colin Cross30e076a2015-04-13 13:58:27 -0700588
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800589 return a.maybeStrippedDexJarFile
590}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800591
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800592func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700593 var jniJarFile android.WritablePath
Colin Crossa4f08812018-10-02 22:03:40 -0700594 if len(jniLibs) > 0 {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700595 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700596 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Sasha Smundak6ad77252019-05-01 13:16:22 -0700597 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700598 for _, jni := range jniLibs {
599 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700600 // Only collect coverage for the first target arch if this is a multilib target.
601 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
602 // data file path collisions since the current coverage file path format doesn't contain
603 // arch-related strings. This is fine for now though; the code coverage team doesn't use
604 // multi-arch targets such as test_suite_* for coverage collections yet.
605 //
606 // Work with the team to come up with a new format that handles multilib modules properly
607 // and change this.
608 if len(ctx.Config().Targets[android.Android]) == 1 ||
609 ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType {
610 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
611 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700612 }
613 }
Colin Crossa4f08812018-10-02 22:03:40 -0700614 } else {
615 a.installJniLibs = jniLibs
616 }
617 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800618 return jniJarFile
619}
Colin Crossa4f08812018-10-02 22:03:40 -0700620
Jaewoong Jung0949f312019-09-11 10:25:18 -0700621func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700622 // Collect NOTICE files from all dependencies.
623 seenModules := make(map[android.Module]bool)
624 noticePathSet := make(map[android.Path]bool)
625
626 ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
627 // Have we already seen this?
628 if _, ok := seenModules[child]; ok {
629 return false
630 }
631 seenModules[child] = true
632
633 // Skip host modules.
634 if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
635 return false
636 }
637
Bob Badoura75b0572020-02-18 20:21:55 -0800638 paths := child.(android.Module).NoticeFiles()
639 if len(paths) > 0 {
640 for _, path := range paths {
641 noticePathSet[path] = true
642 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700643 }
644 return true
645 })
646
647 // If the app has one, add it too.
Bob Badoura75b0572020-02-18 20:21:55 -0800648 if len(a.NoticeFiles()) > 0 {
649 for _, path := range a.NoticeFiles() {
650 noticePathSet[path] = true
651 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700652 }
653
654 if len(noticePathSet) == 0 {
Jaewoong Jung98772792019-07-01 17:15:13 -0700655 return
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700656 }
657 var noticePaths []android.Path
658 for path := range noticePathSet {
659 noticePaths = append(noticePaths, path)
660 }
661 sort.Slice(noticePaths, func(i, j int) bool {
662 return noticePaths[i].String() < noticePaths[j].String()
663 })
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700664
Jaewoong Jung0949f312019-09-11 10:25:18 -0700665 a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700666}
667
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700668// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
669// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
670func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
671 if android.SrcIsModule(certPropValue) == "" {
672 var mainCert Certificate
673 if certPropValue != "" {
674 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
675 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800676 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
677 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700678 }
679 } else {
680 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800681 mainCert = Certificate{
682 Pem: pem,
683 Key: key,
684 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700685 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700686 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700687 }
688
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700689 if !m.Platform() {
690 certPath := certificates[0].Pem.String()
Jeongik Chac9464142019-01-07 12:07:27 +0900691 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
692 if strings.HasPrefix(certPath, systemCertPath) {
693 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
694 whitelist := ctx.Config().EnforceSystemCertificateWhitelist()
695
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700696 if enforceSystemCert && !inList(m.Name(), whitelist) {
Jeongik Chac9464142019-01-07 12:07:27 +0900697 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
698 }
699 }
700 }
701
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700702 return certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800703}
704
Jooyung Han39ee1192020-03-23 20:21:11 +0900705func (a *AndroidApp) InstallApkName() string {
706 return a.installApkName
707}
708
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800709func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700710 var apkDeps android.Paths
711
Jeongik Cha538c0d02019-07-11 15:54:27 +0900712 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
713 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
714
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800715 // Check if the install APK name needs to be overridden.
Jaewoong Jung525443a2019-02-28 15:35:54 -0800716 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800717
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700718 if ctx.ModuleName() == "framework-res" {
719 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700720 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900721 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700722 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
723 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800724 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700725 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700726 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700727 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700728 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700729
Jaewoong Jung0949f312019-09-11 10:25:18 -0700730 a.noticeBuildActions(ctx)
Jaewoong Jung98772792019-07-01 17:15:13 -0700731 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
732 a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
733 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700734
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800735 // Process all building blocks, from AAPT to certificates.
736 a.aaptBuildActions(ctx)
737
Colin Cross50ddcc42019-05-16 12:28:22 -0700738 if a.usesLibrary.enforceUsesLibraries() {
739 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
740 apkDeps = append(apkDeps, manifestCheckFile)
741 }
742
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800743 a.proguardBuildActions(ctx)
744
745 dexJarFile := a.dexBuildActions(ctx)
746
Colin Crossc2d24052020-05-13 11:05:02 -0700747 jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800748 jniJarFile := a.jniBuildActions(jniLibs, ctx)
749
750 if ctx.Failed() {
751 return
752 }
753
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700754 certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
755 a.certificate = certificates[0]
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800756
757 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800758 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700759 var lineageFile android.Path
760 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
761 lineageFile = android.PathForModuleSrc(ctx, lineage)
762 }
763 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, lineageFile)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800764 a.outputFile = packageFile
765
Colin Crosse560c4a2019-03-19 16:03:11 -0700766 for _, split := range a.aapt.splits {
767 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800768 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700769 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, lineageFile)
Colin Crosse560c4a2019-03-19 16:03:11 -0700770 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
771 }
772
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800773 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700774 bundleFile := android.PathForModuleOut(ctx, "base.zip")
775 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
776 a.bundleFile = bundleFile
777
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800778 // Install the app package.
Jiyong Park8ba50f92019-11-13 15:01:01 +0900779 if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
780 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
781 for _, extra := range a.extraOutputFiles {
782 ctx.InstallFile(a.installDir, extra.Base(), extra)
783 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800784 }
Artur Satayev1111b842020-04-27 19:05:28 +0100785
786 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700787}
788
Colin Crossc2d24052020-05-13 11:05:02 -0700789type appDepsInterface interface {
790 sdkVersion() sdkSpec
791 minSdkVersion() sdkSpec
792 RequiresStableAPIs(ctx android.BaseModuleContext) bool
793}
794
795func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
796 shouldCollectRecursiveNativeDeps bool,
Colin Cross094cde42020-02-15 10:38:00 -0800797 checkNativeSdkVersion bool) ([]jniLib, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700798
Colin Crossa4f08812018-10-02 22:03:40 -0700799 var jniLibs []jniLib
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900800 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800801 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700802
Colin Crossc2d24052020-05-13 11:05:02 -0700803 if checkNativeSdkVersion {
804 checkNativeSdkVersion = app.sdkVersion().specified() &&
805 app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx)
806 }
807
Peter Collingbournead84f972019-12-17 16:46:18 -0800808 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700809 otherName := ctx.OtherModuleName(module)
810 tag := ctx.OtherModuleDependencyTag(module)
811
Peter Collingbournead84f972019-12-17 16:46:18 -0800812 if IsJniDepTag(tag) || tag == cc.SharedDepTag {
Colin Crossa4f08812018-10-02 22:03:40 -0700813 if dep, ok := module.(*cc.Module); ok {
Peter Collingbournead84f972019-12-17 16:46:18 -0800814 if dep.IsNdk() || dep.IsStubs() {
815 return false
816 }
817
Colin Crossa4f08812018-10-02 22:03:40 -0700818 lib := dep.OutputFile()
Peter Collingbournead84f972019-12-17 16:46:18 -0800819 path := lib.Path()
820 if seenModulePaths[path.String()] {
821 return false
822 }
823 seenModulePaths[path.String()] = true
824
Colin Crossc2d24052020-05-13 11:05:02 -0700825 if checkNativeSdkVersion && dep.SdkVersion() == "" {
826 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
827 otherName)
Colin Cross094cde42020-02-15 10:38:00 -0800828 }
829
Colin Crossa4f08812018-10-02 22:03:40 -0700830 if lib.Valid() {
831 jniLibs = append(jniLibs, jniLib{
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700832 name: ctx.OtherModuleName(module),
833 path: path,
834 target: module.Target(),
835 coverageFile: dep.CoverageOutputFile(),
Colin Crossa4f08812018-10-02 22:03:40 -0700836 })
837 } else {
838 ctx.ModuleErrorf("dependency %q missing output file", otherName)
839 }
840 } else {
841 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700842 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800843
844 return shouldCollectRecursiveNativeDeps
845 }
846
847 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700848 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900849 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700850 } else {
851 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
852 }
Colin Crossa4f08812018-10-02 22:03:40 -0700853 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800854
855 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700856 })
857
Colin Crossbd01e2a2018-10-04 15:21:03 -0700858 return jniLibs, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700859}
860
Artur Satayev1111b842020-04-27 19:05:28 +0100861func (a *AndroidApp) walkPayloadDeps(ctx android.ModuleContext,
862 do func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool)) {
863
864 ctx.WalkDeps(func(child, parent android.Module) bool {
865 isExternal := !a.DepIsInSameApex(ctx, child)
866 if am, ok := child.(android.ApexModule); ok {
867 do(ctx, parent, am, isExternal)
868 }
869 return !isExternal
870 })
871}
872
873func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
874 if ctx.Host() {
875 return
876 }
877
878 depsInfo := android.DepNameToDepInfoMap{}
879 a.walkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) {
880 depName := to.Name()
881 if info, exist := depsInfo[depName]; exist {
882 info.From = append(info.From, from.Name())
883 info.IsExternal = info.IsExternal && externalDep
884 depsInfo[depName] = info
885 } else {
886 toMinSdkVersion := "(no version)"
887 if m, ok := to.(interface{ MinSdkVersion() string }); ok {
888 if v := m.MinSdkVersion(); v != "" {
889 toMinSdkVersion = v
890 }
891 }
892 depsInfo[depName] = android.ApexModuleDepInfo{
893 To: depName,
894 From: []string{from.Name()},
895 IsExternal: externalDep,
896 MinSdkVersion: toMinSdkVersion,
897 }
898 }
899 })
900
901 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo)
902}
903
Artur Satayev849f8442020-04-28 14:57:42 +0100904func (a *AndroidApp) Updatable() bool {
905 return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable()
906}
907
Colin Cross0ea8ba82019-06-06 14:33:29 -0700908func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800909 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
910 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000911 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800912 }
Jaewoong Jung525443a2019-02-28 15:35:54 -0800913 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800914}
915
Jiyong Park0f80c182020-01-31 02:49:53 +0900916func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
917 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
918 return true
919 }
920 return a.Library.DepIsInSameApex(ctx, dep)
921}
922
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900923// For OutputFileProducer interface
924func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
925 switch tag {
926 case ".aapt.srcjar":
927 return []android.Path{a.aaptSrcJar}, nil
928 }
929 return a.Library.OutputFiles(tag)
930}
931
Jiyong Parkf7487312019-10-17 12:54:30 +0900932func (a *AndroidApp) Privileged() bool {
933 return Bool(a.appProperties.Privileged)
934}
935
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700936func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
937 return ctx.Device() && (ctx.DeviceConfig().NativeCoverageEnabled() || ctx.DeviceConfig().ClangCoverageEnabled())
938}
939
940func (a *AndroidApp) PreventInstall() {
941 a.appProperties.PreventInstall = true
942}
943
944func (a *AndroidApp) HideFromMake() {
945 a.appProperties.HideFromMake = true
946}
947
948func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
949 a.appProperties.IsCoverageVariant = coverage
950}
951
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400952func (a *AndroidApp) EnableCoverageIfNeeded() {}
953
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700954var _ cc.Coverage = (*AndroidApp)(nil)
955
Colin Cross1b16b0e2019-02-12 14:41:32 -0800956// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -0700957func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -0700958 module := &AndroidApp{}
959
Sasha Smundak2057f822019-04-16 17:16:58 -0700960 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross66dbc0b2017-12-28 12:23:20 -0800961 module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
962
Colin Crossae5caf52018-05-22 11:11:52 -0700963 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700964 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -0700965
Colin Cross36242852017-06-23 15:06:31 -0700966 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -0700967 &module.Module.properties,
968 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800969 &module.Module.dexpreoptProperties,
Colin Crossa97c5d32018-03-28 14:58:31 -0700970 &module.Module.protoProperties,
971 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800972 &module.appProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700973 &module.overridableAppProperties,
974 &module.usesLibrary.usesLibraryProperties)
Colin Cross36242852017-06-23 15:06:31 -0700975
Colin Crossa9d8bee2018-10-02 13:59:46 -0700976 module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool {
977 return class == android.Device && ctx.Config().DevicePrefer32BitApps()
978 })
979
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 Crossae5caf52018-05-22 11:11:52 -07001089
1090 module.AddProperties(
1091 &module.Module.properties,
1092 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001093 &module.Module.dexpreoptProperties,
Colin Crossae5caf52018-05-22 11:11:52 -07001094 &module.Module.protoProperties,
1095 &module.aaptProperties,
1096 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001097 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001098 &module.overridableAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001099 &module.usesLibrary.usesLibraryProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001100 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001101
Colin Crossa4f08812018-10-02 22:03:40 -07001102 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1103 android.InitDefaultableModule(module)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001104 android.InitOverridableModule(module, &module.appProperties.Overrides)
Colin Crossae5caf52018-05-22 11:11:52 -07001105 return module
1106}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001107
Colin Cross252fc6f2018-10-04 15:22:03 -07001108type appTestHelperAppProperties struct {
1109 // list of compatibility suites (for example "cts", "vts") that the module should be
1110 // installed into.
1111 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001112
1113 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1114 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1115 // explicitly.
1116 Auto_gen_config *bool
Colin Cross252fc6f2018-10-04 15:22:03 -07001117}
1118
1119type AndroidTestHelperApp struct {
1120 AndroidApp
1121
1122 appTestHelperAppProperties appTestHelperAppProperties
1123}
1124
Jaewoong Jung326a9412019-11-21 10:41:00 -08001125func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1126 return true
1127}
1128
Colin Cross1b16b0e2019-02-12 14:41:32 -08001129// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1130// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1131// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001132func AndroidTestHelperAppFactory() android.Module {
1133 module := &AndroidTestHelperApp{}
1134
Sasha Smundak2057f822019-04-16 17:16:58 -07001135 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001136
1137 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001138 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001139 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001140 module.Module.dexpreopter.isTest = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001141
1142 module.AddProperties(
1143 &module.Module.properties,
1144 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001145 &module.Module.dexpreoptProperties,
Colin Cross252fc6f2018-10-04 15:22:03 -07001146 &module.Module.protoProperties,
1147 &module.aaptProperties,
1148 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001149 &module.appTestHelperAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001150 &module.overridableAppProperties,
1151 &module.usesLibrary.usesLibraryProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001152
1153 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1154 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001155 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001156 return module
1157}
1158
Colin Crossbd01e2a2018-10-04 15:21:03 -07001159type AndroidAppCertificate struct {
1160 android.ModuleBase
1161 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001162 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001163}
1164
1165type AndroidAppCertificateProperties struct {
1166 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1167 Certificate *string
1168}
1169
Colin Cross1b16b0e2019-02-12 14:41:32 -08001170// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1171// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001172func AndroidAppCertificateFactory() android.Module {
1173 module := &AndroidAppCertificate{}
1174 module.AddProperties(&module.properties)
1175 android.InitAndroidModule(module)
1176 return module
1177}
1178
Colin Crossbd01e2a2018-10-04 15:21:03 -07001179func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1180 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001181 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001182 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1183 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001184 }
1185}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001186
1187type OverrideAndroidApp struct {
1188 android.ModuleBase
1189 android.OverrideModuleBase
1190}
1191
Sasha Smundak613cbb12020-06-05 10:27:23 -07001192func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001193 // All the overrides happen in the base module.
1194 // TODO(jungjw): Check the base module type.
1195}
1196
1197// override_android_app is used to create an android_app module based on another android_app by overriding
1198// some of its properties.
1199func OverrideAndroidAppModuleFactory() android.Module {
1200 m := &OverrideAndroidApp{}
1201 m.AddProperties(&overridableAppProperties{})
1202
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001203 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001204 android.InitOverrideModule(m)
1205 return m
1206}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001207
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001208type OverrideAndroidTest struct {
1209 android.ModuleBase
1210 android.OverrideModuleBase
1211}
1212
Sasha Smundak613cbb12020-06-05 10:27:23 -07001213func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001214 // All the overrides happen in the base module.
1215 // TODO(jungjw): Check the base module type.
1216}
1217
1218// override_android_test is used to create an android_app module based on another android_test by overriding
1219// some of its properties.
1220func OverrideAndroidTestModuleFactory() android.Module {
1221 m := &OverrideAndroidTest{}
1222 m.AddProperties(&overridableAppProperties{})
1223 m.AddProperties(&appTestProperties{})
1224
1225 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1226 android.InitOverrideModule(m)
1227 return m
1228}
1229
Roshan Pius4df2bc72020-04-27 09:42:27 -07001230type OverrideRuntimeResourceOverlay struct {
1231 android.ModuleBase
1232 android.OverrideModuleBase
1233}
1234
Sasha Smundak613cbb12020-06-05 10:27:23 -07001235func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(_ android.ModuleContext) {
Roshan Pius4df2bc72020-04-27 09:42:27 -07001236 // All the overrides happen in the base module.
1237 // TODO(jungjw): Check the base module type.
1238}
1239
1240// override_runtime_resource_overlay is used to create a module based on another
1241// runtime_resource_overlay module by overriding some of its properties.
1242func OverrideRuntimeResourceOverlayModuleFactory() android.Module {
1243 m := &OverrideRuntimeResourceOverlay{}
1244 m.AddProperties(&OverridableRuntimeResourceOverlayProperties{})
1245
1246 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1247 android.InitOverrideModule(m)
1248 return m
1249}
1250
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001251type AndroidAppImport struct {
1252 android.ModuleBase
1253 android.DefaultableModuleBase
Jiyong Park592a6a42020-04-21 22:34:28 +09001254 android.ApexModuleBase
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001255 prebuilt android.Prebuilt
1256
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001257 properties AndroidAppImportProperties
1258 dpiVariants interface{}
1259 archVariants interface{}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001260
1261 outputFile android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001262 certificate Certificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001263
1264 dexpreopter
Colin Cross50ddcc42019-05-16 12:28:22 -07001265
1266 usesLibrary usesLibrary
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001267
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001268 preprocessed bool
1269
Colin Cross70dda7e2019-10-01 22:05:35 -07001270 installPath android.InstallPath
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001271}
1272
1273type AndroidAppImportProperties struct {
1274 // A prebuilt apk to import
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001275 Apk *string
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001276
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001277 // The name of a certificate in the default certificate directory or an android_app_certificate
1278 // module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001279 Certificate *string
1280
1281 // Set this flag to true if the prebuilt apk is already signed. The certificate property must not
1282 // be set for presigned modules.
1283 Presigned *bool
1284
Liz Kammer24978992020-05-13 15:49:21 -07001285 // Name of the signing certificate lineage file.
1286 Lineage *string
1287
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001288 // Sign with the default system dev certificate. Must be used judiciously. Most imported apps
1289 // need to either specify a specific certificate or be presigned.
1290 Default_dev_cert *bool
1291
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001292 // Specifies that this app should be installed to the priv-app directory,
1293 // where the system will grant it additional privileges not available to
1294 // normal apps.
1295 Privileged *bool
1296
1297 // Names of modules to be overridden. Listed modules can only be other binaries
1298 // (in Make or Soong).
1299 // This does not completely prevent installation of the overridden binaries, but if both
1300 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
1301 // from PRODUCT_PACKAGES.
1302 Overrides []string
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001303
1304 // Optional name for the installed app. If unspecified, it is derived from the module name.
1305 Filename *string
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001306}
1307
Martin Stjernholm6d415272020-01-31 17:10:36 +00001308func (a *AndroidAppImport) IsInstallable() bool {
1309 return true
1310}
1311
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001312// Updates properties with variant-specific values.
1313func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001314 config := ctx.Config()
1315
1316 dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
1317 // Try DPI variant matches in the reverse-priority order so that the highest priority match
1318 // overwrites everything else.
1319 // TODO(jungjw): Can we optimize this by making it priority order?
1320 for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001321 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001322 }
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001323 if config.ProductAAPTPreferredConfig() != "" {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001324 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001325 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001326
1327 archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
1328 archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
1329 MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001330}
1331
Colin Cross1184b642019-12-30 18:43:07 -08001332func MergePropertiesFromVariant(ctx android.EarlyModuleContext,
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001333 dst interface{}, variantGroup reflect.Value, variant string) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001334 src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
1335 if !src.IsValid() {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001336 return
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001337 }
1338
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001339 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
1340 if err != nil {
1341 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1342 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1343 } else {
1344 panic(err)
1345 }
1346 }
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001347}
1348
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001349func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
1350 cert := android.SrcIsModule(String(a.properties.Certificate))
1351 if cert != "" {
1352 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1353 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001354
Paul Duffin250e6192019-06-07 10:44:37 +01001355 a.usesLibrary.deps(ctx, true)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001356}
1357
1358func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
1359 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001360 // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing
1361 // with them may invalidate pre-existing signature data.
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001362 if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001363 ctx.Build(pctx, android.BuildParams{
1364 Rule: android.Cp,
1365 Output: outputPath,
1366 Input: inputPath,
1367 })
1368 return
1369 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001370 rule := android.NewRuleBuilder()
1371 rule.Command().
1372 Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001373 BuiltTool(ctx, "zip2zip").
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001374 FlagWithInput("-i ", inputPath).
1375 FlagWithOutput("-o ", outputPath).
1376 FlagWithArg("-0 ", "'lib/**/*.so'").
1377 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1378 rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
1379}
1380
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001381// Returns whether this module should have the dex file stored uncompressed in the APK.
1382func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001383 if ctx.Config().UnbundledBuild() || a.preprocessed {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001384 return false
1385 }
1386
1387 // Uncompress dex in APKs of privileged apps
Jiyong Parkf7487312019-10-17 12:54:30 +09001388 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001389 return true
1390 }
1391
1392 return shouldUncompressDex(ctx, &a.dexpreopter)
1393}
1394
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001395func (a *AndroidAppImport) uncompressDex(
1396 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
1397 rule := android.NewRuleBuilder()
1398 rule.Command().
1399 Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001400 BuiltTool(ctx, "zip2zip").
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001401 FlagWithInput("-i ", inputPath).
1402 FlagWithOutput("-o ", outputPath).
1403 FlagWithArg("-0 ", "'classes*.dex'").
1404 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1405 rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
1406}
1407
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001408func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001409 a.generateAndroidBuildActions(ctx)
1410}
1411
Jooyung Han39ee1192020-03-23 20:21:11 +09001412func (a *AndroidAppImport) InstallApkName() string {
1413 return a.BaseModuleName()
1414}
1415
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001416func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001417 numCertPropsSet := 0
1418 if String(a.properties.Certificate) != "" {
1419 numCertPropsSet++
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001420 }
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001421 if Bool(a.properties.Presigned) {
1422 numCertPropsSet++
1423 }
1424 if Bool(a.properties.Default_dev_cert) {
1425 numCertPropsSet++
1426 }
1427 if numCertPropsSet != 1 {
1428 ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001429 }
1430
Colin Crossc2d24052020-05-13 11:05:02 -07001431 _, certificates := collectAppDeps(ctx, a, false, false)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001432
1433 // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001434 // TODO: LOCAL_PACKAGE_SPLITS
1435
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001436 srcApk := a.prebuilt.SingleSourcePath(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001437
1438 if a.usesLibrary.enforceUsesLibraries() {
1439 srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
1440 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001441
1442 // TODO: Install or embed JNI libraries
1443
1444 // Uncompress JNI libraries in the apk
1445 jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
1446 a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
1447
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001448 var installDir android.InstallPath
1449 if Bool(a.properties.Privileged) {
1450 installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001451 } else if ctx.InstallInTestcases() {
1452 installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch())
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001453 } else {
1454 installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
1455 }
1456
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001457 a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001458 a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001459 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001460
1461 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
1462 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
1463 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
1464 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
1465
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001466 dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001467 if a.dexpreopter.uncompressedDex {
1468 dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
1469 a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
1470 dexOutput = dexUncompressed
1471 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001472
Jooyung Han39ee1192020-03-23 20:21:11 +09001473 apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk")
1474
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001475 // TODO: Handle EXTERNAL
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001476
1477 // Sign or align the package if package has not been preprocessed
1478 if a.preprocessed {
1479 a.outputFile = srcApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001480 a.certificate = PresignedCertificate
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001481 } else if !Bool(a.properties.Presigned) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001482 // If the certificate property is empty at this point, default_dev_cert must be set to true.
1483 // Which makes processMainCert's behavior for the empty cert string WAI.
1484 certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001485 if len(certificates) != 1 {
1486 ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
1487 }
Colin Cross503c1d02020-01-28 14:00:53 -08001488 a.certificate = certificates[0]
Jooyung Han39ee1192020-03-23 20:21:11 +09001489 signed := android.PathForModuleOut(ctx, "signed", apkFilename)
Liz Kammer24978992020-05-13 15:49:21 -07001490 var lineageFile android.Path
1491 if lineage := String(a.properties.Lineage); lineage != "" {
1492 lineageFile = android.PathForModuleSrc(ctx, lineage)
1493 }
1494 SignAppPackage(ctx, signed, dexOutput, certificates, lineageFile)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001495 a.outputFile = signed
1496 } else {
Jooyung Han39ee1192020-03-23 20:21:11 +09001497 alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001498 TransformZipAlign(ctx, alignedApk, dexOutput)
1499 a.outputFile = alignedApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001500 a.certificate = PresignedCertificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001501 }
1502
1503 // TODO: Optionally compress the output apk.
1504
Jiyong Park592a6a42020-04-21 22:34:28 +09001505 if a.IsForPlatform() {
1506 a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile)
1507 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001508
1509 // TODO: androidmk converter jni libs
1510}
1511
1512func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
1513 return &a.prebuilt
1514}
1515
1516func (a *AndroidAppImport) Name() string {
1517 return a.prebuilt.Name(a.ModuleBase.Name())
1518}
1519
Dario Frenicde2a032019-10-27 00:29:22 +01001520func (a *AndroidAppImport) OutputFile() android.Path {
1521 return a.outputFile
1522}
1523
Jiyong Park618922e2020-01-08 13:35:43 +09001524func (a *AndroidAppImport) JacocoReportClassesFile() android.Path {
1525 return nil
1526}
1527
Colin Cross503c1d02020-01-28 14:00:53 -08001528func (a *AndroidAppImport) Certificate() Certificate {
1529 return a.certificate
1530}
1531
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001532var dpiVariantGroupType reflect.Type
1533var archVariantGroupType reflect.Type
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001534
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001535func initAndroidAppImportVariantGroupTypes() {
1536 dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
1537
1538 archNames := make([]string, len(android.ArchTypeList()))
1539 for i, archType := range android.ArchTypeList() {
1540 archNames[i] = archType.Name
1541 }
1542 archVariantGroupType = createVariantGroupType(archNames, "Arch")
1543}
1544
1545// Populates all variant struct properties at creation time.
1546func (a *AndroidAppImport) populateAllVariantStructs() {
1547 a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
1548 a.AddProperties(a.dpiVariants)
1549
1550 a.archVariants = reflect.New(archVariantGroupType).Interface()
1551 a.AddProperties(a.archVariants)
1552}
1553
Jiyong Parkf7487312019-10-17 12:54:30 +09001554func (a *AndroidAppImport) Privileged() bool {
1555 return Bool(a.properties.Privileged)
1556}
1557
Sasha Smundak613cbb12020-06-05 10:27:23 -07001558func (a *AndroidAppImport) DepIsInSameApex(_ android.BaseModuleContext, _ android.Module) bool {
Jiyong Park592a6a42020-04-21 22:34:28 +09001559 // android_app_import might have extra dependencies via uses_libs property.
1560 // Don't track the dependency as we don't automatically add those libraries
1561 // to the classpath. It should be explicitly added to java_libs property of APEX
1562 return false
1563}
1564
Colin Crossc2d24052020-05-13 11:05:02 -07001565func (a *AndroidAppImport) sdkVersion() sdkSpec {
1566 return sdkSpecFrom("")
1567}
1568
1569func (a *AndroidAppImport) minSdkVersion() sdkSpec {
1570 return sdkSpecFrom("")
1571}
1572
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001573func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
1574 props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
1575
1576 variantFields := make([]reflect.StructField, len(variants))
1577 for i, variant := range variants {
1578 variantFields[i] = reflect.StructField{
1579 Name: proptools.FieldNameForProperty(variant),
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001580 Type: props,
1581 }
1582 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001583
1584 variantGroupStruct := reflect.StructOf(variantFields)
1585 return reflect.StructOf([]reflect.StructField{
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001586 {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001587 Name: variantGroupName,
1588 Type: variantGroupStruct,
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001589 },
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001590 })
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001591}
1592
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001593// android_app_import imports a prebuilt apk with additional processing specified in the module.
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001594// DPI-specific apk source files can be specified using dpi_variants. Example:
1595//
1596// android_app_import {
1597// name: "example_import",
1598// apk: "prebuilts/example.apk",
1599// dpi_variants: {
1600// mdpi: {
1601// apk: "prebuilts/example_mdpi.apk",
1602// },
1603// xhdpi: {
1604// apk: "prebuilts/example_xhdpi.apk",
1605// },
1606// },
1607// certificate: "PRESIGNED",
1608// }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001609func AndroidAppImportFactory() android.Module {
1610 module := &AndroidAppImport{}
1611 module.AddProperties(&module.properties)
1612 module.AddProperties(&module.dexpreoptProperties)
Colin Cross50ddcc42019-05-16 12:28:22 -07001613 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001614 module.populateAllVariantStructs()
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001615 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001616 module.processVariants(ctx)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001617 })
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001618
Jiyong Park592a6a42020-04-21 22:34:28 +09001619 android.InitApexModule(module)
Jaewoong Jung6abfbf72020-05-26 20:10:08 -07001620 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1621 android.InitDefaultableModule(module)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001622 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001623
1624 return module
1625}
Colin Cross50ddcc42019-05-16 12:28:22 -07001626
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001627type androidTestImportProperties struct {
1628 // Whether the prebuilt apk can be installed without additional processing. Default is false.
1629 Preprocessed *bool
1630}
1631
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001632type AndroidTestImport struct {
1633 AndroidAppImport
1634
1635 testProperties testProperties
1636
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001637 testImportProperties androidTestImportProperties
1638
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001639 data android.Paths
1640}
1641
1642func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001643 a.preprocessed = Bool(a.testImportProperties.Preprocessed)
1644
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001645 a.generateAndroidBuildActions(ctx)
1646
1647 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
1648}
1649
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001650func (a *AndroidTestImport) InstallInTestcases() bool {
1651 return true
1652}
1653
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001654// android_test_import imports a prebuilt test apk with additional processing specified in the
1655// module. DPI or arch variant configurations can be made as with android_app_import.
1656func AndroidTestImportFactory() android.Module {
1657 module := &AndroidTestImport{}
1658 module.AddProperties(&module.properties)
1659 module.AddProperties(&module.dexpreoptProperties)
1660 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
1661 module.AddProperties(&module.testProperties)
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001662 module.AddProperties(&module.testImportProperties)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001663 module.populateAllVariantStructs()
1664 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1665 module.processVariants(ctx)
1666 })
1667
Colin Crossc80828d2020-05-06 22:29:10 -07001668 module.dexpreopter.isTest = true
1669
Jiyong Park592a6a42020-04-21 22:34:28 +09001670 android.InitApexModule(module)
Jaewoong Jung243688e2020-05-01 15:50:08 -07001671 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1672 android.InitDefaultableModule(module)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001673 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
1674
1675 return module
1676}
1677
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001678type RuntimeResourceOverlay struct {
1679 android.ModuleBase
1680 android.DefaultableModuleBase
Roshan Pius4df2bc72020-04-27 09:42:27 -07001681 android.OverridableModuleBase
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001682 aapt
1683
Roshan Pius4df2bc72020-04-27 09:42:27 -07001684 properties RuntimeResourceOverlayProperties
1685 overridableProperties OverridableRuntimeResourceOverlayProperties
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001686
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001687 certificate Certificate
1688
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001689 outputFile android.Path
1690 installDir android.InstallPath
1691}
1692
1693type RuntimeResourceOverlayProperties struct {
1694 // the name of a certificate in the default certificate directory or an android_app_certificate
1695 // module name in the form ":module".
1696 Certificate *string
1697
Liz Kammer966b2f02020-05-19 16:15:25 -07001698 // Name of the signing certificate lineage file.
1699 Lineage *string
1700
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001701 // optional theme name. If specified, the overlay package will be applied
1702 // only when the ro.boot.vendor.overlay.theme system property is set to the same value.
1703 Theme *string
1704
1705 // if not blank, set to the version of the sdk to compile against.
1706 // Defaults to compiling against the current platform.
1707 Sdk_version *string
1708
1709 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
1710 // Defaults to sdk_version if not set.
1711 Min_sdk_version *string
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001712
1713 // list of android_library modules whose resources are extracted and linked against statically
1714 Static_libs []string
1715
1716 // list of android_app modules whose resources are extracted and linked against
1717 Resource_libs []string
Jaewoong Jungad0177b2020-04-24 15:22:40 -07001718
1719 // Names of modules to be overridden. Listed modules can only be other overlays
1720 // (in Make or Soong).
1721 // This does not completely prevent installation of the overridden overlays, but if both
1722 // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed
1723 // from PRODUCT_PACKAGES.
1724 Overrides []string
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001725}
1726
Jiyong Park69aeba92020-04-24 21:16:36 +09001727// RuntimeResourceOverlayModule interface is used by the apex package to gather information from
1728// a RuntimeResourceOverlay module.
1729type RuntimeResourceOverlayModule interface {
1730 android.Module
1731 OutputFile() android.Path
1732 Certificate() Certificate
1733 Theme() string
1734}
1735
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001736func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) {
1737 sdkDep := decodeSdkDep(ctx, sdkContext(r))
1738 if sdkDep.hasFrameworkLibs() {
1739 r.aapt.deps(ctx, sdkDep)
1740 }
1741
1742 cert := android.SrcIsModule(String(r.properties.Certificate))
1743 if cert != "" {
1744 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1745 }
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001746
1747 ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...)
1748 ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001749}
1750
1751func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1752 // Compile and link resources
1753 r.aapt.hasNoCode = true
Jaewoong Jungf0f747c2020-01-24 10:30:02 -08001754 // Do not remove resources without default values nor dedupe resource configurations with the same value
Roshan Pius4df2bc72020-04-27 09:42:27 -07001755 aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"}
1756 // Allow the override of "package name" and "overlay target package name"
1757 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
1758 if overridden || r.overridableProperties.Package_name != nil {
1759 // The product override variable has a priority over the package_name property.
1760 if !overridden {
1761 manifestPackageName = *r.overridableProperties.Package_name
1762 }
1763 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
1764 }
1765 if r.overridableProperties.Target_package_name != nil {
1766 aaptLinkFlags = append(aaptLinkFlags,
1767 "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name)
1768 }
1769 r.aapt.buildActions(ctx, r, aaptLinkFlags...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001770
1771 // Sign the built package
Colin Crossc2d24052020-05-13 11:05:02 -07001772 _, certificates := collectAppDeps(ctx, r, false, false)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001773 certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx)
1774 signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk")
Liz Kammer966b2f02020-05-19 16:15:25 -07001775 var lineageFile android.Path
1776 if lineage := String(r.properties.Lineage); lineage != "" {
1777 lineageFile = android.PathForModuleSrc(ctx, lineage)
1778 }
1779 SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, lineageFile)
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001780 r.certificate = certificates[0]
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001781
1782 r.outputFile = signed
1783 r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme))
1784 ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile)
1785}
1786
Jiyong Park6a927c42020-01-21 02:03:43 +09001787func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec {
1788 return sdkSpecFrom(String(r.properties.Sdk_version))
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001789}
1790
1791func (r *RuntimeResourceOverlay) systemModules() string {
1792 return ""
1793}
1794
Jiyong Park6a927c42020-01-21 02:03:43 +09001795func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001796 if r.properties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +09001797 return sdkSpecFrom(*r.properties.Min_sdk_version)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001798 }
1799 return r.sdkVersion()
1800}
1801
Jiyong Park6a927c42020-01-21 02:03:43 +09001802func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001803 return r.sdkVersion()
1804}
1805
Jiyong Park69aeba92020-04-24 21:16:36 +09001806func (r *RuntimeResourceOverlay) Certificate() Certificate {
1807 return r.certificate
1808}
1809
1810func (r *RuntimeResourceOverlay) OutputFile() android.Path {
1811 return r.outputFile
1812}
1813
1814func (r *RuntimeResourceOverlay) Theme() string {
1815 return String(r.properties.Theme)
1816}
1817
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001818// runtime_resource_overlay generates a resource-only apk file that can overlay application and
1819// system resources at run time.
1820func RuntimeResourceOverlayFactory() android.Module {
1821 module := &RuntimeResourceOverlay{}
1822 module.AddProperties(
1823 &module.properties,
Roshan Pius4df2bc72020-04-27 09:42:27 -07001824 &module.aaptProperties,
1825 &module.overridableProperties)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001826
Roshan Pius4df2bc72020-04-27 09:42:27 -07001827 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1828 android.InitDefaultableModule(module)
1829 android.InitOverridableModule(module, &module.properties.Overrides)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001830 return module
1831}
1832
Colin Cross50ddcc42019-05-16 12:28:22 -07001833type UsesLibraryProperties struct {
1834 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1835 Uses_libs []string
1836
1837 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1838 // required=false.
1839 Optional_uses_libs []string
1840
1841 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1842 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1843 Enforce_uses_libs *bool
1844}
1845
1846// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1847// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1848// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1849// with knowledge of their shared libraries.
1850type usesLibrary struct {
1851 usesLibraryProperties UsesLibraryProperties
1852}
1853
Paul Duffin250e6192019-06-07 10:44:37 +01001854func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
Colin Cross3245b2c2019-06-07 13:18:09 -07001855 if !ctx.Config().UnbundledBuild() {
1856 ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
1857 ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
Paul Duffin250e6192019-06-07 10:44:37 +01001858 // Only add these extra dependencies if the module depends on framework libs. This avoids
1859 // creating a cyclic dependency:
1860 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
1861 if hasFrameworkLibs {
Colin Cross3245b2c2019-06-07 13:18:09 -07001862 // dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs
1863 // to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each
1864 // library to dexpreopt.
1865 ctx.AddVariationDependencies(nil, usesLibTag,
1866 "org.apache.http.legacy",
1867 "android.hidl.base-V1.0-java",
1868 "android.hidl.manager-V1.0-java")
Ulya Trafimovichc9af5382020-05-29 15:35:06 +01001869 ctx.AddVariationDependencies(nil, usesLibTag, optionalUsesLibs...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001870 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001871 }
1872}
1873
1874// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
1875// build.
1876func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
1877 optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
1878 return optionalUsesLibs
1879}
1880
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001881// usesLibraryPaths returns a map of module names of shared library dependencies to the paths
1882// to their dex jars on host and on device.
1883func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) dexpreopt.LibraryPaths {
1884 usesLibPaths := make(dexpreopt.LibraryPaths)
Colin Cross50ddcc42019-05-16 12:28:22 -07001885
1886 if !ctx.Config().UnbundledBuild() {
1887 ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001888 dep := ctx.OtherModuleName(m)
Colin Cross50ddcc42019-05-16 12:28:22 -07001889 if lib, ok := m.(Dependency); ok {
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001890 buildPath := lib.DexJarBuildPath()
1891 if buildPath == nil {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001892 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must"+
1893 " produce a dex jar, does it have installable: true?", dep)
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001894 return
Colin Cross50ddcc42019-05-16 12:28:22 -07001895 }
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001896
1897 var devicePath string
1898 installPath := lib.DexJarInstallPath()
1899 if installPath == nil {
1900 devicePath = filepath.Join("/system/framework", dep+".jar")
1901 } else {
1902 devicePath = android.InstallPathToOnDevicePath(ctx, installPath.(android.InstallPath))
1903 }
1904
1905 usesLibPaths[dep] = &dexpreopt.LibraryPath{buildPath, devicePath}
Colin Cross50ddcc42019-05-16 12:28:22 -07001906 } else if ctx.Config().AllowMissingDependencies() {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001907 ctx.AddMissingDependencies([]string{dep})
Colin Cross50ddcc42019-05-16 12:28:22 -07001908 } else {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001909 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be "+
1910 "a java library", dep)
Colin Cross50ddcc42019-05-16 12:28:22 -07001911 }
1912 })
1913 }
1914
1915 return usesLibPaths
1916}
1917
1918// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1919// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1920// unconditionally in the future.
1921func (u *usesLibrary) enforceUsesLibraries() bool {
1922 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1923 len(u.usesLibraryProperties.Optional_uses_libs) > 0
1924 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
1925}
1926
1927// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
1928// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
1929func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1930 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
1931
1932 rule := android.NewRuleBuilder()
Colin Crossee94d6a2019-07-08 17:08:34 -07001933 cmd := rule.Command().BuiltTool(ctx, "manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001934 Flag("--enforce-uses-libraries").
1935 Input(manifest).
1936 FlagWithOutput("-o ", outputFile)
1937
1938 for _, lib := range u.usesLibraryProperties.Uses_libs {
1939 cmd.FlagWithArg("--uses-library ", lib)
1940 }
1941
1942 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1943 cmd.FlagWithArg("--optional-uses-library ", lib)
1944 }
1945
1946 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1947
1948 return outputFile
1949}
1950
1951// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
1952// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
1953func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
1954 outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
1955
1956 rule := android.NewRuleBuilder()
1957 aapt := ctx.Config().HostToolPath(ctx, "aapt")
1958 rule.Command().
1959 Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
1960 Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
1961 Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
1962 Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
1963 rule.Command().Text("cp -f").Input(apk).Output(outputFile)
1964
1965 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1966
1967 return outputFile
1968}