blob: 1e348d4b29e11045d2f0a07b6670b3f08906ee28 [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".
161// The set will always contain `base-master.apk` and every APK built
162// to the target device. All density-specific APK will be included, too,
163// unless PRODUCT_APPT_PREBUILT_DPI is defined (should contain comma-sepearated
164// list of density names (LDPI, MDPI, HDPI, etc.)
165func AndroidApkSetFactory() android.Module {
166 module := &AndroidAppSet{}
167 module.AddProperties(&module.properties)
168 InitJavaModule(module, android.DeviceSupported)
169 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set")
170 return module
Paul Duffinf9b1da02019-12-18 19:51:55 +0000171}
172
Colin Cross30e076a2015-04-13 13:58:27 -0700173// AndroidManifest.xml merging
174// package splits
175
Colin Crossfabb6082018-02-20 17:22:23 -0800176type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700177 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -0700178 Additional_certificates []string
179
180 // If set, create package-export.apk, which other packages can
181 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -0800182 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700183
Colin Cross16056062017-12-13 22:46:28 -0800184 // Specifies that this app should be installed to the priv-app directory,
185 // where the system will grant it additional privileges not available to
186 // normal apps.
187 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -0700188
189 // list of resource labels to generate individual resource packages
190 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -0400191
192 // Names of modules to be overridden. Listed modules can only be other binaries
193 // (in Make or Soong).
194 // This does not completely prevent installation of the overridden binaries, but if both
195 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
196 // from PRODUCT_PACKAGES.
197 Overrides []string
Colin Crossa4f08812018-10-02 22:03:40 -0700198
199 // list of native libraries that will be provided in or alongside the resulting jar
200 Jni_libs []string `android:"arch_variant"`
201
Colin Cross7204cf02020-05-06 17:51:39 -0700202 // if true, use JNI libraries that link against platform APIs even if this module sets
Colin Crossee87c602020-02-19 16:57:15 -0800203 // sdk_version.
204 Jni_uses_platform_apis *bool
205
Colin Cross7204cf02020-05-06 17:51:39 -0700206 // if true, use JNI libraries that link against SDK APIs even if this module does not set
207 // sdk_version.
208 Jni_uses_sdk_apis *bool
209
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700210 // STL library to use for JNI libraries.
211 Stl *string `android:"arch_variant"`
212
Colin Crosse4246ab2019-02-05 21:55:21 -0800213 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
214 // 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 +0900215 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
216 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
217 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -0800218 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -0800219
220 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
221 // they are used from inside the APK at runtime.
222 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700223
224 // Forces native libraries to always be packaged into the APK,
225 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
226 // True for android_test* modules.
227 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700228
229 // If set, find and merge all NOTICE files that this module and its dependencies have and store
230 // it in the APK as an asset.
231 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700232
233 // cc.Coverage related properties
234 PreventInstall bool `blueprint:"mutated"`
235 HideFromMake bool `blueprint:"mutated"`
236 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100237
238 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100239 // additional rules to make sure an app can safely be updated. Default is false.
240 // Prefer using other specific properties if build behaviour must be changed; avoid using this
241 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100242 Updatable *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700243}
244
Jaewoong Jung525443a2019-02-28 15:35:54 -0800245// android_app properties that can be overridden by override_android_app
246type overridableAppProperties struct {
247 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
248 // or an android_app_certificate module name in the form ":module".
249 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700250
Liz Kammere2b27f42020-05-07 13:24:05 -0700251 // Name of the signing certificate lineage file.
252 Lineage *string
253
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700254 // the package name of this app. The package name in the manifest file is used if one was not given.
255 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800256
257 // the logging parent of this app.
258 Logging_parent *string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800259}
260
Roshan Pius4df2bc72020-04-27 09:42:27 -0700261// runtime_resource_overlay properties that can be overridden by override_runtime_resource_overlay
262type OverridableRuntimeResourceOverlayProperties struct {
263 // the package name of this app. The package name in the manifest file is used if one was not given.
264 Package_name *string
265
266 // the target package name of this overlay app. The target package name in the manifest file is used if one was not given.
267 Target_package_name *string
268}
269
Colin Cross30e076a2015-04-13 13:58:27 -0700270type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700271 Library
272 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800273 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700274
Colin Cross50ddcc42019-05-16 12:28:22 -0700275 usesLibrary usesLibrary
276
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900277 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700278
Colin Crossfabb6082018-02-20 17:22:23 -0800279 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700280
Jaewoong Jung525443a2019-02-28 15:35:54 -0800281 overridableAppProperties overridableAppProperties
282
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700283 installJniLibs []jniLib
284 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700285
286 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800287
288 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
289 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800290
Colin Cross70dda7e2019-10-01 22:05:35 -0700291 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700292
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700293 onDeviceDir string
294
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800295 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700296
297 noticeOutputs android.NoticeOutputs
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900298
299 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100300
301 android.ApexBundleDepsInfo
Colin Crosse1731a52017-12-14 11:22:55 -0800302}
303
Martin Stjernholm6d415272020-01-31 17:10:36 +0000304func (a *AndroidApp) IsInstallable() bool {
305 return Bool(a.properties.Installable)
306}
307
Colin Cross89c31582018-04-30 15:55:11 -0700308func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths {
309 return nil
310}
311
Colin Cross66f78822018-05-02 12:58:28 -0700312func (a *AndroidApp) ExportedStaticPackages() android.Paths {
313 return nil
314}
315
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900316func (a *AndroidApp) OutputFile() android.Path {
317 return a.outputFile
318}
319
Colin Cross503c1d02020-01-28 14:00:53 -0800320func (a *AndroidApp) Certificate() Certificate {
321 return a.certificate
322}
323
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700324func (a *AndroidApp) JniCoverageOutputs() android.Paths {
325 return a.jniCoverageOutputs
326}
327
Colin Crossa97c5d32018-03-28 14:58:31 -0700328var _ AndroidLibraryDependency = (*AndroidApp)(nil)
329
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900330type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800331 Pem, Key android.Path
332 presigned bool
333}
334
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700335var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800336
337func (c Certificate) AndroidMkString() string {
338 if c.presigned {
339 return "PRESIGNED"
340 } else {
341 return c.Pem.String()
342 }
Colin Cross30e076a2015-04-13 13:58:27 -0700343}
344
Colin Cross46c9b8b2017-06-22 16:51:17 -0700345func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
346 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700347
Jiyong Park6a927c42020-01-21 02:03:43 +0900348 if String(a.appProperties.Stl) == "c++_shared" && !a.sdkVersion().specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700349 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
350 }
351
Paul Duffin250e6192019-06-07 10:44:37 +0100352 sdkDep := decodeSdkDep(ctx, sdkContext(a))
353 if sdkDep.hasFrameworkLibs() {
354 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700355 }
Colin Crossa4f08812018-10-02 22:03:40 -0700356
Colin Cross3c007702020-05-08 11:20:24 -0700357 usesSDK := a.sdkVersion().specified() && a.sdkVersion().kind != sdkCorePlatform
358
359 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
360 ctx.PropertyErrorf("jni_uses_sdk_apis",
361 "can only be set for modules that do not set sdk_version")
362 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
363 ctx.PropertyErrorf("jni_uses_platform_apis",
364 "can only be set for modules that set sdk_version")
365 }
366
Peter Collingbournead84f972019-12-17 16:46:18 -0800367 tag := &jniDependencyTag{}
Colin Crossa4f08812018-10-02 22:03:40 -0700368 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700369 variation := append(jniTarget.Variations(),
370 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000371
372 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
373 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700374 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
375 // have stable APIs through the VNDK.
376 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
377 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700378 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000379 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
380 }
Colin Crossa4f08812018-10-02 22:03:40 -0700381 ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...)
382 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700383
Paul Duffin250e6192019-06-07 10:44:37 +0100384 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700385}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700386
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700387func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800388 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700389 if cert != "" {
390 ctx.AddDependency(ctx.Module(), certificateTag, cert)
391 }
392
393 for _, cert := range a.appProperties.Additional_certificates {
394 cert = android.SrcIsModule(cert)
395 if cert != "" {
396 ctx.AddDependency(ctx.Module(), certificateTag, cert)
397 } else {
398 ctx.PropertyErrorf("additional_certificates",
399 `must be names of android_app_certificate modules in the form ":module"`)
400 }
401 }
Colin Cross30e076a2015-04-13 13:58:27 -0700402}
403
Jeongik Cha538c0d02019-07-11 15:54:27 +0900404func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
405 a.generateAndroidBuildActions(ctx)
406}
407
Colin Cross46c9b8b2017-06-22 16:51:17 -0700408func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100409 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700410 a.generateAndroidBuildActions(ctx)
411}
412
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100413func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100414 if a.Updatable() {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100415 if !a.sdkVersion().stable() {
416 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.sdkVersion())
417 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100418 if String(a.deviceProperties.Min_sdk_version) == "" {
419 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
420 }
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900421 if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil {
422 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
423 } else {
424 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
425 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100426 }
427
428 a.checkPlatformAPI(ctx)
429 a.checkSdkVersions(ctx)
430}
431
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900432// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
433// This check is enforced for "updatable" APKs (including APK-in-APEX).
434// b/155209650: until min_sdk_version is properly supported, use sdk_version instead.
435// because, sdk_version is overridden by min_sdk_version (if set as smaller)
436// and linkType is checked with dependencies so we can be sure that the whole dependency tree
437// will meet the requirements.
438func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) {
439 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
440 ctx.VisitDirectDeps(func(m android.Module) {
441 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
442 return
443 }
444 dep, _ := m.(*cc.Module)
445 jniSdkVersion, err := android.ApiStrToNum(ctx, dep.SdkVersion())
446 if err != nil || int(minSdkVersion) < jniSdkVersion {
447 ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
448 dep.SdkVersion(), minSdkVersion, ctx.ModuleName())
449 return
450 }
451
452 })
453}
454
Sasha Smundak6ad77252019-05-01 13:16:22 -0700455// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800456// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700457func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park6a927c42020-01-21 02:03:43 +0900458 minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800459 if err != nil {
460 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
461 }
462
Jiyong Park52cd06f2019-11-11 10:14:32 +0900463 return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
464 !a.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800465}
466
Colin Cross43f08db2018-11-12 10:13:39 -0800467// Returns whether this module should have the dex file stored uncompressed in the APK.
468func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800469 if Bool(a.appProperties.Use_embedded_dex) {
470 return true
471 }
472
Colin Cross53a87f52019-06-25 13:35:30 -0700473 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
474 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900475 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000476 return true
477 }
478
Colin Cross53a87f52019-06-25 13:35:30 -0700479 if ctx.Config().UnbundledBuild() {
480 return false
481 }
482
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700483 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700484}
485
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700486func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
487 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Jiyong Park52cd06f2019-11-11 10:14:32 +0900488 !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700489}
490
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900491func (a *AndroidApp) OverriddenManifestPackageName() string {
492 return a.overriddenManifestPackageName
493}
494
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800495func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
David Brazdild25060a2019-02-18 18:24:16 +0000496 a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
497
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700498 // Ask manifest_fixer to add or update the application element indicating this app has no code.
499 a.aapt.hasNoCode = !a.hasCode(ctx)
500
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800501 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800502
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800503 // 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 -0800504 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700505 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800506 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700507 }
508
Dan Willemsen72be5902018-10-24 20:24:57 -0700509 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
510 // Product AAPT config
511 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800512 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700513 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700514
Dan Willemsen72be5902018-10-24 20:24:57 -0700515 // Product AAPT preferred config
516 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800517 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700518 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700519 }
520
Jiyong Park7f67f482019-01-05 12:57:48 +0900521 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700522 if overridden || a.overridableAppProperties.Package_name != nil {
523 // The product override variable has a priority over the package_name property.
524 if !overridden {
525 manifestPackageName = *a.overridableAppProperties.Package_name
526 }
Liz Kammer1d5983b2020-05-19 19:15:37 +0000527 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900528 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900529 }
530
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800531 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
532
Colin Crosse560c4a2019-03-19 16:03:11 -0700533 a.aapt.splitNames = a.appProperties.Package_splits
Colin Cross50ddcc42019-05-16 12:28:22 -0700534 a.aapt.sdkLibraries = a.exportedSdkLibs
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800535 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800536 a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
Colin Cross30e076a2015-04-13 13:58:27 -0700537
Colin Cross46c9b8b2017-06-22 16:51:17 -0700538 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700539 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800540}
Colin Cross30e076a2015-04-13 13:58:27 -0700541
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800542func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700543 var staticLibProguardFlagFiles android.Paths
544 ctx.VisitDirectDeps(func(m android.Module) {
545 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
546 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
547 }
548 })
549
550 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
551
552 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
553 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800554}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800555
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800556func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross43f08db2018-11-12 10:13:39 -0800557
558 var installDir string
559 if ctx.ModuleName() == "framework-res" {
560 // framework-res.apk is installed as system/framework/framework-res.apk
561 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900562 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800563 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800564 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800565 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800566 }
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800567 a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
David Srbeckye033cba2020-05-20 22:20:28 +0100568 if a.deviceProperties.Uncompress_dex == nil {
569 // If the value was not force-set by the user, use reasonable default based on the module.
570 a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
571 }
572 a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700573 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
574 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
575 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
576 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
577 a.dexpreopter.manifestFile = a.mergedManifestFile
578
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800579 if ctx.ModuleName() != "framework-res" {
580 a.Module.compile(ctx, a.aaptSrcJar)
581 }
Colin Cross30e076a2015-04-13 13:58:27 -0700582
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800583 return a.maybeStrippedDexJarFile
584}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800585
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800586func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700587 var jniJarFile android.WritablePath
Colin Crossa4f08812018-10-02 22:03:40 -0700588 if len(jniLibs) > 0 {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700589 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700590 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Sasha Smundak6ad77252019-05-01 13:16:22 -0700591 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700592 for _, jni := range jniLibs {
593 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700594 // Only collect coverage for the first target arch if this is a multilib target.
595 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
596 // data file path collisions since the current coverage file path format doesn't contain
597 // arch-related strings. This is fine for now though; the code coverage team doesn't use
598 // multi-arch targets such as test_suite_* for coverage collections yet.
599 //
600 // Work with the team to come up with a new format that handles multilib modules properly
601 // and change this.
602 if len(ctx.Config().Targets[android.Android]) == 1 ||
603 ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType {
604 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
605 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700606 }
607 }
Colin Crossa4f08812018-10-02 22:03:40 -0700608 } else {
609 a.installJniLibs = jniLibs
610 }
611 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800612 return jniJarFile
613}
Colin Crossa4f08812018-10-02 22:03:40 -0700614
Jaewoong Jung0949f312019-09-11 10:25:18 -0700615func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700616 // Collect NOTICE files from all dependencies.
617 seenModules := make(map[android.Module]bool)
618 noticePathSet := make(map[android.Path]bool)
619
620 ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
621 // Have we already seen this?
622 if _, ok := seenModules[child]; ok {
623 return false
624 }
625 seenModules[child] = true
626
627 // Skip host modules.
628 if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
629 return false
630 }
631
Bob Badoura75b0572020-02-18 20:21:55 -0800632 paths := child.(android.Module).NoticeFiles()
633 if len(paths) > 0 {
634 for _, path := range paths {
635 noticePathSet[path] = true
636 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700637 }
638 return true
639 })
640
641 // If the app has one, add it too.
Bob Badoura75b0572020-02-18 20:21:55 -0800642 if len(a.NoticeFiles()) > 0 {
643 for _, path := range a.NoticeFiles() {
644 noticePathSet[path] = true
645 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700646 }
647
648 if len(noticePathSet) == 0 {
Jaewoong Jung98772792019-07-01 17:15:13 -0700649 return
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700650 }
651 var noticePaths []android.Path
652 for path := range noticePathSet {
653 noticePaths = append(noticePaths, path)
654 }
655 sort.Slice(noticePaths, func(i, j int) bool {
656 return noticePaths[i].String() < noticePaths[j].String()
657 })
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700658
Jaewoong Jung0949f312019-09-11 10:25:18 -0700659 a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700660}
661
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700662// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
663// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
664func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
665 if android.SrcIsModule(certPropValue) == "" {
666 var mainCert Certificate
667 if certPropValue != "" {
668 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
669 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800670 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
671 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700672 }
673 } else {
674 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800675 mainCert = Certificate{
676 Pem: pem,
677 Key: key,
678 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700679 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700680 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700681 }
682
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700683 if !m.Platform() {
684 certPath := certificates[0].Pem.String()
Jeongik Chac9464142019-01-07 12:07:27 +0900685 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
686 if strings.HasPrefix(certPath, systemCertPath) {
687 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
688 whitelist := ctx.Config().EnforceSystemCertificateWhitelist()
689
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700690 if enforceSystemCert && !inList(m.Name(), whitelist) {
Jeongik Chac9464142019-01-07 12:07:27 +0900691 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
692 }
693 }
694 }
695
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700696 return certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800697}
698
Jooyung Han39ee1192020-03-23 20:21:11 +0900699func (a *AndroidApp) InstallApkName() string {
700 return a.installApkName
701}
702
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800703func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700704 var apkDeps android.Paths
705
Jeongik Cha538c0d02019-07-11 15:54:27 +0900706 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
707 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
708
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800709 // Check if the install APK name needs to be overridden.
Jaewoong Jung525443a2019-02-28 15:35:54 -0800710 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800711
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700712 if ctx.ModuleName() == "framework-res" {
713 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700714 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900715 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700716 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
717 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800718 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700719 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700720 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700721 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700722 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700723
Jaewoong Jung0949f312019-09-11 10:25:18 -0700724 a.noticeBuildActions(ctx)
Jaewoong Jung98772792019-07-01 17:15:13 -0700725 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
726 a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
727 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700728
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800729 // Process all building blocks, from AAPT to certificates.
730 a.aaptBuildActions(ctx)
731
Colin Cross50ddcc42019-05-16 12:28:22 -0700732 if a.usesLibrary.enforceUsesLibraries() {
733 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
734 apkDeps = append(apkDeps, manifestCheckFile)
735 }
736
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800737 a.proguardBuildActions(ctx)
738
739 dexJarFile := a.dexBuildActions(ctx)
740
Colin Crossc2d24052020-05-13 11:05:02 -0700741 jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800742 jniJarFile := a.jniBuildActions(jniLibs, ctx)
743
744 if ctx.Failed() {
745 return
746 }
747
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700748 certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
749 a.certificate = certificates[0]
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800750
751 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800752 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700753 var lineageFile android.Path
754 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
755 lineageFile = android.PathForModuleSrc(ctx, lineage)
756 }
757 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, lineageFile)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800758 a.outputFile = packageFile
759
Colin Crosse560c4a2019-03-19 16:03:11 -0700760 for _, split := range a.aapt.splits {
761 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800762 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700763 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, lineageFile)
Colin Crosse560c4a2019-03-19 16:03:11 -0700764 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
765 }
766
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800767 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700768 bundleFile := android.PathForModuleOut(ctx, "base.zip")
769 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
770 a.bundleFile = bundleFile
771
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800772 // Install the app package.
Jiyong Park8ba50f92019-11-13 15:01:01 +0900773 if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
774 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
775 for _, extra := range a.extraOutputFiles {
776 ctx.InstallFile(a.installDir, extra.Base(), extra)
777 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800778 }
Artur Satayev1111b842020-04-27 19:05:28 +0100779
780 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700781}
782
Colin Crossc2d24052020-05-13 11:05:02 -0700783type appDepsInterface interface {
784 sdkVersion() sdkSpec
785 minSdkVersion() sdkSpec
786 RequiresStableAPIs(ctx android.BaseModuleContext) bool
787}
788
789func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
790 shouldCollectRecursiveNativeDeps bool,
Colin Cross094cde42020-02-15 10:38:00 -0800791 checkNativeSdkVersion bool) ([]jniLib, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700792
Colin Crossa4f08812018-10-02 22:03:40 -0700793 var jniLibs []jniLib
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900794 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800795 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700796
Colin Crossc2d24052020-05-13 11:05:02 -0700797 if checkNativeSdkVersion {
798 checkNativeSdkVersion = app.sdkVersion().specified() &&
799 app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx)
800 }
801
Peter Collingbournead84f972019-12-17 16:46:18 -0800802 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700803 otherName := ctx.OtherModuleName(module)
804 tag := ctx.OtherModuleDependencyTag(module)
805
Peter Collingbournead84f972019-12-17 16:46:18 -0800806 if IsJniDepTag(tag) || tag == cc.SharedDepTag {
Colin Crossa4f08812018-10-02 22:03:40 -0700807 if dep, ok := module.(*cc.Module); ok {
Peter Collingbournead84f972019-12-17 16:46:18 -0800808 if dep.IsNdk() || dep.IsStubs() {
809 return false
810 }
811
Colin Crossa4f08812018-10-02 22:03:40 -0700812 lib := dep.OutputFile()
Peter Collingbournead84f972019-12-17 16:46:18 -0800813 path := lib.Path()
814 if seenModulePaths[path.String()] {
815 return false
816 }
817 seenModulePaths[path.String()] = true
818
Colin Crossc2d24052020-05-13 11:05:02 -0700819 if checkNativeSdkVersion && dep.SdkVersion() == "" {
820 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
821 otherName)
Colin Cross094cde42020-02-15 10:38:00 -0800822 }
823
Colin Crossa4f08812018-10-02 22:03:40 -0700824 if lib.Valid() {
825 jniLibs = append(jniLibs, jniLib{
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700826 name: ctx.OtherModuleName(module),
827 path: path,
828 target: module.Target(),
829 coverageFile: dep.CoverageOutputFile(),
Colin Crossa4f08812018-10-02 22:03:40 -0700830 })
831 } else {
832 ctx.ModuleErrorf("dependency %q missing output file", otherName)
833 }
834 } else {
835 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700836 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800837
838 return shouldCollectRecursiveNativeDeps
839 }
840
841 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700842 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900843 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700844 } else {
845 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
846 }
Colin Crossa4f08812018-10-02 22:03:40 -0700847 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800848
849 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700850 })
851
Colin Crossbd01e2a2018-10-04 15:21:03 -0700852 return jniLibs, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700853}
854
Artur Satayev1111b842020-04-27 19:05:28 +0100855func (a *AndroidApp) walkPayloadDeps(ctx android.ModuleContext,
856 do func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool)) {
857
858 ctx.WalkDeps(func(child, parent android.Module) bool {
859 isExternal := !a.DepIsInSameApex(ctx, child)
860 if am, ok := child.(android.ApexModule); ok {
861 do(ctx, parent, am, isExternal)
862 }
863 return !isExternal
864 })
865}
866
867func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
868 if ctx.Host() {
869 return
870 }
871
872 depsInfo := android.DepNameToDepInfoMap{}
873 a.walkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) {
874 depName := to.Name()
875 if info, exist := depsInfo[depName]; exist {
876 info.From = append(info.From, from.Name())
877 info.IsExternal = info.IsExternal && externalDep
878 depsInfo[depName] = info
879 } else {
880 toMinSdkVersion := "(no version)"
881 if m, ok := to.(interface{ MinSdkVersion() string }); ok {
882 if v := m.MinSdkVersion(); v != "" {
883 toMinSdkVersion = v
884 }
885 }
886 depsInfo[depName] = android.ApexModuleDepInfo{
887 To: depName,
888 From: []string{from.Name()},
889 IsExternal: externalDep,
890 MinSdkVersion: toMinSdkVersion,
891 }
892 }
893 })
894
895 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo)
896}
897
Artur Satayev849f8442020-04-28 14:57:42 +0100898func (a *AndroidApp) Updatable() bool {
899 return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable()
900}
901
Colin Cross0ea8ba82019-06-06 14:33:29 -0700902func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800903 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
904 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000905 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800906 }
Jaewoong Jung525443a2019-02-28 15:35:54 -0800907 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800908}
909
Jiyong Park0f80c182020-01-31 02:49:53 +0900910func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
911 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
912 return true
913 }
914 return a.Library.DepIsInSameApex(ctx, dep)
915}
916
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900917// For OutputFileProducer interface
918func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
919 switch tag {
920 case ".aapt.srcjar":
921 return []android.Path{a.aaptSrcJar}, nil
922 }
923 return a.Library.OutputFiles(tag)
924}
925
Jiyong Parkf7487312019-10-17 12:54:30 +0900926func (a *AndroidApp) Privileged() bool {
927 return Bool(a.appProperties.Privileged)
928}
929
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700930func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
931 return ctx.Device() && (ctx.DeviceConfig().NativeCoverageEnabled() || ctx.DeviceConfig().ClangCoverageEnabled())
932}
933
934func (a *AndroidApp) PreventInstall() {
935 a.appProperties.PreventInstall = true
936}
937
938func (a *AndroidApp) HideFromMake() {
939 a.appProperties.HideFromMake = true
940}
941
942func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
943 a.appProperties.IsCoverageVariant = coverage
944}
945
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400946func (a *AndroidApp) EnableCoverageIfNeeded() {}
947
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700948var _ cc.Coverage = (*AndroidApp)(nil)
949
Colin Cross1b16b0e2019-02-12 14:41:32 -0800950// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -0700951func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -0700952 module := &AndroidApp{}
953
Sasha Smundak2057f822019-04-16 17:16:58 -0700954 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross66dbc0b2017-12-28 12:23:20 -0800955 module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
956
Colin Crossae5caf52018-05-22 11:11:52 -0700957 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700958 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -0700959
Colin Cross36242852017-06-23 15:06:31 -0700960 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -0700961 &module.Module.properties,
962 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800963 &module.Module.dexpreoptProperties,
Colin Crossa97c5d32018-03-28 14:58:31 -0700964 &module.Module.protoProperties,
965 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800966 &module.appProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700967 &module.overridableAppProperties,
968 &module.usesLibrary.usesLibraryProperties)
Colin Cross36242852017-06-23 15:06:31 -0700969
Colin Crossa9d8bee2018-10-02 13:59:46 -0700970 module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool {
971 return class == android.Device && ctx.Config().DevicePrefer32BitApps()
972 })
973
Colin Crossa4f08812018-10-02 22:03:40 -0700974 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
975 android.InitDefaultableModule(module)
Jaewoong Jung525443a2019-02-28 15:35:54 -0800976 android.InitOverridableModule(module, &module.appProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +0900977 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -0700978
Colin Cross36242852017-06-23 15:06:31 -0700979 return module
Colin Cross30e076a2015-04-13 13:58:27 -0700980}
Colin Crossae5caf52018-05-22 11:11:52 -0700981
982type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -0700983 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -0700984 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -0700985
986 // if specified, the instrumentation target package name in the manifest is overwritten by it.
987 Instrumentation_target_package *string
Colin Crossae5caf52018-05-22 11:11:52 -0700988}
989
990type AndroidTest struct {
991 AndroidApp
992
993 appTestProperties appTestProperties
994
995 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -0700996
997 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -0700998 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -0700999}
1000
Jaewoong Jung0949f312019-09-11 10:25:18 -07001001func (a *AndroidTest) InstallInTestcases() bool {
1002 return true
1003}
1004
Colin Crossae5caf52018-05-22 11:11:52 -07001005func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001006 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001007 if a.appTestProperties.Instrumentation_target_package != nil {
1008 a.additionalAaptFlags = append(a.additionalAaptFlags,
1009 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1010 } else if a.appTestProperties.Instrumentation_for != nil {
1011 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001012 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1013 if overridden {
1014 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1015 }
1016 }
Colin Crossae5caf52018-05-22 11:11:52 -07001017 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001018
easoncylee5bcff5d2020-04-30 14:57:06 +08001019 for _, module := range a.testProperties.Test_mainline_modules {
1020 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1021 }
1022
Jaewoong Jung39982342020-01-14 10:27:18 -08001023 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001024 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001025 a.testConfig = a.FixTestConfig(ctx, testConfig)
Colin Cross8a497952019-03-05 22:25:09 -08001026 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001027}
1028
Jaewoong Jung39982342020-01-14 10:27:18 -08001029func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1030 if testConfig == nil {
1031 return nil
1032 }
1033
1034 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
1035 rule := android.NewRuleBuilder()
1036 command := rule.Command().BuiltTool(ctx, "test_config_fixer").Input(testConfig).Output(fixedConfig)
1037 fixNeeded := false
1038
1039 if ctx.ModuleName() != a.installApkName {
1040 fixNeeded = true
1041 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1042 }
1043
1044 if a.overridableAppProperties.Package_name != nil {
1045 fixNeeded = true
1046 command.FlagWithInput("--manifest ", a.manifestPath).
1047 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1048 }
1049
1050 if fixNeeded {
1051 rule.Build(pctx, ctx, "fix_test_config", "fix test config")
1052 return fixedConfig
1053 }
1054 return testConfig
1055}
1056
Colin Cross303e21f2018-08-07 16:49:25 -07001057func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001058 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001059}
1060
1061func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1062 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001063 if a.appTestProperties.Instrumentation_for != nil {
1064 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1065 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1066 // use instrumentationForTag instead of libTag.
1067 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1068 }
Colin Crossae5caf52018-05-22 11:11:52 -07001069}
1070
Colin Cross1b16b0e2019-02-12 14:41:32 -08001071// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1072// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001073func AndroidTestFactory() android.Module {
1074 module := &AndroidTest{}
1075
Sasha Smundak2057f822019-04-16 17:16:58 -07001076 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross5067db92018-09-17 16:46:35 -07001077
1078 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001079 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001080 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001081 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001082 module.Module.dexpreopter.isTest = true
Colin Crossae5caf52018-05-22 11:11:52 -07001083
1084 module.AddProperties(
1085 &module.Module.properties,
1086 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001087 &module.Module.dexpreoptProperties,
Colin Crossae5caf52018-05-22 11:11:52 -07001088 &module.Module.protoProperties,
1089 &module.aaptProperties,
1090 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001091 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001092 &module.overridableAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001093 &module.usesLibrary.usesLibraryProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001094 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001095
Colin Crossa4f08812018-10-02 22:03:40 -07001096 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1097 android.InitDefaultableModule(module)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001098 android.InitOverridableModule(module, &module.appProperties.Overrides)
Colin Crossae5caf52018-05-22 11:11:52 -07001099 return module
1100}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001101
Colin Cross252fc6f2018-10-04 15:22:03 -07001102type appTestHelperAppProperties struct {
1103 // list of compatibility suites (for example "cts", "vts") that the module should be
1104 // installed into.
1105 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001106
1107 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1108 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1109 // explicitly.
1110 Auto_gen_config *bool
Colin Cross252fc6f2018-10-04 15:22:03 -07001111}
1112
1113type AndroidTestHelperApp struct {
1114 AndroidApp
1115
1116 appTestHelperAppProperties appTestHelperAppProperties
1117}
1118
Jaewoong Jung326a9412019-11-21 10:41:00 -08001119func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1120 return true
1121}
1122
Colin Cross1b16b0e2019-02-12 14:41:32 -08001123// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1124// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1125// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001126func AndroidTestHelperAppFactory() android.Module {
1127 module := &AndroidTestHelperApp{}
1128
Sasha Smundak2057f822019-04-16 17:16:58 -07001129 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001130
1131 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001132 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001133 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001134 module.Module.dexpreopter.isTest = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001135
1136 module.AddProperties(
1137 &module.Module.properties,
1138 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001139 &module.Module.dexpreoptProperties,
Colin Cross252fc6f2018-10-04 15:22:03 -07001140 &module.Module.protoProperties,
1141 &module.aaptProperties,
1142 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001143 &module.appTestHelperAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001144 &module.overridableAppProperties,
1145 &module.usesLibrary.usesLibraryProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001146
1147 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1148 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001149 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001150 return module
1151}
1152
Colin Crossbd01e2a2018-10-04 15:21:03 -07001153type AndroidAppCertificate struct {
1154 android.ModuleBase
1155 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001156 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001157}
1158
1159type AndroidAppCertificateProperties struct {
1160 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1161 Certificate *string
1162}
1163
Colin Cross1b16b0e2019-02-12 14:41:32 -08001164// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1165// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001166func AndroidAppCertificateFactory() android.Module {
1167 module := &AndroidAppCertificate{}
1168 module.AddProperties(&module.properties)
1169 android.InitAndroidModule(module)
1170 return module
1171}
1172
Colin Crossbd01e2a2018-10-04 15:21:03 -07001173func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1174 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001175 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001176 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1177 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001178 }
1179}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001180
1181type OverrideAndroidApp struct {
1182 android.ModuleBase
1183 android.OverrideModuleBase
1184}
1185
1186func (i *OverrideAndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1187 // All the overrides happen in the base module.
1188 // TODO(jungjw): Check the base module type.
1189}
1190
1191// override_android_app is used to create an android_app module based on another android_app by overriding
1192// some of its properties.
1193func OverrideAndroidAppModuleFactory() android.Module {
1194 m := &OverrideAndroidApp{}
1195 m.AddProperties(&overridableAppProperties{})
1196
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001197 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001198 android.InitOverrideModule(m)
1199 return m
1200}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001201
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001202type OverrideAndroidTest struct {
1203 android.ModuleBase
1204 android.OverrideModuleBase
1205}
1206
1207func (i *OverrideAndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1208 // All the overrides happen in the base module.
1209 // TODO(jungjw): Check the base module type.
1210}
1211
1212// override_android_test is used to create an android_app module based on another android_test by overriding
1213// some of its properties.
1214func OverrideAndroidTestModuleFactory() android.Module {
1215 m := &OverrideAndroidTest{}
1216 m.AddProperties(&overridableAppProperties{})
1217 m.AddProperties(&appTestProperties{})
1218
1219 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1220 android.InitOverrideModule(m)
1221 return m
1222}
1223
Roshan Pius4df2bc72020-04-27 09:42:27 -07001224type OverrideRuntimeResourceOverlay struct {
1225 android.ModuleBase
1226 android.OverrideModuleBase
1227}
1228
1229func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1230 // All the overrides happen in the base module.
1231 // TODO(jungjw): Check the base module type.
1232}
1233
1234// override_runtime_resource_overlay is used to create a module based on another
1235// runtime_resource_overlay module by overriding some of its properties.
1236func OverrideRuntimeResourceOverlayModuleFactory() android.Module {
1237 m := &OverrideRuntimeResourceOverlay{}
1238 m.AddProperties(&OverridableRuntimeResourceOverlayProperties{})
1239
1240 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1241 android.InitOverrideModule(m)
1242 return m
1243}
1244
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001245type AndroidAppImport struct {
1246 android.ModuleBase
1247 android.DefaultableModuleBase
Jiyong Park592a6a42020-04-21 22:34:28 +09001248 android.ApexModuleBase
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001249 prebuilt android.Prebuilt
1250
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001251 properties AndroidAppImportProperties
1252 dpiVariants interface{}
1253 archVariants interface{}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001254
1255 outputFile android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001256 certificate Certificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001257
1258 dexpreopter
Colin Cross50ddcc42019-05-16 12:28:22 -07001259
1260 usesLibrary usesLibrary
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001261
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001262 preprocessed bool
1263
Colin Cross70dda7e2019-10-01 22:05:35 -07001264 installPath android.InstallPath
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001265}
1266
1267type AndroidAppImportProperties struct {
1268 // A prebuilt apk to import
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001269 Apk *string
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001270
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001271 // The name of a certificate in the default certificate directory or an android_app_certificate
1272 // module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001273 Certificate *string
1274
1275 // Set this flag to true if the prebuilt apk is already signed. The certificate property must not
1276 // be set for presigned modules.
1277 Presigned *bool
1278
Liz Kammer24978992020-05-13 15:49:21 -07001279 // Name of the signing certificate lineage file.
1280 Lineage *string
1281
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001282 // Sign with the default system dev certificate. Must be used judiciously. Most imported apps
1283 // need to either specify a specific certificate or be presigned.
1284 Default_dev_cert *bool
1285
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001286 // Specifies that this app should be installed to the priv-app directory,
1287 // where the system will grant it additional privileges not available to
1288 // normal apps.
1289 Privileged *bool
1290
1291 // Names of modules to be overridden. Listed modules can only be other binaries
1292 // (in Make or Soong).
1293 // This does not completely prevent installation of the overridden binaries, but if both
1294 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
1295 // from PRODUCT_PACKAGES.
1296 Overrides []string
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001297
1298 // Optional name for the installed app. If unspecified, it is derived from the module name.
1299 Filename *string
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001300}
1301
Martin Stjernholm6d415272020-01-31 17:10:36 +00001302func (a *AndroidAppImport) IsInstallable() bool {
1303 return true
1304}
1305
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001306// Updates properties with variant-specific values.
1307func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001308 config := ctx.Config()
1309
1310 dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
1311 // Try DPI variant matches in the reverse-priority order so that the highest priority match
1312 // overwrites everything else.
1313 // TODO(jungjw): Can we optimize this by making it priority order?
1314 for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001315 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001316 }
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001317 if config.ProductAAPTPreferredConfig() != "" {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001318 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001319 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001320
1321 archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
1322 archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
1323 MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001324}
1325
Colin Cross1184b642019-12-30 18:43:07 -08001326func MergePropertiesFromVariant(ctx android.EarlyModuleContext,
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001327 dst interface{}, variantGroup reflect.Value, variant string) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001328 src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
1329 if !src.IsValid() {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001330 return
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001331 }
1332
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001333 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
1334 if err != nil {
1335 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1336 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1337 } else {
1338 panic(err)
1339 }
1340 }
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001341}
1342
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001343func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
1344 cert := android.SrcIsModule(String(a.properties.Certificate))
1345 if cert != "" {
1346 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1347 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001348
Paul Duffin250e6192019-06-07 10:44:37 +01001349 a.usesLibrary.deps(ctx, true)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001350}
1351
1352func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
1353 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001354 // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing
1355 // with them may invalidate pre-existing signature data.
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001356 if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001357 ctx.Build(pctx, android.BuildParams{
1358 Rule: android.Cp,
1359 Output: outputPath,
1360 Input: inputPath,
1361 })
1362 return
1363 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001364 rule := android.NewRuleBuilder()
1365 rule.Command().
1366 Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001367 BuiltTool(ctx, "zip2zip").
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001368 FlagWithInput("-i ", inputPath).
1369 FlagWithOutput("-o ", outputPath).
1370 FlagWithArg("-0 ", "'lib/**/*.so'").
1371 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1372 rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
1373}
1374
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001375// Returns whether this module should have the dex file stored uncompressed in the APK.
1376func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001377 if ctx.Config().UnbundledBuild() || a.preprocessed {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001378 return false
1379 }
1380
1381 // Uncompress dex in APKs of privileged apps
Jiyong Parkf7487312019-10-17 12:54:30 +09001382 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001383 return true
1384 }
1385
1386 return shouldUncompressDex(ctx, &a.dexpreopter)
1387}
1388
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001389func (a *AndroidAppImport) uncompressDex(
1390 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
1391 rule := android.NewRuleBuilder()
1392 rule.Command().
1393 Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001394 BuiltTool(ctx, "zip2zip").
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001395 FlagWithInput("-i ", inputPath).
1396 FlagWithOutput("-o ", outputPath).
1397 FlagWithArg("-0 ", "'classes*.dex'").
1398 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1399 rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
1400}
1401
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001402func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001403 a.generateAndroidBuildActions(ctx)
1404}
1405
Jooyung Han39ee1192020-03-23 20:21:11 +09001406func (a *AndroidAppImport) InstallApkName() string {
1407 return a.BaseModuleName()
1408}
1409
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001410func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001411 numCertPropsSet := 0
1412 if String(a.properties.Certificate) != "" {
1413 numCertPropsSet++
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001414 }
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001415 if Bool(a.properties.Presigned) {
1416 numCertPropsSet++
1417 }
1418 if Bool(a.properties.Default_dev_cert) {
1419 numCertPropsSet++
1420 }
1421 if numCertPropsSet != 1 {
1422 ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001423 }
1424
Colin Crossc2d24052020-05-13 11:05:02 -07001425 _, certificates := collectAppDeps(ctx, a, false, false)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001426
1427 // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001428 // TODO: LOCAL_PACKAGE_SPLITS
1429
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001430 srcApk := a.prebuilt.SingleSourcePath(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001431
1432 if a.usesLibrary.enforceUsesLibraries() {
1433 srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
1434 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001435
1436 // TODO: Install or embed JNI libraries
1437
1438 // Uncompress JNI libraries in the apk
1439 jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
1440 a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
1441
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001442 var installDir android.InstallPath
1443 if Bool(a.properties.Privileged) {
1444 installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001445 } else if ctx.InstallInTestcases() {
1446 installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch())
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001447 } else {
1448 installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
1449 }
1450
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001451 a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001452 a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001453 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001454
1455 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
1456 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
1457 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
1458 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
1459
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001460 dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001461 if a.dexpreopter.uncompressedDex {
1462 dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
1463 a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
1464 dexOutput = dexUncompressed
1465 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001466
Jooyung Han39ee1192020-03-23 20:21:11 +09001467 apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk")
1468
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001469 // TODO: Handle EXTERNAL
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001470
1471 // Sign or align the package if package has not been preprocessed
1472 if a.preprocessed {
1473 a.outputFile = srcApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001474 a.certificate = PresignedCertificate
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001475 } else if !Bool(a.properties.Presigned) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001476 // If the certificate property is empty at this point, default_dev_cert must be set to true.
1477 // Which makes processMainCert's behavior for the empty cert string WAI.
1478 certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001479 if len(certificates) != 1 {
1480 ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
1481 }
Colin Cross503c1d02020-01-28 14:00:53 -08001482 a.certificate = certificates[0]
Jooyung Han39ee1192020-03-23 20:21:11 +09001483 signed := android.PathForModuleOut(ctx, "signed", apkFilename)
Liz Kammer24978992020-05-13 15:49:21 -07001484 var lineageFile android.Path
1485 if lineage := String(a.properties.Lineage); lineage != "" {
1486 lineageFile = android.PathForModuleSrc(ctx, lineage)
1487 }
1488 SignAppPackage(ctx, signed, dexOutput, certificates, lineageFile)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001489 a.outputFile = signed
1490 } else {
Jooyung Han39ee1192020-03-23 20:21:11 +09001491 alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001492 TransformZipAlign(ctx, alignedApk, dexOutput)
1493 a.outputFile = alignedApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001494 a.certificate = PresignedCertificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001495 }
1496
1497 // TODO: Optionally compress the output apk.
1498
Jiyong Park592a6a42020-04-21 22:34:28 +09001499 if a.IsForPlatform() {
1500 a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile)
1501 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001502
1503 // TODO: androidmk converter jni libs
1504}
1505
1506func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
1507 return &a.prebuilt
1508}
1509
1510func (a *AndroidAppImport) Name() string {
1511 return a.prebuilt.Name(a.ModuleBase.Name())
1512}
1513
Dario Frenicde2a032019-10-27 00:29:22 +01001514func (a *AndroidAppImport) OutputFile() android.Path {
1515 return a.outputFile
1516}
1517
Jiyong Park618922e2020-01-08 13:35:43 +09001518func (a *AndroidAppImport) JacocoReportClassesFile() android.Path {
1519 return nil
1520}
1521
Colin Cross503c1d02020-01-28 14:00:53 -08001522func (a *AndroidAppImport) Certificate() Certificate {
1523 return a.certificate
1524}
1525
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001526var dpiVariantGroupType reflect.Type
1527var archVariantGroupType reflect.Type
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001528
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001529func initAndroidAppImportVariantGroupTypes() {
1530 dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
1531
1532 archNames := make([]string, len(android.ArchTypeList()))
1533 for i, archType := range android.ArchTypeList() {
1534 archNames[i] = archType.Name
1535 }
1536 archVariantGroupType = createVariantGroupType(archNames, "Arch")
1537}
1538
1539// Populates all variant struct properties at creation time.
1540func (a *AndroidAppImport) populateAllVariantStructs() {
1541 a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
1542 a.AddProperties(a.dpiVariants)
1543
1544 a.archVariants = reflect.New(archVariantGroupType).Interface()
1545 a.AddProperties(a.archVariants)
1546}
1547
Jiyong Parkf7487312019-10-17 12:54:30 +09001548func (a *AndroidAppImport) Privileged() bool {
1549 return Bool(a.properties.Privileged)
1550}
1551
Jiyong Park592a6a42020-04-21 22:34:28 +09001552func (a *AndroidAppImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1553 // android_app_import might have extra dependencies via uses_libs property.
1554 // Don't track the dependency as we don't automatically add those libraries
1555 // to the classpath. It should be explicitly added to java_libs property of APEX
1556 return false
1557}
1558
Colin Crossc2d24052020-05-13 11:05:02 -07001559func (a *AndroidAppImport) sdkVersion() sdkSpec {
1560 return sdkSpecFrom("")
1561}
1562
1563func (a *AndroidAppImport) minSdkVersion() sdkSpec {
1564 return sdkSpecFrom("")
1565}
1566
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001567func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
1568 props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
1569
1570 variantFields := make([]reflect.StructField, len(variants))
1571 for i, variant := range variants {
1572 variantFields[i] = reflect.StructField{
1573 Name: proptools.FieldNameForProperty(variant),
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001574 Type: props,
1575 }
1576 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001577
1578 variantGroupStruct := reflect.StructOf(variantFields)
1579 return reflect.StructOf([]reflect.StructField{
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001580 {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001581 Name: variantGroupName,
1582 Type: variantGroupStruct,
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001583 },
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001584 })
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001585}
1586
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001587// android_app_import imports a prebuilt apk with additional processing specified in the module.
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001588// DPI-specific apk source files can be specified using dpi_variants. Example:
1589//
1590// android_app_import {
1591// name: "example_import",
1592// apk: "prebuilts/example.apk",
1593// dpi_variants: {
1594// mdpi: {
1595// apk: "prebuilts/example_mdpi.apk",
1596// },
1597// xhdpi: {
1598// apk: "prebuilts/example_xhdpi.apk",
1599// },
1600// },
1601// certificate: "PRESIGNED",
1602// }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001603func AndroidAppImportFactory() android.Module {
1604 module := &AndroidAppImport{}
1605 module.AddProperties(&module.properties)
1606 module.AddProperties(&module.dexpreoptProperties)
Colin Cross50ddcc42019-05-16 12:28:22 -07001607 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001608 module.populateAllVariantStructs()
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001609 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001610 module.processVariants(ctx)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001611 })
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001612
Jiyong Park592a6a42020-04-21 22:34:28 +09001613 android.InitApexModule(module)
Jaewoong Jung6abfbf72020-05-26 20:10:08 -07001614 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1615 android.InitDefaultableModule(module)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001616 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001617
1618 return module
1619}
Colin Cross50ddcc42019-05-16 12:28:22 -07001620
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001621type androidTestImportProperties struct {
1622 // Whether the prebuilt apk can be installed without additional processing. Default is false.
1623 Preprocessed *bool
1624}
1625
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001626type AndroidTestImport struct {
1627 AndroidAppImport
1628
1629 testProperties testProperties
1630
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001631 testImportProperties androidTestImportProperties
1632
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001633 data android.Paths
1634}
1635
1636func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001637 a.preprocessed = Bool(a.testImportProperties.Preprocessed)
1638
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001639 a.generateAndroidBuildActions(ctx)
1640
1641 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
1642}
1643
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001644func (a *AndroidTestImport) InstallInTestcases() bool {
1645 return true
1646}
1647
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001648// android_test_import imports a prebuilt test apk with additional processing specified in the
1649// module. DPI or arch variant configurations can be made as with android_app_import.
1650func AndroidTestImportFactory() android.Module {
1651 module := &AndroidTestImport{}
1652 module.AddProperties(&module.properties)
1653 module.AddProperties(&module.dexpreoptProperties)
1654 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
1655 module.AddProperties(&module.testProperties)
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001656 module.AddProperties(&module.testImportProperties)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001657 module.populateAllVariantStructs()
1658 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1659 module.processVariants(ctx)
1660 })
1661
Colin Crossc80828d2020-05-06 22:29:10 -07001662 module.dexpreopter.isTest = true
1663
Jiyong Park592a6a42020-04-21 22:34:28 +09001664 android.InitApexModule(module)
Jaewoong Jung243688e2020-05-01 15:50:08 -07001665 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1666 android.InitDefaultableModule(module)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001667 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
1668
1669 return module
1670}
1671
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001672type RuntimeResourceOverlay struct {
1673 android.ModuleBase
1674 android.DefaultableModuleBase
Roshan Pius4df2bc72020-04-27 09:42:27 -07001675 android.OverridableModuleBase
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001676 aapt
1677
Roshan Pius4df2bc72020-04-27 09:42:27 -07001678 properties RuntimeResourceOverlayProperties
1679 overridableProperties OverridableRuntimeResourceOverlayProperties
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001680
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001681 certificate Certificate
1682
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001683 outputFile android.Path
1684 installDir android.InstallPath
1685}
1686
1687type RuntimeResourceOverlayProperties struct {
1688 // the name of a certificate in the default certificate directory or an android_app_certificate
1689 // module name in the form ":module".
1690 Certificate *string
1691
Liz Kammer966b2f02020-05-19 16:15:25 -07001692 // Name of the signing certificate lineage file.
1693 Lineage *string
1694
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001695 // optional theme name. If specified, the overlay package will be applied
1696 // only when the ro.boot.vendor.overlay.theme system property is set to the same value.
1697 Theme *string
1698
1699 // if not blank, set to the version of the sdk to compile against.
1700 // Defaults to compiling against the current platform.
1701 Sdk_version *string
1702
1703 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
1704 // Defaults to sdk_version if not set.
1705 Min_sdk_version *string
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001706
1707 // list of android_library modules whose resources are extracted and linked against statically
1708 Static_libs []string
1709
1710 // list of android_app modules whose resources are extracted and linked against
1711 Resource_libs []string
Jaewoong Jungad0177b2020-04-24 15:22:40 -07001712
1713 // Names of modules to be overridden. Listed modules can only be other overlays
1714 // (in Make or Soong).
1715 // This does not completely prevent installation of the overridden overlays, but if both
1716 // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed
1717 // from PRODUCT_PACKAGES.
1718 Overrides []string
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001719}
1720
Jiyong Park69aeba92020-04-24 21:16:36 +09001721// RuntimeResourceOverlayModule interface is used by the apex package to gather information from
1722// a RuntimeResourceOverlay module.
1723type RuntimeResourceOverlayModule interface {
1724 android.Module
1725 OutputFile() android.Path
1726 Certificate() Certificate
1727 Theme() string
1728}
1729
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001730func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) {
1731 sdkDep := decodeSdkDep(ctx, sdkContext(r))
1732 if sdkDep.hasFrameworkLibs() {
1733 r.aapt.deps(ctx, sdkDep)
1734 }
1735
1736 cert := android.SrcIsModule(String(r.properties.Certificate))
1737 if cert != "" {
1738 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1739 }
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001740
1741 ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...)
1742 ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001743}
1744
1745func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1746 // Compile and link resources
1747 r.aapt.hasNoCode = true
Jaewoong Jungf0f747c2020-01-24 10:30:02 -08001748 // Do not remove resources without default values nor dedupe resource configurations with the same value
Roshan Pius4df2bc72020-04-27 09:42:27 -07001749 aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"}
1750 // Allow the override of "package name" and "overlay target package name"
1751 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
1752 if overridden || r.overridableProperties.Package_name != nil {
1753 // The product override variable has a priority over the package_name property.
1754 if !overridden {
1755 manifestPackageName = *r.overridableProperties.Package_name
1756 }
1757 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
1758 }
1759 if r.overridableProperties.Target_package_name != nil {
1760 aaptLinkFlags = append(aaptLinkFlags,
1761 "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name)
1762 }
1763 r.aapt.buildActions(ctx, r, aaptLinkFlags...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001764
1765 // Sign the built package
Colin Crossc2d24052020-05-13 11:05:02 -07001766 _, certificates := collectAppDeps(ctx, r, false, false)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001767 certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx)
1768 signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk")
Liz Kammer966b2f02020-05-19 16:15:25 -07001769 var lineageFile android.Path
1770 if lineage := String(r.properties.Lineage); lineage != "" {
1771 lineageFile = android.PathForModuleSrc(ctx, lineage)
1772 }
1773 SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, lineageFile)
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001774 r.certificate = certificates[0]
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001775
1776 r.outputFile = signed
1777 r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme))
1778 ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile)
1779}
1780
Jiyong Park6a927c42020-01-21 02:03:43 +09001781func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec {
1782 return sdkSpecFrom(String(r.properties.Sdk_version))
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001783}
1784
1785func (r *RuntimeResourceOverlay) systemModules() string {
1786 return ""
1787}
1788
Jiyong Park6a927c42020-01-21 02:03:43 +09001789func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001790 if r.properties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +09001791 return sdkSpecFrom(*r.properties.Min_sdk_version)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001792 }
1793 return r.sdkVersion()
1794}
1795
Jiyong Park6a927c42020-01-21 02:03:43 +09001796func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001797 return r.sdkVersion()
1798}
1799
Jiyong Park69aeba92020-04-24 21:16:36 +09001800func (r *RuntimeResourceOverlay) Certificate() Certificate {
1801 return r.certificate
1802}
1803
1804func (r *RuntimeResourceOverlay) OutputFile() android.Path {
1805 return r.outputFile
1806}
1807
1808func (r *RuntimeResourceOverlay) Theme() string {
1809 return String(r.properties.Theme)
1810}
1811
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001812// runtime_resource_overlay generates a resource-only apk file that can overlay application and
1813// system resources at run time.
1814func RuntimeResourceOverlayFactory() android.Module {
1815 module := &RuntimeResourceOverlay{}
1816 module.AddProperties(
1817 &module.properties,
Roshan Pius4df2bc72020-04-27 09:42:27 -07001818 &module.aaptProperties,
1819 &module.overridableProperties)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001820
Roshan Pius4df2bc72020-04-27 09:42:27 -07001821 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1822 android.InitDefaultableModule(module)
1823 android.InitOverridableModule(module, &module.properties.Overrides)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001824 return module
1825}
1826
Colin Cross50ddcc42019-05-16 12:28:22 -07001827type UsesLibraryProperties struct {
1828 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1829 Uses_libs []string
1830
1831 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1832 // required=false.
1833 Optional_uses_libs []string
1834
1835 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1836 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1837 Enforce_uses_libs *bool
1838}
1839
1840// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1841// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1842// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1843// with knowledge of their shared libraries.
1844type usesLibrary struct {
1845 usesLibraryProperties UsesLibraryProperties
1846}
1847
Paul Duffin250e6192019-06-07 10:44:37 +01001848func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
Colin Cross3245b2c2019-06-07 13:18:09 -07001849 if !ctx.Config().UnbundledBuild() {
1850 ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
1851 ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
Paul Duffin250e6192019-06-07 10:44:37 +01001852 // Only add these extra dependencies if the module depends on framework libs. This avoids
1853 // creating a cyclic dependency:
1854 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
1855 if hasFrameworkLibs {
Colin Cross3245b2c2019-06-07 13:18:09 -07001856 // dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs
1857 // to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each
1858 // library to dexpreopt.
1859 ctx.AddVariationDependencies(nil, usesLibTag,
1860 "org.apache.http.legacy",
1861 "android.hidl.base-V1.0-java",
1862 "android.hidl.manager-V1.0-java")
Ulya Trafimovichc9af5382020-05-29 15:35:06 +01001863 ctx.AddVariationDependencies(nil, usesLibTag, optionalUsesLibs...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001864 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001865 }
1866}
1867
1868// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
1869// build.
1870func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
1871 optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
1872 return optionalUsesLibs
1873}
1874
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001875// usesLibraryPaths returns a map of module names of shared library dependencies to the paths
1876// to their dex jars on host and on device.
1877func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) dexpreopt.LibraryPaths {
1878 usesLibPaths := make(dexpreopt.LibraryPaths)
Colin Cross50ddcc42019-05-16 12:28:22 -07001879
1880 if !ctx.Config().UnbundledBuild() {
1881 ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001882 dep := ctx.OtherModuleName(m)
Colin Cross50ddcc42019-05-16 12:28:22 -07001883 if lib, ok := m.(Dependency); ok {
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00001884 if dexJar := lib.DexJarBuildPath(); dexJar != nil {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001885 usesLibPaths[dep] = &dexpreopt.LibraryPath{
1886 dexJar,
1887 // TODO(b/132357300): propagate actual install paths here.
1888 filepath.Join("/system/framework", dep+".jar"),
1889 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001890 } else {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001891 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must"+
1892 " produce a dex jar, does it have installable: true?", dep)
Colin Cross50ddcc42019-05-16 12:28:22 -07001893 }
1894 } else if ctx.Config().AllowMissingDependencies() {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001895 ctx.AddMissingDependencies([]string{dep})
Colin Cross50ddcc42019-05-16 12:28:22 -07001896 } else {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001897 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be "+
1898 "a java library", dep)
Colin Cross50ddcc42019-05-16 12:28:22 -07001899 }
1900 })
1901 }
1902
1903 return usesLibPaths
1904}
1905
1906// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1907// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1908// unconditionally in the future.
1909func (u *usesLibrary) enforceUsesLibraries() bool {
1910 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1911 len(u.usesLibraryProperties.Optional_uses_libs) > 0
1912 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
1913}
1914
1915// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
1916// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
1917func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1918 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
1919
1920 rule := android.NewRuleBuilder()
Colin Crossee94d6a2019-07-08 17:08:34 -07001921 cmd := rule.Command().BuiltTool(ctx, "manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001922 Flag("--enforce-uses-libraries").
1923 Input(manifest).
1924 FlagWithOutput("-o ", outputFile)
1925
1926 for _, lib := range u.usesLibraryProperties.Uses_libs {
1927 cmd.FlagWithArg("--uses-library ", lib)
1928 }
1929
1930 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1931 cmd.FlagWithArg("--optional-uses-library ", lib)
1932 }
1933
1934 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1935
1936 return outputFile
1937}
1938
1939// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
1940// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
1941func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
1942 outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
1943
1944 rule := android.NewRuleBuilder()
1945 aapt := ctx.Config().HostToolPath(ctx, "aapt")
1946 rule.Command().
1947 Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
1948 Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
1949 Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
1950 Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
1951 rule.Command().Text("cp -f").Input(apk).Output(outputFile)
1952
1953 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1954
1955 return outputFile
1956}