Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 1 | // 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 | |
| 15 | package java |
| 16 | |
| 17 | // This file contains the module types for compiling Android apps. |
| 18 | |
| 19 | import ( |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 20 | "path/filepath" |
| 21 | "reflect" |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 22 | "sort" |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 23 | "strconv" |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 24 | "strings" |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 25 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 26 | "github.com/google/blueprint" |
| 27 | "github.com/google/blueprint/proptools" |
| 28 | |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 29 | "android/soong/android" |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 30 | "android/soong/cc" |
Ulya Trafimovich | d4bcea4 | 2020-06-03 14:57:22 +0100 | [diff] [blame] | 31 | "android/soong/dexpreopt" |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 32 | "android/soong/tradefed" |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 33 | ) |
| 34 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 35 | var supportedDpis = []string{"ldpi", "mdpi", "hdpi", "xhdpi", "xxhdpi", "xxxhdpi"} |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 36 | |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 37 | func init() { |
Paul Duffin | f9b1da0 | 2019-12-18 19:51:55 +0000 | [diff] [blame] | 38 | RegisterAppBuildComponents(android.InitRegistrationContext) |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 39 | |
| 40 | initAndroidAppImportVariantGroupTypes() |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 41 | } |
| 42 | |
Paul Duffin | f9b1da0 | 2019-12-18 19:51:55 +0000 | [diff] [blame] | 43 | func 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 Pius | 4df2bc7 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 50 | ctx.RegisterModuleType("override_runtime_resource_overlay", OverrideRuntimeResourceOverlayModuleFactory) |
Paul Duffin | f9b1da0 | 2019-12-18 19:51:55 +0000 | [diff] [blame] | 51 | ctx.RegisterModuleType("android_app_import", AndroidAppImportFactory) |
| 52 | ctx.RegisterModuleType("android_test_import", AndroidTestImportFactory) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 53 | ctx.RegisterModuleType("runtime_resource_overlay", RuntimeResourceOverlayFactory) |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 54 | ctx.RegisterModuleType("android_app_set", AndroidApkSetFactory) |
| 55 | } |
| 56 | |
| 57 | type 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 | |
| 74 | type AndroidAppSet struct { |
| 75 | android.ModuleBase |
| 76 | android.DefaultableModuleBase |
| 77 | prebuilt android.Prebuilt |
| 78 | |
| 79 | properties AndroidAppSetProperties |
| 80 | packedOutput android.WritablePath |
| 81 | masterFile string |
| 82 | } |
| 83 | |
| 84 | func (as *AndroidAppSet) Name() string { |
| 85 | return as.prebuilt.Name(as.ModuleBase.Name()) |
| 86 | } |
| 87 | |
| 88 | func (as *AndroidAppSet) IsInstallable() bool { |
| 89 | return true |
| 90 | } |
| 91 | |
| 92 | func (as *AndroidAppSet) Prebuilt() *android.Prebuilt { |
| 93 | return &as.prebuilt |
| 94 | } |
| 95 | |
| 96 | func (as *AndroidAppSet) Privileged() bool { |
| 97 | return Bool(as.properties.Privileged) |
| 98 | } |
| 99 | |
Sasha Smundak | 18d98bc | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 100 | func (as *AndroidAppSet) OutputFile() android.Path { |
| 101 | return as.packedOutput |
| 102 | } |
| 103 | |
| 104 | func (as *AndroidAppSet) MasterFile() string { |
| 105 | return as.masterFile |
| 106 | } |
| 107 | |
Jaewoong Jung | fa00c06 | 2020-05-14 14:15:24 -0700 | [diff] [blame] | 108 | var TargetCpuAbi = map[string]string{ |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 109 | "arm": "ARMEABI_V7A", |
| 110 | "arm64": "ARM64_V8A", |
| 111 | "x86": "X86", |
| 112 | "x86_64": "X86_64", |
| 113 | } |
| 114 | |
Jaewoong Jung | fa00c06 | 2020-05-14 14:15:24 -0700 | [diff] [blame] | 115 | func SupportedAbis(ctx android.ModuleContext) []string { |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 116 | abiName := func(archVar string, deviceArch string) string { |
Jaewoong Jung | fa00c06 | 2020-05-14 14:15:24 -0700 | [diff] [blame] | 117 | if abi, found := TargetCpuAbi[deviceArch]; found { |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 118 | return abi |
| 119 | } |
| 120 | ctx.ModuleErrorf("Invalid %s: %s", archVar, deviceArch) |
| 121 | return "BAD_ABI" |
| 122 | } |
| 123 | |
| 124 | result := []string{abiName("TARGET_ARCH", ctx.DeviceConfig().DeviceArch())} |
| 125 | if s := ctx.DeviceConfig().DeviceSecondaryArch(); s != "" { |
| 126 | result = append(result, abiName("TARGET_2ND_ARCH", s)) |
| 127 | } |
| 128 | return result |
| 129 | } |
| 130 | |
| 131 | func (as *AndroidAppSet) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Sasha Smundak | 18d98bc | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 132 | as.packedOutput = android.PathForModuleOut(ctx, ctx.ModuleName()+".zip") |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 133 | // We are assuming here that the master file in the APK |
| 134 | // set has `.apk` suffix. If it doesn't the build will fail. |
| 135 | // APK sets containing APEX files are handled elsewhere. |
Sasha Smundak | 57f0ee1 | 2020-06-15 18:25:27 -0700 | [diff] [blame] | 136 | as.masterFile = as.BaseModuleName() + ".apk" |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 137 | screenDensities := "all" |
| 138 | if dpis := ctx.Config().ProductAAPTPrebuiltDPI(); len(dpis) > 0 { |
| 139 | screenDensities = strings.ToUpper(strings.Join(dpis, ",")) |
| 140 | } |
| 141 | // TODO(asmundak): handle locales. |
| 142 | // TODO(asmundak): do we support device features |
| 143 | ctx.Build(pctx, |
| 144 | android.BuildParams{ |
| 145 | Rule: extractMatchingApks, |
| 146 | Description: "Extract APKs from APK set", |
| 147 | Output: as.packedOutput, |
| 148 | Inputs: android.Paths{as.prebuilt.SingleSourcePath(ctx)}, |
| 149 | Args: map[string]string{ |
Jaewoong Jung | fa00c06 | 2020-05-14 14:15:24 -0700 | [diff] [blame] | 150 | "abis": strings.Join(SupportedAbis(ctx), ","), |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 151 | "allow-prereleased": strconv.FormatBool(proptools.Bool(as.properties.Prerelease)), |
| 152 | "screen-densities": screenDensities, |
| 153 | "sdk-version": ctx.Config().PlatformSdkVersion(), |
Sasha Smundak | e88b436 | 2020-06-22 16:53:33 -0700 | [diff] [blame] | 154 | "stem": as.BaseModuleName(), |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 155 | }, |
| 156 | }) |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | // android_app_set extracts a set of APKs based on the target device |
| 160 | // configuration and installs this set as "split APKs". |
Sasha Smundak | 613cbb1 | 2020-06-05 10:27:23 -0700 | [diff] [blame] | 161 | // The extracted set always contains 'master' APK whose name is |
| 162 | // _module_name_.apk and every split APK matching target device. |
| 163 | // The extraction of the density-specific splits depends on |
| 164 | // PRODUCT_AAPT_PREBUILT_DPI variable. If present (its value should |
| 165 | // be a list density names: LDPI, MDPI, HDPI, etc.), only listed |
| 166 | // splits will be extracted. Otherwise all density-specific splits |
| 167 | // will be extracted. |
Sasha Smundak | a7856c0 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 168 | func AndroidApkSetFactory() android.Module { |
| 169 | module := &AndroidAppSet{} |
| 170 | module.AddProperties(&module.properties) |
| 171 | InitJavaModule(module, android.DeviceSupported) |
| 172 | android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set") |
| 173 | return module |
Paul Duffin | f9b1da0 | 2019-12-18 19:51:55 +0000 | [diff] [blame] | 174 | } |
| 175 | |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 176 | // AndroidManifest.xml merging |
| 177 | // package splits |
| 178 | |
Colin Cross | fabb608 | 2018-02-20 17:22:23 -0800 | [diff] [blame] | 179 | type appProperties struct { |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 180 | // Names of extra android_app_certificate modules to sign the apk with in the form ":module". |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 181 | Additional_certificates []string |
| 182 | |
| 183 | // If set, create package-export.apk, which other packages can |
| 184 | // use to get PRODUCT-agnostic resource data like IDs and type definitions. |
Nan Zhang | ea568a4 | 2017-11-08 21:20:04 -0800 | [diff] [blame] | 185 | Export_package_resources *bool |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 186 | |
Colin Cross | 1605606 | 2017-12-13 22:46:28 -0800 | [diff] [blame] | 187 | // Specifies that this app should be installed to the priv-app directory, |
| 188 | // where the system will grant it additional privileges not available to |
| 189 | // normal apps. |
| 190 | Privileged *bool |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 191 | |
| 192 | // list of resource labels to generate individual resource packages |
| 193 | Package_splits []string |
Jason Monk | d4122be | 2018-08-10 09:33:36 -0400 | [diff] [blame] | 194 | |
| 195 | // Names of modules to be overridden. Listed modules can only be other binaries |
| 196 | // (in Make or Soong). |
| 197 | // This does not completely prevent installation of the overridden binaries, but if both |
| 198 | // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed |
| 199 | // from PRODUCT_PACKAGES. |
| 200 | Overrides []string |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 201 | |
| 202 | // list of native libraries that will be provided in or alongside the resulting jar |
| 203 | Jni_libs []string `android:"arch_variant"` |
| 204 | |
Colin Cross | 7204cf0 | 2020-05-06 17:51:39 -0700 | [diff] [blame] | 205 | // if true, use JNI libraries that link against platform APIs even if this module sets |
Colin Cross | ee87c60 | 2020-02-19 16:57:15 -0800 | [diff] [blame] | 206 | // sdk_version. |
| 207 | Jni_uses_platform_apis *bool |
| 208 | |
Colin Cross | 7204cf0 | 2020-05-06 17:51:39 -0700 | [diff] [blame] | 209 | // if true, use JNI libraries that link against SDK APIs even if this module does not set |
| 210 | // sdk_version. |
| 211 | Jni_uses_sdk_apis *bool |
| 212 | |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 213 | // STL library to use for JNI libraries. |
| 214 | Stl *string `android:"arch_variant"` |
| 215 | |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 216 | // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest |
| 217 | // flag so that they are used from inside the APK at runtime. Defaults to true for android_test modules unless |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 218 | // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for |
| 219 | // android_app modules that are embedded to APEXes, defaults to false for other module types where the native |
| 220 | // libraries are generally preinstalled outside the APK. |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 221 | Use_embedded_native_libs *bool |
Colin Cross | 46abdad | 2019-02-07 13:07:08 -0800 | [diff] [blame] | 222 | |
| 223 | // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that |
| 224 | // they are used from inside the APK at runtime. |
| 225 | Use_embedded_dex *bool |
Colin Cross | 47fa9d3 | 2019-03-26 10:51:39 -0700 | [diff] [blame] | 226 | |
| 227 | // Forces native libraries to always be packaged into the APK, |
| 228 | // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed. |
| 229 | // True for android_test* modules. |
| 230 | AlwaysPackageNativeLibs bool `blueprint:"mutated"` |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 231 | |
| 232 | // If set, find and merge all NOTICE files that this module and its dependencies have and store |
| 233 | // it in the APK as an asset. |
| 234 | Embed_notices *bool |
Jaewoong Jung | 87a33e7 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 235 | |
| 236 | // cc.Coverage related properties |
| 237 | PreventInstall bool `blueprint:"mutated"` |
| 238 | HideFromMake bool `blueprint:"mutated"` |
| 239 | IsCoverageVariant bool `blueprint:"mutated"` |
Artur Satayev | 2db1c3f | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 240 | |
| 241 | // Whether this app is considered mainline updatable or not. When set to true, this will enforce |
Artur Satayev | f40fc85 | 2020-04-16 13:43:02 +0100 | [diff] [blame] | 242 | // additional rules to make sure an app can safely be updated. Default is false. |
| 243 | // Prefer using other specific properties if build behaviour must be changed; avoid using this |
| 244 | // flag for anything but neverallow rules (unless the behaviour change is invisible to owners). |
Artur Satayev | 2db1c3f | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 245 | Updatable *bool |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 246 | } |
| 247 | |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 248 | // android_app properties that can be overridden by override_android_app |
| 249 | type overridableAppProperties struct { |
| 250 | // The name of a certificate in the default certificate directory, blank to use the default product certificate, |
| 251 | // or an android_app_certificate module name in the form ":module". |
| 252 | Certificate *string |
Jaewoong Jung | 6f373f6 | 2019-03-13 10:13:24 -0700 | [diff] [blame] | 253 | |
Liz Kammer | e2b27f4 | 2020-05-07 13:24:05 -0700 | [diff] [blame] | 254 | // Name of the signing certificate lineage file. |
| 255 | Lineage *string |
| 256 | |
Jaewoong Jung | 6f373f6 | 2019-03-13 10:13:24 -0700 | [diff] [blame] | 257 | // the package name of this app. The package name in the manifest file is used if one was not given. |
| 258 | Package_name *string |
Baligh Uddin | 5b16dfb | 2020-02-11 17:27:19 -0800 | [diff] [blame] | 259 | |
| 260 | // the logging parent of this app. |
| 261 | Logging_parent *string |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 262 | } |
| 263 | |
Roshan Pius | 4df2bc7 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 264 | // runtime_resource_overlay properties that can be overridden by override_runtime_resource_overlay |
| 265 | type OverridableRuntimeResourceOverlayProperties struct { |
| 266 | // the package name of this app. The package name in the manifest file is used if one was not given. |
| 267 | Package_name *string |
| 268 | |
| 269 | // the target package name of this overlay app. The target package name in the manifest file is used if one was not given. |
| 270 | Target_package_name *string |
| 271 | } |
| 272 | |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 273 | type AndroidApp struct { |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 274 | Library |
| 275 | aapt |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 276 | android.OverridableModuleBase |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 277 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 278 | usesLibrary usesLibrary |
| 279 | |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 280 | certificate Certificate |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 281 | |
Colin Cross | fabb608 | 2018-02-20 17:22:23 -0800 | [diff] [blame] | 282 | appProperties appProperties |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 283 | |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 284 | overridableAppProperties overridableAppProperties |
| 285 | |
Jaewoong Jung | 87a33e7 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 286 | installJniLibs []jniLib |
| 287 | jniCoverageOutputs android.Paths |
Colin Cross | f623721 | 2018-10-29 23:14:58 -0700 | [diff] [blame] | 288 | |
| 289 | bundleFile android.Path |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 290 | |
| 291 | // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES. |
| 292 | installApkName string |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 293 | |
Colin Cross | 70dda7e | 2019-10-01 22:05:35 -0700 | [diff] [blame] | 294 | installDir android.InstallPath |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 295 | |
Jaewoong Jung | 7dd4ae2 | 2019-09-27 17:13:15 -0700 | [diff] [blame] | 296 | onDeviceDir string |
| 297 | |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 298 | additionalAaptFlags []string |
Jaewoong Jung | 9877279 | 2019-07-01 17:15:13 -0700 | [diff] [blame] | 299 | |
| 300 | noticeOutputs android.NoticeOutputs |
Jiyong Park | cfaa164 | 2020-02-28 16:51:07 +0900 | [diff] [blame] | 301 | |
| 302 | overriddenManifestPackageName string |
Artur Satayev | 1111b84 | 2020-04-27 19:05:28 +0100 | [diff] [blame] | 303 | |
| 304 | android.ApexBundleDepsInfo |
Colin Cross | e1731a5 | 2017-12-14 11:22:55 -0800 | [diff] [blame] | 305 | } |
| 306 | |
Martin Stjernholm | 6d41527 | 2020-01-31 17:10:36 +0000 | [diff] [blame] | 307 | func (a *AndroidApp) IsInstallable() bool { |
| 308 | return Bool(a.properties.Installable) |
| 309 | } |
| 310 | |
Colin Cross | 89c3158 | 2018-04-30 15:55:11 -0700 | [diff] [blame] | 311 | func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths { |
| 312 | return nil |
| 313 | } |
| 314 | |
Colin Cross | 66f7882 | 2018-05-02 12:58:28 -0700 | [diff] [blame] | 315 | func (a *AndroidApp) ExportedStaticPackages() android.Paths { |
| 316 | return nil |
| 317 | } |
| 318 | |
Sundong Ahn | e1f05aa | 2019-08-27 13:55:42 +0900 | [diff] [blame] | 319 | func (a *AndroidApp) OutputFile() android.Path { |
| 320 | return a.outputFile |
| 321 | } |
| 322 | |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 323 | func (a *AndroidApp) Certificate() Certificate { |
| 324 | return a.certificate |
| 325 | } |
| 326 | |
Jaewoong Jung | 87a33e7 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 327 | func (a *AndroidApp) JniCoverageOutputs() android.Paths { |
| 328 | return a.jniCoverageOutputs |
| 329 | } |
| 330 | |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 331 | var _ AndroidLibraryDependency = (*AndroidApp)(nil) |
| 332 | |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 333 | type Certificate struct { |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 334 | Pem, Key android.Path |
| 335 | presigned bool |
| 336 | } |
| 337 | |
Sasha Smundak | 18d98bc | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 338 | var PresignedCertificate = Certificate{presigned: true} |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 339 | |
| 340 | func (c Certificate) AndroidMkString() string { |
| 341 | if c.presigned { |
| 342 | return "PRESIGNED" |
| 343 | } else { |
| 344 | return c.Pem.String() |
| 345 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 346 | } |
| 347 | |
Colin Cross | 46c9b8b | 2017-06-22 16:51:17 -0700 | [diff] [blame] | 348 | func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) { |
| 349 | a.Module.deps(ctx) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 350 | |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 351 | if String(a.appProperties.Stl) == "c++_shared" && !a.sdkVersion().specified() { |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 352 | ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared") |
| 353 | } |
| 354 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 355 | sdkDep := decodeSdkDep(ctx, sdkContext(a)) |
| 356 | if sdkDep.hasFrameworkLibs() { |
| 357 | a.aapt.deps(ctx, sdkDep) |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 358 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 359 | |
Colin Cross | 3c00770 | 2020-05-08 11:20:24 -0700 | [diff] [blame] | 360 | usesSDK := a.sdkVersion().specified() && a.sdkVersion().kind != sdkCorePlatform |
| 361 | |
| 362 | if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) { |
| 363 | ctx.PropertyErrorf("jni_uses_sdk_apis", |
| 364 | "can only be set for modules that do not set sdk_version") |
| 365 | } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) { |
| 366 | ctx.PropertyErrorf("jni_uses_platform_apis", |
| 367 | "can only be set for modules that set sdk_version") |
| 368 | } |
| 369 | |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 370 | tag := &jniDependencyTag{} |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 371 | for _, jniTarget := range ctx.MultiTargets() { |
Colin Cross | 0f7d2ef | 2019-10-16 11:03:10 -0700 | [diff] [blame] | 372 | variation := append(jniTarget.Variations(), |
| 373 | blueprint.Variation{Mutator: "link", Variation: "shared"}) |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 374 | |
| 375 | // If the app builds against an Android SDK use the SDK variant of JNI dependencies |
| 376 | // unless jni_uses_platform_apis is set. |
Colin Cross | c2d2405 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 377 | // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already |
| 378 | // have stable APIs through the VNDK. |
| 379 | if (usesSDK && !a.RequiresStableAPIs(ctx) && |
| 380 | !Bool(a.appProperties.Jni_uses_platform_apis)) || |
Colin Cross | 7204cf0 | 2020-05-06 17:51:39 -0700 | [diff] [blame] | 381 | Bool(a.appProperties.Jni_uses_sdk_apis) { |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 382 | variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"}) |
| 383 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 384 | ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...) |
| 385 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 386 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 387 | a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs()) |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 388 | } |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 389 | |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 390 | func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) { |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 391 | cert := android.SrcIsModule(a.getCertString(ctx)) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 392 | if cert != "" { |
| 393 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 394 | } |
| 395 | |
| 396 | for _, cert := range a.appProperties.Additional_certificates { |
| 397 | cert = android.SrcIsModule(cert) |
| 398 | if cert != "" { |
| 399 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 400 | } else { |
| 401 | ctx.PropertyErrorf("additional_certificates", |
| 402 | `must be names of android_app_certificate modules in the form ":module"`) |
| 403 | } |
| 404 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 405 | } |
| 406 | |
Jeongik Cha | 538c0d0 | 2019-07-11 15:54:27 +0900 | [diff] [blame] | 407 | func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 408 | a.generateAndroidBuildActions(ctx) |
| 409 | } |
| 410 | |
Colin Cross | 46c9b8b | 2017-06-22 16:51:17 -0700 | [diff] [blame] | 411 | func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Artur Satayev | 2db1c3f | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 412 | a.checkAppSdkVersions(ctx) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 413 | a.generateAndroidBuildActions(ctx) |
| 414 | } |
| 415 | |
Artur Satayev | 2db1c3f | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 416 | func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) { |
Artur Satayev | 849f844 | 2020-04-28 14:57:42 +0100 | [diff] [blame] | 417 | if a.Updatable() { |
Artur Satayev | 2db1c3f | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 418 | if !a.sdkVersion().stable() { |
| 419 | ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.sdkVersion()) |
| 420 | } |
Artur Satayev | f40fc85 | 2020-04-16 13:43:02 +0100 | [diff] [blame] | 421 | if String(a.deviceProperties.Min_sdk_version) == "" { |
| 422 | ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.") |
| 423 | } |
Jooyung Han | 749dc69 | 2020-04-15 11:03:39 +0900 | [diff] [blame^] | 424 | |
Jooyung Han | bbc3fb7 | 2020-04-29 14:01:06 +0900 | [diff] [blame] | 425 | if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil { |
| 426 | a.checkJniLibsSdkVersion(ctx, minSdkVersion) |
Jooyung Han | 749dc69 | 2020-04-15 11:03:39 +0900 | [diff] [blame^] | 427 | android.CheckMinSdkVersion(a, ctx, int(minSdkVersion)) |
Jooyung Han | bbc3fb7 | 2020-04-29 14:01:06 +0900 | [diff] [blame] | 428 | } else { |
| 429 | ctx.PropertyErrorf("min_sdk_version", "%s", err.Error()) |
| 430 | } |
Artur Satayev | 2db1c3f | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 431 | } |
| 432 | |
| 433 | a.checkPlatformAPI(ctx) |
| 434 | a.checkSdkVersions(ctx) |
| 435 | } |
| 436 | |
Jooyung Han | bbc3fb7 | 2020-04-29 14:01:06 +0900 | [diff] [blame] | 437 | // If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it. |
| 438 | // This check is enforced for "updatable" APKs (including APK-in-APEX). |
| 439 | // b/155209650: until min_sdk_version is properly supported, use sdk_version instead. |
| 440 | // because, sdk_version is overridden by min_sdk_version (if set as smaller) |
| 441 | // and linkType is checked with dependencies so we can be sure that the whole dependency tree |
| 442 | // will meet the requirements. |
| 443 | func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) { |
| 444 | // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType() |
| 445 | ctx.VisitDirectDeps(func(m android.Module) { |
| 446 | if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) { |
| 447 | return |
| 448 | } |
| 449 | dep, _ := m.(*cc.Module) |
Jooyung Han | 652d5b3 | 2020-05-20 17:12:13 +0900 | [diff] [blame] | 450 | // The domain of cc.sdk_version is "current" and <number> |
| 451 | // We can rely on sdkSpec to convert it to <number> so that "current" is handled |
| 452 | // properly regardless of sdk finalization. |
| 453 | jniSdkVersion, err := sdkSpecFrom(dep.SdkVersion()).effectiveVersion(ctx) |
| 454 | if err != nil || minSdkVersion < jniSdkVersion { |
Jooyung Han | bbc3fb7 | 2020-04-29 14:01:06 +0900 | [diff] [blame] | 455 | ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)", |
| 456 | dep.SdkVersion(), minSdkVersion, ctx.ModuleName()) |
| 457 | return |
| 458 | } |
| 459 | |
| 460 | }) |
| 461 | } |
| 462 | |
Sasha Smundak | 6ad7725 | 2019-05-01 13:16:22 -0700 | [diff] [blame] | 463 | // Returns true if the native libraries should be stored in the APK uncompressed and the |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 464 | // extractNativeLibs application flag should be set to false in the manifest. |
Sasha Smundak | 6ad7725 | 2019-05-01 13:16:22 -0700 | [diff] [blame] | 465 | func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool { |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 466 | minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx) |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 467 | if err != nil { |
| 468 | ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err) |
| 469 | } |
| 470 | |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 471 | return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) || |
| 472 | !a.IsForPlatform() |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 473 | } |
| 474 | |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 475 | // Returns whether this module should have the dex file stored uncompressed in the APK. |
| 476 | func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool { |
Colin Cross | 46abdad | 2019-02-07 13:07:08 -0800 | [diff] [blame] | 477 | if Bool(a.appProperties.Use_embedded_dex) { |
| 478 | return true |
| 479 | } |
| 480 | |
Colin Cross | 53a87f5 | 2019-06-25 13:35:30 -0700 | [diff] [blame] | 481 | // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may |
| 482 | // be preinstalled as prebuilts). |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 483 | if ctx.Config().UncompressPrivAppDex() && a.Privileged() { |
Nicolas Geoffray | fa6e9ec | 2019-02-12 13:12:16 +0000 | [diff] [blame] | 484 | return true |
| 485 | } |
| 486 | |
Colin Cross | 53a87f5 | 2019-06-25 13:35:30 -0700 | [diff] [blame] | 487 | if ctx.Config().UnbundledBuild() { |
| 488 | return false |
| 489 | } |
| 490 | |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 491 | return shouldUncompressDex(ctx, &a.dexpreopter) |
Colin Cross | 5a0dcd5 | 2018-10-05 14:20:06 -0700 | [diff] [blame] | 492 | } |
| 493 | |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 494 | func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool { |
| 495 | return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) || |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 496 | !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 497 | } |
| 498 | |
Jiyong Park | cfaa164 | 2020-02-28 16:51:07 +0900 | [diff] [blame] | 499 | func (a *AndroidApp) OverriddenManifestPackageName() string { |
| 500 | return a.overriddenManifestPackageName |
| 501 | } |
| 502 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 503 | func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) { |
David Brazdil | d25060a | 2019-02-18 18:24:16 +0000 | [diff] [blame] | 504 | a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis) |
| 505 | |
Jaewoong Jung | c27ab66 | 2019-05-30 15:51:14 -0700 | [diff] [blame] | 506 | // Ask manifest_fixer to add or update the application element indicating this app has no code. |
| 507 | a.aapt.hasNoCode = !a.hasCode(ctx) |
| 508 | |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 509 | aaptLinkFlags := []string{} |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 510 | |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 511 | // Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided. |
Jaewoong Jung | 3aff578 | 2020-02-11 07:54:35 -0800 | [diff] [blame] | 512 | hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product") |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 513 | if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 { |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 514 | aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics()) |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 515 | } |
| 516 | |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 517 | if !Bool(a.aaptProperties.Aapt_include_all_resources) { |
| 518 | // Product AAPT config |
| 519 | for _, aaptConfig := range ctx.Config().ProductAAPTConfig() { |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 520 | aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig) |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 521 | } |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 522 | |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 523 | // Product AAPT preferred config |
| 524 | if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 { |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 525 | aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig()) |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 526 | } |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 527 | } |
| 528 | |
Jiyong Park | 7f67f48 | 2019-01-05 12:57:48 +0900 | [diff] [blame] | 529 | manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName()) |
Jaewoong Jung | 6f373f6 | 2019-03-13 10:13:24 -0700 | [diff] [blame] | 530 | if overridden || a.overridableAppProperties.Package_name != nil { |
| 531 | // The product override variable has a priority over the package_name property. |
| 532 | if !overridden { |
| 533 | manifestPackageName = *a.overridableAppProperties.Package_name |
| 534 | } |
Liz Kammer | 1d5983b | 2020-05-19 19:15:37 +0000 | [diff] [blame] | 535 | aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName) |
Jiyong Park | cfaa164 | 2020-02-28 16:51:07 +0900 | [diff] [blame] | 536 | a.overriddenManifestPackageName = manifestPackageName |
Jiyong Park | 7f67f48 | 2019-01-05 12:57:48 +0900 | [diff] [blame] | 537 | } |
| 538 | |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 539 | aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...) |
| 540 | |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 541 | a.aapt.splitNames = a.appProperties.Package_splits |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 542 | a.aapt.sdkLibraries = a.exportedSdkLibs |
Baligh Uddin | 5b16dfb | 2020-02-11 17:27:19 -0800 | [diff] [blame] | 543 | a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent) |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 544 | a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...) |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 545 | |
Colin Cross | 46c9b8b | 2017-06-22 16:51:17 -0700 | [diff] [blame] | 546 | // apps manifests are handled by aapt, don't let Module see them |
Dan Willemsen | 34cc69e | 2015-09-23 15:26:20 -0700 | [diff] [blame] | 547 | a.properties.Manifest = nil |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 548 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 549 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 550 | func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) { |
Colin Cross | 89c3158 | 2018-04-30 15:55:11 -0700 | [diff] [blame] | 551 | var staticLibProguardFlagFiles android.Paths |
| 552 | ctx.VisitDirectDeps(func(m android.Module) { |
| 553 | if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag { |
| 554 | staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...) |
| 555 | } |
| 556 | }) |
| 557 | |
| 558 | staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles) |
| 559 | |
| 560 | a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...) |
| 561 | a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile) |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 562 | } |
Colin Cross | 66dbc0b | 2017-12-28 12:23:20 -0800 | [diff] [blame] | 563 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 564 | func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path { |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 565 | |
| 566 | var installDir string |
| 567 | if ctx.ModuleName() == "framework-res" { |
| 568 | // framework-res.apk is installed as system/framework/framework-res.apk |
| 569 | installDir = "framework" |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 570 | } else if a.Privileged() { |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 571 | installDir = filepath.Join("priv-app", a.installApkName) |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 572 | } else { |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 573 | installDir = filepath.Join("app", a.installApkName) |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 574 | } |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 575 | a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk") |
David Srbecky | e033cba | 2020-05-20 22:20:28 +0100 | [diff] [blame] | 576 | if a.deviceProperties.Uncompress_dex == nil { |
| 577 | // If the value was not force-set by the user, use reasonable default based on the module. |
| 578 | a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx)) |
| 579 | } |
| 580 | a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 581 | a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries() |
| 582 | a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs |
| 583 | a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx) |
| 584 | a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx) |
| 585 | a.dexpreopter.manifestFile = a.mergedManifestFile |
| 586 | |
Colin Cross | 5ab4e6d | 2017-11-22 16:20:45 -0800 | [diff] [blame] | 587 | if ctx.ModuleName() != "framework-res" { |
| 588 | a.Module.compile(ctx, a.aaptSrcJar) |
| 589 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 590 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 591 | return a.maybeStrippedDexJarFile |
| 592 | } |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 593 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 594 | func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 595 | var jniJarFile android.WritablePath |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 596 | if len(jniLibs) > 0 { |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 597 | if a.shouldEmbedJnis(ctx) { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 598 | jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip") |
Sasha Smundak | 6ad7725 | 2019-05-01 13:16:22 -0700 | [diff] [blame] | 599 | TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx)) |
Jaewoong Jung | 87a33e7 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 600 | for _, jni := range jniLibs { |
| 601 | if jni.coverageFile.Valid() { |
Jaewoong Jung | 46984ee | 2020-04-07 13:07:55 -0700 | [diff] [blame] | 602 | // Only collect coverage for the first target arch if this is a multilib target. |
| 603 | // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage |
| 604 | // data file path collisions since the current coverage file path format doesn't contain |
| 605 | // arch-related strings. This is fine for now though; the code coverage team doesn't use |
| 606 | // multi-arch targets such as test_suite_* for coverage collections yet. |
| 607 | // |
| 608 | // Work with the team to come up with a new format that handles multilib modules properly |
| 609 | // and change this. |
| 610 | if len(ctx.Config().Targets[android.Android]) == 1 || |
| 611 | ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType { |
| 612 | a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path()) |
| 613 | } |
Jaewoong Jung | 87a33e7 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 614 | } |
| 615 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 616 | } else { |
| 617 | a.installJniLibs = jniLibs |
| 618 | } |
| 619 | } |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 620 | return jniJarFile |
| 621 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 622 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 623 | func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 624 | // Collect NOTICE files from all dependencies. |
| 625 | seenModules := make(map[android.Module]bool) |
| 626 | noticePathSet := make(map[android.Path]bool) |
| 627 | |
| 628 | ctx.WalkDeps(func(child android.Module, parent android.Module) bool { |
| 629 | // Have we already seen this? |
| 630 | if _, ok := seenModules[child]; ok { |
| 631 | return false |
| 632 | } |
| 633 | seenModules[child] = true |
| 634 | |
| 635 | // Skip host modules. |
| 636 | if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross { |
| 637 | return false |
| 638 | } |
| 639 | |
Bob Badour | a75b057 | 2020-02-18 20:21:55 -0800 | [diff] [blame] | 640 | paths := child.(android.Module).NoticeFiles() |
| 641 | if len(paths) > 0 { |
| 642 | for _, path := range paths { |
| 643 | noticePathSet[path] = true |
| 644 | } |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 645 | } |
| 646 | return true |
| 647 | }) |
| 648 | |
| 649 | // If the app has one, add it too. |
Bob Badour | a75b057 | 2020-02-18 20:21:55 -0800 | [diff] [blame] | 650 | if len(a.NoticeFiles()) > 0 { |
| 651 | for _, path := range a.NoticeFiles() { |
| 652 | noticePathSet[path] = true |
| 653 | } |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 654 | } |
| 655 | |
| 656 | if len(noticePathSet) == 0 { |
Jaewoong Jung | 9877279 | 2019-07-01 17:15:13 -0700 | [diff] [blame] | 657 | return |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 658 | } |
| 659 | var noticePaths []android.Path |
| 660 | for path := range noticePathSet { |
| 661 | noticePaths = append(noticePaths, path) |
| 662 | } |
| 663 | sort.Slice(noticePaths, func(i, j int) bool { |
| 664 | return noticePaths[i].String() < noticePaths[j].String() |
| 665 | }) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 666 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 667 | a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 668 | } |
| 669 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 670 | // Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it |
| 671 | // isn't a cert module reference. Also checks and enforces system cert restriction if applicable. |
| 672 | func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate { |
| 673 | if android.SrcIsModule(certPropValue) == "" { |
| 674 | var mainCert Certificate |
| 675 | if certPropValue != "" { |
| 676 | defaultDir := ctx.Config().DefaultAppCertificateDir(ctx) |
| 677 | mainCert = Certificate{ |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 678 | Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"), |
| 679 | Key: defaultDir.Join(ctx, certPropValue+".pk8"), |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 680 | } |
| 681 | } else { |
| 682 | pem, key := ctx.Config().DefaultAppCertificate(ctx) |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 683 | mainCert = Certificate{ |
| 684 | Pem: pem, |
| 685 | Key: key, |
| 686 | } |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 687 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 688 | certificates = append([]Certificate{mainCert}, certificates...) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 689 | } |
| 690 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 691 | if !m.Platform() { |
| 692 | certPath := certificates[0].Pem.String() |
Jeongik Cha | c946414 | 2019-01-07 12:07:27 +0900 | [diff] [blame] | 693 | systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String() |
| 694 | if strings.HasPrefix(certPath, systemCertPath) { |
| 695 | enforceSystemCert := ctx.Config().EnforceSystemCertificate() |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 696 | allowed := ctx.Config().EnforceSystemCertificateAllowList() |
Jeongik Cha | c946414 | 2019-01-07 12:07:27 +0900 | [diff] [blame] | 697 | |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 698 | if enforceSystemCert && !inList(m.Name(), allowed) { |
Jeongik Cha | c946414 | 2019-01-07 12:07:27 +0900 | [diff] [blame] | 699 | ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.") |
| 700 | } |
| 701 | } |
| 702 | } |
| 703 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 704 | return certificates |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 705 | } |
| 706 | |
Jooyung Han | 39ee119 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 707 | func (a *AndroidApp) InstallApkName() string { |
| 708 | return a.installApkName |
| 709 | } |
| 710 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 711 | func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) { |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 712 | var apkDeps android.Paths |
| 713 | |
Jeongik Cha | 538c0d0 | 2019-07-11 15:54:27 +0900 | [diff] [blame] | 714 | a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx) |
| 715 | a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex) |
| 716 | |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 717 | // Check if the install APK name needs to be overridden. |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 718 | a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name()) |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 719 | |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 720 | if ctx.ModuleName() == "framework-res" { |
| 721 | // framework-res.apk is installed as system/framework/framework-res.apk |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 722 | a.installDir = android.PathForModuleInstall(ctx, "framework") |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 723 | } else if a.Privileged() { |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 724 | a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName) |
| 725 | } else if ctx.InstallInTestcases() { |
Jaewoong Jung | 326a941 | 2019-11-21 10:41:00 -0800 | [diff] [blame] | 726 | a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch()) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 727 | } else { |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 728 | a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 729 | } |
Jaewoong Jung | 7dd4ae2 | 2019-09-27 17:13:15 -0700 | [diff] [blame] | 730 | a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 731 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 732 | a.noticeBuildActions(ctx) |
Jaewoong Jung | 9877279 | 2019-07-01 17:15:13 -0700 | [diff] [blame] | 733 | if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") { |
| 734 | a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput |
| 735 | } |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 736 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 737 | // Process all building blocks, from AAPT to certificates. |
| 738 | a.aaptBuildActions(ctx) |
| 739 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 740 | if a.usesLibrary.enforceUsesLibraries() { |
| 741 | manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile) |
| 742 | apkDeps = append(apkDeps, manifestCheckFile) |
| 743 | } |
| 744 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 745 | a.proguardBuildActions(ctx) |
| 746 | |
Colin Cross | 014489c | 2020-06-02 20:09:13 -0700 | [diff] [blame] | 747 | a.linter.mergedManifest = a.aapt.mergedManifestFile |
| 748 | a.linter.manifest = a.aapt.manifestPath |
| 749 | a.linter.resources = a.aapt.resourceFiles |
| 750 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 751 | dexJarFile := a.dexBuildActions(ctx) |
| 752 | |
Colin Cross | c2d2405 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 753 | jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis)) |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 754 | jniJarFile := a.jniBuildActions(jniLibs, ctx) |
| 755 | |
| 756 | if ctx.Failed() { |
| 757 | return |
| 758 | } |
| 759 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 760 | certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx) |
| 761 | a.certificate = certificates[0] |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 762 | |
| 763 | // Build a final signed app package. |
Jaewoong Jung | 5a49881 | 2019-11-07 14:14:38 -0800 | [diff] [blame] | 764 | packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk") |
Liz Kammer | e2b27f4 | 2020-05-07 13:24:05 -0700 | [diff] [blame] | 765 | var lineageFile android.Path |
| 766 | if lineage := String(a.overridableAppProperties.Lineage); lineage != "" { |
| 767 | lineageFile = android.PathForModuleSrc(ctx, lineage) |
| 768 | } |
| 769 | CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, lineageFile) |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 770 | a.outputFile = packageFile |
| 771 | |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 772 | for _, split := range a.aapt.splits { |
| 773 | // Sign the split APKs |
Jaewoong Jung | 5a49881 | 2019-11-07 14:14:38 -0800 | [diff] [blame] | 774 | packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk") |
Liz Kammer | e2b27f4 | 2020-05-07 13:24:05 -0700 | [diff] [blame] | 775 | CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, lineageFile) |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 776 | a.extraOutputFiles = append(a.extraOutputFiles, packageFile) |
| 777 | } |
| 778 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 779 | // Build an app bundle. |
Colin Cross | f623721 | 2018-10-29 23:14:58 -0700 | [diff] [blame] | 780 | bundleFile := android.PathForModuleOut(ctx, "base.zip") |
| 781 | BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile) |
| 782 | a.bundleFile = bundleFile |
| 783 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 784 | // Install the app package. |
Jiyong Park | 8ba50f9 | 2019-11-13 15:01:01 +0900 | [diff] [blame] | 785 | if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() { |
| 786 | ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile) |
| 787 | for _, extra := range a.extraOutputFiles { |
| 788 | ctx.InstallFile(a.installDir, extra.Base(), extra) |
| 789 | } |
Colin Cross | 5ab4e6d | 2017-11-22 16:20:45 -0800 | [diff] [blame] | 790 | } |
Artur Satayev | 1111b84 | 2020-04-27 19:05:28 +0100 | [diff] [blame] | 791 | |
| 792 | a.buildAppDependencyInfo(ctx) |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 793 | } |
| 794 | |
Colin Cross | c2d2405 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 795 | type appDepsInterface interface { |
| 796 | sdkVersion() sdkSpec |
| 797 | minSdkVersion() sdkSpec |
| 798 | RequiresStableAPIs(ctx android.BaseModuleContext) bool |
| 799 | } |
| 800 | |
| 801 | func collectAppDeps(ctx android.ModuleContext, app appDepsInterface, |
| 802 | shouldCollectRecursiveNativeDeps bool, |
Colin Cross | 094cde4 | 2020-02-15 10:38:00 -0800 | [diff] [blame] | 803 | checkNativeSdkVersion bool) ([]jniLib, []Certificate) { |
Colin Cross | c2d2405 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 804 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 805 | var jniLibs []jniLib |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 806 | var certificates []Certificate |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 807 | seenModulePaths := make(map[string]bool) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 808 | |
Colin Cross | c2d2405 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 809 | if checkNativeSdkVersion { |
| 810 | checkNativeSdkVersion = app.sdkVersion().specified() && |
| 811 | app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx) |
| 812 | } |
| 813 | |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 814 | ctx.WalkDeps(func(module android.Module, parent android.Module) bool { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 815 | otherName := ctx.OtherModuleName(module) |
| 816 | tag := ctx.OtherModuleDependencyTag(module) |
| 817 | |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 818 | if IsJniDepTag(tag) || tag == cc.SharedDepTag { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 819 | if dep, ok := module.(*cc.Module); ok { |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 820 | if dep.IsNdk() || dep.IsStubs() { |
| 821 | return false |
| 822 | } |
| 823 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 824 | lib := dep.OutputFile() |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 825 | path := lib.Path() |
| 826 | if seenModulePaths[path.String()] { |
| 827 | return false |
| 828 | } |
| 829 | seenModulePaths[path.String()] = true |
| 830 | |
Colin Cross | c2d2405 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 831 | if checkNativeSdkVersion && dep.SdkVersion() == "" { |
| 832 | ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not", |
| 833 | otherName) |
Colin Cross | 094cde4 | 2020-02-15 10:38:00 -0800 | [diff] [blame] | 834 | } |
| 835 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 836 | if lib.Valid() { |
| 837 | jniLibs = append(jniLibs, jniLib{ |
Jaewoong Jung | 87a33e7 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 838 | name: ctx.OtherModuleName(module), |
| 839 | path: path, |
| 840 | target: module.Target(), |
| 841 | coverageFile: dep.CoverageOutputFile(), |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 842 | }) |
| 843 | } else { |
| 844 | ctx.ModuleErrorf("dependency %q missing output file", otherName) |
| 845 | } |
| 846 | } else { |
| 847 | ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 848 | } |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 849 | |
| 850 | return shouldCollectRecursiveNativeDeps |
| 851 | } |
| 852 | |
| 853 | if tag == certificateTag { |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 854 | if dep, ok := module.(*AndroidAppCertificate); ok { |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 855 | certificates = append(certificates, dep.Certificate) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 856 | } else { |
| 857 | ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName) |
| 858 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 859 | } |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 860 | |
| 861 | return false |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 862 | }) |
| 863 | |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 864 | return jniLibs, certificates |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 865 | } |
| 866 | |
Jooyung Han | 749dc69 | 2020-04-15 11:03:39 +0900 | [diff] [blame^] | 867 | func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) { |
Artur Satayev | 1111b84 | 2020-04-27 19:05:28 +0100 | [diff] [blame] | 868 | ctx.WalkDeps(func(child, parent android.Module) bool { |
| 869 | isExternal := !a.DepIsInSameApex(ctx, child) |
| 870 | if am, ok := child.(android.ApexModule); ok { |
Jooyung Han | 749dc69 | 2020-04-15 11:03:39 +0900 | [diff] [blame^] | 871 | if !do(ctx, parent, am, isExternal) { |
| 872 | return false |
| 873 | } |
Artur Satayev | 1111b84 | 2020-04-27 19:05:28 +0100 | [diff] [blame] | 874 | } |
| 875 | return !isExternal |
| 876 | }) |
| 877 | } |
| 878 | |
| 879 | func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) { |
| 880 | if ctx.Host() { |
| 881 | return |
| 882 | } |
| 883 | |
| 884 | depsInfo := android.DepNameToDepInfoMap{} |
Jooyung Han | 749dc69 | 2020-04-15 11:03:39 +0900 | [diff] [blame^] | 885 | a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool { |
Artur Satayev | 1111b84 | 2020-04-27 19:05:28 +0100 | [diff] [blame] | 886 | depName := to.Name() |
| 887 | if info, exist := depsInfo[depName]; exist { |
| 888 | info.From = append(info.From, from.Name()) |
| 889 | info.IsExternal = info.IsExternal && externalDep |
| 890 | depsInfo[depName] = info |
| 891 | } else { |
| 892 | toMinSdkVersion := "(no version)" |
| 893 | if m, ok := to.(interface{ MinSdkVersion() string }); ok { |
| 894 | if v := m.MinSdkVersion(); v != "" { |
| 895 | toMinSdkVersion = v |
| 896 | } |
| 897 | } |
| 898 | depsInfo[depName] = android.ApexModuleDepInfo{ |
| 899 | To: depName, |
| 900 | From: []string{from.Name()}, |
| 901 | IsExternal: externalDep, |
| 902 | MinSdkVersion: toMinSdkVersion, |
| 903 | } |
| 904 | } |
Jooyung Han | 749dc69 | 2020-04-15 11:03:39 +0900 | [diff] [blame^] | 905 | return true |
Artur Satayev | 1111b84 | 2020-04-27 19:05:28 +0100 | [diff] [blame] | 906 | }) |
| 907 | |
| 908 | a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo) |
| 909 | } |
| 910 | |
Artur Satayev | 849f844 | 2020-04-28 14:57:42 +0100 | [diff] [blame] | 911 | func (a *AndroidApp) Updatable() bool { |
| 912 | return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable() |
| 913 | } |
| 914 | |
Colin Cross | 0ea8ba8 | 2019-06-06 14:33:29 -0700 | [diff] [blame] | 915 | func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string { |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 916 | certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName()) |
| 917 | if overridden { |
Jaewoong Jung | acb6db3 | 2019-02-28 16:22:30 +0000 | [diff] [blame] | 918 | return ":" + certificate |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 919 | } |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 920 | return String(a.overridableAppProperties.Certificate) |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 921 | } |
| 922 | |
Jiyong Park | 0f80c18 | 2020-01-31 02:49:53 +0900 | [diff] [blame] | 923 | func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool { |
| 924 | if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) { |
| 925 | return true |
| 926 | } |
| 927 | return a.Library.DepIsInSameApex(ctx, dep) |
| 928 | } |
| 929 | |
Jiyong Park | b7c639e | 2019-08-19 14:56:02 +0900 | [diff] [blame] | 930 | // For OutputFileProducer interface |
| 931 | func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) { |
| 932 | switch tag { |
| 933 | case ".aapt.srcjar": |
| 934 | return []android.Path{a.aaptSrcJar}, nil |
| 935 | } |
| 936 | return a.Library.OutputFiles(tag) |
| 937 | } |
| 938 | |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 939 | func (a *AndroidApp) Privileged() bool { |
| 940 | return Bool(a.appProperties.Privileged) |
| 941 | } |
| 942 | |
Jaewoong Jung | 87a33e7 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 943 | func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool { |
Colin Cross | 1a6acd4 | 2020-06-16 17:51:46 -0700 | [diff] [blame] | 944 | return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled() |
Jaewoong Jung | 87a33e7 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 945 | } |
| 946 | |
| 947 | func (a *AndroidApp) PreventInstall() { |
| 948 | a.appProperties.PreventInstall = true |
| 949 | } |
| 950 | |
| 951 | func (a *AndroidApp) HideFromMake() { |
| 952 | a.appProperties.HideFromMake = true |
| 953 | } |
| 954 | |
| 955 | func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) { |
| 956 | a.appProperties.IsCoverageVariant = coverage |
| 957 | } |
| 958 | |
Ivan Lozano | a0cd8f9 | 2020-04-09 09:56:02 -0400 | [diff] [blame] | 959 | func (a *AndroidApp) EnableCoverageIfNeeded() {} |
| 960 | |
Jaewoong Jung | 87a33e7 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 961 | var _ cc.Coverage = (*AndroidApp)(nil) |
| 962 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 963 | // android_app compiles sources and Android resources into an Android application package `.apk` file. |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 964 | func AndroidAppFactory() android.Module { |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 965 | module := &AndroidApp{} |
| 966 | |
Sasha Smundak | 2057f82 | 2019-04-16 17:16:58 -0700 | [diff] [blame] | 967 | module.Module.deviceProperties.Optimize.EnabledByDefault = true |
Colin Cross | 66dbc0b | 2017-12-28 12:23:20 -0800 | [diff] [blame] | 968 | module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true) |
| 969 | |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 970 | module.Module.properties.Instrument = true |
Colin Cross | 9ae1b92 | 2018-06-26 17:59:05 -0700 | [diff] [blame] | 971 | module.Module.properties.Installable = proptools.BoolPtr(true) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 972 | |
Colin Cross | ce6734e | 2020-06-15 16:09:53 -0700 | [diff] [blame] | 973 | module.addHostAndDeviceProperties() |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 974 | module.AddProperties( |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 975 | &module.aaptProperties, |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 976 | &module.appProperties, |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 977 | &module.overridableAppProperties, |
| 978 | &module.usesLibrary.usesLibraryProperties) |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 979 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 980 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 981 | android.InitDefaultableModule(module) |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 982 | android.InitOverridableModule(module, &module.appProperties.Overrides) |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 983 | android.InitApexModule(module) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 984 | |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 985 | return module |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 986 | } |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 987 | |
| 988 | type appTestProperties struct { |
Liz Kammer | 6b0c552 | 2020-04-28 16:10:55 -0700 | [diff] [blame] | 989 | // The name of the android_app module that the tests will run against. |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 990 | Instrumentation_for *string |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 991 | |
| 992 | // if specified, the instrumentation target package name in the manifest is overwritten by it. |
| 993 | Instrumentation_target_package *string |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 994 | } |
| 995 | |
| 996 | type AndroidTest struct { |
| 997 | AndroidApp |
| 998 | |
| 999 | appTestProperties appTestProperties |
| 1000 | |
| 1001 | testProperties testProperties |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1002 | |
| 1003 | testConfig android.Path |
Colin Cross | d96ca35 | 2018-08-10 16:06:24 -0700 | [diff] [blame] | 1004 | data android.Paths |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1005 | } |
| 1006 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 1007 | func (a *AndroidTest) InstallInTestcases() bool { |
| 1008 | return true |
| 1009 | } |
| 1010 | |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1011 | func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
easoncylee | 5bcff5d | 2020-04-30 14:57:06 +0800 | [diff] [blame] | 1012 | var configs []tradefed.Config |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1013 | if a.appTestProperties.Instrumentation_target_package != nil { |
| 1014 | a.additionalAaptFlags = append(a.additionalAaptFlags, |
| 1015 | "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package) |
| 1016 | } else if a.appTestProperties.Instrumentation_for != nil { |
| 1017 | // Check if the instrumentation target package is overridden. |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 1018 | manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for) |
| 1019 | if overridden { |
| 1020 | a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName) |
| 1021 | } |
| 1022 | } |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1023 | a.generateAndroidBuildActions(ctx) |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1024 | |
easoncylee | 5bcff5d | 2020-04-30 14:57:06 +0800 | [diff] [blame] | 1025 | for _, module := range a.testProperties.Test_mainline_modules { |
| 1026 | configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module}) |
| 1027 | } |
| 1028 | |
Jaewoong Jung | 3998234 | 2020-01-14 10:27:18 -0800 | [diff] [blame] | 1029 | testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config, |
easoncylee | 5bcff5d | 2020-04-30 14:57:06 +0800 | [diff] [blame] | 1030 | a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs) |
Jaewoong Jung | 3998234 | 2020-01-14 10:27:18 -0800 | [diff] [blame] | 1031 | a.testConfig = a.FixTestConfig(ctx, testConfig) |
Colin Cross | 8a49795 | 2019-03-05 22:25:09 -0800 | [diff] [blame] | 1032 | a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data) |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1033 | } |
| 1034 | |
Jaewoong Jung | 3998234 | 2020-01-14 10:27:18 -0800 | [diff] [blame] | 1035 | func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path { |
| 1036 | if testConfig == nil { |
| 1037 | return nil |
| 1038 | } |
| 1039 | |
| 1040 | fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml") |
| 1041 | rule := android.NewRuleBuilder() |
| 1042 | command := rule.Command().BuiltTool(ctx, "test_config_fixer").Input(testConfig).Output(fixedConfig) |
| 1043 | fixNeeded := false |
| 1044 | |
| 1045 | if ctx.ModuleName() != a.installApkName { |
| 1046 | fixNeeded = true |
| 1047 | command.FlagWithArg("--test-file-name ", a.installApkName+".apk") |
| 1048 | } |
| 1049 | |
| 1050 | if a.overridableAppProperties.Package_name != nil { |
| 1051 | fixNeeded = true |
| 1052 | command.FlagWithInput("--manifest ", a.manifestPath). |
| 1053 | FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name) |
| 1054 | } |
| 1055 | |
| 1056 | if fixNeeded { |
| 1057 | rule.Build(pctx, ctx, "fix_test_config", "fix test config") |
| 1058 | return fixedConfig |
| 1059 | } |
| 1060 | return testConfig |
| 1061 | } |
| 1062 | |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1063 | func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) { |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1064 | a.AndroidApp.DepsMutator(ctx) |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1065 | } |
| 1066 | |
| 1067 | func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) { |
| 1068 | a.AndroidApp.OverridablePropertiesDepsMutator(ctx) |
Colin Cross | 4b964c0 | 2018-10-15 16:18:06 -0700 | [diff] [blame] | 1069 | if a.appTestProperties.Instrumentation_for != nil { |
| 1070 | // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac, |
| 1071 | // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so |
| 1072 | // use instrumentationForTag instead of libTag. |
| 1073 | ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for)) |
| 1074 | } |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1075 | } |
| 1076 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 1077 | // android_test compiles test sources and Android resources into an Android application package `.apk` file and |
| 1078 | // creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file. |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1079 | func AndroidTestFactory() android.Module { |
| 1080 | module := &AndroidTest{} |
| 1081 | |
Sasha Smundak | 2057f82 | 2019-04-16 17:16:58 -0700 | [diff] [blame] | 1082 | module.Module.deviceProperties.Optimize.EnabledByDefault = true |
Colin Cross | 5067db9 | 2018-09-17 16:46:35 -0700 | [diff] [blame] | 1083 | |
| 1084 | module.Module.properties.Instrument = true |
Colin Cross | 9ae1b92 | 2018-06-26 17:59:05 -0700 | [diff] [blame] | 1085 | module.Module.properties.Installable = proptools.BoolPtr(true) |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 1086 | module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true) |
Colin Cross | 47fa9d3 | 2019-03-26 10:51:39 -0700 | [diff] [blame] | 1087 | module.appProperties.AlwaysPackageNativeLibs = true |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 1088 | module.Module.dexpreopter.isTest = true |
Colin Cross | 014489c | 2020-06-02 20:09:13 -0700 | [diff] [blame] | 1089 | module.Module.linter.test = true |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1090 | |
Colin Cross | ce6734e | 2020-06-15 16:09:53 -0700 | [diff] [blame] | 1091 | module.addHostAndDeviceProperties() |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1092 | module.AddProperties( |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1093 | &module.aaptProperties, |
| 1094 | &module.appProperties, |
Dan Willemsen | f5531d2 | 2018-07-16 17:21:19 -0700 | [diff] [blame] | 1095 | &module.appTestProperties, |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1096 | &module.overridableAppProperties, |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1097 | &module.usesLibrary.usesLibraryProperties, |
Dan Willemsen | f5531d2 | 2018-07-16 17:21:19 -0700 | [diff] [blame] | 1098 | &module.testProperties) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1099 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 1100 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1101 | android.InitDefaultableModule(module) |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1102 | android.InitOverridableModule(module, &module.appProperties.Overrides) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1103 | return module |
| 1104 | } |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1105 | |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1106 | type appTestHelperAppProperties struct { |
| 1107 | // list of compatibility suites (for example "cts", "vts") that the module should be |
| 1108 | // installed into. |
| 1109 | Test_suites []string `android:"arch_variant"` |
Dan Shi | 6ffaaa8 | 2019-09-26 11:41:36 -0700 | [diff] [blame] | 1110 | |
| 1111 | // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml |
| 1112 | // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true |
| 1113 | // explicitly. |
| 1114 | Auto_gen_config *bool |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1115 | } |
| 1116 | |
| 1117 | type AndroidTestHelperApp struct { |
| 1118 | AndroidApp |
| 1119 | |
| 1120 | appTestHelperAppProperties appTestHelperAppProperties |
| 1121 | } |
| 1122 | |
Jaewoong Jung | 326a941 | 2019-11-21 10:41:00 -0800 | [diff] [blame] | 1123 | func (a *AndroidTestHelperApp) InstallInTestcases() bool { |
| 1124 | return true |
| 1125 | } |
| 1126 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 1127 | // android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that |
| 1128 | // will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a |
| 1129 | // test. |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1130 | func AndroidTestHelperAppFactory() android.Module { |
| 1131 | module := &AndroidTestHelperApp{} |
| 1132 | |
Sasha Smundak | 2057f82 | 2019-04-16 17:16:58 -0700 | [diff] [blame] | 1133 | module.Module.deviceProperties.Optimize.EnabledByDefault = true |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1134 | |
| 1135 | module.Module.properties.Installable = proptools.BoolPtr(true) |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 1136 | module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true) |
Colin Cross | 47fa9d3 | 2019-03-26 10:51:39 -0700 | [diff] [blame] | 1137 | module.appProperties.AlwaysPackageNativeLibs = true |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 1138 | module.Module.dexpreopter.isTest = true |
Colin Cross | 014489c | 2020-06-02 20:09:13 -0700 | [diff] [blame] | 1139 | module.Module.linter.test = true |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1140 | |
Colin Cross | ce6734e | 2020-06-15 16:09:53 -0700 | [diff] [blame] | 1141 | module.addHostAndDeviceProperties() |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1142 | module.AddProperties( |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1143 | &module.aaptProperties, |
| 1144 | &module.appProperties, |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1145 | &module.appTestHelperAppProperties, |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1146 | &module.overridableAppProperties, |
| 1147 | &module.usesLibrary.usesLibraryProperties) |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1148 | |
| 1149 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1150 | android.InitDefaultableModule(module) |
Anton Hansson | 3d2b6b4 | 2020-01-10 15:06:01 +0000 | [diff] [blame] | 1151 | android.InitApexModule(module) |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1152 | return module |
| 1153 | } |
| 1154 | |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1155 | type AndroidAppCertificate struct { |
| 1156 | android.ModuleBase |
| 1157 | properties AndroidAppCertificateProperties |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 1158 | Certificate Certificate |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1159 | } |
| 1160 | |
| 1161 | type AndroidAppCertificateProperties struct { |
| 1162 | // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name. |
| 1163 | Certificate *string |
| 1164 | } |
| 1165 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 1166 | // android_app_certificate modules can be referenced by the certificates property of android_app modules to select |
| 1167 | // the signing key. |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1168 | func AndroidAppCertificateFactory() android.Module { |
| 1169 | module := &AndroidAppCertificate{} |
| 1170 | module.AddProperties(&module.properties) |
| 1171 | android.InitAndroidModule(module) |
| 1172 | return module |
| 1173 | } |
| 1174 | |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1175 | func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 1176 | cert := String(c.properties.Certificate) |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 1177 | c.Certificate = Certificate{ |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 1178 | Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"), |
| 1179 | Key: android.PathForModuleSrc(ctx, cert+".pk8"), |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1180 | } |
| 1181 | } |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1182 | |
| 1183 | type OverrideAndroidApp struct { |
| 1184 | android.ModuleBase |
| 1185 | android.OverrideModuleBase |
| 1186 | } |
| 1187 | |
Sasha Smundak | 613cbb1 | 2020-06-05 10:27:23 -0700 | [diff] [blame] | 1188 | func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) { |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1189 | // All the overrides happen in the base module. |
| 1190 | // TODO(jungjw): Check the base module type. |
| 1191 | } |
| 1192 | |
| 1193 | // override_android_app is used to create an android_app module based on another android_app by overriding |
| 1194 | // some of its properties. |
| 1195 | func OverrideAndroidAppModuleFactory() android.Module { |
| 1196 | m := &OverrideAndroidApp{} |
| 1197 | m.AddProperties(&overridableAppProperties{}) |
| 1198 | |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 1199 | android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon) |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1200 | android.InitOverrideModule(m) |
| 1201 | return m |
| 1202 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1203 | |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1204 | type OverrideAndroidTest struct { |
| 1205 | android.ModuleBase |
| 1206 | android.OverrideModuleBase |
| 1207 | } |
| 1208 | |
Sasha Smundak | 613cbb1 | 2020-06-05 10:27:23 -0700 | [diff] [blame] | 1209 | func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) { |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1210 | // All the overrides happen in the base module. |
| 1211 | // TODO(jungjw): Check the base module type. |
| 1212 | } |
| 1213 | |
| 1214 | // override_android_test is used to create an android_app module based on another android_test by overriding |
| 1215 | // some of its properties. |
| 1216 | func OverrideAndroidTestModuleFactory() android.Module { |
| 1217 | m := &OverrideAndroidTest{} |
| 1218 | m.AddProperties(&overridableAppProperties{}) |
| 1219 | m.AddProperties(&appTestProperties{}) |
| 1220 | |
| 1221 | android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon) |
| 1222 | android.InitOverrideModule(m) |
| 1223 | return m |
| 1224 | } |
| 1225 | |
Roshan Pius | 4df2bc7 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1226 | type OverrideRuntimeResourceOverlay struct { |
| 1227 | android.ModuleBase |
| 1228 | android.OverrideModuleBase |
| 1229 | } |
| 1230 | |
Sasha Smundak | 613cbb1 | 2020-06-05 10:27:23 -0700 | [diff] [blame] | 1231 | func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(_ android.ModuleContext) { |
Roshan Pius | 4df2bc7 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1232 | // All the overrides happen in the base module. |
| 1233 | // TODO(jungjw): Check the base module type. |
| 1234 | } |
| 1235 | |
| 1236 | // override_runtime_resource_overlay is used to create a module based on another |
| 1237 | // runtime_resource_overlay module by overriding some of its properties. |
| 1238 | func OverrideRuntimeResourceOverlayModuleFactory() android.Module { |
| 1239 | m := &OverrideRuntimeResourceOverlay{} |
| 1240 | m.AddProperties(&OverridableRuntimeResourceOverlayProperties{}) |
| 1241 | |
| 1242 | android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon) |
| 1243 | android.InitOverrideModule(m) |
| 1244 | return m |
| 1245 | } |
| 1246 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1247 | type AndroidAppImport struct { |
| 1248 | android.ModuleBase |
| 1249 | android.DefaultableModuleBase |
Jiyong Park | 592a6a4 | 2020-04-21 22:34:28 +0900 | [diff] [blame] | 1250 | android.ApexModuleBase |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1251 | prebuilt android.Prebuilt |
| 1252 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1253 | properties AndroidAppImportProperties |
| 1254 | dpiVariants interface{} |
| 1255 | archVariants interface{} |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1256 | |
| 1257 | outputFile android.Path |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 1258 | certificate Certificate |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1259 | |
| 1260 | dexpreopter |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1261 | |
| 1262 | usesLibrary usesLibrary |
Jaewoong Jung | 8aae22e | 2019-07-17 10:21:49 -0700 | [diff] [blame] | 1263 | |
Liz Kammer | 3b70b3f | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1264 | preprocessed bool |
| 1265 | |
Colin Cross | 70dda7e | 2019-10-01 22:05:35 -0700 | [diff] [blame] | 1266 | installPath android.InstallPath |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1267 | } |
| 1268 | |
| 1269 | type AndroidAppImportProperties struct { |
| 1270 | // A prebuilt apk to import |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1271 | Apk *string |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1272 | |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1273 | // The name of a certificate in the default certificate directory or an android_app_certificate |
| 1274 | // module name in the form ":module". Should be empty if presigned or default_dev_cert is set. |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1275 | Certificate *string |
| 1276 | |
| 1277 | // Set this flag to true if the prebuilt apk is already signed. The certificate property must not |
| 1278 | // be set for presigned modules. |
| 1279 | Presigned *bool |
| 1280 | |
Liz Kammer | 2497899 | 2020-05-13 15:49:21 -0700 | [diff] [blame] | 1281 | // Name of the signing certificate lineage file. |
| 1282 | Lineage *string |
| 1283 | |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1284 | // Sign with the default system dev certificate. Must be used judiciously. Most imported apps |
| 1285 | // need to either specify a specific certificate or be presigned. |
| 1286 | Default_dev_cert *bool |
| 1287 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1288 | // Specifies that this app should be installed to the priv-app directory, |
| 1289 | // where the system will grant it additional privileges not available to |
| 1290 | // normal apps. |
| 1291 | Privileged *bool |
| 1292 | |
| 1293 | // Names of modules to be overridden. Listed modules can only be other binaries |
| 1294 | // (in Make or Soong). |
| 1295 | // This does not completely prevent installation of the overridden binaries, but if both |
| 1296 | // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed |
| 1297 | // from PRODUCT_PACKAGES. |
| 1298 | Overrides []string |
Jaewoong Jung | 8aae22e | 2019-07-17 10:21:49 -0700 | [diff] [blame] | 1299 | |
| 1300 | // Optional name for the installed app. If unspecified, it is derived from the module name. |
| 1301 | Filename *string |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1302 | } |
| 1303 | |
Martin Stjernholm | 6d41527 | 2020-01-31 17:10:36 +0000 | [diff] [blame] | 1304 | func (a *AndroidAppImport) IsInstallable() bool { |
| 1305 | return true |
| 1306 | } |
| 1307 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1308 | // Updates properties with variant-specific values. |
| 1309 | func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) { |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1310 | config := ctx.Config() |
| 1311 | |
| 1312 | dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants") |
| 1313 | // Try DPI variant matches in the reverse-priority order so that the highest priority match |
| 1314 | // overwrites everything else. |
| 1315 | // TODO(jungjw): Can we optimize this by making it priority order? |
| 1316 | for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1317 | MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i]) |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1318 | } |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1319 | if config.ProductAAPTPreferredConfig() != "" { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1320 | MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig()) |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1321 | } |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1322 | |
| 1323 | archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch") |
| 1324 | archType := ctx.Config().Targets[android.Android][0].Arch.ArchType |
| 1325 | MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name) |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1326 | } |
| 1327 | |
Colin Cross | 1184b64 | 2019-12-30 18:43:07 -0800 | [diff] [blame] | 1328 | func MergePropertiesFromVariant(ctx android.EarlyModuleContext, |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1329 | dst interface{}, variantGroup reflect.Value, variant string) { |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1330 | src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant)) |
| 1331 | if !src.IsValid() { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1332 | return |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1333 | } |
| 1334 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1335 | err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend) |
| 1336 | if err != nil { |
| 1337 | if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok { |
| 1338 | ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error()) |
| 1339 | } else { |
| 1340 | panic(err) |
| 1341 | } |
| 1342 | } |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1343 | } |
| 1344 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1345 | func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) { |
| 1346 | cert := android.SrcIsModule(String(a.properties.Certificate)) |
| 1347 | if cert != "" { |
| 1348 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 1349 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1350 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 1351 | a.usesLibrary.deps(ctx, true) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1352 | } |
| 1353 | |
| 1354 | func (a *AndroidAppImport) uncompressEmbeddedJniLibs( |
| 1355 | ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) { |
Jaewoong Jung | 7c5bd83 | 2020-01-13 09:55:39 -0800 | [diff] [blame] | 1356 | // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing |
| 1357 | // with them may invalidate pre-existing signature data. |
Liz Kammer | 3b70b3f | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1358 | if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) { |
Jaewoong Jung | 7c5bd83 | 2020-01-13 09:55:39 -0800 | [diff] [blame] | 1359 | ctx.Build(pctx, android.BuildParams{ |
| 1360 | Rule: android.Cp, |
| 1361 | Output: outputPath, |
| 1362 | Input: inputPath, |
| 1363 | }) |
| 1364 | return |
| 1365 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1366 | rule := android.NewRuleBuilder() |
| 1367 | rule.Command(). |
| 1368 | Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath). |
Colin Cross | ee94d6a | 2019-07-08 17:08:34 -0700 | [diff] [blame] | 1369 | BuiltTool(ctx, "zip2zip"). |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1370 | FlagWithInput("-i ", inputPath). |
| 1371 | FlagWithOutput("-o ", outputPath). |
| 1372 | FlagWithArg("-0 ", "'lib/**/*.so'"). |
| 1373 | Textf(`; else cp -f %s %s; fi`, inputPath, outputPath) |
| 1374 | rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs") |
| 1375 | } |
| 1376 | |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 1377 | // Returns whether this module should have the dex file stored uncompressed in the APK. |
| 1378 | func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool { |
Liz Kammer | 3b70b3f | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1379 | if ctx.Config().UnbundledBuild() || a.preprocessed { |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 1380 | return false |
| 1381 | } |
| 1382 | |
| 1383 | // Uncompress dex in APKs of privileged apps |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 1384 | if ctx.Config().UncompressPrivAppDex() && a.Privileged() { |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 1385 | return true |
| 1386 | } |
| 1387 | |
| 1388 | return shouldUncompressDex(ctx, &a.dexpreopter) |
| 1389 | } |
| 1390 | |
Jaewoong Jung | ea1bdb0 | 2019-05-09 14:36:34 -0700 | [diff] [blame] | 1391 | func (a *AndroidAppImport) uncompressDex( |
| 1392 | ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) { |
| 1393 | rule := android.NewRuleBuilder() |
| 1394 | rule.Command(). |
| 1395 | Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath). |
Colin Cross | ee94d6a | 2019-07-08 17:08:34 -0700 | [diff] [blame] | 1396 | BuiltTool(ctx, "zip2zip"). |
Jaewoong Jung | ea1bdb0 | 2019-05-09 14:36:34 -0700 | [diff] [blame] | 1397 | FlagWithInput("-i ", inputPath). |
| 1398 | FlagWithOutput("-o ", outputPath). |
| 1399 | FlagWithArg("-0 ", "'classes*.dex'"). |
| 1400 | Textf(`; else cp -f %s %s; fi`, inputPath, outputPath) |
| 1401 | rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files") |
| 1402 | } |
| 1403 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1404 | func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1405 | a.generateAndroidBuildActions(ctx) |
| 1406 | } |
| 1407 | |
Jooyung Han | 39ee119 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 1408 | func (a *AndroidAppImport) InstallApkName() string { |
| 1409 | return a.BaseModuleName() |
| 1410 | } |
| 1411 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1412 | func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1413 | numCertPropsSet := 0 |
| 1414 | if String(a.properties.Certificate) != "" { |
| 1415 | numCertPropsSet++ |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1416 | } |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1417 | if Bool(a.properties.Presigned) { |
| 1418 | numCertPropsSet++ |
| 1419 | } |
| 1420 | if Bool(a.properties.Default_dev_cert) { |
| 1421 | numCertPropsSet++ |
| 1422 | } |
| 1423 | if numCertPropsSet != 1 { |
| 1424 | ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set") |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1425 | } |
| 1426 | |
Colin Cross | c2d2405 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 1427 | _, certificates := collectAppDeps(ctx, a, false, false) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1428 | |
| 1429 | // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1430 | // TODO: LOCAL_PACKAGE_SPLITS |
| 1431 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1432 | srcApk := a.prebuilt.SingleSourcePath(ctx) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1433 | |
| 1434 | if a.usesLibrary.enforceUsesLibraries() { |
| 1435 | srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk) |
| 1436 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1437 | |
| 1438 | // TODO: Install or embed JNI libraries |
| 1439 | |
| 1440 | // Uncompress JNI libraries in the apk |
| 1441 | jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk") |
| 1442 | a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath) |
| 1443 | |
Kyeongkab.Nam | c499714 | 2019-11-22 11:38:16 +0900 | [diff] [blame] | 1444 | var installDir android.InstallPath |
| 1445 | if Bool(a.properties.Privileged) { |
| 1446 | installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName()) |
Jaewoong Jung | 7c5bd83 | 2020-01-13 09:55:39 -0800 | [diff] [blame] | 1447 | } else if ctx.InstallInTestcases() { |
| 1448 | installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch()) |
Kyeongkab.Nam | c499714 | 2019-11-22 11:38:16 +0900 | [diff] [blame] | 1449 | } else { |
| 1450 | installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName()) |
| 1451 | } |
| 1452 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1453 | a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk") |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1454 | a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned) |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 1455 | a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1456 | |
| 1457 | a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries() |
| 1458 | a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs |
| 1459 | a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx) |
| 1460 | a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx) |
| 1461 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1462 | dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed) |
Jaewoong Jung | ea1bdb0 | 2019-05-09 14:36:34 -0700 | [diff] [blame] | 1463 | if a.dexpreopter.uncompressedDex { |
| 1464 | dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk") |
| 1465 | a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath) |
| 1466 | dexOutput = dexUncompressed |
| 1467 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1468 | |
Jooyung Han | 39ee119 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 1469 | apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk") |
| 1470 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1471 | // TODO: Handle EXTERNAL |
Liz Kammer | 3b70b3f | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1472 | |
| 1473 | // Sign or align the package if package has not been preprocessed |
| 1474 | if a.preprocessed { |
| 1475 | a.outputFile = srcApk |
Sasha Smundak | 18d98bc | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 1476 | a.certificate = PresignedCertificate |
Liz Kammer | 3b70b3f | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1477 | } else if !Bool(a.properties.Presigned) { |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1478 | // If the certificate property is empty at this point, default_dev_cert must be set to true. |
| 1479 | // Which makes processMainCert's behavior for the empty cert string WAI. |
| 1480 | certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1481 | if len(certificates) != 1 { |
| 1482 | ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates) |
| 1483 | } |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 1484 | a.certificate = certificates[0] |
Jooyung Han | 39ee119 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 1485 | signed := android.PathForModuleOut(ctx, "signed", apkFilename) |
Liz Kammer | 2497899 | 2020-05-13 15:49:21 -0700 | [diff] [blame] | 1486 | var lineageFile android.Path |
| 1487 | if lineage := String(a.properties.Lineage); lineage != "" { |
| 1488 | lineageFile = android.PathForModuleSrc(ctx, lineage) |
| 1489 | } |
| 1490 | SignAppPackage(ctx, signed, dexOutput, certificates, lineageFile) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1491 | a.outputFile = signed |
| 1492 | } else { |
Jooyung Han | 39ee119 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 1493 | alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1494 | TransformZipAlign(ctx, alignedApk, dexOutput) |
| 1495 | a.outputFile = alignedApk |
Sasha Smundak | 18d98bc | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 1496 | a.certificate = PresignedCertificate |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1497 | } |
| 1498 | |
| 1499 | // TODO: Optionally compress the output apk. |
| 1500 | |
Jiyong Park | 592a6a4 | 2020-04-21 22:34:28 +0900 | [diff] [blame] | 1501 | if a.IsForPlatform() { |
| 1502 | a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile) |
| 1503 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1504 | |
| 1505 | // TODO: androidmk converter jni libs |
| 1506 | } |
| 1507 | |
| 1508 | func (a *AndroidAppImport) Prebuilt() *android.Prebuilt { |
| 1509 | return &a.prebuilt |
| 1510 | } |
| 1511 | |
| 1512 | func (a *AndroidAppImport) Name() string { |
| 1513 | return a.prebuilt.Name(a.ModuleBase.Name()) |
| 1514 | } |
| 1515 | |
Dario Freni | cde2a03 | 2019-10-27 00:29:22 +0100 | [diff] [blame] | 1516 | func (a *AndroidAppImport) OutputFile() android.Path { |
| 1517 | return a.outputFile |
| 1518 | } |
| 1519 | |
Jiyong Park | 618922e | 2020-01-08 13:35:43 +0900 | [diff] [blame] | 1520 | func (a *AndroidAppImport) JacocoReportClassesFile() android.Path { |
| 1521 | return nil |
| 1522 | } |
| 1523 | |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 1524 | func (a *AndroidAppImport) Certificate() Certificate { |
| 1525 | return a.certificate |
| 1526 | } |
| 1527 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1528 | var dpiVariantGroupType reflect.Type |
| 1529 | var archVariantGroupType reflect.Type |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1530 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1531 | func initAndroidAppImportVariantGroupTypes() { |
| 1532 | dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants") |
| 1533 | |
| 1534 | archNames := make([]string, len(android.ArchTypeList())) |
| 1535 | for i, archType := range android.ArchTypeList() { |
| 1536 | archNames[i] = archType.Name |
| 1537 | } |
| 1538 | archVariantGroupType = createVariantGroupType(archNames, "Arch") |
| 1539 | } |
| 1540 | |
| 1541 | // Populates all variant struct properties at creation time. |
| 1542 | func (a *AndroidAppImport) populateAllVariantStructs() { |
| 1543 | a.dpiVariants = reflect.New(dpiVariantGroupType).Interface() |
| 1544 | a.AddProperties(a.dpiVariants) |
| 1545 | |
| 1546 | a.archVariants = reflect.New(archVariantGroupType).Interface() |
| 1547 | a.AddProperties(a.archVariants) |
| 1548 | } |
| 1549 | |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 1550 | func (a *AndroidAppImport) Privileged() bool { |
| 1551 | return Bool(a.properties.Privileged) |
| 1552 | } |
| 1553 | |
Sasha Smundak | 613cbb1 | 2020-06-05 10:27:23 -0700 | [diff] [blame] | 1554 | func (a *AndroidAppImport) DepIsInSameApex(_ android.BaseModuleContext, _ android.Module) bool { |
Jiyong Park | 592a6a4 | 2020-04-21 22:34:28 +0900 | [diff] [blame] | 1555 | // android_app_import might have extra dependencies via uses_libs property. |
| 1556 | // Don't track the dependency as we don't automatically add those libraries |
| 1557 | // to the classpath. It should be explicitly added to java_libs property of APEX |
| 1558 | return false |
| 1559 | } |
| 1560 | |
Colin Cross | c2d2405 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 1561 | func (a *AndroidAppImport) sdkVersion() sdkSpec { |
| 1562 | return sdkSpecFrom("") |
| 1563 | } |
| 1564 | |
| 1565 | func (a *AndroidAppImport) minSdkVersion() sdkSpec { |
| 1566 | return sdkSpecFrom("") |
| 1567 | } |
| 1568 | |
Jooyung Han | 749dc69 | 2020-04-15 11:03:39 +0900 | [diff] [blame^] | 1569 | func (j *AndroidAppImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion int) error { |
| 1570 | // Do not check for prebuilts against the min_sdk_version of enclosing APEX |
| 1571 | return nil |
| 1572 | } |
| 1573 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1574 | func createVariantGroupType(variants []string, variantGroupName string) reflect.Type { |
| 1575 | props := reflect.TypeOf((*AndroidAppImportProperties)(nil)) |
| 1576 | |
| 1577 | variantFields := make([]reflect.StructField, len(variants)) |
| 1578 | for i, variant := range variants { |
| 1579 | variantFields[i] = reflect.StructField{ |
| 1580 | Name: proptools.FieldNameForProperty(variant), |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1581 | Type: props, |
| 1582 | } |
| 1583 | } |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1584 | |
| 1585 | variantGroupStruct := reflect.StructOf(variantFields) |
| 1586 | return reflect.StructOf([]reflect.StructField{ |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1587 | { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1588 | Name: variantGroupName, |
| 1589 | Type: variantGroupStruct, |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1590 | }, |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1591 | }) |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1592 | } |
| 1593 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1594 | // android_app_import imports a prebuilt apk with additional processing specified in the module. |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1595 | // DPI-specific apk source files can be specified using dpi_variants. Example: |
| 1596 | // |
| 1597 | // android_app_import { |
| 1598 | // name: "example_import", |
| 1599 | // apk: "prebuilts/example.apk", |
| 1600 | // dpi_variants: { |
| 1601 | // mdpi: { |
| 1602 | // apk: "prebuilts/example_mdpi.apk", |
| 1603 | // }, |
| 1604 | // xhdpi: { |
| 1605 | // apk: "prebuilts/example_xhdpi.apk", |
| 1606 | // }, |
| 1607 | // }, |
| 1608 | // certificate: "PRESIGNED", |
| 1609 | // } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1610 | func AndroidAppImportFactory() android.Module { |
| 1611 | module := &AndroidAppImport{} |
| 1612 | module.AddProperties(&module.properties) |
| 1613 | module.AddProperties(&module.dexpreoptProperties) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1614 | module.AddProperties(&module.usesLibrary.usesLibraryProperties) |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1615 | module.populateAllVariantStructs() |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1616 | android.AddLoadHook(module, func(ctx android.LoadHookContext) { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1617 | module.processVariants(ctx) |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1618 | }) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1619 | |
Jiyong Park | 592a6a4 | 2020-04-21 22:34:28 +0900 | [diff] [blame] | 1620 | android.InitApexModule(module) |
Jaewoong Jung | 6abfbf7 | 2020-05-26 20:10:08 -0700 | [diff] [blame] | 1621 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1622 | android.InitDefaultableModule(module) |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1623 | android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk") |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1624 | |
| 1625 | return module |
| 1626 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1627 | |
Liz Kammer | 3b70b3f | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1628 | type androidTestImportProperties struct { |
| 1629 | // Whether the prebuilt apk can be installed without additional processing. Default is false. |
| 1630 | Preprocessed *bool |
| 1631 | } |
| 1632 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1633 | type AndroidTestImport struct { |
| 1634 | AndroidAppImport |
| 1635 | |
| 1636 | testProperties testProperties |
| 1637 | |
Liz Kammer | 3b70b3f | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1638 | testImportProperties androidTestImportProperties |
| 1639 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1640 | data android.Paths |
| 1641 | } |
| 1642 | |
| 1643 | func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Liz Kammer | 3b70b3f | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1644 | a.preprocessed = Bool(a.testImportProperties.Preprocessed) |
| 1645 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1646 | a.generateAndroidBuildActions(ctx) |
| 1647 | |
| 1648 | a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data) |
| 1649 | } |
| 1650 | |
Jaewoong Jung | 7c5bd83 | 2020-01-13 09:55:39 -0800 | [diff] [blame] | 1651 | func (a *AndroidTestImport) InstallInTestcases() bool { |
| 1652 | return true |
| 1653 | } |
| 1654 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1655 | // android_test_import imports a prebuilt test apk with additional processing specified in the |
| 1656 | // module. DPI or arch variant configurations can be made as with android_app_import. |
| 1657 | func AndroidTestImportFactory() android.Module { |
| 1658 | module := &AndroidTestImport{} |
| 1659 | module.AddProperties(&module.properties) |
| 1660 | module.AddProperties(&module.dexpreoptProperties) |
| 1661 | module.AddProperties(&module.usesLibrary.usesLibraryProperties) |
| 1662 | module.AddProperties(&module.testProperties) |
Liz Kammer | 3b70b3f | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1663 | module.AddProperties(&module.testImportProperties) |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1664 | module.populateAllVariantStructs() |
| 1665 | android.AddLoadHook(module, func(ctx android.LoadHookContext) { |
| 1666 | module.processVariants(ctx) |
| 1667 | }) |
| 1668 | |
Colin Cross | c80828d | 2020-05-06 22:29:10 -0700 | [diff] [blame] | 1669 | module.dexpreopter.isTest = true |
| 1670 | |
Jiyong Park | 592a6a4 | 2020-04-21 22:34:28 +0900 | [diff] [blame] | 1671 | android.InitApexModule(module) |
Jaewoong Jung | 243688e | 2020-05-01 15:50:08 -0700 | [diff] [blame] | 1672 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1673 | android.InitDefaultableModule(module) |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1674 | android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk") |
| 1675 | |
| 1676 | return module |
| 1677 | } |
| 1678 | |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1679 | type RuntimeResourceOverlay struct { |
| 1680 | android.ModuleBase |
| 1681 | android.DefaultableModuleBase |
Roshan Pius | 4df2bc7 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1682 | android.OverridableModuleBase |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1683 | aapt |
| 1684 | |
Roshan Pius | 4df2bc7 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1685 | properties RuntimeResourceOverlayProperties |
| 1686 | overridableProperties OverridableRuntimeResourceOverlayProperties |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1687 | |
Jaewoong Jung | 78ec5d8 | 2020-01-31 10:11:47 -0800 | [diff] [blame] | 1688 | certificate Certificate |
| 1689 | |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1690 | outputFile android.Path |
| 1691 | installDir android.InstallPath |
| 1692 | } |
| 1693 | |
| 1694 | type RuntimeResourceOverlayProperties struct { |
| 1695 | // the name of a certificate in the default certificate directory or an android_app_certificate |
| 1696 | // module name in the form ":module". |
| 1697 | Certificate *string |
| 1698 | |
Liz Kammer | 966b2f0 | 2020-05-19 16:15:25 -0700 | [diff] [blame] | 1699 | // Name of the signing certificate lineage file. |
| 1700 | Lineage *string |
| 1701 | |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1702 | // optional theme name. If specified, the overlay package will be applied |
| 1703 | // only when the ro.boot.vendor.overlay.theme system property is set to the same value. |
| 1704 | Theme *string |
| 1705 | |
| 1706 | // if not blank, set to the version of the sdk to compile against. |
| 1707 | // Defaults to compiling against the current platform. |
| 1708 | Sdk_version *string |
| 1709 | |
| 1710 | // if not blank, set the minimum version of the sdk that the compiled artifacts will run against. |
| 1711 | // Defaults to sdk_version if not set. |
| 1712 | Min_sdk_version *string |
Jaewoong Jung | fe3c7f6 | 2020-04-09 16:15:30 -0700 | [diff] [blame] | 1713 | |
| 1714 | // list of android_library modules whose resources are extracted and linked against statically |
| 1715 | Static_libs []string |
| 1716 | |
| 1717 | // list of android_app modules whose resources are extracted and linked against |
| 1718 | Resource_libs []string |
Jaewoong Jung | ad0177b | 2020-04-24 15:22:40 -0700 | [diff] [blame] | 1719 | |
| 1720 | // Names of modules to be overridden. Listed modules can only be other overlays |
| 1721 | // (in Make or Soong). |
| 1722 | // This does not completely prevent installation of the overridden overlays, but if both |
| 1723 | // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed |
| 1724 | // from PRODUCT_PACKAGES. |
| 1725 | Overrides []string |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1726 | } |
| 1727 | |
Jiyong Park | 69aeba9 | 2020-04-24 21:16:36 +0900 | [diff] [blame] | 1728 | // RuntimeResourceOverlayModule interface is used by the apex package to gather information from |
| 1729 | // a RuntimeResourceOverlay module. |
| 1730 | type RuntimeResourceOverlayModule interface { |
| 1731 | android.Module |
| 1732 | OutputFile() android.Path |
| 1733 | Certificate() Certificate |
| 1734 | Theme() string |
| 1735 | } |
| 1736 | |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1737 | func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) { |
| 1738 | sdkDep := decodeSdkDep(ctx, sdkContext(r)) |
| 1739 | if sdkDep.hasFrameworkLibs() { |
| 1740 | r.aapt.deps(ctx, sdkDep) |
| 1741 | } |
| 1742 | |
| 1743 | cert := android.SrcIsModule(String(r.properties.Certificate)) |
| 1744 | if cert != "" { |
| 1745 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 1746 | } |
Jaewoong Jung | fe3c7f6 | 2020-04-09 16:15:30 -0700 | [diff] [blame] | 1747 | |
| 1748 | ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...) |
| 1749 | ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1750 | } |
| 1751 | |
| 1752 | func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 1753 | // Compile and link resources |
| 1754 | r.aapt.hasNoCode = true |
Jaewoong Jung | f0f747c | 2020-01-24 10:30:02 -0800 | [diff] [blame] | 1755 | // Do not remove resources without default values nor dedupe resource configurations with the same value |
Roshan Pius | 4df2bc7 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1756 | aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"} |
| 1757 | // Allow the override of "package name" and "overlay target package name" |
| 1758 | manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName()) |
| 1759 | if overridden || r.overridableProperties.Package_name != nil { |
| 1760 | // The product override variable has a priority over the package_name property. |
| 1761 | if !overridden { |
| 1762 | manifestPackageName = *r.overridableProperties.Package_name |
| 1763 | } |
| 1764 | aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName) |
| 1765 | } |
| 1766 | if r.overridableProperties.Target_package_name != nil { |
| 1767 | aaptLinkFlags = append(aaptLinkFlags, |
| 1768 | "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name) |
| 1769 | } |
| 1770 | r.aapt.buildActions(ctx, r, aaptLinkFlags...) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1771 | |
| 1772 | // Sign the built package |
Colin Cross | c2d2405 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 1773 | _, certificates := collectAppDeps(ctx, r, false, false) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1774 | certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx) |
| 1775 | signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk") |
Liz Kammer | 966b2f0 | 2020-05-19 16:15:25 -0700 | [diff] [blame] | 1776 | var lineageFile android.Path |
| 1777 | if lineage := String(r.properties.Lineage); lineage != "" { |
| 1778 | lineageFile = android.PathForModuleSrc(ctx, lineage) |
| 1779 | } |
| 1780 | SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, lineageFile) |
Jaewoong Jung | 78ec5d8 | 2020-01-31 10:11:47 -0800 | [diff] [blame] | 1781 | r.certificate = certificates[0] |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1782 | |
| 1783 | r.outputFile = signed |
| 1784 | r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme)) |
| 1785 | ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile) |
| 1786 | } |
| 1787 | |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 1788 | func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec { |
| 1789 | return sdkSpecFrom(String(r.properties.Sdk_version)) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1790 | } |
| 1791 | |
| 1792 | func (r *RuntimeResourceOverlay) systemModules() string { |
| 1793 | return "" |
| 1794 | } |
| 1795 | |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 1796 | func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec { |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1797 | if r.properties.Min_sdk_version != nil { |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 1798 | return sdkSpecFrom(*r.properties.Min_sdk_version) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1799 | } |
| 1800 | return r.sdkVersion() |
| 1801 | } |
| 1802 | |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 1803 | func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec { |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1804 | return r.sdkVersion() |
| 1805 | } |
| 1806 | |
Jiyong Park | 69aeba9 | 2020-04-24 21:16:36 +0900 | [diff] [blame] | 1807 | func (r *RuntimeResourceOverlay) Certificate() Certificate { |
| 1808 | return r.certificate |
| 1809 | } |
| 1810 | |
| 1811 | func (r *RuntimeResourceOverlay) OutputFile() android.Path { |
| 1812 | return r.outputFile |
| 1813 | } |
| 1814 | |
| 1815 | func (r *RuntimeResourceOverlay) Theme() string { |
| 1816 | return String(r.properties.Theme) |
| 1817 | } |
| 1818 | |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1819 | // runtime_resource_overlay generates a resource-only apk file that can overlay application and |
| 1820 | // system resources at run time. |
| 1821 | func RuntimeResourceOverlayFactory() android.Module { |
| 1822 | module := &RuntimeResourceOverlay{} |
| 1823 | module.AddProperties( |
| 1824 | &module.properties, |
Roshan Pius | 4df2bc7 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1825 | &module.aaptProperties, |
| 1826 | &module.overridableProperties) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1827 | |
Roshan Pius | 4df2bc7 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1828 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1829 | android.InitDefaultableModule(module) |
| 1830 | android.InitOverridableModule(module, &module.properties.Overrides) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1831 | return module |
| 1832 | } |
| 1833 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1834 | type UsesLibraryProperties struct { |
| 1835 | // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file. |
| 1836 | Uses_libs []string |
| 1837 | |
| 1838 | // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with |
| 1839 | // required=false. |
| 1840 | Optional_uses_libs []string |
| 1841 | |
| 1842 | // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults |
| 1843 | // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future. |
| 1844 | Enforce_uses_libs *bool |
| 1845 | } |
| 1846 | |
| 1847 | // usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the |
| 1848 | // <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the |
| 1849 | // uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps |
| 1850 | // with knowledge of their shared libraries. |
| 1851 | type usesLibrary struct { |
| 1852 | usesLibraryProperties UsesLibraryProperties |
| 1853 | } |
| 1854 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 1855 | func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) { |
Colin Cross | 3245b2c | 2019-06-07 13:18:09 -0700 | [diff] [blame] | 1856 | if !ctx.Config().UnbundledBuild() { |
| 1857 | ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...) |
| 1858 | ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...) |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 1859 | // Only add these extra dependencies if the module depends on framework libs. This avoids |
| 1860 | // creating a cyclic dependency: |
| 1861 | // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res. |
| 1862 | if hasFrameworkLibs { |
Colin Cross | 3245b2c | 2019-06-07 13:18:09 -0700 | [diff] [blame] | 1863 | // dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs |
| 1864 | // to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each |
| 1865 | // library to dexpreopt. |
| 1866 | ctx.AddVariationDependencies(nil, usesLibTag, |
| 1867 | "org.apache.http.legacy", |
| 1868 | "android.hidl.base-V1.0-java", |
| 1869 | "android.hidl.manager-V1.0-java") |
Ulya Trafimovich | c9af538 | 2020-05-29 15:35:06 +0100 | [diff] [blame] | 1870 | ctx.AddVariationDependencies(nil, usesLibTag, optionalUsesLibs...) |
Colin Cross | 3245b2c | 2019-06-07 13:18:09 -0700 | [diff] [blame] | 1871 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1872 | } |
| 1873 | } |
| 1874 | |
| 1875 | // presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the |
| 1876 | // build. |
| 1877 | func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string { |
| 1878 | optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries()) |
| 1879 | return optionalUsesLibs |
| 1880 | } |
| 1881 | |
Ulya Trafimovich | d4bcea4 | 2020-06-03 14:57:22 +0100 | [diff] [blame] | 1882 | // usesLibraryPaths returns a map of module names of shared library dependencies to the paths |
| 1883 | // to their dex jars on host and on device. |
| 1884 | func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) dexpreopt.LibraryPaths { |
| 1885 | usesLibPaths := make(dexpreopt.LibraryPaths) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1886 | |
| 1887 | if !ctx.Config().UnbundledBuild() { |
| 1888 | ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) { |
Ulya Trafimovich | d4bcea4 | 2020-06-03 14:57:22 +0100 | [diff] [blame] | 1889 | dep := ctx.OtherModuleName(m) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1890 | if lib, ok := m.(Dependency); ok { |
Ulya Trafimovich | 9f3052c | 2020-06-09 14:31:19 +0100 | [diff] [blame] | 1891 | buildPath := lib.DexJarBuildPath() |
| 1892 | if buildPath == nil { |
Ulya Trafimovich | d4bcea4 | 2020-06-03 14:57:22 +0100 | [diff] [blame] | 1893 | ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must"+ |
| 1894 | " produce a dex jar, does it have installable: true?", dep) |
Ulya Trafimovich | 9f3052c | 2020-06-09 14:31:19 +0100 | [diff] [blame] | 1895 | return |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1896 | } |
Ulya Trafimovich | 9f3052c | 2020-06-09 14:31:19 +0100 | [diff] [blame] | 1897 | |
| 1898 | var devicePath string |
| 1899 | installPath := lib.DexJarInstallPath() |
| 1900 | if installPath == nil { |
| 1901 | devicePath = filepath.Join("/system/framework", dep+".jar") |
| 1902 | } else { |
| 1903 | devicePath = android.InstallPathToOnDevicePath(ctx, installPath.(android.InstallPath)) |
| 1904 | } |
| 1905 | |
| 1906 | usesLibPaths[dep] = &dexpreopt.LibraryPath{buildPath, devicePath} |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1907 | } else if ctx.Config().AllowMissingDependencies() { |
Ulya Trafimovich | d4bcea4 | 2020-06-03 14:57:22 +0100 | [diff] [blame] | 1908 | ctx.AddMissingDependencies([]string{dep}) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1909 | } else { |
Ulya Trafimovich | d4bcea4 | 2020-06-03 14:57:22 +0100 | [diff] [blame] | 1910 | ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be "+ |
| 1911 | "a java library", dep) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1912 | } |
| 1913 | }) |
| 1914 | } |
| 1915 | |
| 1916 | return usesLibPaths |
| 1917 | } |
| 1918 | |
| 1919 | // enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs |
| 1920 | // properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true |
| 1921 | // unconditionally in the future. |
| 1922 | func (u *usesLibrary) enforceUsesLibraries() bool { |
| 1923 | defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 || |
| 1924 | len(u.usesLibraryProperties.Optional_uses_libs) > 0 |
| 1925 | return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs) |
| 1926 | } |
| 1927 | |
| 1928 | // verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified |
| 1929 | // in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest. |
| 1930 | func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path { |
| 1931 | outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml") |
| 1932 | |
| 1933 | rule := android.NewRuleBuilder() |
Colin Cross | ee94d6a | 2019-07-08 17:08:34 -0700 | [diff] [blame] | 1934 | cmd := rule.Command().BuiltTool(ctx, "manifest_check"). |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1935 | Flag("--enforce-uses-libraries"). |
| 1936 | Input(manifest). |
| 1937 | FlagWithOutput("-o ", outputFile) |
| 1938 | |
| 1939 | for _, lib := range u.usesLibraryProperties.Uses_libs { |
| 1940 | cmd.FlagWithArg("--uses-library ", lib) |
| 1941 | } |
| 1942 | |
| 1943 | for _, lib := range u.usesLibraryProperties.Optional_uses_libs { |
| 1944 | cmd.FlagWithArg("--optional-uses-library ", lib) |
| 1945 | } |
| 1946 | |
| 1947 | rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>") |
| 1948 | |
| 1949 | return outputFile |
| 1950 | } |
| 1951 | |
| 1952 | // verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified |
| 1953 | // in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK. |
| 1954 | func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path { |
| 1955 | outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base()) |
| 1956 | |
| 1957 | rule := android.NewRuleBuilder() |
| 1958 | aapt := ctx.Config().HostToolPath(ctx, "aapt") |
| 1959 | rule.Command(). |
| 1960 | Textf("aapt_binary=%s", aapt.String()).Implicit(aapt). |
| 1961 | Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")). |
| 1962 | Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")). |
| 1963 | Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk) |
| 1964 | rule.Command().Text("cp -f").Input(apk).Output(outputFile) |
| 1965 | |
| 1966 | rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>") |
| 1967 | |
| 1968 | return outputFile |
| 1969 | } |