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" |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 23 | "strings" |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 24 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 25 | "github.com/google/blueprint" |
| 26 | "github.com/google/blueprint/proptools" |
| 27 | |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 28 | "android/soong/android" |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 29 | "android/soong/cc" |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 30 | "android/soong/tradefed" |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 31 | ) |
| 32 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 33 | var supportedDpis = []string{"ldpi", "mdpi", "hdpi", "xhdpi", "xxhdpi", "xxxhdpi"} |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 34 | |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 35 | func init() { |
Colin Cross | 5ab4e6d | 2017-11-22 16:20:45 -0800 | [diff] [blame] | 36 | android.RegisterModuleType("android_app", AndroidAppFactory) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 37 | android.RegisterModuleType("android_test", AndroidTestFactory) |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 38 | android.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 39 | android.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory) |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 40 | android.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory) |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 41 | android.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 42 | android.RegisterModuleType("android_app_import", AndroidAppImportFactory) |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 43 | android.RegisterModuleType("android_test_import", AndroidTestImportFactory) |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 44 | |
| 45 | initAndroidAppImportVariantGroupTypes() |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 46 | } |
| 47 | |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 48 | // AndroidManifest.xml merging |
| 49 | // package splits |
| 50 | |
Colin Cross | fabb608 | 2018-02-20 17:22:23 -0800 | [diff] [blame] | 51 | type appProperties struct { |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 52 | // 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] | 53 | Additional_certificates []string |
| 54 | |
| 55 | // If set, create package-export.apk, which other packages can |
| 56 | // use to get PRODUCT-agnostic resource data like IDs and type definitions. |
Nan Zhang | ea568a4 | 2017-11-08 21:20:04 -0800 | [diff] [blame] | 57 | Export_package_resources *bool |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 58 | |
Colin Cross | 1605606 | 2017-12-13 22:46:28 -0800 | [diff] [blame] | 59 | // Specifies that this app should be installed to the priv-app directory, |
| 60 | // where the system will grant it additional privileges not available to |
| 61 | // normal apps. |
| 62 | Privileged *bool |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 63 | |
| 64 | // list of resource labels to generate individual resource packages |
| 65 | Package_splits []string |
Jason Monk | d4122be | 2018-08-10 09:33:36 -0400 | [diff] [blame] | 66 | |
| 67 | // Names of modules to be overridden. Listed modules can only be other binaries |
| 68 | // (in Make or Soong). |
| 69 | // This does not completely prevent installation of the overridden binaries, but if both |
| 70 | // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed |
| 71 | // from PRODUCT_PACKAGES. |
| 72 | Overrides []string |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 73 | |
| 74 | // list of native libraries that will be provided in or alongside the resulting jar |
| 75 | Jni_libs []string `android:"arch_variant"` |
| 76 | |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 77 | // STL library to use for JNI libraries. |
| 78 | Stl *string `android:"arch_variant"` |
| 79 | |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 80 | // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest |
| 81 | // 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] | 82 | // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for |
| 83 | // android_app modules that are embedded to APEXes, defaults to false for other module types where the native |
| 84 | // libraries are generally preinstalled outside the APK. |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 85 | Use_embedded_native_libs *bool |
Colin Cross | 46abdad | 2019-02-07 13:07:08 -0800 | [diff] [blame] | 86 | |
| 87 | // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that |
| 88 | // they are used from inside the APK at runtime. |
| 89 | Use_embedded_dex *bool |
Colin Cross | 47fa9d3 | 2019-03-26 10:51:39 -0700 | [diff] [blame] | 90 | |
| 91 | // Forces native libraries to always be packaged into the APK, |
| 92 | // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed. |
| 93 | // True for android_test* modules. |
| 94 | AlwaysPackageNativeLibs bool `blueprint:"mutated"` |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 95 | |
| 96 | // If set, find and merge all NOTICE files that this module and its dependencies have and store |
| 97 | // it in the APK as an asset. |
| 98 | Embed_notices *bool |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 99 | } |
| 100 | |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 101 | // android_app properties that can be overridden by override_android_app |
| 102 | type overridableAppProperties struct { |
| 103 | // The name of a certificate in the default certificate directory, blank to use the default product certificate, |
| 104 | // or an android_app_certificate module name in the form ":module". |
| 105 | Certificate *string |
Jaewoong Jung | 6f373f6 | 2019-03-13 10:13:24 -0700 | [diff] [blame] | 106 | |
| 107 | // the package name of this app. The package name in the manifest file is used if one was not given. |
| 108 | Package_name *string |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 109 | } |
| 110 | |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 111 | type AndroidApp struct { |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 112 | Library |
| 113 | aapt |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 114 | android.OverridableModuleBase |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 115 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 116 | usesLibrary usesLibrary |
| 117 | |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 118 | certificate Certificate |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 119 | |
Colin Cross | fabb608 | 2018-02-20 17:22:23 -0800 | [diff] [blame] | 120 | appProperties appProperties |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 121 | |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 122 | overridableAppProperties overridableAppProperties |
| 123 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 124 | installJniLibs []jniLib |
Colin Cross | f623721 | 2018-10-29 23:14:58 -0700 | [diff] [blame] | 125 | |
| 126 | bundleFile android.Path |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 127 | |
| 128 | // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES. |
| 129 | installApkName string |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 130 | |
Colin Cross | 70dda7e | 2019-10-01 22:05:35 -0700 | [diff] [blame] | 131 | installDir android.InstallPath |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 132 | |
Jaewoong Jung | 7dd4ae2 | 2019-09-27 17:13:15 -0700 | [diff] [blame] | 133 | onDeviceDir string |
| 134 | |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 135 | additionalAaptFlags []string |
Jaewoong Jung | 9877279 | 2019-07-01 17:15:13 -0700 | [diff] [blame] | 136 | |
| 137 | noticeOutputs android.NoticeOutputs |
Colin Cross | e1731a5 | 2017-12-14 11:22:55 -0800 | [diff] [blame] | 138 | } |
| 139 | |
Colin Cross | 89c3158 | 2018-04-30 15:55:11 -0700 | [diff] [blame] | 140 | func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths { |
| 141 | return nil |
| 142 | } |
| 143 | |
Colin Cross | 66f7882 | 2018-05-02 12:58:28 -0700 | [diff] [blame] | 144 | func (a *AndroidApp) ExportedStaticPackages() android.Paths { |
| 145 | return nil |
| 146 | } |
| 147 | |
Sundong Ahn | e1f05aa | 2019-08-27 13:55:42 +0900 | [diff] [blame] | 148 | func (a *AndroidApp) OutputFile() android.Path { |
| 149 | return a.outputFile |
| 150 | } |
| 151 | |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 152 | var _ AndroidLibraryDependency = (*AndroidApp)(nil) |
| 153 | |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 154 | type Certificate struct { |
| 155 | Pem, Key android.Path |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 156 | } |
| 157 | |
Colin Cross | 46c9b8b | 2017-06-22 16:51:17 -0700 | [diff] [blame] | 158 | func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) { |
| 159 | a.Module.deps(ctx) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 160 | |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 161 | if String(a.appProperties.Stl) == "c++_shared" && a.sdkVersion() == "" { |
| 162 | ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared") |
| 163 | } |
| 164 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 165 | sdkDep := decodeSdkDep(ctx, sdkContext(a)) |
| 166 | if sdkDep.hasFrameworkLibs() { |
| 167 | a.aapt.deps(ctx, sdkDep) |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 168 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 169 | |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 170 | tag := &jniDependencyTag{} |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 171 | for _, jniTarget := range ctx.MultiTargets() { |
Colin Cross | 0f7d2ef | 2019-10-16 11:03:10 -0700 | [diff] [blame] | 172 | variation := append(jniTarget.Variations(), |
| 173 | blueprint.Variation{Mutator: "link", Variation: "shared"}) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 174 | ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...) |
| 175 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 176 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 177 | a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs()) |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 178 | } |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 179 | |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 180 | func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) { |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 181 | cert := android.SrcIsModule(a.getCertString(ctx)) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 182 | if cert != "" { |
| 183 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 184 | } |
| 185 | |
| 186 | for _, cert := range a.appProperties.Additional_certificates { |
| 187 | cert = android.SrcIsModule(cert) |
| 188 | if cert != "" { |
| 189 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 190 | } else { |
| 191 | ctx.PropertyErrorf("additional_certificates", |
| 192 | `must be names of android_app_certificate modules in the form ":module"`) |
| 193 | } |
| 194 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 195 | } |
| 196 | |
Jeongik Cha | 538c0d0 | 2019-07-11 15:54:27 +0900 | [diff] [blame] | 197 | func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 198 | a.generateAndroidBuildActions(ctx) |
| 199 | } |
| 200 | |
Colin Cross | 46c9b8b | 2017-06-22 16:51:17 -0700 | [diff] [blame] | 201 | func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Jeongik Cha | 538c0d0 | 2019-07-11 15:54:27 +0900 | [diff] [blame] | 202 | a.checkPlatformAPI(ctx) |
Jeongik Cha | 2cc570d | 2019-10-29 15:44:45 +0900 | [diff] [blame] | 203 | a.checkSdkVersion(ctx) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 204 | a.generateAndroidBuildActions(ctx) |
| 205 | } |
| 206 | |
Sasha Smundak | 6ad7725 | 2019-05-01 13:16:22 -0700 | [diff] [blame] | 207 | // 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] | 208 | // extractNativeLibs application flag should be set to false in the manifest. |
Sasha Smundak | 6ad7725 | 2019-05-01 13:16:22 -0700 | [diff] [blame] | 209 | func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool { |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 210 | minSdkVersion, err := sdkVersionToNumber(ctx, a.minSdkVersion()) |
| 211 | if err != nil { |
| 212 | ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err) |
| 213 | } |
| 214 | |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 215 | return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) || |
| 216 | !a.IsForPlatform() |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 217 | } |
| 218 | |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 219 | // Returns whether this module should have the dex file stored uncompressed in the APK. |
| 220 | func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool { |
Colin Cross | 46abdad | 2019-02-07 13:07:08 -0800 | [diff] [blame] | 221 | if Bool(a.appProperties.Use_embedded_dex) { |
| 222 | return true |
| 223 | } |
| 224 | |
Colin Cross | 53a87f5 | 2019-06-25 13:35:30 -0700 | [diff] [blame] | 225 | // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may |
| 226 | // be preinstalled as prebuilts). |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 227 | if ctx.Config().UncompressPrivAppDex() && a.Privileged() { |
Nicolas Geoffray | fa6e9ec | 2019-02-12 13:12:16 +0000 | [diff] [blame] | 228 | return true |
| 229 | } |
| 230 | |
Colin Cross | 53a87f5 | 2019-06-25 13:35:30 -0700 | [diff] [blame] | 231 | if ctx.Config().UnbundledBuild() { |
| 232 | return false |
| 233 | } |
| 234 | |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 235 | return shouldUncompressDex(ctx, &a.dexpreopter) |
Colin Cross | 5a0dcd5 | 2018-10-05 14:20:06 -0700 | [diff] [blame] | 236 | } |
| 237 | |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 238 | func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool { |
| 239 | return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) || |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 240 | !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 241 | } |
| 242 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 243 | func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) { |
David Brazdil | d25060a | 2019-02-18 18:24:16 +0000 | [diff] [blame] | 244 | a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis) |
| 245 | |
Jaewoong Jung | c27ab66 | 2019-05-30 15:51:14 -0700 | [diff] [blame] | 246 | // Ask manifest_fixer to add or update the application element indicating this app has no code. |
| 247 | a.aapt.hasNoCode = !a.hasCode(ctx) |
| 248 | |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 249 | aaptLinkFlags := []string{} |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 250 | |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 251 | // Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided. |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 252 | hasProduct := false |
| 253 | for _, f := range a.aaptProperties.Aaptflags { |
| 254 | if strings.HasPrefix(f, "--product") { |
| 255 | hasProduct = true |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 256 | break |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 257 | } |
| 258 | } |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 259 | if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 { |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 260 | aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics()) |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 261 | } |
| 262 | |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 263 | if !Bool(a.aaptProperties.Aapt_include_all_resources) { |
| 264 | // Product AAPT config |
| 265 | for _, aaptConfig := range ctx.Config().ProductAAPTConfig() { |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 266 | aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig) |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 267 | } |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 268 | |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 269 | // Product AAPT preferred config |
| 270 | if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 { |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 271 | aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig()) |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 272 | } |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 273 | } |
| 274 | |
Jiyong Park | 7f67f48 | 2019-01-05 12:57:48 +0900 | [diff] [blame] | 275 | manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName()) |
Jaewoong Jung | 6f373f6 | 2019-03-13 10:13:24 -0700 | [diff] [blame] | 276 | if overridden || a.overridableAppProperties.Package_name != nil { |
| 277 | // The product override variable has a priority over the package_name property. |
| 278 | if !overridden { |
| 279 | manifestPackageName = *a.overridableAppProperties.Package_name |
| 280 | } |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 281 | aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName) |
Jiyong Park | 7f67f48 | 2019-01-05 12:57:48 +0900 | [diff] [blame] | 282 | } |
| 283 | |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 284 | aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...) |
| 285 | |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 286 | a.aapt.splitNames = a.appProperties.Package_splits |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 287 | a.aapt.sdkLibraries = a.exportedSdkLibs |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 288 | |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 289 | a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...) |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 290 | |
Colin Cross | 46c9b8b | 2017-06-22 16:51:17 -0700 | [diff] [blame] | 291 | // apps manifests are handled by aapt, don't let Module see them |
Dan Willemsen | 34cc69e | 2015-09-23 15:26:20 -0700 | [diff] [blame] | 292 | a.properties.Manifest = nil |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 293 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 294 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 295 | func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) { |
Colin Cross | 89c3158 | 2018-04-30 15:55:11 -0700 | [diff] [blame] | 296 | var staticLibProguardFlagFiles android.Paths |
| 297 | ctx.VisitDirectDeps(func(m android.Module) { |
| 298 | if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag { |
| 299 | staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...) |
| 300 | } |
| 301 | }) |
| 302 | |
| 303 | staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles) |
| 304 | |
| 305 | a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...) |
| 306 | a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile) |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 307 | } |
Colin Cross | 66dbc0b | 2017-12-28 12:23:20 -0800 | [diff] [blame] | 308 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 309 | func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path { |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 310 | |
| 311 | var installDir string |
| 312 | if ctx.ModuleName() == "framework-res" { |
| 313 | // framework-res.apk is installed as system/framework/framework-res.apk |
| 314 | installDir = "framework" |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 315 | } else if a.Privileged() { |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 316 | installDir = filepath.Join("priv-app", a.installApkName) |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 317 | } else { |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 318 | installDir = filepath.Join("app", a.installApkName) |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 319 | } |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 320 | a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk") |
Nicolas Geoffray | fa6e9ec | 2019-02-12 13:12:16 +0000 | [diff] [blame] | 321 | a.dexpreopter.isInstallable = Bool(a.properties.Installable) |
| 322 | a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 323 | |
| 324 | a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries() |
| 325 | a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs |
| 326 | a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx) |
| 327 | a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx) |
| 328 | a.dexpreopter.manifestFile = a.mergedManifestFile |
| 329 | |
Nicolas Geoffray | fa6e9ec | 2019-02-12 13:12:16 +0000 | [diff] [blame] | 330 | a.deviceProperties.UncompressDex = a.dexpreopter.uncompressedDex |
Colin Cross | 5a0dcd5 | 2018-10-05 14:20:06 -0700 | [diff] [blame] | 331 | |
Colin Cross | 5ab4e6d | 2017-11-22 16:20:45 -0800 | [diff] [blame] | 332 | if ctx.ModuleName() != "framework-res" { |
| 333 | a.Module.compile(ctx, a.aaptSrcJar) |
| 334 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 335 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 336 | return a.maybeStrippedDexJarFile |
| 337 | } |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 338 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 339 | func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 340 | var jniJarFile android.WritablePath |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 341 | if len(jniLibs) > 0 { |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 342 | if a.shouldEmbedJnis(ctx) { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 343 | jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip") |
Sasha Smundak | 6ad7725 | 2019-05-01 13:16:22 -0700 | [diff] [blame] | 344 | TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx)) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 345 | } else { |
| 346 | a.installJniLibs = jniLibs |
| 347 | } |
| 348 | } |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 349 | return jniJarFile |
| 350 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 351 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 352 | func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 353 | // Collect NOTICE files from all dependencies. |
| 354 | seenModules := make(map[android.Module]bool) |
| 355 | noticePathSet := make(map[android.Path]bool) |
| 356 | |
| 357 | ctx.WalkDeps(func(child android.Module, parent android.Module) bool { |
| 358 | // Have we already seen this? |
| 359 | if _, ok := seenModules[child]; ok { |
| 360 | return false |
| 361 | } |
| 362 | seenModules[child] = true |
| 363 | |
| 364 | // Skip host modules. |
| 365 | if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross { |
| 366 | return false |
| 367 | } |
| 368 | |
| 369 | path := child.(android.Module).NoticeFile() |
| 370 | if path.Valid() { |
| 371 | noticePathSet[path.Path()] = true |
| 372 | } |
| 373 | return true |
| 374 | }) |
| 375 | |
| 376 | // If the app has one, add it too. |
| 377 | if a.NoticeFile().Valid() { |
| 378 | noticePathSet[a.NoticeFile().Path()] = true |
| 379 | } |
| 380 | |
| 381 | if len(noticePathSet) == 0 { |
Jaewoong Jung | 9877279 | 2019-07-01 17:15:13 -0700 | [diff] [blame] | 382 | return |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 383 | } |
| 384 | var noticePaths []android.Path |
| 385 | for path := range noticePathSet { |
| 386 | noticePaths = append(noticePaths, path) |
| 387 | } |
| 388 | sort.Slice(noticePaths, func(i, j int) bool { |
| 389 | return noticePaths[i].String() < noticePaths[j].String() |
| 390 | }) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 391 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 392 | a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 393 | } |
| 394 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 395 | // Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it |
| 396 | // isn't a cert module reference. Also checks and enforces system cert restriction if applicable. |
| 397 | func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate { |
| 398 | if android.SrcIsModule(certPropValue) == "" { |
| 399 | var mainCert Certificate |
| 400 | if certPropValue != "" { |
| 401 | defaultDir := ctx.Config().DefaultAppCertificateDir(ctx) |
| 402 | mainCert = Certificate{ |
| 403 | defaultDir.Join(ctx, certPropValue+".x509.pem"), |
| 404 | defaultDir.Join(ctx, certPropValue+".pk8"), |
| 405 | } |
| 406 | } else { |
| 407 | pem, key := ctx.Config().DefaultAppCertificate(ctx) |
| 408 | mainCert = Certificate{pem, key} |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 409 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 410 | certificates = append([]Certificate{mainCert}, certificates...) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 411 | } |
| 412 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 413 | if !m.Platform() { |
| 414 | certPath := certificates[0].Pem.String() |
Jeongik Cha | c946414 | 2019-01-07 12:07:27 +0900 | [diff] [blame] | 415 | systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String() |
| 416 | if strings.HasPrefix(certPath, systemCertPath) { |
| 417 | enforceSystemCert := ctx.Config().EnforceSystemCertificate() |
| 418 | whitelist := ctx.Config().EnforceSystemCertificateWhitelist() |
| 419 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 420 | if enforceSystemCert && !inList(m.Name(), whitelist) { |
Jeongik Cha | c946414 | 2019-01-07 12:07:27 +0900 | [diff] [blame] | 421 | ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.") |
| 422 | } |
| 423 | } |
| 424 | } |
| 425 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 426 | return certificates |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 427 | } |
| 428 | |
| 429 | func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) { |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 430 | var apkDeps android.Paths |
| 431 | |
Jeongik Cha | 538c0d0 | 2019-07-11 15:54:27 +0900 | [diff] [blame] | 432 | a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx) |
| 433 | a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex) |
| 434 | |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 435 | // Check if the install APK name needs to be overridden. |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 436 | a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name()) |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 437 | |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 438 | if ctx.ModuleName() == "framework-res" { |
| 439 | // framework-res.apk is installed as system/framework/framework-res.apk |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 440 | a.installDir = android.PathForModuleInstall(ctx, "framework") |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 441 | } else if a.Privileged() { |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 442 | a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName) |
| 443 | } else if ctx.InstallInTestcases() { |
Jaewoong Jung | 326a941 | 2019-11-21 10:41:00 -0800 | [diff] [blame] | 444 | a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch()) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 445 | } else { |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 446 | a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 447 | } |
Jaewoong Jung | 7dd4ae2 | 2019-09-27 17:13:15 -0700 | [diff] [blame] | 448 | a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 449 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 450 | a.noticeBuildActions(ctx) |
Jaewoong Jung | 9877279 | 2019-07-01 17:15:13 -0700 | [diff] [blame] | 451 | if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") { |
| 452 | a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput |
| 453 | } |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 454 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 455 | // Process all building blocks, from AAPT to certificates. |
| 456 | a.aaptBuildActions(ctx) |
| 457 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 458 | if a.usesLibrary.enforceUsesLibraries() { |
| 459 | manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile) |
| 460 | apkDeps = append(apkDeps, manifestCheckFile) |
| 461 | } |
| 462 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 463 | a.proguardBuildActions(ctx) |
| 464 | |
| 465 | dexJarFile := a.dexBuildActions(ctx) |
| 466 | |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 467 | jniLibs, certificateDeps := collectAppDeps(ctx, a.shouldEmbedJnis(ctx)) |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 468 | jniJarFile := a.jniBuildActions(jniLibs, ctx) |
| 469 | |
| 470 | if ctx.Failed() { |
| 471 | return |
| 472 | } |
| 473 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 474 | certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx) |
| 475 | a.certificate = certificates[0] |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 476 | |
| 477 | // Build a final signed app package. |
Jaewoong Jung | 5a49881 | 2019-11-07 14:14:38 -0800 | [diff] [blame] | 478 | packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk") |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 479 | CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps) |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 480 | a.outputFile = packageFile |
| 481 | |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 482 | for _, split := range a.aapt.splits { |
| 483 | // Sign the split APKs |
Jaewoong Jung | 5a49881 | 2019-11-07 14:14:38 -0800 | [diff] [blame] | 484 | packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk") |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 485 | CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps) |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 486 | a.extraOutputFiles = append(a.extraOutputFiles, packageFile) |
| 487 | } |
| 488 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 489 | // Build an app bundle. |
Colin Cross | f623721 | 2018-10-29 23:14:58 -0700 | [diff] [blame] | 490 | bundleFile := android.PathForModuleOut(ctx, "base.zip") |
| 491 | BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile) |
| 492 | a.bundleFile = bundleFile |
| 493 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 494 | // Install the app package. |
Jiyong Park | 8ba50f9 | 2019-11-13 15:01:01 +0900 | [diff] [blame] | 495 | if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() { |
| 496 | ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile) |
| 497 | for _, extra := range a.extraOutputFiles { |
| 498 | ctx.InstallFile(a.installDir, extra.Base(), extra) |
| 499 | } |
Colin Cross | 5ab4e6d | 2017-11-22 16:20:45 -0800 | [diff] [blame] | 500 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 501 | } |
| 502 | |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 503 | func collectAppDeps(ctx android.ModuleContext, shouldCollectRecursiveNativeDeps bool) ([]jniLib, []Certificate) { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 504 | var jniLibs []jniLib |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 505 | var certificates []Certificate |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 506 | seenModulePaths := make(map[string]bool) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 507 | |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 508 | ctx.WalkDeps(func(module android.Module, parent android.Module) bool { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 509 | otherName := ctx.OtherModuleName(module) |
| 510 | tag := ctx.OtherModuleDependencyTag(module) |
| 511 | |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 512 | if IsJniDepTag(tag) || tag == cc.SharedDepTag { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 513 | if dep, ok := module.(*cc.Module); ok { |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 514 | if dep.IsLlndk(ctx.Config()) || dep.IsStubs() { |
| 515 | return false |
| 516 | } |
| 517 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 518 | lib := dep.OutputFile() |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 519 | path := lib.Path() |
| 520 | if seenModulePaths[path.String()] { |
| 521 | return false |
| 522 | } |
| 523 | seenModulePaths[path.String()] = true |
| 524 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 525 | if lib.Valid() { |
| 526 | jniLibs = append(jniLibs, jniLib{ |
| 527 | name: ctx.OtherModuleName(module), |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 528 | path: path, |
| 529 | target: module.Target(), |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 530 | }) |
| 531 | } else { |
| 532 | ctx.ModuleErrorf("dependency %q missing output file", otherName) |
| 533 | } |
| 534 | } else { |
| 535 | ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 536 | } |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 537 | |
| 538 | return shouldCollectRecursiveNativeDeps |
| 539 | } |
| 540 | |
| 541 | if tag == certificateTag { |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 542 | if dep, ok := module.(*AndroidAppCertificate); ok { |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 543 | certificates = append(certificates, dep.Certificate) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 544 | } else { |
| 545 | ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName) |
| 546 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 547 | } |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 548 | |
| 549 | return false |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 550 | }) |
| 551 | |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 552 | return jniLibs, certificates |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 553 | } |
| 554 | |
Colin Cross | 0ea8ba8 | 2019-06-06 14:33:29 -0700 | [diff] [blame] | 555 | func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string { |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 556 | certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName()) |
| 557 | if overridden { |
Jaewoong Jung | acb6db3 | 2019-02-28 16:22:30 +0000 | [diff] [blame] | 558 | return ":" + certificate |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 559 | } |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 560 | return String(a.overridableAppProperties.Certificate) |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 561 | } |
| 562 | |
Jiyong Park | b7c639e | 2019-08-19 14:56:02 +0900 | [diff] [blame] | 563 | // For OutputFileProducer interface |
| 564 | func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) { |
| 565 | switch tag { |
| 566 | case ".aapt.srcjar": |
| 567 | return []android.Path{a.aaptSrcJar}, nil |
| 568 | } |
| 569 | return a.Library.OutputFiles(tag) |
| 570 | } |
| 571 | |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 572 | func (a *AndroidApp) Privileged() bool { |
| 573 | return Bool(a.appProperties.Privileged) |
| 574 | } |
| 575 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 576 | // 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] | 577 | func AndroidAppFactory() android.Module { |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 578 | module := &AndroidApp{} |
| 579 | |
Sasha Smundak | 2057f82 | 2019-04-16 17:16:58 -0700 | [diff] [blame] | 580 | module.Module.deviceProperties.Optimize.EnabledByDefault = true |
Colin Cross | 66dbc0b | 2017-12-28 12:23:20 -0800 | [diff] [blame] | 581 | module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true) |
| 582 | |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 583 | module.Module.properties.Instrument = true |
Colin Cross | 9ae1b92 | 2018-06-26 17:59:05 -0700 | [diff] [blame] | 584 | module.Module.properties.Installable = proptools.BoolPtr(true) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 585 | |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 586 | module.AddProperties( |
Colin Cross | 540eff8 | 2017-06-22 17:01:52 -0700 | [diff] [blame] | 587 | &module.Module.properties, |
| 588 | &module.Module.deviceProperties, |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 589 | &module.Module.dexpreoptProperties, |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 590 | &module.Module.protoProperties, |
| 591 | &module.aaptProperties, |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 592 | &module.appProperties, |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 593 | &module.overridableAppProperties, |
| 594 | &module.usesLibrary.usesLibraryProperties) |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 595 | |
Colin Cross | a9d8bee | 2018-10-02 13:59:46 -0700 | [diff] [blame] | 596 | module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool { |
| 597 | return class == android.Device && ctx.Config().DevicePrefer32BitApps() |
| 598 | }) |
| 599 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 600 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 601 | android.InitDefaultableModule(module) |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 602 | android.InitOverridableModule(module, &module.appProperties.Overrides) |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 603 | android.InitApexModule(module) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 604 | |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 605 | return module |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 606 | } |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 607 | |
| 608 | type appTestProperties struct { |
| 609 | Instrumentation_for *string |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 610 | |
| 611 | // if specified, the instrumentation target package name in the manifest is overwritten by it. |
| 612 | Instrumentation_target_package *string |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 613 | } |
| 614 | |
| 615 | type AndroidTest struct { |
| 616 | AndroidApp |
| 617 | |
| 618 | appTestProperties appTestProperties |
| 619 | |
| 620 | testProperties testProperties |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 621 | |
| 622 | testConfig android.Path |
Colin Cross | d96ca35 | 2018-08-10 16:06:24 -0700 | [diff] [blame] | 623 | data android.Paths |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 624 | } |
| 625 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 626 | func (a *AndroidTest) InstallInTestcases() bool { |
| 627 | return true |
| 628 | } |
| 629 | |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 630 | func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 631 | if a.appTestProperties.Instrumentation_target_package != nil { |
| 632 | a.additionalAaptFlags = append(a.additionalAaptFlags, |
| 633 | "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package) |
| 634 | } else if a.appTestProperties.Instrumentation_for != nil { |
| 635 | // Check if the instrumentation target package is overridden. |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 636 | manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for) |
| 637 | if overridden { |
| 638 | a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName) |
| 639 | } |
| 640 | } |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 641 | a.generateAndroidBuildActions(ctx) |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 642 | |
Dan Shi | 6ffaaa8 | 2019-09-26 11:41:36 -0700 | [diff] [blame] | 643 | a.testConfig = tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config, |
| 644 | a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config) |
Jaewoong Jung | e5cd4e1 | 2019-11-22 14:34:55 -0800 | [diff] [blame] | 645 | if a.overridableAppProperties.Package_name != nil { |
| 646 | fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml") |
| 647 | rule := android.NewRuleBuilder() |
| 648 | rule.Command().BuiltTool(ctx, "test_config_fixer"). |
Jaewoong Jung | f192d55 | 2019-12-17 13:56:13 -0800 | [diff] [blame^] | 649 | FlagWithInput("--manifest ", a.manifestPath). |
Jaewoong Jung | e5cd4e1 | 2019-11-22 14:34:55 -0800 | [diff] [blame] | 650 | FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name). |
| 651 | Input(a.testConfig). |
| 652 | Output(fixedConfig) |
| 653 | rule.Build(pctx, ctx, "fix_test_config", "fix test config") |
| 654 | a.testConfig = fixedConfig |
| 655 | } |
Colin Cross | 8a49795 | 2019-03-05 22:25:09 -0800 | [diff] [blame] | 656 | a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data) |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 657 | } |
| 658 | |
| 659 | func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) { |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 660 | a.AndroidApp.DepsMutator(ctx) |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 661 | } |
| 662 | |
| 663 | func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) { |
| 664 | a.AndroidApp.OverridablePropertiesDepsMutator(ctx) |
Colin Cross | 4b964c0 | 2018-10-15 16:18:06 -0700 | [diff] [blame] | 665 | if a.appTestProperties.Instrumentation_for != nil { |
| 666 | // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac, |
| 667 | // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so |
| 668 | // use instrumentationForTag instead of libTag. |
| 669 | ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for)) |
| 670 | } |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 671 | } |
| 672 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 673 | // android_test compiles test sources and Android resources into an Android application package `.apk` file and |
| 674 | // 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] | 675 | func AndroidTestFactory() android.Module { |
| 676 | module := &AndroidTest{} |
| 677 | |
Sasha Smundak | 2057f82 | 2019-04-16 17:16:58 -0700 | [diff] [blame] | 678 | module.Module.deviceProperties.Optimize.EnabledByDefault = true |
Colin Cross | 5067db9 | 2018-09-17 16:46:35 -0700 | [diff] [blame] | 679 | |
| 680 | module.Module.properties.Instrument = true |
Colin Cross | 9ae1b92 | 2018-06-26 17:59:05 -0700 | [diff] [blame] | 681 | module.Module.properties.Installable = proptools.BoolPtr(true) |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 682 | module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true) |
Colin Cross | 47fa9d3 | 2019-03-26 10:51:39 -0700 | [diff] [blame] | 683 | module.appProperties.AlwaysPackageNativeLibs = true |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 684 | module.Module.dexpreopter.isTest = true |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 685 | |
| 686 | module.AddProperties( |
| 687 | &module.Module.properties, |
| 688 | &module.Module.deviceProperties, |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 689 | &module.Module.dexpreoptProperties, |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 690 | &module.Module.protoProperties, |
| 691 | &module.aaptProperties, |
| 692 | &module.appProperties, |
Dan Willemsen | f5531d2 | 2018-07-16 17:21:19 -0700 | [diff] [blame] | 693 | &module.appTestProperties, |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 694 | &module.overridableAppProperties, |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 695 | &module.usesLibrary.usesLibraryProperties, |
Dan Willemsen | f5531d2 | 2018-07-16 17:21:19 -0700 | [diff] [blame] | 696 | &module.testProperties) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 697 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 698 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 699 | android.InitDefaultableModule(module) |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 700 | android.InitOverridableModule(module, &module.appProperties.Overrides) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 701 | return module |
| 702 | } |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 703 | |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 704 | type appTestHelperAppProperties struct { |
| 705 | // list of compatibility suites (for example "cts", "vts") that the module should be |
| 706 | // installed into. |
| 707 | Test_suites []string `android:"arch_variant"` |
Dan Shi | 6ffaaa8 | 2019-09-26 11:41:36 -0700 | [diff] [blame] | 708 | |
| 709 | // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml |
| 710 | // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true |
| 711 | // explicitly. |
| 712 | Auto_gen_config *bool |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 713 | } |
| 714 | |
| 715 | type AndroidTestHelperApp struct { |
| 716 | AndroidApp |
| 717 | |
| 718 | appTestHelperAppProperties appTestHelperAppProperties |
| 719 | } |
| 720 | |
Jaewoong Jung | 326a941 | 2019-11-21 10:41:00 -0800 | [diff] [blame] | 721 | func (a *AndroidTestHelperApp) InstallInTestcases() bool { |
| 722 | return true |
| 723 | } |
| 724 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 725 | // android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that |
| 726 | // will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a |
| 727 | // test. |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 728 | func AndroidTestHelperAppFactory() android.Module { |
| 729 | module := &AndroidTestHelperApp{} |
| 730 | |
Sasha Smundak | 2057f82 | 2019-04-16 17:16:58 -0700 | [diff] [blame] | 731 | module.Module.deviceProperties.Optimize.EnabledByDefault = true |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 732 | |
| 733 | module.Module.properties.Installable = proptools.BoolPtr(true) |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 734 | module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true) |
Colin Cross | 47fa9d3 | 2019-03-26 10:51:39 -0700 | [diff] [blame] | 735 | module.appProperties.AlwaysPackageNativeLibs = true |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 736 | module.Module.dexpreopter.isTest = true |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 737 | |
| 738 | module.AddProperties( |
| 739 | &module.Module.properties, |
| 740 | &module.Module.deviceProperties, |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 741 | &module.Module.dexpreoptProperties, |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 742 | &module.Module.protoProperties, |
| 743 | &module.aaptProperties, |
| 744 | &module.appProperties, |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 745 | &module.appTestHelperAppProperties, |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 746 | &module.overridableAppProperties, |
| 747 | &module.usesLibrary.usesLibraryProperties) |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 748 | |
| 749 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 750 | android.InitDefaultableModule(module) |
| 751 | return module |
| 752 | } |
| 753 | |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 754 | type AndroidAppCertificate struct { |
| 755 | android.ModuleBase |
| 756 | properties AndroidAppCertificateProperties |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 757 | Certificate Certificate |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 758 | } |
| 759 | |
| 760 | type AndroidAppCertificateProperties struct { |
| 761 | // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name. |
| 762 | Certificate *string |
| 763 | } |
| 764 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 765 | // android_app_certificate modules can be referenced by the certificates property of android_app modules to select |
| 766 | // the signing key. |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 767 | func AndroidAppCertificateFactory() android.Module { |
| 768 | module := &AndroidAppCertificate{} |
| 769 | module.AddProperties(&module.properties) |
| 770 | android.InitAndroidModule(module) |
| 771 | return module |
| 772 | } |
| 773 | |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 774 | func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 775 | cert := String(c.properties.Certificate) |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 776 | c.Certificate = Certificate{ |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 777 | android.PathForModuleSrc(ctx, cert+".x509.pem"), |
| 778 | android.PathForModuleSrc(ctx, cert+".pk8"), |
| 779 | } |
| 780 | } |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 781 | |
| 782 | type OverrideAndroidApp struct { |
| 783 | android.ModuleBase |
| 784 | android.OverrideModuleBase |
| 785 | } |
| 786 | |
| 787 | func (i *OverrideAndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 788 | // All the overrides happen in the base module. |
| 789 | // TODO(jungjw): Check the base module type. |
| 790 | } |
| 791 | |
| 792 | // override_android_app is used to create an android_app module based on another android_app by overriding |
| 793 | // some of its properties. |
| 794 | func OverrideAndroidAppModuleFactory() android.Module { |
| 795 | m := &OverrideAndroidApp{} |
| 796 | m.AddProperties(&overridableAppProperties{}) |
| 797 | |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 798 | android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon) |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 799 | android.InitOverrideModule(m) |
| 800 | return m |
| 801 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 802 | |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 803 | type OverrideAndroidTest struct { |
| 804 | android.ModuleBase |
| 805 | android.OverrideModuleBase |
| 806 | } |
| 807 | |
| 808 | func (i *OverrideAndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 809 | // All the overrides happen in the base module. |
| 810 | // TODO(jungjw): Check the base module type. |
| 811 | } |
| 812 | |
| 813 | // override_android_test is used to create an android_app module based on another android_test by overriding |
| 814 | // some of its properties. |
| 815 | func OverrideAndroidTestModuleFactory() android.Module { |
| 816 | m := &OverrideAndroidTest{} |
| 817 | m.AddProperties(&overridableAppProperties{}) |
| 818 | m.AddProperties(&appTestProperties{}) |
| 819 | |
| 820 | android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon) |
| 821 | android.InitOverrideModule(m) |
| 822 | return m |
| 823 | } |
| 824 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 825 | type AndroidAppImport struct { |
| 826 | android.ModuleBase |
| 827 | android.DefaultableModuleBase |
| 828 | prebuilt android.Prebuilt |
| 829 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 830 | properties AndroidAppImportProperties |
| 831 | dpiVariants interface{} |
| 832 | archVariants interface{} |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 833 | |
| 834 | outputFile android.Path |
| 835 | certificate *Certificate |
| 836 | |
| 837 | dexpreopter |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 838 | |
| 839 | usesLibrary usesLibrary |
Jaewoong Jung | 8aae22e | 2019-07-17 10:21:49 -0700 | [diff] [blame] | 840 | |
Colin Cross | 70dda7e | 2019-10-01 22:05:35 -0700 | [diff] [blame] | 841 | installPath android.InstallPath |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 842 | } |
| 843 | |
| 844 | type AndroidAppImportProperties struct { |
| 845 | // A prebuilt apk to import |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 846 | Apk *string |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 847 | |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 848 | // The name of a certificate in the default certificate directory or an android_app_certificate |
| 849 | // 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] | 850 | Certificate *string |
| 851 | |
| 852 | // Set this flag to true if the prebuilt apk is already signed. The certificate property must not |
| 853 | // be set for presigned modules. |
| 854 | Presigned *bool |
| 855 | |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 856 | // Sign with the default system dev certificate. Must be used judiciously. Most imported apps |
| 857 | // need to either specify a specific certificate or be presigned. |
| 858 | Default_dev_cert *bool |
| 859 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 860 | // Specifies that this app should be installed to the priv-app directory, |
| 861 | // where the system will grant it additional privileges not available to |
| 862 | // normal apps. |
| 863 | Privileged *bool |
| 864 | |
| 865 | // Names of modules to be overridden. Listed modules can only be other binaries |
| 866 | // (in Make or Soong). |
| 867 | // This does not completely prevent installation of the overridden binaries, but if both |
| 868 | // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed |
| 869 | // from PRODUCT_PACKAGES. |
| 870 | Overrides []string |
Jaewoong Jung | 8aae22e | 2019-07-17 10:21:49 -0700 | [diff] [blame] | 871 | |
| 872 | // Optional name for the installed app. If unspecified, it is derived from the module name. |
| 873 | Filename *string |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 874 | } |
| 875 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 876 | // Updates properties with variant-specific values. |
| 877 | func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) { |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 878 | config := ctx.Config() |
| 879 | |
| 880 | dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants") |
| 881 | // Try DPI variant matches in the reverse-priority order so that the highest priority match |
| 882 | // overwrites everything else. |
| 883 | // TODO(jungjw): Can we optimize this by making it priority order? |
| 884 | for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 885 | MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i]) |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 886 | } |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 887 | if config.ProductAAPTPreferredConfig() != "" { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 888 | MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig()) |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 889 | } |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 890 | |
| 891 | archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch") |
| 892 | archType := ctx.Config().Targets[android.Android][0].Arch.ArchType |
| 893 | MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name) |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 894 | } |
| 895 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 896 | func MergePropertiesFromVariant(ctx android.BaseModuleContext, |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 897 | dst interface{}, variantGroup reflect.Value, variant string) { |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 898 | src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant)) |
| 899 | if !src.IsValid() { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 900 | return |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 901 | } |
| 902 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 903 | err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend) |
| 904 | if err != nil { |
| 905 | if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok { |
| 906 | ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error()) |
| 907 | } else { |
| 908 | panic(err) |
| 909 | } |
| 910 | } |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 911 | } |
| 912 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 913 | func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) { |
| 914 | cert := android.SrcIsModule(String(a.properties.Certificate)) |
| 915 | if cert != "" { |
| 916 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 917 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 918 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 919 | a.usesLibrary.deps(ctx, true) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 920 | } |
| 921 | |
| 922 | func (a *AndroidAppImport) uncompressEmbeddedJniLibs( |
| 923 | ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) { |
| 924 | rule := android.NewRuleBuilder() |
| 925 | rule.Command(). |
| 926 | 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] | 927 | BuiltTool(ctx, "zip2zip"). |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 928 | FlagWithInput("-i ", inputPath). |
| 929 | FlagWithOutput("-o ", outputPath). |
| 930 | FlagWithArg("-0 ", "'lib/**/*.so'"). |
| 931 | Textf(`; else cp -f %s %s; fi`, inputPath, outputPath) |
| 932 | rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs") |
| 933 | } |
| 934 | |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 935 | // Returns whether this module should have the dex file stored uncompressed in the APK. |
| 936 | func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool { |
| 937 | if ctx.Config().UnbundledBuild() { |
| 938 | return false |
| 939 | } |
| 940 | |
| 941 | // Uncompress dex in APKs of privileged apps |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 942 | if ctx.Config().UncompressPrivAppDex() && a.Privileged() { |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 943 | return true |
| 944 | } |
| 945 | |
| 946 | return shouldUncompressDex(ctx, &a.dexpreopter) |
| 947 | } |
| 948 | |
Jaewoong Jung | ea1bdb0 | 2019-05-09 14:36:34 -0700 | [diff] [blame] | 949 | func (a *AndroidAppImport) uncompressDex( |
| 950 | ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) { |
| 951 | rule := android.NewRuleBuilder() |
| 952 | rule.Command(). |
| 953 | 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] | 954 | BuiltTool(ctx, "zip2zip"). |
Jaewoong Jung | ea1bdb0 | 2019-05-09 14:36:34 -0700 | [diff] [blame] | 955 | FlagWithInput("-i ", inputPath). |
| 956 | FlagWithOutput("-o ", outputPath). |
| 957 | FlagWithArg("-0 ", "'classes*.dex'"). |
| 958 | Textf(`; else cp -f %s %s; fi`, inputPath, outputPath) |
| 959 | rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files") |
| 960 | } |
| 961 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 962 | func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 963 | a.generateAndroidBuildActions(ctx) |
| 964 | } |
| 965 | |
| 966 | func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 967 | numCertPropsSet := 0 |
| 968 | if String(a.properties.Certificate) != "" { |
| 969 | numCertPropsSet++ |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 970 | } |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 971 | if Bool(a.properties.Presigned) { |
| 972 | numCertPropsSet++ |
| 973 | } |
| 974 | if Bool(a.properties.Default_dev_cert) { |
| 975 | numCertPropsSet++ |
| 976 | } |
| 977 | if numCertPropsSet != 1 { |
| 978 | 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] | 979 | } |
| 980 | |
Peter Collingbourne | 6f907ad | 2019-12-16 13:40:14 -0800 | [diff] [blame] | 981 | _, certificates := collectAppDeps(ctx, false) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 982 | |
| 983 | // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 984 | // TODO: LOCAL_PACKAGE_SPLITS |
| 985 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 986 | srcApk := a.prebuilt.SingleSourcePath(ctx) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 987 | |
| 988 | if a.usesLibrary.enforceUsesLibraries() { |
| 989 | srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk) |
| 990 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 991 | |
| 992 | // TODO: Install or embed JNI libraries |
| 993 | |
| 994 | // Uncompress JNI libraries in the apk |
| 995 | jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk") |
| 996 | a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath) |
| 997 | |
Kyeongkab.Nam | c499714 | 2019-11-22 11:38:16 +0900 | [diff] [blame] | 998 | var installDir android.InstallPath |
| 999 | if Bool(a.properties.Privileged) { |
| 1000 | installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName()) |
| 1001 | } else { |
| 1002 | installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName()) |
| 1003 | } |
| 1004 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1005 | a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk") |
| 1006 | a.dexpreopter.isInstallable = true |
| 1007 | a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned) |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 1008 | a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1009 | |
| 1010 | a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries() |
| 1011 | a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs |
| 1012 | a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx) |
| 1013 | a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx) |
| 1014 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1015 | dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed) |
Jaewoong Jung | ea1bdb0 | 2019-05-09 14:36:34 -0700 | [diff] [blame] | 1016 | if a.dexpreopter.uncompressedDex { |
| 1017 | dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk") |
| 1018 | a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath) |
| 1019 | dexOutput = dexUncompressed |
| 1020 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1021 | |
| 1022 | // Sign or align the package |
| 1023 | // TODO: Handle EXTERNAL |
| 1024 | if !Bool(a.properties.Presigned) { |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1025 | // If the certificate property is empty at this point, default_dev_cert must be set to true. |
| 1026 | // Which makes processMainCert's behavior for the empty cert string WAI. |
| 1027 | certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1028 | if len(certificates) != 1 { |
| 1029 | ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates) |
| 1030 | } |
| 1031 | a.certificate = &certificates[0] |
| 1032 | signed := android.PathForModuleOut(ctx, "signed", ctx.ModuleName()+".apk") |
| 1033 | SignAppPackage(ctx, signed, dexOutput, certificates) |
| 1034 | a.outputFile = signed |
| 1035 | } else { |
| 1036 | alignedApk := android.PathForModuleOut(ctx, "zip-aligned", ctx.ModuleName()+".apk") |
| 1037 | TransformZipAlign(ctx, alignedApk, dexOutput) |
| 1038 | a.outputFile = alignedApk |
| 1039 | } |
| 1040 | |
| 1041 | // TODO: Optionally compress the output apk. |
| 1042 | |
Jaewoong Jung | 8aae22e | 2019-07-17 10:21:49 -0700 | [diff] [blame] | 1043 | a.installPath = ctx.InstallFile(installDir, |
| 1044 | proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk"), a.outputFile) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1045 | |
| 1046 | // TODO: androidmk converter jni libs |
| 1047 | } |
| 1048 | |
| 1049 | func (a *AndroidAppImport) Prebuilt() *android.Prebuilt { |
| 1050 | return &a.prebuilt |
| 1051 | } |
| 1052 | |
| 1053 | func (a *AndroidAppImport) Name() string { |
| 1054 | return a.prebuilt.Name(a.ModuleBase.Name()) |
| 1055 | } |
| 1056 | |
Dario Freni | cde2a03 | 2019-10-27 00:29:22 +0100 | [diff] [blame] | 1057 | func (a *AndroidAppImport) OutputFile() android.Path { |
| 1058 | return a.outputFile |
| 1059 | } |
| 1060 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1061 | var dpiVariantGroupType reflect.Type |
| 1062 | var archVariantGroupType reflect.Type |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1063 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1064 | func initAndroidAppImportVariantGroupTypes() { |
| 1065 | dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants") |
| 1066 | |
| 1067 | archNames := make([]string, len(android.ArchTypeList())) |
| 1068 | for i, archType := range android.ArchTypeList() { |
| 1069 | archNames[i] = archType.Name |
| 1070 | } |
| 1071 | archVariantGroupType = createVariantGroupType(archNames, "Arch") |
| 1072 | } |
| 1073 | |
| 1074 | // Populates all variant struct properties at creation time. |
| 1075 | func (a *AndroidAppImport) populateAllVariantStructs() { |
| 1076 | a.dpiVariants = reflect.New(dpiVariantGroupType).Interface() |
| 1077 | a.AddProperties(a.dpiVariants) |
| 1078 | |
| 1079 | a.archVariants = reflect.New(archVariantGroupType).Interface() |
| 1080 | a.AddProperties(a.archVariants) |
| 1081 | } |
| 1082 | |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 1083 | func (a *AndroidAppImport) Privileged() bool { |
| 1084 | return Bool(a.properties.Privileged) |
| 1085 | } |
| 1086 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1087 | func createVariantGroupType(variants []string, variantGroupName string) reflect.Type { |
| 1088 | props := reflect.TypeOf((*AndroidAppImportProperties)(nil)) |
| 1089 | |
| 1090 | variantFields := make([]reflect.StructField, len(variants)) |
| 1091 | for i, variant := range variants { |
| 1092 | variantFields[i] = reflect.StructField{ |
| 1093 | Name: proptools.FieldNameForProperty(variant), |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1094 | Type: props, |
| 1095 | } |
| 1096 | } |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1097 | |
| 1098 | variantGroupStruct := reflect.StructOf(variantFields) |
| 1099 | return reflect.StructOf([]reflect.StructField{ |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1100 | { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1101 | Name: variantGroupName, |
| 1102 | Type: variantGroupStruct, |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1103 | }, |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1104 | }) |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1105 | } |
| 1106 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1107 | // 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] | 1108 | // DPI-specific apk source files can be specified using dpi_variants. Example: |
| 1109 | // |
| 1110 | // android_app_import { |
| 1111 | // name: "example_import", |
| 1112 | // apk: "prebuilts/example.apk", |
| 1113 | // dpi_variants: { |
| 1114 | // mdpi: { |
| 1115 | // apk: "prebuilts/example_mdpi.apk", |
| 1116 | // }, |
| 1117 | // xhdpi: { |
| 1118 | // apk: "prebuilts/example_xhdpi.apk", |
| 1119 | // }, |
| 1120 | // }, |
| 1121 | // certificate: "PRESIGNED", |
| 1122 | // } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1123 | func AndroidAppImportFactory() android.Module { |
| 1124 | module := &AndroidAppImport{} |
| 1125 | module.AddProperties(&module.properties) |
| 1126 | module.AddProperties(&module.dexpreoptProperties) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1127 | module.AddProperties(&module.usesLibrary.usesLibraryProperties) |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1128 | module.populateAllVariantStructs() |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1129 | android.AddLoadHook(module, func(ctx android.LoadHookContext) { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1130 | module.processVariants(ctx) |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1131 | }) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1132 | |
| 1133 | InitJavaModule(module, android.DeviceSupported) |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1134 | android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk") |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1135 | |
| 1136 | return module |
| 1137 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1138 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1139 | type AndroidTestImport struct { |
| 1140 | AndroidAppImport |
| 1141 | |
| 1142 | testProperties testProperties |
| 1143 | |
| 1144 | data android.Paths |
| 1145 | } |
| 1146 | |
| 1147 | func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 1148 | a.generateAndroidBuildActions(ctx) |
| 1149 | |
| 1150 | a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data) |
| 1151 | } |
| 1152 | |
| 1153 | // android_test_import imports a prebuilt test apk with additional processing specified in the |
| 1154 | // module. DPI or arch variant configurations can be made as with android_app_import. |
| 1155 | func AndroidTestImportFactory() android.Module { |
| 1156 | module := &AndroidTestImport{} |
| 1157 | module.AddProperties(&module.properties) |
| 1158 | module.AddProperties(&module.dexpreoptProperties) |
| 1159 | module.AddProperties(&module.usesLibrary.usesLibraryProperties) |
| 1160 | module.AddProperties(&module.testProperties) |
| 1161 | module.populateAllVariantStructs() |
| 1162 | android.AddLoadHook(module, func(ctx android.LoadHookContext) { |
| 1163 | module.processVariants(ctx) |
| 1164 | }) |
| 1165 | |
| 1166 | InitJavaModule(module, android.DeviceSupported) |
| 1167 | android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk") |
| 1168 | |
| 1169 | return module |
| 1170 | } |
| 1171 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1172 | type UsesLibraryProperties struct { |
| 1173 | // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file. |
| 1174 | Uses_libs []string |
| 1175 | |
| 1176 | // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with |
| 1177 | // required=false. |
| 1178 | Optional_uses_libs []string |
| 1179 | |
| 1180 | // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults |
| 1181 | // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future. |
| 1182 | Enforce_uses_libs *bool |
| 1183 | } |
| 1184 | |
| 1185 | // usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the |
| 1186 | // <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the |
| 1187 | // uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps |
| 1188 | // with knowledge of their shared libraries. |
| 1189 | type usesLibrary struct { |
| 1190 | usesLibraryProperties UsesLibraryProperties |
| 1191 | } |
| 1192 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 1193 | func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) { |
Colin Cross | 3245b2c | 2019-06-07 13:18:09 -0700 | [diff] [blame] | 1194 | if !ctx.Config().UnbundledBuild() { |
| 1195 | ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...) |
| 1196 | ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...) |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 1197 | // Only add these extra dependencies if the module depends on framework libs. This avoids |
| 1198 | // creating a cyclic dependency: |
| 1199 | // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res. |
| 1200 | if hasFrameworkLibs { |
Colin Cross | 3245b2c | 2019-06-07 13:18:09 -0700 | [diff] [blame] | 1201 | // dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs |
| 1202 | // to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each |
| 1203 | // library to dexpreopt. |
| 1204 | ctx.AddVariationDependencies(nil, usesLibTag, |
| 1205 | "org.apache.http.legacy", |
| 1206 | "android.hidl.base-V1.0-java", |
| 1207 | "android.hidl.manager-V1.0-java") |
| 1208 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1209 | } |
| 1210 | } |
| 1211 | |
| 1212 | // presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the |
| 1213 | // build. |
| 1214 | func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string { |
| 1215 | optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries()) |
| 1216 | return optionalUsesLibs |
| 1217 | } |
| 1218 | |
| 1219 | // usesLibraryPaths returns a map of module names of shared library dependencies to the paths to their dex jars. |
| 1220 | func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) map[string]android.Path { |
| 1221 | usesLibPaths := make(map[string]android.Path) |
| 1222 | |
| 1223 | if !ctx.Config().UnbundledBuild() { |
| 1224 | ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) { |
| 1225 | if lib, ok := m.(Dependency); ok { |
| 1226 | if dexJar := lib.DexJar(); dexJar != nil { |
| 1227 | usesLibPaths[ctx.OtherModuleName(m)] = dexJar |
| 1228 | } else { |
| 1229 | ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must produce a dex jar, does it have installable: true?", |
| 1230 | ctx.OtherModuleName(m)) |
| 1231 | } |
| 1232 | } else if ctx.Config().AllowMissingDependencies() { |
| 1233 | ctx.AddMissingDependencies([]string{ctx.OtherModuleName(m)}) |
| 1234 | } else { |
| 1235 | ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library", |
| 1236 | ctx.OtherModuleName(m)) |
| 1237 | } |
| 1238 | }) |
| 1239 | } |
| 1240 | |
| 1241 | return usesLibPaths |
| 1242 | } |
| 1243 | |
| 1244 | // enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs |
| 1245 | // properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true |
| 1246 | // unconditionally in the future. |
| 1247 | func (u *usesLibrary) enforceUsesLibraries() bool { |
| 1248 | defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 || |
| 1249 | len(u.usesLibraryProperties.Optional_uses_libs) > 0 |
| 1250 | return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs) |
| 1251 | } |
| 1252 | |
| 1253 | // verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified |
| 1254 | // in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest. |
| 1255 | func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path { |
| 1256 | outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml") |
| 1257 | |
| 1258 | rule := android.NewRuleBuilder() |
Colin Cross | ee94d6a | 2019-07-08 17:08:34 -0700 | [diff] [blame] | 1259 | cmd := rule.Command().BuiltTool(ctx, "manifest_check"). |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1260 | Flag("--enforce-uses-libraries"). |
| 1261 | Input(manifest). |
| 1262 | FlagWithOutput("-o ", outputFile) |
| 1263 | |
| 1264 | for _, lib := range u.usesLibraryProperties.Uses_libs { |
| 1265 | cmd.FlagWithArg("--uses-library ", lib) |
| 1266 | } |
| 1267 | |
| 1268 | for _, lib := range u.usesLibraryProperties.Optional_uses_libs { |
| 1269 | cmd.FlagWithArg("--optional-uses-library ", lib) |
| 1270 | } |
| 1271 | |
| 1272 | rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>") |
| 1273 | |
| 1274 | return outputFile |
| 1275 | } |
| 1276 | |
| 1277 | // verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified |
| 1278 | // in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK. |
| 1279 | func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path { |
| 1280 | outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base()) |
| 1281 | |
| 1282 | rule := android.NewRuleBuilder() |
| 1283 | aapt := ctx.Config().HostToolPath(ctx, "aapt") |
| 1284 | rule.Command(). |
| 1285 | Textf("aapt_binary=%s", aapt.String()).Implicit(aapt). |
| 1286 | Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")). |
| 1287 | Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")). |
| 1288 | Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk) |
| 1289 | rule.Command().Text("cp -f").Input(apk).Output(outputFile) |
| 1290 | |
| 1291 | rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>") |
| 1292 | |
| 1293 | return outputFile |
| 1294 | } |