blob: e6e0e1a8befd07018ec3e5812cbcc0a5d21c88a0 [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
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -070082 apkcertsFile android.ModuleOutPath
Sasha Smundaka7856c02020-04-23 09:49:59 -070083}
84
85func (as *AndroidAppSet) Name() string {
86 return as.prebuilt.Name(as.ModuleBase.Name())
87}
88
89func (as *AndroidAppSet) IsInstallable() bool {
90 return true
91}
92
93func (as *AndroidAppSet) Prebuilt() *android.Prebuilt {
94 return &as.prebuilt
95}
96
97func (as *AndroidAppSet) Privileged() bool {
98 return Bool(as.properties.Privileged)
99}
100
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700101func (as *AndroidAppSet) OutputFile() android.Path {
102 return as.packedOutput
103}
104
105func (as *AndroidAppSet) MasterFile() string {
106 return as.masterFile
107}
108
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700109var TargetCpuAbi = map[string]string{
Sasha Smundaka7856c02020-04-23 09:49:59 -0700110 "arm": "ARMEABI_V7A",
111 "arm64": "ARM64_V8A",
112 "x86": "X86",
113 "x86_64": "X86_64",
114}
115
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700116func SupportedAbis(ctx android.ModuleContext) []string {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700117 abiName := func(archVar string, deviceArch string) string {
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700118 if abi, found := TargetCpuAbi[deviceArch]; found {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700119 return abi
120 }
121 ctx.ModuleErrorf("Invalid %s: %s", archVar, deviceArch)
122 return "BAD_ABI"
123 }
124
125 result := []string{abiName("TARGET_ARCH", ctx.DeviceConfig().DeviceArch())}
126 if s := ctx.DeviceConfig().DeviceSecondaryArch(); s != "" {
127 result = append(result, abiName("TARGET_2ND_ARCH", s))
128 }
129 return result
130}
131
132func (as *AndroidAppSet) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700133 as.packedOutput = android.PathForModuleOut(ctx, ctx.ModuleName()+".zip")
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700134 as.apkcertsFile = android.PathForModuleOut(ctx, "apkcerts.txt")
Sasha Smundaka7856c02020-04-23 09:49:59 -0700135 // We are assuming here that the master file in the APK
136 // set has `.apk` suffix. If it doesn't the build will fail.
137 // APK sets containing APEX files are handled elsewhere.
Sasha Smundak57f0ee12020-06-15 18:25:27 -0700138 as.masterFile = as.BaseModuleName() + ".apk"
Sasha Smundaka7856c02020-04-23 09:49:59 -0700139 screenDensities := "all"
140 if dpis := ctx.Config().ProductAAPTPrebuiltDPI(); len(dpis) > 0 {
141 screenDensities = strings.ToUpper(strings.Join(dpis, ","))
142 }
143 // TODO(asmundak): handle locales.
144 // TODO(asmundak): do we support device features
145 ctx.Build(pctx,
146 android.BuildParams{
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700147 Rule: extractMatchingApks,
148 Description: "Extract APKs from APK set",
149 Output: as.packedOutput,
150 ImplicitOutput: as.apkcertsFile,
151 Inputs: android.Paths{as.prebuilt.SingleSourcePath(ctx)},
Sasha Smundaka7856c02020-04-23 09:49:59 -0700152 Args: map[string]string{
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700153 "abis": strings.Join(SupportedAbis(ctx), ","),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700154 "allow-prereleased": strconv.FormatBool(proptools.Bool(as.properties.Prerelease)),
155 "screen-densities": screenDensities,
156 "sdk-version": ctx.Config().PlatformSdkVersion(),
Sasha Smundake88b4362020-06-22 16:53:33 -0700157 "stem": as.BaseModuleName(),
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700158 "apkcerts": as.apkcertsFile.String(),
159 "partition": as.PartitionTag(ctx.DeviceConfig()),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700160 },
161 })
Sasha Smundaka7856c02020-04-23 09:49:59 -0700162}
163
164// android_app_set extracts a set of APKs based on the target device
165// configuration and installs this set as "split APKs".
Sasha Smundak613cbb12020-06-05 10:27:23 -0700166// The extracted set always contains 'master' APK whose name is
167// _module_name_.apk and every split APK matching target device.
168// The extraction of the density-specific splits depends on
169// PRODUCT_AAPT_PREBUILT_DPI variable. If present (its value should
170// be a list density names: LDPI, MDPI, HDPI, etc.), only listed
171// splits will be extracted. Otherwise all density-specific splits
172// will be extracted.
Sasha Smundaka7856c02020-04-23 09:49:59 -0700173func AndroidApkSetFactory() android.Module {
174 module := &AndroidAppSet{}
175 module.AddProperties(&module.properties)
176 InitJavaModule(module, android.DeviceSupported)
177 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set")
178 return module
Paul Duffinf9b1da02019-12-18 19:51:55 +0000179}
180
Colin Cross30e076a2015-04-13 13:58:27 -0700181// AndroidManifest.xml merging
182// package splits
183
Colin Crossfabb6082018-02-20 17:22:23 -0800184type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700185 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -0700186 Additional_certificates []string
187
188 // If set, create package-export.apk, which other packages can
189 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -0800190 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700191
Colin Cross16056062017-12-13 22:46:28 -0800192 // Specifies that this app should be installed to the priv-app directory,
193 // where the system will grant it additional privileges not available to
194 // normal apps.
195 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -0700196
197 // list of resource labels to generate individual resource packages
198 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -0400199
200 // Names of modules to be overridden. Listed modules can only be other binaries
201 // (in Make or Soong).
202 // This does not completely prevent installation of the overridden binaries, but if both
203 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
204 // from PRODUCT_PACKAGES.
205 Overrides []string
Colin Crossa4f08812018-10-02 22:03:40 -0700206
207 // list of native libraries that will be provided in or alongside the resulting jar
208 Jni_libs []string `android:"arch_variant"`
209
Colin Cross7204cf02020-05-06 17:51:39 -0700210 // if true, use JNI libraries that link against platform APIs even if this module sets
Colin Crossee87c602020-02-19 16:57:15 -0800211 // sdk_version.
212 Jni_uses_platform_apis *bool
213
Colin Cross7204cf02020-05-06 17:51:39 -0700214 // if true, use JNI libraries that link against SDK APIs even if this module does not set
215 // sdk_version.
216 Jni_uses_sdk_apis *bool
217
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700218 // STL library to use for JNI libraries.
219 Stl *string `android:"arch_variant"`
220
Colin Crosse4246ab2019-02-05 21:55:21 -0800221 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
222 // 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 +0900223 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
224 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
225 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -0800226 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -0800227
228 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
229 // they are used from inside the APK at runtime.
230 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700231
232 // Forces native libraries to always be packaged into the APK,
233 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
234 // True for android_test* modules.
235 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700236
237 // If set, find and merge all NOTICE files that this module and its dependencies have and store
238 // it in the APK as an asset.
239 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700240
241 // cc.Coverage related properties
242 PreventInstall bool `blueprint:"mutated"`
243 HideFromMake bool `blueprint:"mutated"`
244 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100245
246 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100247 // additional rules to make sure an app can safely be updated. Default is false.
248 // Prefer using other specific properties if build behaviour must be changed; avoid using this
249 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100250 Updatable *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700251}
252
Jaewoong Jung525443a2019-02-28 15:35:54 -0800253// android_app properties that can be overridden by override_android_app
254type overridableAppProperties struct {
255 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
256 // or an android_app_certificate module name in the form ":module".
257 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700258
Liz Kammere2b27f42020-05-07 13:24:05 -0700259 // Name of the signing certificate lineage file.
260 Lineage *string
261
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700262 // the package name of this app. The package name in the manifest file is used if one was not given.
263 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800264
265 // the logging parent of this app.
266 Logging_parent *string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800267}
268
Roshan Pius4df2bc72020-04-27 09:42:27 -0700269// runtime_resource_overlay properties that can be overridden by override_runtime_resource_overlay
270type OverridableRuntimeResourceOverlayProperties struct {
271 // the package name of this app. The package name in the manifest file is used if one was not given.
272 Package_name *string
273
274 // the target package name of this overlay app. The target package name in the manifest file is used if one was not given.
275 Target_package_name *string
276}
277
Colin Cross30e076a2015-04-13 13:58:27 -0700278type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700279 Library
280 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800281 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700282
Colin Cross50ddcc42019-05-16 12:28:22 -0700283 usesLibrary usesLibrary
284
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900285 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700286
Colin Crossfabb6082018-02-20 17:22:23 -0800287 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700288
Jaewoong Jung525443a2019-02-28 15:35:54 -0800289 overridableAppProperties overridableAppProperties
290
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700291 installJniLibs []jniLib
292 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700293
294 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800295
296 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
297 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800298
Colin Cross70dda7e2019-10-01 22:05:35 -0700299 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700300
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700301 onDeviceDir string
302
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800303 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700304
305 noticeOutputs android.NoticeOutputs
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900306
307 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100308
309 android.ApexBundleDepsInfo
Colin Crosse1731a52017-12-14 11:22:55 -0800310}
311
Martin Stjernholm6d415272020-01-31 17:10:36 +0000312func (a *AndroidApp) IsInstallable() bool {
313 return Bool(a.properties.Installable)
314}
315
Colin Cross89c31582018-04-30 15:55:11 -0700316func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths {
317 return nil
318}
319
Colin Cross66f78822018-05-02 12:58:28 -0700320func (a *AndroidApp) ExportedStaticPackages() android.Paths {
321 return nil
322}
323
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900324func (a *AndroidApp) OutputFile() android.Path {
325 return a.outputFile
326}
327
Colin Cross503c1d02020-01-28 14:00:53 -0800328func (a *AndroidApp) Certificate() Certificate {
329 return a.certificate
330}
331
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700332func (a *AndroidApp) JniCoverageOutputs() android.Paths {
333 return a.jniCoverageOutputs
334}
335
Colin Crossa97c5d32018-03-28 14:58:31 -0700336var _ AndroidLibraryDependency = (*AndroidApp)(nil)
337
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900338type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800339 Pem, Key android.Path
340 presigned bool
341}
342
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700343var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800344
345func (c Certificate) AndroidMkString() string {
346 if c.presigned {
347 return "PRESIGNED"
348 } else {
349 return c.Pem.String()
350 }
Colin Cross30e076a2015-04-13 13:58:27 -0700351}
352
Colin Cross46c9b8b2017-06-22 16:51:17 -0700353func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
354 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700355
Jiyong Park6a927c42020-01-21 02:03:43 +0900356 if String(a.appProperties.Stl) == "c++_shared" && !a.sdkVersion().specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700357 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
358 }
359
Paul Duffin250e6192019-06-07 10:44:37 +0100360 sdkDep := decodeSdkDep(ctx, sdkContext(a))
361 if sdkDep.hasFrameworkLibs() {
362 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700363 }
Colin Crossa4f08812018-10-02 22:03:40 -0700364
Colin Cross3c007702020-05-08 11:20:24 -0700365 usesSDK := a.sdkVersion().specified() && a.sdkVersion().kind != sdkCorePlatform
366
367 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
368 ctx.PropertyErrorf("jni_uses_sdk_apis",
369 "can only be set for modules that do not set sdk_version")
370 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
371 ctx.PropertyErrorf("jni_uses_platform_apis",
372 "can only be set for modules that set sdk_version")
373 }
374
Peter Collingbournead84f972019-12-17 16:46:18 -0800375 tag := &jniDependencyTag{}
Colin Crossa4f08812018-10-02 22:03:40 -0700376 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700377 variation := append(jniTarget.Variations(),
378 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000379
380 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
381 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700382 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
383 // have stable APIs through the VNDK.
384 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
385 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700386 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000387 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
388 }
Colin Crossa4f08812018-10-02 22:03:40 -0700389 ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...)
390 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700391
Paul Duffin250e6192019-06-07 10:44:37 +0100392 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700393}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700394
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700395func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800396 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700397 if cert != "" {
398 ctx.AddDependency(ctx.Module(), certificateTag, cert)
399 }
400
401 for _, cert := range a.appProperties.Additional_certificates {
402 cert = android.SrcIsModule(cert)
403 if cert != "" {
404 ctx.AddDependency(ctx.Module(), certificateTag, cert)
405 } else {
406 ctx.PropertyErrorf("additional_certificates",
407 `must be names of android_app_certificate modules in the form ":module"`)
408 }
409 }
Colin Cross30e076a2015-04-13 13:58:27 -0700410}
411
Jeongik Cha538c0d02019-07-11 15:54:27 +0900412func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
413 a.generateAndroidBuildActions(ctx)
414}
415
Colin Cross46c9b8b2017-06-22 16:51:17 -0700416func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100417 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700418 a.generateAndroidBuildActions(ctx)
419}
420
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100421func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100422 if a.Updatable() {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100423 if !a.sdkVersion().stable() {
424 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.sdkVersion())
425 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100426 if String(a.deviceProperties.Min_sdk_version) == "" {
427 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
428 }
Jooyung Han749dc692020-04-15 11:03:39 +0900429
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900430 if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil {
431 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +0900432 android.CheckMinSdkVersion(a, ctx, int(minSdkVersion))
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900433 } else {
434 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
435 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100436 }
437
438 a.checkPlatformAPI(ctx)
439 a.checkSdkVersions(ctx)
440}
441
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900442// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
443// This check is enforced for "updatable" APKs (including APK-in-APEX).
444// b/155209650: until min_sdk_version is properly supported, use sdk_version instead.
445// because, sdk_version is overridden by min_sdk_version (if set as smaller)
446// and linkType is checked with dependencies so we can be sure that the whole dependency tree
447// will meet the requirements.
448func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) {
449 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
450 ctx.VisitDirectDeps(func(m android.Module) {
451 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
452 return
453 }
454 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900455 // The domain of cc.sdk_version is "current" and <number>
456 // We can rely on sdkSpec to convert it to <number> so that "current" is handled
457 // properly regardless of sdk finalization.
458 jniSdkVersion, err := sdkSpecFrom(dep.SdkVersion()).effectiveVersion(ctx)
459 if err != nil || minSdkVersion < jniSdkVersion {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900460 ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
461 dep.SdkVersion(), minSdkVersion, ctx.ModuleName())
462 return
463 }
464
465 })
466}
467
Sasha Smundak6ad77252019-05-01 13:16:22 -0700468// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800469// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700470func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park6a927c42020-01-21 02:03:43 +0900471 minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800472 if err != nil {
473 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
474 }
475
Jiyong Park52cd06f2019-11-11 10:14:32 +0900476 return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
477 !a.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800478}
479
Colin Cross43f08db2018-11-12 10:13:39 -0800480// Returns whether this module should have the dex file stored uncompressed in the APK.
481func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800482 if Bool(a.appProperties.Use_embedded_dex) {
483 return true
484 }
485
Colin Cross53a87f52019-06-25 13:35:30 -0700486 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
487 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900488 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000489 return true
490 }
491
Colin Cross53a87f52019-06-25 13:35:30 -0700492 if ctx.Config().UnbundledBuild() {
493 return false
494 }
495
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700496 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700497}
498
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700499func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
500 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Jiyong Park52cd06f2019-11-11 10:14:32 +0900501 !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700502}
503
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900504func (a *AndroidApp) OverriddenManifestPackageName() string {
505 return a.overriddenManifestPackageName
506}
507
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800508func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
David Brazdild25060a2019-02-18 18:24:16 +0000509 a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
510
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700511 // Ask manifest_fixer to add or update the application element indicating this app has no code.
512 a.aapt.hasNoCode = !a.hasCode(ctx)
513
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800514 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800515
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800516 // 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 -0800517 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700518 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800519 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700520 }
521
Dan Willemsen72be5902018-10-24 20:24:57 -0700522 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
523 // Product AAPT config
524 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800525 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700526 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700527
Dan Willemsen72be5902018-10-24 20:24:57 -0700528 // Product AAPT preferred config
529 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800530 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700531 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700532 }
533
Jiyong Park7f67f482019-01-05 12:57:48 +0900534 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700535 if overridden || a.overridableAppProperties.Package_name != nil {
536 // The product override variable has a priority over the package_name property.
537 if !overridden {
538 manifestPackageName = *a.overridableAppProperties.Package_name
539 }
Liz Kammer1d5983b2020-05-19 19:15:37 +0000540 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900541 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900542 }
543
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800544 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
545
Colin Crosse560c4a2019-03-19 16:03:11 -0700546 a.aapt.splitNames = a.appProperties.Package_splits
Colin Cross50ddcc42019-05-16 12:28:22 -0700547 a.aapt.sdkLibraries = a.exportedSdkLibs
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800548 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800549 a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
Colin Cross30e076a2015-04-13 13:58:27 -0700550
Colin Cross46c9b8b2017-06-22 16:51:17 -0700551 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700552 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800553}
Colin Cross30e076a2015-04-13 13:58:27 -0700554
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800555func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700556 var staticLibProguardFlagFiles android.Paths
557 ctx.VisitDirectDeps(func(m android.Module) {
558 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
559 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
560 }
561 })
562
563 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
564
565 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
566 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800567}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800568
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800569func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross43f08db2018-11-12 10:13:39 -0800570
571 var installDir string
572 if ctx.ModuleName() == "framework-res" {
573 // framework-res.apk is installed as system/framework/framework-res.apk
574 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900575 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800576 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800577 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800578 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800579 }
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800580 a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
David Srbeckye033cba2020-05-20 22:20:28 +0100581 if a.deviceProperties.Uncompress_dex == nil {
582 // If the value was not force-set by the user, use reasonable default based on the module.
583 a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
584 }
585 a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700586 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
587 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
588 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
589 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
590 a.dexpreopter.manifestFile = a.mergedManifestFile
591
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800592 if ctx.ModuleName() != "framework-res" {
593 a.Module.compile(ctx, a.aaptSrcJar)
594 }
Colin Cross30e076a2015-04-13 13:58:27 -0700595
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800596 return a.maybeStrippedDexJarFile
597}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800598
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800599func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700600 var jniJarFile android.WritablePath
Colin Crossa4f08812018-10-02 22:03:40 -0700601 if len(jniLibs) > 0 {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700602 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700603 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Sasha Smundak6ad77252019-05-01 13:16:22 -0700604 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700605 for _, jni := range jniLibs {
606 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700607 // Only collect coverage for the first target arch if this is a multilib target.
608 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
609 // data file path collisions since the current coverage file path format doesn't contain
610 // arch-related strings. This is fine for now though; the code coverage team doesn't use
611 // multi-arch targets such as test_suite_* for coverage collections yet.
612 //
613 // Work with the team to come up with a new format that handles multilib modules properly
614 // and change this.
615 if len(ctx.Config().Targets[android.Android]) == 1 ||
616 ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType {
617 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
618 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700619 }
620 }
Colin Crossa4f08812018-10-02 22:03:40 -0700621 } else {
622 a.installJniLibs = jniLibs
623 }
624 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800625 return jniJarFile
626}
Colin Crossa4f08812018-10-02 22:03:40 -0700627
Jaewoong Jung0949f312019-09-11 10:25:18 -0700628func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700629 // Collect NOTICE files from all dependencies.
630 seenModules := make(map[android.Module]bool)
631 noticePathSet := make(map[android.Path]bool)
632
633 ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
634 // Have we already seen this?
635 if _, ok := seenModules[child]; ok {
636 return false
637 }
638 seenModules[child] = true
639
640 // Skip host modules.
641 if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
642 return false
643 }
644
Bob Badoura75b0572020-02-18 20:21:55 -0800645 paths := child.(android.Module).NoticeFiles()
646 if len(paths) > 0 {
647 for _, path := range paths {
648 noticePathSet[path] = true
649 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700650 }
651 return true
652 })
653
654 // If the app has one, add it too.
Bob Badoura75b0572020-02-18 20:21:55 -0800655 if len(a.NoticeFiles()) > 0 {
656 for _, path := range a.NoticeFiles() {
657 noticePathSet[path] = true
658 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700659 }
660
661 if len(noticePathSet) == 0 {
Jaewoong Jung98772792019-07-01 17:15:13 -0700662 return
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700663 }
664 var noticePaths []android.Path
665 for path := range noticePathSet {
666 noticePaths = append(noticePaths, path)
667 }
668 sort.Slice(noticePaths, func(i, j int) bool {
669 return noticePaths[i].String() < noticePaths[j].String()
670 })
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700671
Jaewoong Jung0949f312019-09-11 10:25:18 -0700672 a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700673}
674
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700675// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
676// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
677func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
678 if android.SrcIsModule(certPropValue) == "" {
679 var mainCert Certificate
680 if certPropValue != "" {
681 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
682 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800683 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
684 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700685 }
686 } else {
687 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800688 mainCert = Certificate{
689 Pem: pem,
690 Key: key,
691 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700692 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700693 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700694 }
695
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700696 if !m.Platform() {
697 certPath := certificates[0].Pem.String()
Jeongik Chac9464142019-01-07 12:07:27 +0900698 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
699 if strings.HasPrefix(certPath, systemCertPath) {
700 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
Colin Cross440e0d02020-06-11 11:32:11 -0700701 allowed := ctx.Config().EnforceSystemCertificateAllowList()
Jeongik Chac9464142019-01-07 12:07:27 +0900702
Colin Cross440e0d02020-06-11 11:32:11 -0700703 if enforceSystemCert && !inList(m.Name(), allowed) {
Jeongik Chac9464142019-01-07 12:07:27 +0900704 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
705 }
706 }
707 }
708
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700709 return certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800710}
711
Jooyung Han39ee1192020-03-23 20:21:11 +0900712func (a *AndroidApp) InstallApkName() string {
713 return a.installApkName
714}
715
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800716func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700717 var apkDeps android.Paths
718
Jeongik Cha538c0d02019-07-11 15:54:27 +0900719 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
720 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
721
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800722 // Check if the install APK name needs to be overridden.
Jaewoong Jung525443a2019-02-28 15:35:54 -0800723 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800724
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700725 if ctx.ModuleName() == "framework-res" {
726 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700727 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900728 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700729 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
730 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800731 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700732 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700733 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700734 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700735 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700736
Jaewoong Jung0949f312019-09-11 10:25:18 -0700737 a.noticeBuildActions(ctx)
Jaewoong Jung98772792019-07-01 17:15:13 -0700738 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
739 a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
740 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700741
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800742 // Process all building blocks, from AAPT to certificates.
743 a.aaptBuildActions(ctx)
744
Colin Cross50ddcc42019-05-16 12:28:22 -0700745 if a.usesLibrary.enforceUsesLibraries() {
746 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
747 apkDeps = append(apkDeps, manifestCheckFile)
748 }
749
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800750 a.proguardBuildActions(ctx)
751
Colin Cross014489c2020-06-02 20:09:13 -0700752 a.linter.mergedManifest = a.aapt.mergedManifestFile
753 a.linter.manifest = a.aapt.manifestPath
754 a.linter.resources = a.aapt.resourceFiles
Colin Crossc0efd1d2020-07-03 11:56:24 -0700755 a.linter.buildModuleReportZip = ctx.Config().UnbundledBuildApps()
Colin Cross014489c2020-06-02 20:09:13 -0700756
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800757 dexJarFile := a.dexBuildActions(ctx)
758
Colin Crossc2d24052020-05-13 11:05:02 -0700759 jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800760 jniJarFile := a.jniBuildActions(jniLibs, ctx)
761
762 if ctx.Failed() {
763 return
764 }
765
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700766 certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
767 a.certificate = certificates[0]
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800768
769 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800770 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700771 var lineageFile android.Path
772 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
773 lineageFile = android.PathForModuleSrc(ctx, lineage)
774 }
775 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, lineageFile)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800776 a.outputFile = packageFile
777
Colin Crosse560c4a2019-03-19 16:03:11 -0700778 for _, split := range a.aapt.splits {
779 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800780 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700781 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, lineageFile)
Colin Crosse560c4a2019-03-19 16:03:11 -0700782 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
783 }
784
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800785 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700786 bundleFile := android.PathForModuleOut(ctx, "base.zip")
787 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
788 a.bundleFile = bundleFile
789
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800790 // Install the app package.
Jiyong Park8ba50f92019-11-13 15:01:01 +0900791 if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
792 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
793 for _, extra := range a.extraOutputFiles {
794 ctx.InstallFile(a.installDir, extra.Base(), extra)
795 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800796 }
Artur Satayev1111b842020-04-27 19:05:28 +0100797
798 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700799}
800
Colin Crossc2d24052020-05-13 11:05:02 -0700801type appDepsInterface interface {
802 sdkVersion() sdkSpec
803 minSdkVersion() sdkSpec
804 RequiresStableAPIs(ctx android.BaseModuleContext) bool
805}
806
807func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
808 shouldCollectRecursiveNativeDeps bool,
Colin Cross094cde42020-02-15 10:38:00 -0800809 checkNativeSdkVersion bool) ([]jniLib, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700810
Colin Crossa4f08812018-10-02 22:03:40 -0700811 var jniLibs []jniLib
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900812 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800813 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700814
Colin Crossc2d24052020-05-13 11:05:02 -0700815 if checkNativeSdkVersion {
816 checkNativeSdkVersion = app.sdkVersion().specified() &&
817 app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx)
818 }
819
Peter Collingbournead84f972019-12-17 16:46:18 -0800820 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700821 otherName := ctx.OtherModuleName(module)
822 tag := ctx.OtherModuleDependencyTag(module)
823
Peter Collingbournead84f972019-12-17 16:46:18 -0800824 if IsJniDepTag(tag) || tag == cc.SharedDepTag {
Colin Crossa4f08812018-10-02 22:03:40 -0700825 if dep, ok := module.(*cc.Module); ok {
Peter Collingbournead84f972019-12-17 16:46:18 -0800826 if dep.IsNdk() || dep.IsStubs() {
827 return false
828 }
829
Colin Crossa4f08812018-10-02 22:03:40 -0700830 lib := dep.OutputFile()
Peter Collingbournead84f972019-12-17 16:46:18 -0800831 path := lib.Path()
832 if seenModulePaths[path.String()] {
833 return false
834 }
835 seenModulePaths[path.String()] = true
836
Colin Crossc2d24052020-05-13 11:05:02 -0700837 if checkNativeSdkVersion && dep.SdkVersion() == "" {
838 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
839 otherName)
Colin Cross094cde42020-02-15 10:38:00 -0800840 }
841
Colin Crossa4f08812018-10-02 22:03:40 -0700842 if lib.Valid() {
843 jniLibs = append(jniLibs, jniLib{
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700844 name: ctx.OtherModuleName(module),
845 path: path,
846 target: module.Target(),
847 coverageFile: dep.CoverageOutputFile(),
Colin Crossa4f08812018-10-02 22:03:40 -0700848 })
849 } else {
850 ctx.ModuleErrorf("dependency %q missing output file", otherName)
851 }
852 } else {
853 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700854 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800855
856 return shouldCollectRecursiveNativeDeps
857 }
858
859 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700860 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900861 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700862 } else {
863 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
864 }
Colin Crossa4f08812018-10-02 22:03:40 -0700865 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800866
867 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700868 })
869
Colin Crossbd01e2a2018-10-04 15:21:03 -0700870 return jniLibs, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700871}
872
Jooyung Han749dc692020-04-15 11:03:39 +0900873func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +0100874 ctx.WalkDeps(func(child, parent android.Module) bool {
875 isExternal := !a.DepIsInSameApex(ctx, child)
876 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +0900877 if !do(ctx, parent, am, isExternal) {
878 return false
879 }
Artur Satayev1111b842020-04-27 19:05:28 +0100880 }
881 return !isExternal
882 })
883}
884
885func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
886 if ctx.Host() {
887 return
888 }
889
890 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +0900891 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +0100892 depName := to.Name()
893 if info, exist := depsInfo[depName]; exist {
894 info.From = append(info.From, from.Name())
895 info.IsExternal = info.IsExternal && externalDep
896 depsInfo[depName] = info
897 } else {
898 toMinSdkVersion := "(no version)"
899 if m, ok := to.(interface{ MinSdkVersion() string }); ok {
900 if v := m.MinSdkVersion(); v != "" {
901 toMinSdkVersion = v
902 }
903 }
904 depsInfo[depName] = android.ApexModuleDepInfo{
905 To: depName,
906 From: []string{from.Name()},
907 IsExternal: externalDep,
908 MinSdkVersion: toMinSdkVersion,
909 }
910 }
Jooyung Han749dc692020-04-15 11:03:39 +0900911 return true
Artur Satayev1111b842020-04-27 19:05:28 +0100912 })
913
914 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo)
915}
916
Artur Satayev849f8442020-04-28 14:57:42 +0100917func (a *AndroidApp) Updatable() bool {
918 return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable()
919}
920
Colin Cross0ea8ba82019-06-06 14:33:29 -0700921func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800922 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
923 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000924 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800925 }
Jaewoong Jung525443a2019-02-28 15:35:54 -0800926 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800927}
928
Jiyong Park0f80c182020-01-31 02:49:53 +0900929func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
930 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
931 return true
932 }
933 return a.Library.DepIsInSameApex(ctx, dep)
934}
935
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900936// For OutputFileProducer interface
937func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
938 switch tag {
939 case ".aapt.srcjar":
940 return []android.Path{a.aaptSrcJar}, nil
941 }
942 return a.Library.OutputFiles(tag)
943}
944
Jiyong Parkf7487312019-10-17 12:54:30 +0900945func (a *AndroidApp) Privileged() bool {
946 return Bool(a.appProperties.Privileged)
947}
948
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700949func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -0700950 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700951}
952
953func (a *AndroidApp) PreventInstall() {
954 a.appProperties.PreventInstall = true
955}
956
957func (a *AndroidApp) HideFromMake() {
958 a.appProperties.HideFromMake = true
959}
960
961func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
962 a.appProperties.IsCoverageVariant = coverage
963}
964
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400965func (a *AndroidApp) EnableCoverageIfNeeded() {}
966
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700967var _ cc.Coverage = (*AndroidApp)(nil)
968
Colin Cross1b16b0e2019-02-12 14:41:32 -0800969// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -0700970func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -0700971 module := &AndroidApp{}
972
Sasha Smundak2057f822019-04-16 17:16:58 -0700973 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross66dbc0b2017-12-28 12:23:20 -0800974 module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
975
Colin Crossae5caf52018-05-22 11:11:52 -0700976 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700977 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -0700978
Colin Crossce6734e2020-06-15 16:09:53 -0700979 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -0700980 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700981 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800982 &module.appProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700983 &module.overridableAppProperties,
984 &module.usesLibrary.usesLibraryProperties)
Colin Cross36242852017-06-23 15:06:31 -0700985
Colin Crossa4f08812018-10-02 22:03:40 -0700986 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
987 android.InitDefaultableModule(module)
Jaewoong Jung525443a2019-02-28 15:35:54 -0800988 android.InitOverridableModule(module, &module.appProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +0900989 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -0700990
Colin Cross36242852017-06-23 15:06:31 -0700991 return module
Colin Cross30e076a2015-04-13 13:58:27 -0700992}
Colin Crossae5caf52018-05-22 11:11:52 -0700993
994type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -0700995 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -0700996 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -0700997
998 // if specified, the instrumentation target package name in the manifest is overwritten by it.
999 Instrumentation_target_package *string
Colin Crossae5caf52018-05-22 11:11:52 -07001000}
1001
1002type AndroidTest struct {
1003 AndroidApp
1004
1005 appTestProperties appTestProperties
1006
1007 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001008
1009 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001010 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -07001011}
1012
Jaewoong Jung0949f312019-09-11 10:25:18 -07001013func (a *AndroidTest) InstallInTestcases() bool {
1014 return true
1015}
1016
Colin Crossae5caf52018-05-22 11:11:52 -07001017func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001018 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001019 if a.appTestProperties.Instrumentation_target_package != nil {
1020 a.additionalAaptFlags = append(a.additionalAaptFlags,
1021 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1022 } else if a.appTestProperties.Instrumentation_for != nil {
1023 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001024 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1025 if overridden {
1026 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1027 }
1028 }
Colin Crossae5caf52018-05-22 11:11:52 -07001029 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001030
easoncylee5bcff5d2020-04-30 14:57:06 +08001031 for _, module := range a.testProperties.Test_mainline_modules {
1032 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1033 }
1034
Jaewoong Jung39982342020-01-14 10:27:18 -08001035 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001036 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001037 a.testConfig = a.FixTestConfig(ctx, testConfig)
Colin Cross8a497952019-03-05 22:25:09 -08001038 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001039}
1040
Jaewoong Jung39982342020-01-14 10:27:18 -08001041func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1042 if testConfig == nil {
1043 return nil
1044 }
1045
1046 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
1047 rule := android.NewRuleBuilder()
1048 command := rule.Command().BuiltTool(ctx, "test_config_fixer").Input(testConfig).Output(fixedConfig)
1049 fixNeeded := false
1050
1051 if ctx.ModuleName() != a.installApkName {
1052 fixNeeded = true
1053 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1054 }
1055
1056 if a.overridableAppProperties.Package_name != nil {
1057 fixNeeded = true
1058 command.FlagWithInput("--manifest ", a.manifestPath).
1059 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1060 }
1061
1062 if fixNeeded {
1063 rule.Build(pctx, ctx, "fix_test_config", "fix test config")
1064 return fixedConfig
1065 }
1066 return testConfig
1067}
1068
Colin Cross303e21f2018-08-07 16:49:25 -07001069func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001070 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001071}
1072
1073func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1074 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001075 if a.appTestProperties.Instrumentation_for != nil {
1076 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1077 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1078 // use instrumentationForTag instead of libTag.
1079 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1080 }
Colin Crossae5caf52018-05-22 11:11:52 -07001081}
1082
Colin Cross1b16b0e2019-02-12 14:41:32 -08001083// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1084// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001085func AndroidTestFactory() android.Module {
1086 module := &AndroidTest{}
1087
Sasha Smundak2057f822019-04-16 17:16:58 -07001088 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross5067db92018-09-17 16:46:35 -07001089
1090 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001091 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001092 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001093 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001094 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07001095 module.Module.linter.test = true
Colin Crossae5caf52018-05-22 11:11:52 -07001096
Colin Crossce6734e2020-06-15 16:09:53 -07001097 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001098 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001099 &module.aaptProperties,
1100 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001101 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001102 &module.overridableAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001103 &module.usesLibrary.usesLibraryProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001104 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001105
Colin Crossa4f08812018-10-02 22:03:40 -07001106 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1107 android.InitDefaultableModule(module)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001108 android.InitOverridableModule(module, &module.appProperties.Overrides)
Colin Crossae5caf52018-05-22 11:11:52 -07001109 return module
1110}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001111
Colin Cross252fc6f2018-10-04 15:22:03 -07001112type appTestHelperAppProperties struct {
1113 // list of compatibility suites (for example "cts", "vts") that the module should be
1114 // installed into.
1115 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001116
1117 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1118 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1119 // explicitly.
1120 Auto_gen_config *bool
Colin Cross252fc6f2018-10-04 15:22:03 -07001121}
1122
1123type AndroidTestHelperApp struct {
1124 AndroidApp
1125
1126 appTestHelperAppProperties appTestHelperAppProperties
1127}
1128
Jaewoong Jung326a9412019-11-21 10:41:00 -08001129func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1130 return true
1131}
1132
Colin Cross1b16b0e2019-02-12 14:41:32 -08001133// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1134// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1135// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001136func AndroidTestHelperAppFactory() android.Module {
1137 module := &AndroidTestHelperApp{}
1138
Sasha Smundak2057f822019-04-16 17:16:58 -07001139 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001140
1141 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001142 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001143 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001144 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07001145 module.Module.linter.test = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001146
Colin Crossce6734e2020-06-15 16:09:53 -07001147 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001148 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001149 &module.aaptProperties,
1150 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001151 &module.appTestHelperAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001152 &module.overridableAppProperties,
1153 &module.usesLibrary.usesLibraryProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001154
1155 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1156 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001157 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001158 return module
1159}
1160
Colin Crossbd01e2a2018-10-04 15:21:03 -07001161type AndroidAppCertificate struct {
1162 android.ModuleBase
1163 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001164 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001165}
1166
1167type AndroidAppCertificateProperties struct {
1168 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1169 Certificate *string
1170}
1171
Colin Cross1b16b0e2019-02-12 14:41:32 -08001172// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1173// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001174func AndroidAppCertificateFactory() android.Module {
1175 module := &AndroidAppCertificate{}
1176 module.AddProperties(&module.properties)
1177 android.InitAndroidModule(module)
1178 return module
1179}
1180
Colin Crossbd01e2a2018-10-04 15:21:03 -07001181func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1182 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001183 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001184 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1185 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001186 }
1187}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001188
1189type OverrideAndroidApp struct {
1190 android.ModuleBase
1191 android.OverrideModuleBase
1192}
1193
Sasha Smundak613cbb12020-06-05 10:27:23 -07001194func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001195 // All the overrides happen in the base module.
1196 // TODO(jungjw): Check the base module type.
1197}
1198
1199// override_android_app is used to create an android_app module based on another android_app by overriding
1200// some of its properties.
1201func OverrideAndroidAppModuleFactory() android.Module {
1202 m := &OverrideAndroidApp{}
1203 m.AddProperties(&overridableAppProperties{})
1204
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001205 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001206 android.InitOverrideModule(m)
1207 return m
1208}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001209
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001210type OverrideAndroidTest struct {
1211 android.ModuleBase
1212 android.OverrideModuleBase
1213}
1214
Sasha Smundak613cbb12020-06-05 10:27:23 -07001215func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001216 // All the overrides happen in the base module.
1217 // TODO(jungjw): Check the base module type.
1218}
1219
1220// override_android_test is used to create an android_app module based on another android_test by overriding
1221// some of its properties.
1222func OverrideAndroidTestModuleFactory() android.Module {
1223 m := &OverrideAndroidTest{}
1224 m.AddProperties(&overridableAppProperties{})
1225 m.AddProperties(&appTestProperties{})
1226
1227 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1228 android.InitOverrideModule(m)
1229 return m
1230}
1231
Roshan Pius4df2bc72020-04-27 09:42:27 -07001232type OverrideRuntimeResourceOverlay struct {
1233 android.ModuleBase
1234 android.OverrideModuleBase
1235}
1236
Sasha Smundak613cbb12020-06-05 10:27:23 -07001237func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(_ android.ModuleContext) {
Roshan Pius4df2bc72020-04-27 09:42:27 -07001238 // All the overrides happen in the base module.
1239 // TODO(jungjw): Check the base module type.
1240}
1241
1242// override_runtime_resource_overlay is used to create a module based on another
1243// runtime_resource_overlay module by overriding some of its properties.
1244func OverrideRuntimeResourceOverlayModuleFactory() android.Module {
1245 m := &OverrideRuntimeResourceOverlay{}
1246 m.AddProperties(&OverridableRuntimeResourceOverlayProperties{})
1247
1248 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1249 android.InitOverrideModule(m)
1250 return m
1251}
1252
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001253type AndroidAppImport struct {
1254 android.ModuleBase
1255 android.DefaultableModuleBase
Jiyong Park592a6a42020-04-21 22:34:28 +09001256 android.ApexModuleBase
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001257 prebuilt android.Prebuilt
1258
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001259 properties AndroidAppImportProperties
1260 dpiVariants interface{}
1261 archVariants interface{}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001262
1263 outputFile android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001264 certificate Certificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001265
1266 dexpreopter
Colin Cross50ddcc42019-05-16 12:28:22 -07001267
1268 usesLibrary usesLibrary
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001269
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001270 preprocessed bool
1271
Colin Cross70dda7e2019-10-01 22:05:35 -07001272 installPath android.InstallPath
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001273}
1274
1275type AndroidAppImportProperties struct {
1276 // A prebuilt apk to import
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001277 Apk *string
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001278
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001279 // The name of a certificate in the default certificate directory or an android_app_certificate
1280 // module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001281 Certificate *string
1282
1283 // Set this flag to true if the prebuilt apk is already signed. The certificate property must not
1284 // be set for presigned modules.
1285 Presigned *bool
1286
Liz Kammer24978992020-05-13 15:49:21 -07001287 // Name of the signing certificate lineage file.
1288 Lineage *string
1289
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001290 // Sign with the default system dev certificate. Must be used judiciously. Most imported apps
1291 // need to either specify a specific certificate or be presigned.
1292 Default_dev_cert *bool
1293
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001294 // Specifies that this app should be installed to the priv-app directory,
1295 // where the system will grant it additional privileges not available to
1296 // normal apps.
1297 Privileged *bool
1298
1299 // Names of modules to be overridden. Listed modules can only be other binaries
1300 // (in Make or Soong).
1301 // This does not completely prevent installation of the overridden binaries, but if both
1302 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
1303 // from PRODUCT_PACKAGES.
1304 Overrides []string
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001305
1306 // Optional name for the installed app. If unspecified, it is derived from the module name.
1307 Filename *string
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001308}
1309
Martin Stjernholm6d415272020-01-31 17:10:36 +00001310func (a *AndroidAppImport) IsInstallable() bool {
1311 return true
1312}
1313
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001314// Updates properties with variant-specific values.
1315func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001316 config := ctx.Config()
1317
1318 dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
1319 // Try DPI variant matches in the reverse-priority order so that the highest priority match
1320 // overwrites everything else.
1321 // TODO(jungjw): Can we optimize this by making it priority order?
1322 for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001323 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001324 }
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001325 if config.ProductAAPTPreferredConfig() != "" {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001326 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001327 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001328
1329 archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
1330 archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
1331 MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001332}
1333
Colin Cross1184b642019-12-30 18:43:07 -08001334func MergePropertiesFromVariant(ctx android.EarlyModuleContext,
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001335 dst interface{}, variantGroup reflect.Value, variant string) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001336 src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
1337 if !src.IsValid() {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001338 return
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001339 }
1340
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001341 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
1342 if err != nil {
1343 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1344 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1345 } else {
1346 panic(err)
1347 }
1348 }
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001349}
1350
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001351func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
1352 cert := android.SrcIsModule(String(a.properties.Certificate))
1353 if cert != "" {
1354 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1355 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001356
Paul Duffin250e6192019-06-07 10:44:37 +01001357 a.usesLibrary.deps(ctx, true)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001358}
1359
1360func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
1361 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001362 // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing
1363 // with them may invalidate pre-existing signature data.
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001364 if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001365 ctx.Build(pctx, android.BuildParams{
1366 Rule: android.Cp,
1367 Output: outputPath,
1368 Input: inputPath,
1369 })
1370 return
1371 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001372 rule := android.NewRuleBuilder()
1373 rule.Command().
1374 Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001375 BuiltTool(ctx, "zip2zip").
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001376 FlagWithInput("-i ", inputPath).
1377 FlagWithOutput("-o ", outputPath).
1378 FlagWithArg("-0 ", "'lib/**/*.so'").
1379 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1380 rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
1381}
1382
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001383// Returns whether this module should have the dex file stored uncompressed in the APK.
1384func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001385 if ctx.Config().UnbundledBuild() || a.preprocessed {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001386 return false
1387 }
1388
1389 // Uncompress dex in APKs of privileged apps
Jiyong Parkf7487312019-10-17 12:54:30 +09001390 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001391 return true
1392 }
1393
1394 return shouldUncompressDex(ctx, &a.dexpreopter)
1395}
1396
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001397func (a *AndroidAppImport) uncompressDex(
1398 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
1399 rule := android.NewRuleBuilder()
1400 rule.Command().
1401 Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001402 BuiltTool(ctx, "zip2zip").
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001403 FlagWithInput("-i ", inputPath).
1404 FlagWithOutput("-o ", outputPath).
1405 FlagWithArg("-0 ", "'classes*.dex'").
1406 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1407 rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
1408}
1409
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001410func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001411 a.generateAndroidBuildActions(ctx)
1412}
1413
Jooyung Han39ee1192020-03-23 20:21:11 +09001414func (a *AndroidAppImport) InstallApkName() string {
1415 return a.BaseModuleName()
1416}
1417
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001418func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001419 numCertPropsSet := 0
1420 if String(a.properties.Certificate) != "" {
1421 numCertPropsSet++
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001422 }
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001423 if Bool(a.properties.Presigned) {
1424 numCertPropsSet++
1425 }
1426 if Bool(a.properties.Default_dev_cert) {
1427 numCertPropsSet++
1428 }
1429 if numCertPropsSet != 1 {
1430 ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001431 }
1432
Colin Crossc2d24052020-05-13 11:05:02 -07001433 _, certificates := collectAppDeps(ctx, a, false, false)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001434
1435 // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001436 // TODO: LOCAL_PACKAGE_SPLITS
1437
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001438 srcApk := a.prebuilt.SingleSourcePath(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001439
1440 if a.usesLibrary.enforceUsesLibraries() {
1441 srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
1442 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001443
1444 // TODO: Install or embed JNI libraries
1445
1446 // Uncompress JNI libraries in the apk
1447 jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
1448 a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
1449
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001450 var installDir android.InstallPath
1451 if Bool(a.properties.Privileged) {
1452 installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001453 } else if ctx.InstallInTestcases() {
1454 installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch())
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001455 } else {
1456 installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
1457 }
1458
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001459 a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001460 a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001461 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001462
1463 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
1464 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
1465 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
1466 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
1467
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001468 dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001469 if a.dexpreopter.uncompressedDex {
1470 dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
1471 a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
1472 dexOutput = dexUncompressed
1473 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001474
Jooyung Han39ee1192020-03-23 20:21:11 +09001475 apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk")
1476
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001477 // TODO: Handle EXTERNAL
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001478
1479 // Sign or align the package if package has not been preprocessed
1480 if a.preprocessed {
1481 a.outputFile = srcApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001482 a.certificate = PresignedCertificate
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001483 } else if !Bool(a.properties.Presigned) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001484 // If the certificate property is empty at this point, default_dev_cert must be set to true.
1485 // Which makes processMainCert's behavior for the empty cert string WAI.
1486 certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001487 if len(certificates) != 1 {
1488 ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
1489 }
Colin Cross503c1d02020-01-28 14:00:53 -08001490 a.certificate = certificates[0]
Jooyung Han39ee1192020-03-23 20:21:11 +09001491 signed := android.PathForModuleOut(ctx, "signed", apkFilename)
Liz Kammer24978992020-05-13 15:49:21 -07001492 var lineageFile android.Path
1493 if lineage := String(a.properties.Lineage); lineage != "" {
1494 lineageFile = android.PathForModuleSrc(ctx, lineage)
1495 }
1496 SignAppPackage(ctx, signed, dexOutput, certificates, lineageFile)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001497 a.outputFile = signed
1498 } else {
Jooyung Han39ee1192020-03-23 20:21:11 +09001499 alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001500 TransformZipAlign(ctx, alignedApk, dexOutput)
1501 a.outputFile = alignedApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001502 a.certificate = PresignedCertificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001503 }
1504
1505 // TODO: Optionally compress the output apk.
1506
Jiyong Park592a6a42020-04-21 22:34:28 +09001507 if a.IsForPlatform() {
1508 a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile)
1509 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001510
1511 // TODO: androidmk converter jni libs
1512}
1513
1514func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
1515 return &a.prebuilt
1516}
1517
1518func (a *AndroidAppImport) Name() string {
1519 return a.prebuilt.Name(a.ModuleBase.Name())
1520}
1521
Dario Frenicde2a032019-10-27 00:29:22 +01001522func (a *AndroidAppImport) OutputFile() android.Path {
1523 return a.outputFile
1524}
1525
Jiyong Park618922e2020-01-08 13:35:43 +09001526func (a *AndroidAppImport) JacocoReportClassesFile() android.Path {
1527 return nil
1528}
1529
Colin Cross503c1d02020-01-28 14:00:53 -08001530func (a *AndroidAppImport) Certificate() Certificate {
1531 return a.certificate
1532}
1533
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001534var dpiVariantGroupType reflect.Type
1535var archVariantGroupType reflect.Type
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001536
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001537func initAndroidAppImportVariantGroupTypes() {
1538 dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
1539
1540 archNames := make([]string, len(android.ArchTypeList()))
1541 for i, archType := range android.ArchTypeList() {
1542 archNames[i] = archType.Name
1543 }
1544 archVariantGroupType = createVariantGroupType(archNames, "Arch")
1545}
1546
1547// Populates all variant struct properties at creation time.
1548func (a *AndroidAppImport) populateAllVariantStructs() {
1549 a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
1550 a.AddProperties(a.dpiVariants)
1551
1552 a.archVariants = reflect.New(archVariantGroupType).Interface()
1553 a.AddProperties(a.archVariants)
1554}
1555
Jiyong Parkf7487312019-10-17 12:54:30 +09001556func (a *AndroidAppImport) Privileged() bool {
1557 return Bool(a.properties.Privileged)
1558}
1559
Sasha Smundak613cbb12020-06-05 10:27:23 -07001560func (a *AndroidAppImport) DepIsInSameApex(_ android.BaseModuleContext, _ android.Module) bool {
Jiyong Park592a6a42020-04-21 22:34:28 +09001561 // android_app_import might have extra dependencies via uses_libs property.
1562 // Don't track the dependency as we don't automatically add those libraries
1563 // to the classpath. It should be explicitly added to java_libs property of APEX
1564 return false
1565}
1566
Colin Crossc2d24052020-05-13 11:05:02 -07001567func (a *AndroidAppImport) sdkVersion() sdkSpec {
1568 return sdkSpecFrom("")
1569}
1570
1571func (a *AndroidAppImport) minSdkVersion() sdkSpec {
1572 return sdkSpecFrom("")
1573}
1574
Jooyung Han749dc692020-04-15 11:03:39 +09001575func (j *AndroidAppImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion int) error {
1576 // Do not check for prebuilts against the min_sdk_version of enclosing APEX
1577 return nil
1578}
1579
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001580func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
1581 props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
1582
1583 variantFields := make([]reflect.StructField, len(variants))
1584 for i, variant := range variants {
1585 variantFields[i] = reflect.StructField{
1586 Name: proptools.FieldNameForProperty(variant),
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001587 Type: props,
1588 }
1589 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001590
1591 variantGroupStruct := reflect.StructOf(variantFields)
1592 return reflect.StructOf([]reflect.StructField{
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001593 {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001594 Name: variantGroupName,
1595 Type: variantGroupStruct,
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001596 },
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001597 })
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001598}
1599
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001600// android_app_import imports a prebuilt apk with additional processing specified in the module.
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001601// DPI-specific apk source files can be specified using dpi_variants. Example:
1602//
1603// android_app_import {
1604// name: "example_import",
1605// apk: "prebuilts/example.apk",
1606// dpi_variants: {
1607// mdpi: {
1608// apk: "prebuilts/example_mdpi.apk",
1609// },
1610// xhdpi: {
1611// apk: "prebuilts/example_xhdpi.apk",
1612// },
1613// },
1614// certificate: "PRESIGNED",
1615// }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001616func AndroidAppImportFactory() android.Module {
1617 module := &AndroidAppImport{}
1618 module.AddProperties(&module.properties)
1619 module.AddProperties(&module.dexpreoptProperties)
Colin Cross50ddcc42019-05-16 12:28:22 -07001620 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001621 module.populateAllVariantStructs()
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001622 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001623 module.processVariants(ctx)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001624 })
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001625
Jiyong Park592a6a42020-04-21 22:34:28 +09001626 android.InitApexModule(module)
Jaewoong Jung6abfbf72020-05-26 20:10:08 -07001627 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1628 android.InitDefaultableModule(module)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001629 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001630
1631 return module
1632}
Colin Cross50ddcc42019-05-16 12:28:22 -07001633
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001634type androidTestImportProperties struct {
1635 // Whether the prebuilt apk can be installed without additional processing. Default is false.
1636 Preprocessed *bool
1637}
1638
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001639type AndroidTestImport struct {
1640 AndroidAppImport
1641
1642 testProperties testProperties
1643
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001644 testImportProperties androidTestImportProperties
1645
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001646 data android.Paths
1647}
1648
1649func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001650 a.preprocessed = Bool(a.testImportProperties.Preprocessed)
1651
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001652 a.generateAndroidBuildActions(ctx)
1653
1654 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
1655}
1656
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001657func (a *AndroidTestImport) InstallInTestcases() bool {
1658 return true
1659}
1660
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001661// android_test_import imports a prebuilt test apk with additional processing specified in the
1662// module. DPI or arch variant configurations can be made as with android_app_import.
1663func AndroidTestImportFactory() android.Module {
1664 module := &AndroidTestImport{}
1665 module.AddProperties(&module.properties)
1666 module.AddProperties(&module.dexpreoptProperties)
1667 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
1668 module.AddProperties(&module.testProperties)
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001669 module.AddProperties(&module.testImportProperties)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001670 module.populateAllVariantStructs()
1671 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1672 module.processVariants(ctx)
1673 })
1674
Colin Crossc80828d2020-05-06 22:29:10 -07001675 module.dexpreopter.isTest = true
1676
Jiyong Park592a6a42020-04-21 22:34:28 +09001677 android.InitApexModule(module)
Jaewoong Jung243688e2020-05-01 15:50:08 -07001678 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1679 android.InitDefaultableModule(module)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001680 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
1681
1682 return module
1683}
1684
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001685type RuntimeResourceOverlay struct {
1686 android.ModuleBase
1687 android.DefaultableModuleBase
Roshan Pius4df2bc72020-04-27 09:42:27 -07001688 android.OverridableModuleBase
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001689 aapt
1690
Roshan Pius4df2bc72020-04-27 09:42:27 -07001691 properties RuntimeResourceOverlayProperties
1692 overridableProperties OverridableRuntimeResourceOverlayProperties
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001693
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001694 certificate Certificate
1695
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001696 outputFile android.Path
1697 installDir android.InstallPath
1698}
1699
1700type RuntimeResourceOverlayProperties struct {
1701 // the name of a certificate in the default certificate directory or an android_app_certificate
1702 // module name in the form ":module".
1703 Certificate *string
1704
Liz Kammer966b2f02020-05-19 16:15:25 -07001705 // Name of the signing certificate lineage file.
1706 Lineage *string
1707
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001708 // optional theme name. If specified, the overlay package will be applied
1709 // only when the ro.boot.vendor.overlay.theme system property is set to the same value.
1710 Theme *string
1711
1712 // if not blank, set to the version of the sdk to compile against.
1713 // Defaults to compiling against the current platform.
1714 Sdk_version *string
1715
1716 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
1717 // Defaults to sdk_version if not set.
1718 Min_sdk_version *string
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001719
1720 // list of android_library modules whose resources are extracted and linked against statically
1721 Static_libs []string
1722
1723 // list of android_app modules whose resources are extracted and linked against
1724 Resource_libs []string
Jaewoong Jungad0177b2020-04-24 15:22:40 -07001725
1726 // Names of modules to be overridden. Listed modules can only be other overlays
1727 // (in Make or Soong).
1728 // This does not completely prevent installation of the overridden overlays, but if both
1729 // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed
1730 // from PRODUCT_PACKAGES.
1731 Overrides []string
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001732}
1733
Jiyong Park69aeba92020-04-24 21:16:36 +09001734// RuntimeResourceOverlayModule interface is used by the apex package to gather information from
1735// a RuntimeResourceOverlay module.
1736type RuntimeResourceOverlayModule interface {
1737 android.Module
1738 OutputFile() android.Path
1739 Certificate() Certificate
1740 Theme() string
1741}
1742
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001743func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) {
1744 sdkDep := decodeSdkDep(ctx, sdkContext(r))
1745 if sdkDep.hasFrameworkLibs() {
1746 r.aapt.deps(ctx, sdkDep)
1747 }
1748
1749 cert := android.SrcIsModule(String(r.properties.Certificate))
1750 if cert != "" {
1751 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1752 }
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001753
1754 ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...)
1755 ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001756}
1757
1758func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1759 // Compile and link resources
1760 r.aapt.hasNoCode = true
Jaewoong Jungf0f747c2020-01-24 10:30:02 -08001761 // Do not remove resources without default values nor dedupe resource configurations with the same value
Roshan Pius4df2bc72020-04-27 09:42:27 -07001762 aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"}
1763 // Allow the override of "package name" and "overlay target package name"
1764 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
1765 if overridden || r.overridableProperties.Package_name != nil {
1766 // The product override variable has a priority over the package_name property.
1767 if !overridden {
1768 manifestPackageName = *r.overridableProperties.Package_name
1769 }
1770 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
1771 }
1772 if r.overridableProperties.Target_package_name != nil {
1773 aaptLinkFlags = append(aaptLinkFlags,
1774 "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name)
1775 }
1776 r.aapt.buildActions(ctx, r, aaptLinkFlags...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001777
1778 // Sign the built package
Colin Crossc2d24052020-05-13 11:05:02 -07001779 _, certificates := collectAppDeps(ctx, r, false, false)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001780 certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx)
1781 signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk")
Liz Kammer966b2f02020-05-19 16:15:25 -07001782 var lineageFile android.Path
1783 if lineage := String(r.properties.Lineage); lineage != "" {
1784 lineageFile = android.PathForModuleSrc(ctx, lineage)
1785 }
1786 SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, lineageFile)
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001787 r.certificate = certificates[0]
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001788
1789 r.outputFile = signed
1790 r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme))
1791 ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile)
1792}
1793
Jiyong Park6a927c42020-01-21 02:03:43 +09001794func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec {
1795 return sdkSpecFrom(String(r.properties.Sdk_version))
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001796}
1797
1798func (r *RuntimeResourceOverlay) systemModules() string {
1799 return ""
1800}
1801
Jiyong Park6a927c42020-01-21 02:03:43 +09001802func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001803 if r.properties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +09001804 return sdkSpecFrom(*r.properties.Min_sdk_version)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001805 }
1806 return r.sdkVersion()
1807}
1808
Jiyong Park6a927c42020-01-21 02:03:43 +09001809func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001810 return r.sdkVersion()
1811}
1812
Jiyong Park69aeba92020-04-24 21:16:36 +09001813func (r *RuntimeResourceOverlay) Certificate() Certificate {
1814 return r.certificate
1815}
1816
1817func (r *RuntimeResourceOverlay) OutputFile() android.Path {
1818 return r.outputFile
1819}
1820
1821func (r *RuntimeResourceOverlay) Theme() string {
1822 return String(r.properties.Theme)
1823}
1824
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001825// runtime_resource_overlay generates a resource-only apk file that can overlay application and
1826// system resources at run time.
1827func RuntimeResourceOverlayFactory() android.Module {
1828 module := &RuntimeResourceOverlay{}
1829 module.AddProperties(
1830 &module.properties,
Roshan Pius4df2bc72020-04-27 09:42:27 -07001831 &module.aaptProperties,
1832 &module.overridableProperties)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001833
Roshan Pius4df2bc72020-04-27 09:42:27 -07001834 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1835 android.InitDefaultableModule(module)
1836 android.InitOverridableModule(module, &module.properties.Overrides)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001837 return module
1838}
1839
Colin Cross50ddcc42019-05-16 12:28:22 -07001840type UsesLibraryProperties struct {
1841 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1842 Uses_libs []string
1843
1844 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1845 // required=false.
1846 Optional_uses_libs []string
1847
1848 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1849 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1850 Enforce_uses_libs *bool
1851}
1852
1853// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1854// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1855// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1856// with knowledge of their shared libraries.
1857type usesLibrary struct {
1858 usesLibraryProperties UsesLibraryProperties
1859}
1860
Paul Duffin250e6192019-06-07 10:44:37 +01001861func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
Colin Cross3245b2c2019-06-07 13:18:09 -07001862 if !ctx.Config().UnbundledBuild() {
1863 ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
1864 ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
Paul Duffin250e6192019-06-07 10:44:37 +01001865 // Only add these extra dependencies if the module depends on framework libs. This avoids
1866 // creating a cyclic dependency:
1867 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
1868 if hasFrameworkLibs {
Ulya Trafimovich5f364b62020-06-30 12:39:01 +01001869 // Dexpreopt needs paths to the dex jars of these libraries in order to construct
1870 // class loader context for dex2oat. Add them as a dependency with a special tag.
Colin Cross3245b2c2019-06-07 13:18:09 -07001871 ctx.AddVariationDependencies(nil, usesLibTag,
1872 "org.apache.http.legacy",
1873 "android.hidl.base-V1.0-java",
1874 "android.hidl.manager-V1.0-java")
Ulya Trafimovichc9af5382020-05-29 15:35:06 +01001875 ctx.AddVariationDependencies(nil, usesLibTag, optionalUsesLibs...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001876 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001877 }
1878}
1879
1880// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
1881// build.
1882func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
1883 optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
1884 return optionalUsesLibs
1885}
1886
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001887// usesLibraryPaths returns a map of module names of shared library dependencies to the paths
1888// to their dex jars on host and on device.
1889func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) dexpreopt.LibraryPaths {
1890 usesLibPaths := make(dexpreopt.LibraryPaths)
Colin Cross50ddcc42019-05-16 12:28:22 -07001891
1892 if !ctx.Config().UnbundledBuild() {
1893 ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001894 dep := ctx.OtherModuleName(m)
Colin Cross50ddcc42019-05-16 12:28:22 -07001895 if lib, ok := m.(Dependency); ok {
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001896 buildPath := lib.DexJarBuildPath()
1897 if buildPath == nil {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001898 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must"+
1899 " produce a dex jar, does it have installable: true?", dep)
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001900 return
Colin Cross50ddcc42019-05-16 12:28:22 -07001901 }
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001902
1903 var devicePath string
1904 installPath := lib.DexJarInstallPath()
1905 if installPath == nil {
1906 devicePath = filepath.Join("/system/framework", dep+".jar")
1907 } else {
1908 devicePath = android.InstallPathToOnDevicePath(ctx, installPath.(android.InstallPath))
1909 }
1910
1911 usesLibPaths[dep] = &dexpreopt.LibraryPath{buildPath, devicePath}
Colin Cross50ddcc42019-05-16 12:28:22 -07001912 } else if ctx.Config().AllowMissingDependencies() {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001913 ctx.AddMissingDependencies([]string{dep})
Colin Cross50ddcc42019-05-16 12:28:22 -07001914 } else {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001915 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be "+
1916 "a java library", dep)
Colin Cross50ddcc42019-05-16 12:28:22 -07001917 }
1918 })
1919 }
1920
1921 return usesLibPaths
1922}
1923
1924// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1925// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1926// unconditionally in the future.
1927func (u *usesLibrary) enforceUsesLibraries() bool {
1928 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1929 len(u.usesLibraryProperties.Optional_uses_libs) > 0
1930 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
1931}
1932
1933// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
1934// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
1935func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1936 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
1937
1938 rule := android.NewRuleBuilder()
Colin Crossee94d6a2019-07-08 17:08:34 -07001939 cmd := rule.Command().BuiltTool(ctx, "manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001940 Flag("--enforce-uses-libraries").
1941 Input(manifest).
1942 FlagWithOutput("-o ", outputFile)
1943
1944 for _, lib := range u.usesLibraryProperties.Uses_libs {
1945 cmd.FlagWithArg("--uses-library ", lib)
1946 }
1947
1948 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1949 cmd.FlagWithArg("--optional-uses-library ", lib)
1950 }
1951
1952 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1953
1954 return outputFile
1955}
1956
1957// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
1958// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
1959func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
1960 outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
1961
1962 rule := android.NewRuleBuilder()
1963 aapt := ctx.Config().HostToolPath(ctx, "aapt")
1964 rule.Command().
1965 Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
1966 Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
1967 Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
1968 Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
1969 rule.Command().Text("cp -f").Input(apk).Output(outputFile)
1970
1971 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1972
1973 return outputFile
1974}