blob: 597c53c36d21a9155dc45df38be6a82d1daf2814 [file] [log] [blame]
Jiyong Park09d77522019-11-18 11:16:27 +09001// Copyright (C) 2019 The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package apex
16
17import (
Jiyong Parkbd159612020-02-28 15:22:21 +090018 "encoding/json"
Jiyong Park09d77522019-11-18 11:16:27 +090019 "fmt"
Jooyung Han90934ac2023-09-22 14:52:06 +090020 "path"
Jiyong Park09d77522019-11-18 11:16:27 +090021 "path/filepath"
22 "runtime"
23 "sort"
Nikita Ioffe5335bc42020-10-20 00:02:15 +010024 "strconv"
Jiyong Park09d77522019-11-18 11:16:27 +090025 "strings"
26
Yu Liueae7b362023-11-16 17:05:47 -080027 "android/soong/aconfig"
Jiyong Park09d77522019-11-18 11:16:27 +090028 "android/soong/android"
29 "android/soong/java"
30
31 "github.com/google/blueprint"
32 "github.com/google/blueprint/proptools"
33)
34
35var (
36 pctx = android.NewPackageContext("android/apex")
37)
38
39func init() {
Yu Liueae7b362023-11-16 17:05:47 -080040 pctx.Import("android/soong/aconfig")
Jiyong Park09d77522019-11-18 11:16:27 +090041 pctx.Import("android/soong/android")
sophiezc80a2b32020-11-12 16:39:19 +000042 pctx.Import("android/soong/cc/config")
Jiyong Park09d77522019-11-18 11:16:27 +090043 pctx.Import("android/soong/java")
44 pctx.HostBinToolVariable("apexer", "apexer")
Dennis Shenaf41bc12022-08-03 16:46:43 +000045 pctx.HostBinToolVariable("apexer_with_DCLA_preprocessing", "apexer_with_DCLA_preprocessing")
Dennis Shene2ed70c2023-01-11 14:15:43 +000046
Jiyong Park09d77522019-11-18 11:16:27 +090047 // ART minimal builds (using the master-art manifest) do not have the "frameworks/base"
Jiyong Parkb81b9902020-11-24 19:51:18 +090048 // projects, and hence cannot build 'aapt2'. Use the SDK prebuilt instead.
Jiyong Park09d77522019-11-18 11:16:27 +090049 hostBinToolVariableWithPrebuilt := func(name, prebuiltDir, tool string) {
50 pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
51 if !ctx.Config().FrameworksBaseDirExists(ctx) {
52 return filepath.Join(prebuiltDir, runtime.GOOS, "bin", tool)
53 } else {
Martin Stjernholm7260d062019-12-09 21:47:14 +000054 return ctx.Config().HostToolPath(ctx, tool).String()
Jiyong Park09d77522019-11-18 11:16:27 +090055 }
56 })
57 }
58 hostBinToolVariableWithPrebuilt("aapt2", "prebuilts/sdk/tools", "aapt2")
59 pctx.HostBinToolVariable("avbtool", "avbtool")
60 pctx.HostBinToolVariable("e2fsdroid", "e2fsdroid")
61 pctx.HostBinToolVariable("merge_zips", "merge_zips")
62 pctx.HostBinToolVariable("mke2fs", "mke2fs")
63 pctx.HostBinToolVariable("resize2fs", "resize2fs")
64 pctx.HostBinToolVariable("sefcontext_compile", "sefcontext_compile")
65 pctx.HostBinToolVariable("soong_zip", "soong_zip")
66 pctx.HostBinToolVariable("zip2zip", "zip2zip")
67 pctx.HostBinToolVariable("zipalign", "zipalign")
68 pctx.HostBinToolVariable("jsonmodify", "jsonmodify")
69 pctx.HostBinToolVariable("conv_apex_manifest", "conv_apex_manifest")
Jaewoong Jungfa00c062020-05-14 14:15:24 -070070 pctx.HostBinToolVariable("extract_apks", "extract_apks")
Theotime Combes4ba38c12020-06-12 12:46:59 +000071 pctx.HostBinToolVariable("make_f2fs", "make_f2fs")
72 pctx.HostBinToolVariable("sload_f2fs", "sload_f2fs")
Huang Jianan13cac632021-08-02 15:02:17 +080073 pctx.HostBinToolVariable("make_erofs", "make_erofs")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +000074 pctx.HostBinToolVariable("apex_compression_tool", "apex_compression_tool")
sophiez02347372021-11-02 17:58:02 -070075 pctx.HostBinToolVariable("dexdeps", "dexdeps")
Jooyung Han01f5d652023-04-05 16:29:26 +090076 pctx.HostBinToolVariable("apex_sepolicy_tests", "apex_sepolicy_tests")
77 pctx.HostBinToolVariable("deapexer", "deapexer")
78 pctx.HostBinToolVariable("debugfs_static", "debugfs_static")
Jooyung Han55a73062023-11-07 13:09:56 +090079 pctx.HostBinToolVariable("fsck_erofs", "fsck.erofs")
sophiezc80a2b32020-11-12 16:39:19 +000080 pctx.SourcePathVariable("genNdkUsedbyApexPath", "build/soong/scripts/gen_ndk_usedby_apex.sh")
Jooyung Han4bc10262023-09-08 11:51:45 +090081 pctx.HostBinToolVariable("conv_linker_config", "conv_linker_config")
Jooyung Hane6154412023-09-08 15:25:59 +090082 pctx.HostBinToolVariable("assemble_vintf", "assemble_vintf")
Jooyung Han55a73062023-11-07 13:09:56 +090083 pctx.HostBinToolVariable("apex_elf_checker", "apex_elf_checker")
Yu Liueae7b362023-11-16 17:05:47 -080084 pctx.HostBinToolVariable("aconfig", "aconfig")
Jooyung Han2adba482024-02-22 17:27:53 +090085 pctx.HostBinToolVariable("host_apex_verifier", "host_apex_verifier")
Jiyong Park09d77522019-11-18 11:16:27 +090086}
87
Yu Liubba555e2024-02-17 00:36:42 +000088type createStorageStruct struct {
89 Output_file string
90 Desc string
91 File_type string
92}
93
94var createStorageInfo = []createStorageStruct{
95 {"package.map", "create_aconfig_package_map_file", "package_map"},
96 {"flag.map", "create_aconfig_flag_map_file", "flag_map"},
97 {"flag.val", "create_aconfig_flag_val_file", "flag_val"},
Dennis Shen343d09e2024-09-23 17:19:15 +000098 {"flag.info", "create_aconfig_flag_info_file", "flag_info"},
Yu Liubba555e2024-02-17 00:36:42 +000099}
100
Jiyong Park09d77522019-11-18 11:16:27 +0900101var (
Jiyong Park09d77522019-11-18 11:16:27 +0900102 apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{
103 Command: `rm -f $out && ${jsonmodify} $in ` +
104 `-a provideNativeLibs ${provideNativeLibs} ` +
105 `-a requireNativeLibs ${requireNativeLibs} ` +
Alexei Nicoarad887e242022-07-11 14:16:28 +0100106 `-se version 0 ${default_version} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900107 `${opt} ` +
108 `-o $out`,
109 CommandDeps: []string{"${jsonmodify}"},
110 Description: "prepare ${out}",
Alexei Nicoarad887e242022-07-11 14:16:28 +0100111 }, "provideNativeLibs", "requireNativeLibs", "default_version", "opt")
Jiyong Park09d77522019-11-18 11:16:27 +0900112
113 stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{
114 Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`,
115 CommandDeps: []string{"${conv_apex_manifest}"},
116 Description: "strip ${in}=>${out}",
117 })
118
119 pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{
120 Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`,
121 CommandDeps: []string{"${conv_apex_manifest}"},
122 Description: "convert ${in}=>${out}",
123 })
124
Joe Onoratob4638c12021-10-27 15:47:06 -0700125 // TODO(b/113233103): make sure that file_contexts is as expected, i.e., validate
Jiyong Park09d77522019-11-18 11:16:27 +0900126 // against the binary policy using sefcontext_compiler -p <policy>.
127
128 // TODO(b/114327326): automate the generation of file_contexts
129 apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{
130 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
131 `(. ${out}.copy_commands) && ` +
132 `APEXER_TOOL_PATH=${tool_path} ` +
133 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900134 `--file_contexts ${file_contexts} ` +
135 `--canned_fs_config ${canned_fs_config} ` +
Dario Freni0f4ae072020-01-02 15:24:12 +0000136 `--include_build_info ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900137 `--payload_type image ` +
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000138 `--key ${key} ${opt_flags} ${image_dir} ${out} `,
Jiyong Park09d77522019-11-18 11:16:27 +0900139 CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}",
Huang Jianan13cac632021-08-02 15:02:17 +0800140 "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}", "${sload_f2fs}", "${make_erofs}",
Jiyong Park09d77522019-11-18 11:16:27 +0900141 "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"},
142 Rspfile: "${out}.copy_commands",
143 RspfileContent: "${copy_commands}",
144 Description: "APEX ${image_dir} => ${out}",
Dennis Shenaf41bc12022-08-03 16:46:43 +0000145 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
146 "opt_flags", "manifest")
147
148 DCLAApexRule = pctx.StaticRule("DCLAApexRule", blueprint.RuleParams{
149 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
150 `(. ${out}.copy_commands) && ` +
151 `APEXER_TOOL_PATH=${tool_path} ` +
152 `${apexer_with_DCLA_preprocessing} ` +
153 `--apexer ${apexer} ` +
154 `--canned_fs_config ${canned_fs_config} ` +
155 `${image_dir} ` +
156 `${out} ` +
157 `-- ` +
158 `--include_build_info ` +
159 `--force ` +
160 `--payload_type image ` +
161 `--key ${key} ` +
162 `--file_contexts ${file_contexts} ` +
163 `--manifest ${manifest} ` +
164 `${opt_flags} `,
165 CommandDeps: []string{"${apexer_with_DCLA_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
166 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
167 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
168 "prebuilts/sdk/current/public/android.jar"},
169 Rspfile: "${out}.copy_commands",
170 RspfileContent: "${copy_commands}",
171 Description: "APEX ${image_dir} => ${out}",
172 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
173 "opt_flags", "manifest", "is_DCLA")
Jiyong Park09d77522019-11-18 11:16:27 +0900174
Jiyong Park09d77522019-11-18 11:16:27 +0900175 apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule",
176 blueprint.RuleParams{
177 Command: `${aapt2} convert --output-format proto $in -o $out`,
178 CommandDeps: []string{"${aapt2}"},
179 })
180
181 apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{
Jiyong Parkbd159612020-02-28 15:22:21 +0900182 Command: `${zip2zip} -i $in -o $out.base ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900183 `apex_payload.img:apex/${abi}.img ` +
Dario Frenida1aefe2020-03-02 21:47:09 +0000184 `apex_build_info.pb:apex/${abi}.build_info.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900185 `apex_manifest.json:root/apex_manifest.json ` +
Jiyong Park53ae3342019-12-08 02:06:24 +0900186 `apex_manifest.pb:root/apex_manifest.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900187 `AndroidManifest.xml:manifest/AndroidManifest.xml ` +
Jiyong Parkbd159612020-02-28 15:22:21 +0900188 `assets/NOTICE.html.gz:assets/NOTICE.html.gz &&` +
189 `${soong_zip} -o $out.config -C $$(dirname ${config}) -f ${config} && ` +
190 `${merge_zips} $out $out.base $out.config`,
191 CommandDeps: []string{"${zip2zip}", "${soong_zip}", "${merge_zips}"},
Jiyong Park09d77522019-11-18 11:16:27 +0900192 Description: "app bundle",
Jiyong Parkbd159612020-02-28 15:22:21 +0900193 }, "abi", "config")
Jiyong Park09d77522019-11-18 11:16:27 +0900194
Jiyong Park09d77522019-11-18 11:16:27 +0900195 diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{
196 Command: `diff --unchanged-group-format='' \` +
197 `--changed-group-format='%<' \` +
Colin Cross440e0d02020-06-11 11:32:11 -0700198 `${image_content_file} ${allowed_files_file} || (` +
Colin Cross7cd1d422024-11-13 13:05:49 -0800199 `echo "New unexpected files were added to ${apex_module_name}." ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900200 ` "To fix the build run following command:" && ` +
Colin Cross440e0d02020-06-11 11:32:11 -0700201 `echo "system/apex/tools/update_allowed_list.sh ${allowed_files_file} ${image_content_file}" && ` +
Dan Willemsen81e43c52020-01-28 15:40:19 -0800202 `exit 1); touch ${out}`,
Colin Cross440e0d02020-06-11 11:32:11 -0700203 Description: "Diff ${image_content_file} and ${allowed_files_file}",
204 }, "image_content_file", "allowed_files_file", "apex_module_name")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900205
sophiezc80a2b32020-11-12 16:39:19 +0000206 generateAPIsUsedbyApexRule = pctx.StaticRule("generateAPIsUsedbyApexRule", blueprint.RuleParams{
207 Command: "$genNdkUsedbyApexPath ${image_dir} ${readelf} ${out}",
208 CommandDeps: []string{"${genNdkUsedbyApexPath}"},
209 Description: "Generate symbol list used by Apex",
210 }, "image_dir", "readelf")
211
Jooyung Han01f5d652023-04-05 16:29:26 +0900212 apexSepolicyTestsRule = pctx.StaticRule("apexSepolicyTestsRule", blueprint.RuleParams{
213 Command: `${deapexer} --debugfs_path ${debugfs_static} list -Z ${in} > ${out}.fc` +
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900214 ` && ${apex_sepolicy_tests} -f ${out}.fc && touch ${out}`,
Jooyung Han01f5d652023-04-05 16:29:26 +0900215 CommandDeps: []string{"${apex_sepolicy_tests}", "${deapexer}", "${debugfs_static}"},
216 Description: "run apex_sepolicy_tests",
217 })
Jooyung Han4bc10262023-09-08 11:51:45 +0900218
219 apexLinkerconfigValidationRule = pctx.StaticRule("apexLinkerconfigValidationRule", blueprint.RuleParams{
220 Command: `${conv_linker_config} validate --type apex ${image_dir} && touch ${out}`,
221 CommandDeps: []string{"${conv_linker_config}"},
222 Description: "run apex_linkerconfig_validation",
223 }, "image_dir")
Jooyung Hane6154412023-09-08 15:25:59 +0900224
Jooyung Han2adba482024-02-22 17:27:53 +0900225 apexHostVerifierRule = pctx.StaticRule("apexHostVerifierRule", blueprint.RuleParams{
226 Command: `${host_apex_verifier} --deapexer=${deapexer} --debugfs=${debugfs_static} ` +
Jooyung Hanb6ac8222024-10-14 18:20:14 +0900227 `--fsckerofs=${fsck_erofs} --apex=${in} --partition_tag=${partition_tag} && touch ${out}`,
Jooyung Han2adba482024-02-22 17:27:53 +0900228 CommandDeps: []string{"${host_apex_verifier}", "${deapexer}", "${debugfs_static}", "${fsck_erofs}"},
229 Description: "run host_apex_verifier",
Jooyung Hanb6ac8222024-10-14 18:20:14 +0900230 }, "partition_tag")
Jooyung Han2adba482024-02-22 17:27:53 +0900231
Jooyung Han90934ac2023-09-22 14:52:06 +0900232 assembleVintfRule = pctx.StaticRule("assembleVintfRule", blueprint.RuleParams{
233 Command: `rm -f $out && VINTF_IGNORE_TARGET_FCM_VERSION=true ${assemble_vintf} -i $in -o $out`,
Jooyung Hane6154412023-09-08 15:25:59 +0900234 CommandDeps: []string{"${assemble_vintf}"},
Jooyung Han90934ac2023-09-22 14:52:06 +0900235 Description: "run assemble_vintf",
236 })
Jooyung Han55a73062023-11-07 13:09:56 +0900237
238 apexElfCheckerUnwantedRule = pctx.StaticRule("apexElfCheckerUnwantedRule", blueprint.RuleParams{
239 Command: `${apex_elf_checker} --tool_path ${tool_path} --unwanted ${unwanted} ${in} && touch ${out}`,
240 CommandDeps: []string{"${apex_elf_checker}", "${deapexer}", "${debugfs_static}", "${fsck_erofs}", "${config.ClangBin}/llvm-readelf"},
241 Description: "run apex_elf_checker --unwanted",
242 }, "tool_path", "unwanted")
Jiyong Park09d77522019-11-18 11:16:27 +0900243)
244
Jooyung Hana3fddf42024-09-03 13:22:21 +0900245func (a *apexBundle) buildAconfigFiles(ctx android.ModuleContext) []apexFile {
246 var aconfigFiles android.Paths
247 for _, file := range a.filesInfo {
248 if file.module == nil {
249 continue
250 }
251 if dep, ok := android.OtherModuleProvider(ctx, file.module, android.AconfigPropagatingProviderKey); ok {
252 if len(dep.AconfigFiles) > 0 && dep.AconfigFiles[ctx.ModuleName()] != nil {
253 aconfigFiles = append(aconfigFiles, dep.AconfigFiles[ctx.ModuleName()]...)
254 }
255 }
256
257 validationFlag := ctx.DeviceConfig().AconfigContainerValidation()
258 if validationFlag == "error" || validationFlag == "warning" {
259 android.VerifyAconfigBuildMode(ctx, ctx.ModuleName(), file.module, validationFlag == "error")
260 }
261 }
262 aconfigFiles = android.FirstUniquePaths(aconfigFiles)
263
264 var files []apexFile
265 if len(aconfigFiles) > 0 {
266 apexAconfigFile := android.PathForModuleOut(ctx, "aconfig_flags.pb")
267 ctx.Build(pctx, android.BuildParams{
268 Rule: aconfig.AllDeclarationsRule,
269 Inputs: aconfigFiles,
270 Output: apexAconfigFile,
271 Description: "combine_aconfig_declarations",
272 Args: map[string]string{
273 "cache_files": android.JoinPathsWithPrefix(aconfigFiles, "--cache "),
274 },
275 })
276 files = append(files, newApexFile(ctx, apexAconfigFile, "aconfig_flags", "etc", etc, nil))
277
Marybeth Fairc8c74d62024-12-04 14:22:40 -0500278 // To enable fingerprint, we need to have v2 storage files. The default version is 1.
279 storageFilesVersion := 1
280 if ctx.Config().ReleaseFingerprintAconfigPackages() {
281 storageFilesVersion = 2
282 }
283
Jooyung Hana3fddf42024-09-03 13:22:21 +0900284 for _, info := range createStorageInfo {
285 outputFile := android.PathForModuleOut(ctx, info.Output_file)
286 ctx.Build(pctx, android.BuildParams{
287 Rule: aconfig.CreateStorageRule,
288 Inputs: aconfigFiles,
289 Output: outputFile,
290 Description: info.Desc,
291 Args: map[string]string{
292 "container": ctx.ModuleName(),
293 "file_type": info.File_type,
294 "cache_files": android.JoinPathsWithPrefix(aconfigFiles, "--cache "),
Marybeth Fairc8c74d62024-12-04 14:22:40 -0500295 "version": strconv.Itoa(storageFilesVersion),
Jooyung Hana3fddf42024-09-03 13:22:21 +0900296 },
297 })
298 files = append(files, newApexFile(ctx, outputFile, info.File_type, "etc", etc, nil))
299 }
300 }
301 return files
302}
303
Jiyong Parkb81b9902020-11-24 19:51:18 +0900304// buildManifest creates buile rules to modify the input apex_manifest.json to add information
305// gathered by the build system such as provided/required native libraries. Two output files having
306// different formats are generated. a.manifestJsonOut is JSON format for Q devices, and
307// a.manifest.PbOut is protobuf format for R+ devices.
308// TODO(jiyong): make this to return paths instead of directly storing the paths to apexBundle
Jiyong Park09d77522019-11-18 11:16:27 +0900309func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900310 src := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json"))
Jiyong Park09d77522019-11-18 11:16:27 +0900311
Jiyong Parkb81b9902020-11-24 19:51:18 +0900312 // Put dependency({provide|require}NativeLibs) in apex_manifest.json
Jiyong Park09d77522019-11-18 11:16:27 +0900313 provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs)
314 requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs))
315
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900316 // VNDK APEX name is determined at runtime, so update "name" in apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900317 optCommands := []string{}
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900318 if a.vndkApex {
Kiyoung Kimfa13ff12024-03-18 16:01:19 +0900319 apexName := vndkApexNamePrefix + a.vndkVersion()
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900320 optCommands = append(optCommands, "-v name "+apexName)
Jiyong Park09d77522019-11-18 11:16:27 +0900321 }
322
Jiyong Parkb81b9902020-11-24 19:51:18 +0900323 // Collect jniLibs. Notice that a.filesInfo is already sorted
Jooyung Han643adc42020-02-27 13:50:06 +0900324 var jniLibs []string
325 for _, fi := range a.filesInfo {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900326 if fi.isJniLib && !android.InList(fi.stem(), jniLibs) {
327 jniLibs = append(jniLibs, fi.stem())
Jooyung Han643adc42020-02-27 13:50:06 +0900328 }
329 }
330 if len(jniLibs) > 0 {
331 optCommands = append(optCommands, "-a jniLibs "+strings.Join(jniLibs, " "))
332 }
333
Jooyung Hand045ebc2022-12-06 15:23:57 +0900334 if android.InList(":vndk", requireNativeLibs) {
Kiyoung Kim4e765b12024-04-04 17:33:42 +0900335 if _, vndkVersion := a.getImageVariationPair(); vndkVersion != "" {
Jooyung Hand045ebc2022-12-06 15:23:57 +0900336 optCommands = append(optCommands, "-v vndkVersion "+vndkVersion)
337 }
338 }
339
Jiyong Parkb81b9902020-11-24 19:51:18 +0900340 manifestJsonFullOut := android.PathForModuleOut(ctx, "apex_manifest_full.json")
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000341 defaultVersion := ctx.Config().ReleaseDefaultUpdatableModuleVersion()
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400342 if a.properties.Variant_version != nil {
343 defaultVersionInt, err := strconv.Atoi(defaultVersion)
344 if err != nil {
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000345 ctx.ModuleErrorf("expected RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION to be an int, but got %s", defaultVersion)
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400346 }
Alyssa Ketpreechasawat0c89ca32024-12-08 21:15:25 +0000347 if defaultVersionInt%10 != 0 && defaultVersionInt%10 != 9 {
348 ctx.ModuleErrorf("expected RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION to end in a zero or a nine, but got %s", defaultVersion)
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400349 }
350 variantVersion := []rune(*a.properties.Variant_version)
351 if len(variantVersion) != 1 || variantVersion[0] < '0' || variantVersion[0] > '9' {
352 ctx.PropertyErrorf("variant_version", "expected an integer between 0-9; got %s", *a.properties.Variant_version)
353 }
354 defaultVersionRunes := []rune(defaultVersion)
355 defaultVersionRunes[len(defaultVersion)-1] = []rune(variantVersion)[0]
356 defaultVersion = string(defaultVersionRunes)
357 }
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000358 if override := ctx.Config().Getenv("OVERRIDE_APEX_MANIFEST_DEFAULT_VERSION"); override != "" {
359 defaultVersion = override
360 }
Jiyong Park09d77522019-11-18 11:16:27 +0900361 ctx.Build(pctx, android.BuildParams{
362 Rule: apexManifestRule,
Alexei Nicoara0a389202022-07-12 14:35:39 +0100363 Input: src,
Jooyung Han214bf372019-11-12 13:03:50 +0900364 Output: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900365 Args: map[string]string{
366 "provideNativeLibs": strings.Join(provideNativeLibs, " "),
367 "requireNativeLibs": strings.Join(requireNativeLibs, " "),
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000368 "default_version": defaultVersion,
Jiyong Park09d77522019-11-18 11:16:27 +0900369 "opt": strings.Join(optCommands, " "),
370 },
371 })
372
Jiyong Parkb81b9902020-11-24 19:51:18 +0900373 // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json prepare
374 // stripped-down version so that APEX modules built from R+ can be installed to Q
Dan Albertc8060532020-07-22 22:32:17 -0700375 minSdkVersion := a.minSdkVersion(ctx)
376 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Jooyung Han214bf372019-11-12 13:03:50 +0900377 a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json")
378 ctx.Build(pctx, android.BuildParams{
379 Rule: stripApexManifestRule,
380 Input: manifestJsonFullOut,
381 Output: a.manifestJsonOut,
382 })
383 }
Jiyong Park09d77522019-11-18 11:16:27 +0900384
Jiyong Parkb81b9902020-11-24 19:51:18 +0900385 // From R+, protobuf binary format (.pb) is the standard format for apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900386 a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb")
387 ctx.Build(pctx, android.BuildParams{
388 Rule: pbApexManifestRule,
Jooyung Han214bf372019-11-12 13:03:50 +0900389 Input: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900390 Output: a.manifestPbOut,
391 })
392}
393
Jiyong Parkb81b9902020-11-24 19:51:18 +0900394// buildFileContexts create build rules to append an entry for apex_manifest.pb to the file_contexts
395// file for this APEX which is either from /systme/sepolicy/apex/<apexname>-file_contexts or from
396// the file_contexts property of this APEX. This is to make sure that the manifest file is correctly
Jooyung Hanbe953902023-05-31 16:42:16 +0900397// labeled as system_file or vendor_apex_metadata_file.
Cole Faust4e9f5922024-11-13 16:09:23 -0800398func (a *apexBundle) buildFileContexts(ctx android.ModuleContext) android.Path {
Jooyung Han580eb4f2020-06-24 19:33:06 +0900399 var fileContexts android.Path
Liz Kammer37997c42021-09-14 17:53:38 -0400400 var fileContextsDir string
Inseob Kim28d06d22023-11-17 18:04:42 +0900401 isFileContextsModule := false
Jooyung Han580eb4f2020-06-24 19:33:06 +0900402 if a.properties.File_contexts == nil {
403 fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
404 } else {
Liz Kammer37997c42021-09-14 17:53:38 -0400405 if m, t := android.SrcIsModuleWithTag(*a.properties.File_contexts); m != "" {
Inseob Kim28d06d22023-11-17 18:04:42 +0900406 isFileContextsModule = true
Yu Liud3228ac2024-11-08 23:11:47 +0000407 otherModule := android.GetModuleProxyFromPathDep(ctx, m, t)
408 if otherModule != nil {
409 fileContextsDir = ctx.OtherModuleDir(*otherModule)
410 }
Liz Kammer37997c42021-09-14 17:53:38 -0400411 }
Jooyung Han580eb4f2020-06-24 19:33:06 +0900412 fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
413 }
Liz Kammer37997c42021-09-14 17:53:38 -0400414 if fileContextsDir == "" {
415 fileContextsDir = filepath.Dir(fileContexts.String())
416 }
417 fileContextsDir += string(filepath.Separator)
418
Jooyung Han580eb4f2020-06-24 19:33:06 +0900419 if a.Platform() {
Liz Kammer37997c42021-09-14 17:53:38 -0400420 if !strings.HasPrefix(fileContextsDir, "system/sepolicy/") {
421 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but found in %q", fileContextsDir)
Jooyung Han580eb4f2020-06-24 19:33:06 +0900422 }
423 }
Inseob Kim28d06d22023-11-17 18:04:42 +0900424 if !isFileContextsModule && !android.ExistentPathForSource(ctx, fileContexts.String()).Valid() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900425 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", fileContexts.String())
Jooyung Han580eb4f2020-06-24 19:33:06 +0900426 }
427
Jooyung Hanaf730952023-02-28 14:13:38 +0900428 useFileContextsAsIs := proptools.Bool(a.properties.Use_file_contexts_as_is)
429
Jooyung Han580eb4f2020-06-24 19:33:06 +0900430 output := android.PathForModuleOut(ctx, "file_contexts")
Colin Crossf1a035e2020-11-16 17:32:30 -0800431 rule := android.NewRuleBuilder(pctx, ctx)
Jooyung Han7f146c02020-09-23 19:15:55 +0900432
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900433 labelForRoot := "u:object_r:system_file:s0"
434 labelForManifest := "u:object_r:system_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900435 if a.SocSpecific() && !a.vndkApex {
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900436 // APEX on /vendor should label ./ and ./apex_manifest.pb as vendor file.
437 labelForRoot = "u:object_r:vendor_file:s0"
438 labelForManifest = "u:object_r:vendor_apex_metadata_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900439 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900440 // remove old file
441 rule.Command().Text("rm").FlagWithOutput("-f ", output)
442 // copy file_contexts
443 rule.Command().Text("cat").Input(fileContexts).Text(">>").Output(output)
444 // new line
445 rule.Command().Text("echo").Text(">>").Output(output)
446 if !useFileContextsAsIs {
447 // force-label /apex_manifest.pb and /
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900448 rule.Command().Text("echo").Text("/apex_manifest\\\\.pb").Text(labelForManifest).Text(">>").Output(output)
449 rule.Command().Text("echo").Text("/").Text(labelForRoot).Text(">>").Output(output)
Jooyung Han7f146c02020-09-23 19:15:55 +0900450 }
451
Colin Crossf1a035e2020-11-16 17:32:30 -0800452 rule.Build("file_contexts."+a.Name(), "Generate file_contexts")
Cole Faust4e9f5922024-11-13 16:09:23 -0800453 return output
Jooyung Han580eb4f2020-06-24 19:33:06 +0900454}
455
Jiyong Parkb81b9902020-11-24 19:51:18 +0900456// buildInstalledFilesFile creates a build rule for the installed-files.txt file where the list of
457// files included in this APEX is shown. The text file is dist'ed so that people can see what's
458// included in the APEX without actually downloading and extracting it.
Cole Faust4e9f5922024-11-13 16:09:23 -0800459func (a *apexBundle) buildInstalledFilesFile(ctx android.ModuleContext, builtApex android.Path, imageDir android.Path) android.Path {
Jiyong Park3a1602e2020-01-14 14:39:19 +0900460 output := android.PathForModuleOut(ctx, "installed-files.txt")
Colin Crossf1a035e2020-11-16 17:32:30 -0800461 rule := android.NewRuleBuilder(pctx, ctx)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900462 rule.Command().
463 Implicit(builtApex).
464 Text("(cd " + imageDir.String() + " ; ").
Jiyong Parkbd63a102020-02-08 12:40:05 +0900465 Text("find . \\( -type f -o -type l \\) -printf \"%s %p\\n\") ").
Jiyong Park3a1602e2020-01-14 14:39:19 +0900466 Text(" | sort -nr > ").
467 Output(output)
Colin Crossf1a035e2020-11-16 17:32:30 -0800468 rule.Build("installed-files."+a.Name(), "Installed files")
Cole Faust4e9f5922024-11-13 16:09:23 -0800469 return output
Jiyong Park3a1602e2020-01-14 14:39:19 +0900470}
471
Jiyong Parkb81b9902020-11-24 19:51:18 +0900472// buildBundleConfig creates a build rule for the bundle config file that will control the bundle
473// creation process.
Cole Faust4e9f5922024-11-13 16:09:23 -0800474func (a *apexBundle) buildBundleConfig(ctx android.ModuleContext) android.Path {
Jiyong Parkbd159612020-02-28 15:22:21 +0900475 output := android.PathForModuleOut(ctx, "bundle_config.json")
476
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900477 type ApkConfig struct {
478 Package_name string `json:"package_name"`
479 Apk_path string `json:"path"`
480 }
Jiyong Parkbd159612020-02-28 15:22:21 +0900481 config := struct {
482 Compression struct {
483 Uncompressed_glob []string `json:"uncompressed_glob"`
484 } `json:"compression"`
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900485 Apex_config struct {
486 Apex_embedded_apk_config []ApkConfig `json:"apex_embedded_apk_config,omitempty"`
487 } `json:"apex_config,omitempty"`
Jiyong Parkbd159612020-02-28 15:22:21 +0900488 }{}
489
490 config.Compression.Uncompressed_glob = []string{
491 "apex_payload.img",
492 "apex_manifest.*",
493 }
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900494
Jiyong Parkb81b9902020-11-24 19:51:18 +0900495 // Collect the manifest names and paths of android apps if their manifest names are
496 // overridden.
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900497 for _, fi := range a.filesInfo {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700498 if fi.class != app && fi.class != appSet {
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900499 continue
500 }
501 packageName := fi.overriddenPackageName
502 if packageName != "" {
503 config.Apex_config.Apex_embedded_apk_config = append(
504 config.Apex_config.Apex_embedded_apk_config,
505 ApkConfig{
506 Package_name: packageName,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900507 Apk_path: fi.path(),
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900508 })
509 }
510 }
511
Jiyong Parkbd159612020-02-28 15:22:21 +0900512 j, err := json.Marshal(config)
513 if err != nil {
514 panic(fmt.Errorf("error while marshalling to %q: %#v", output, err))
515 }
516
Colin Crosscf371cc2020-11-13 11:48:42 -0800517 android.WriteFileRule(ctx, output, string(j))
Jiyong Parkbd159612020-02-28 15:22:21 +0900518
Cole Faust4e9f5922024-11-13 16:09:23 -0800519 return output
Jiyong Parkbd159612020-02-28 15:22:21 +0900520}
521
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000522func markManifestTestOnly(ctx android.ModuleContext, androidManifestFile android.Path) android.Path {
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000523 return java.ManifestFixer(ctx, androidManifestFile, java.ManifestFixerParams{
524 TestOnly: true,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000525 })
526}
527
Jooyung Han90934ac2023-09-22 14:52:06 +0900528func isVintfFragment(fi apexFile) bool {
Jooyung Han262f73c2024-03-28 11:29:47 +0900529 isVintfFragment, _ := path.Match("etc/vintf/*", fi.path())
Jooyung Han90934ac2023-09-22 14:52:06 +0900530 return isVintfFragment
531}
532
533func runAssembleVintf(ctx android.ModuleContext, vintfFragment android.Path) android.Path {
534 processed := android.PathForModuleOut(ctx, "vintf", vintfFragment.Base())
535 ctx.Build(pctx, android.BuildParams{
536 Rule: assembleVintfRule,
537 Input: vintfFragment,
538 Output: processed,
539 Description: "run assemble_vintf for VINTF in APEX",
540 })
541 return processed
542}
543
Jooyung Haneec1b3f2023-06-20 16:25:59 +0900544// buildApex creates build rules to build an APEX using apexer.
545func (a *apexBundle) buildApex(ctx android.ModuleContext) {
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900546 suffix := imageApexSuffix
Jooyung Han63dff462023-02-09 00:11:27 +0000547 apexName := a.BaseModuleName()
Jiyong Park09d77522019-11-18 11:16:27 +0900548
Jiyong Parkb81b9902020-11-24 19:51:18 +0900549 ////////////////////////////////////////////////////////////////////////////////////////////
550 // Step 1: copy built files to appropriate directories under the image directory
551
552 imageDir := android.PathForModuleOut(ctx, "image"+suffix)
553
Cole Faust74d243c2024-12-11 17:57:34 -0800554 installSymbolFiles := (ctx.Config().KatiEnabled() && a.ExportedToMake()) && a.installable()
Colin Cross6340ea52021-11-04 12:01:18 -0700555
Colin Cross4acaea92021-12-10 23:05:02 +0000556 // set of dependency module:location mappings
557 installMapSet := make(map[string]bool)
Colin Cross6340ea52021-11-04 12:01:18 -0700558
Jiyong Parkb81b9902020-11-24 19:51:18 +0900559 // TODO(jiyong): use the RuleBuilder
Jiyong Park7cd10e32020-01-14 09:22:18 +0900560 var copyCommands []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900561 var implicitInputs []android.Path
Jooyung Han63dff462023-02-09 00:11:27 +0000562 apexDir := android.PathForModuleInPartitionInstall(ctx, "apex", apexName)
Jiyong Park7cd10e32020-01-14 09:22:18 +0900563 for _, fi := range a.filesInfo {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900564 destPath := imageDir.Join(ctx, fi.path()).String()
Jiyong Parkb81b9902020-11-24 19:51:18 +0900565 // Prepare the destination path
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700566 destPathDir := filepath.Dir(destPath)
567 if fi.class == appSet {
568 copyCommands = append(copyCommands, "rm -rf "+destPathDir)
569 }
570 copyCommands = append(copyCommands, "mkdir -p "+destPathDir)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900571
Colin Cross4acaea92021-12-10 23:05:02 +0000572 installMapPath := fi.builtFile
573
Jiyong Parkb81b9902020-11-24 19:51:18 +0900574 // Copy the built file to the directory. But if the symlink optimization is turned
575 // on, place a symlink to the corresponding file in /system partition instead.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900576 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900577 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Jiyong Park7cd10e32020-01-14 09:22:18 +0900578 copyCommands = append(copyCommands, "ln -sfn "+pathOnDevice+" "+destPath)
579 } else {
Jiyong Park4169a252022-09-29 21:30:25 +0900580 // Copy the file into APEX
Jooyung Han90934ac2023-09-22 14:52:06 +0900581 if !a.testApex && isVintfFragment(fi) {
582 // copy the output of assemble_vintf instead of the original
583 vintfFragment := runAssembleVintf(ctx, fi.builtFile)
584 copyCommands = append(copyCommands, "cp -f "+vintfFragment.String()+" "+destPath)
585 implicitInputs = append(implicitInputs, vintfFragment)
586 } else {
587 copyCommands = append(copyCommands, "cp -f "+fi.builtFile.String()+" "+destPath)
588 implicitInputs = append(implicitInputs, fi.builtFile)
589 }
Jiyong Park4169a252022-09-29 21:30:25 +0900590
Colin Cross4acaea92021-12-10 23:05:02 +0000591 var installedPath android.InstallPath
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700592 if fi.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +0900593 // In case of AppSet, we need to copy additional APKs as well. They
594 // are zipped. So we need to unzip them.
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700595 copyCommands = append(copyCommands,
Colin Crossffbcd1d2021-11-12 12:19:42 -0800596 fmt.Sprintf("unzip -qDD -d %s %s", destPathDir,
597 fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs().String()))
Colin Cross6340ea52021-11-04 12:01:18 -0700598 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000599 installedPath = ctx.InstallFileWithExtraFilesZip(apexDir.Join(ctx, fi.installDir),
Colin Cross6340ea52021-11-04 12:01:18 -0700600 fi.stem(), fi.builtFile, fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs())
601 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700602 } else {
Colin Cross6340ea52021-11-04 12:01:18 -0700603 if installSymbolFiles {
Spandan Das72d86c62024-10-15 19:27:41 +0000604 // store installedPath. symlinks might be created if required.
605 installedPath = apexDir.Join(ctx, fi.installDir, fi.stem())
Colin Cross6340ea52021-11-04 12:01:18 -0700606 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700607 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900608
Colin Cross4acaea92021-12-10 23:05:02 +0000609 // Create additional symlinks pointing the file inside the APEX (if any). Note that
610 // this is independent from the symlink optimization.
611 for _, symlinkPath := range fi.symlinkPaths() {
612 symlinkDest := imageDir.Join(ctx, symlinkPath).String()
613 copyCommands = append(copyCommands, "ln -sfn "+filepath.Base(destPath)+" "+symlinkDest)
614 if installSymbolFiles {
Inseob Kim5bedfee2023-04-20 10:16:14 +0900615 ctx.InstallSymlink(apexDir.Join(ctx, filepath.Dir(symlinkPath)), filepath.Base(symlinkPath), installedPath)
Colin Cross4acaea92021-12-10 23:05:02 +0000616 }
Colin Cross6340ea52021-11-04 12:01:18 -0700617 }
Colin Cross4acaea92021-12-10 23:05:02 +0000618
619 installMapPath = installedPath
Jiyong Park7cd10e32020-01-14 09:22:18 +0900620 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900621
622 // Copy the test files (if any)
Liz Kammer1c14a212020-05-12 15:26:55 -0700623 for _, d := range fi.dataPaths {
624 // TODO(eakammer): This is now the third repetition of ~this logic for test paths, refactoring should be possible
Colin Crossd442a0e2023-11-16 11:19:26 -0800625 relPath := d.ToRelativeInstallPath()
626 dataDest := imageDir.Join(ctx, fi.apexRelativePath(relPath)).String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700627
Chris Parsons216e10a2020-07-09 17:12:52 -0400628 copyCommands = append(copyCommands, "cp -f "+d.SrcPath.String()+" "+dataDest)
629 implicitInputs = append(implicitInputs, d.SrcPath)
Liz Kammer1c14a212020-05-12 15:26:55 -0700630 }
Colin Cross4acaea92021-12-10 23:05:02 +0000631
632 installMapSet[installMapPath.String()+":"+fi.installDir+"/"+fi.builtFile.Base()] = true
Jiyong Park09d77522019-11-18 11:16:27 +0900633 }
Yu Liueae7b362023-11-16 17:05:47 -0800634
Jooyung Han214bf372019-11-12 13:03:50 +0900635 implicitInputs = append(implicitInputs, a.manifestPbOut)
Jiyong Park09d77522019-11-18 11:16:27 +0900636
Colin Cross4acaea92021-12-10 23:05:02 +0000637 if len(installMapSet) > 0 {
638 var installs []string
Cole Faust18994c72023-02-28 16:02:16 -0800639 installs = append(installs, android.SortedKeys(installMapSet)...)
Yu Liubad1eef2024-08-21 22:37:35 +0000640 ctx.SetLicenseInstallMap(installs)
Colin Cross4acaea92021-12-10 23:05:02 +0000641 }
642
Jiyong Parkb81b9902020-11-24 19:51:18 +0900643 ////////////////////////////////////////////////////////////////////////////////////////////
644 // Step 1.a: Write the list of files in this APEX to a txt file and compare it against
645 // the allowed list given via the allowed_files property. Build fails when the two lists
646 // differ.
647 //
648 // TODO(jiyong): consider removing this. Nobody other than com.android.apex.cts.shim.* seems
649 // to be using this at this moment. Furthermore, this looks very similar to what
650 // buildInstalledFilesFile does. At least, move this to somewhere else so that this doesn't
651 // hurt readability.
Jooyung Han938b5932020-06-20 12:47:47 +0900652 if a.overridableProperties.Allowed_files != nil {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900653 // Build content.txt
Cole Fausta7347492022-12-16 10:56:24 -0800654 var contentLines []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900655 imageContentFile := android.PathForModuleOut(ctx, "content.txt")
Cole Fausta7347492022-12-16 10:56:24 -0800656 contentLines = append(contentLines, "./apex_manifest.pb")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900657 minSdkVersion := a.minSdkVersion(ctx)
658 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Cole Fausta7347492022-12-16 10:56:24 -0800659 contentLines = append(contentLines, "./apex_manifest.json")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900660 }
661 for _, fi := range a.filesInfo {
Cole Fausta7347492022-12-16 10:56:24 -0800662 contentLines = append(contentLines, "./"+fi.path())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900663 }
Cole Fausta7347492022-12-16 10:56:24 -0800664 sort.Strings(contentLines)
665 android.WriteFileRule(ctx, imageContentFile, strings.Join(contentLines, "\n"))
Jiyong Park09d77522019-11-18 11:16:27 +0900666 implicitInputs = append(implicitInputs, imageContentFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900667
Jiyong Parkb81b9902020-11-24 19:51:18 +0900668 // Compare content.txt against allowed_files.
669 allowedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.overridableProperties.Allowed_files))
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800670 phonyOutput := android.PathForModuleOut(ctx, a.Name()+"-diff-phony-output")
Jiyong Park09d77522019-11-18 11:16:27 +0900671 ctx.Build(pctx, android.BuildParams{
672 Rule: diffApexContentRule,
673 Implicits: implicitInputs,
674 Output: phonyOutput,
675 Description: "diff apex image content",
676 Args: map[string]string{
Colin Cross440e0d02020-06-11 11:32:11 -0700677 "allowed_files_file": allowedFilesFile.String(),
678 "image_content_file": imageContentFile.String(),
679 "apex_module_name": a.Name(),
Jiyong Park09d77522019-11-18 11:16:27 +0900680 },
681 })
Jiyong Park09d77522019-11-18 11:16:27 +0900682 implicitInputs = append(implicitInputs, phonyOutput)
683 }
684
Jiyong Parkb81b9902020-11-24 19:51:18 +0900685 unsignedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix+".unsigned")
Colin Cross790ef352021-10-25 19:15:55 -0700686 outHostBinDir := ctx.Config().HostToolPath(ctx, "").String()
Jiyong Park09d77522019-11-18 11:16:27 +0900687 prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin")
688
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900689 ////////////////////////////////////////////////////////////////////////////////////
690 // Step 2: create canned_fs_config which encodes filemode,uid,gid of each files
691 // in this APEX. The file will be used by apexer in later steps.
Jooyung Hana3fddf42024-09-03 13:22:21 +0900692 cannedFsConfig := a.buildCannedFsConfig(ctx)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900693 implicitInputs = append(implicitInputs, cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +0900694
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900695 ////////////////////////////////////////////////////////////////////////////////////
696 // Step 3: Prepare option flags for apexer and invoke it to create an unsigned APEX.
697 // TODO(jiyong): use the RuleBuilder
698 optFlags := []string{}
Jiyong Park09d77522019-11-18 11:16:27 +0900699
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900700 fileContexts := a.buildFileContexts(ctx)
701 implicitInputs = append(implicitInputs, fileContexts)
Jiyong Park09d77522019-11-18 11:16:27 +0900702
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900703 implicitInputs = append(implicitInputs, a.privateKeyFile, a.publicKeyFile)
704 optFlags = append(optFlags, "--pubkey "+a.publicKeyFile.String())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900705
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900706 manifestPackageName := a.getOverrideManifestPackageName(ctx)
707 if manifestPackageName != "" {
708 optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName)
709 }
Jiyong Park09d77522019-11-18 11:16:27 +0900710
Cole Faustbf1d92a2024-07-29 12:24:25 -0700711 androidManifest := a.properties.AndroidManifest.GetOrDefault(ctx, "")
Inseob Kimb1142342024-07-23 13:39:54 +0900712 if androidManifest != "" {
713 androidManifestFile := android.PathForModuleSrc(ctx, androidManifest)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900714
715 if a.testApex {
716 androidManifestFile = markManifestTestOnly(ctx, androidManifestFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900717 }
718
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900719 implicitInputs = append(implicitInputs, androidManifestFile)
720 optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String())
721 } else if a.testApex {
722 optFlags = append(optFlags, "--test_only")
723 }
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000724
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900725 // Determine target/min sdk version from the context
726 // TODO(jiyong): make this as a function
727 moduleMinSdkVersion := a.minSdkVersion(ctx)
728 minSdkVersion := moduleMinSdkVersion.String()
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000729
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900730 // bundletool doesn't understand what "current" is. We need to transform it to
731 // codename
732 if moduleMinSdkVersion.IsCurrent() || moduleMinSdkVersion.IsNone() {
733 minSdkVersion = ctx.Config().DefaultAppTargetSdk(ctx).String()
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000734
Jihoon Kang842b9992024-02-08 01:41:51 +0000735 if useApiFingerprint, fingerprintMinSdkVersion, fingerprintDeps :=
736 java.UseApiFingerprint(ctx); useApiFingerprint {
737 minSdkVersion = fingerprintMinSdkVersion
738 implicitInputs = append(implicitInputs, fingerprintDeps)
Baligh Uddinf6201372020-01-24 23:15:44 +0000739 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900740 }
741 // apex module doesn't have a concept of target_sdk_version, hence for the time
742 // being targetSdkVersion == default targetSdkVersion of the branch.
743 targetSdkVersion := strconv.Itoa(ctx.Config().DefaultAppTargetSdk(ctx).FinalOrFutureInt())
Jiyong Park09d77522019-11-18 11:16:27 +0900744
Jihoon Kang842b9992024-02-08 01:41:51 +0000745 if useApiFingerprint, fingerprintTargetSdkVersion, fingerprintDeps :=
746 java.UseApiFingerprint(ctx); useApiFingerprint {
747 targetSdkVersion = fingerprintTargetSdkVersion
748 implicitInputs = append(implicitInputs, fingerprintDeps)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900749 }
750 optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion)
751 optFlags = append(optFlags, "--min_sdk_version "+minSdkVersion)
Baligh Uddin004d7172020-02-19 21:29:28 -0800752
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900753 if a.overridableProperties.Logging_parent != "" {
754 optFlags = append(optFlags, "--logging_parent ", a.overridableProperties.Logging_parent)
755 }
Jiyong Park09d77522019-11-18 11:16:27 +0900756
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900757 // Create a NOTICE file, and embed it as an asset file in the APEX.
758 htmlGzNotice := android.PathForModuleOut(ctx, "NOTICE.html.gz")
759 android.BuildNoticeHtmlOutputFromLicenseMetadata(
760 ctx, htmlGzNotice, "", "",
761 []string{
762 android.PathForModuleInstall(ctx).String() + "/",
763 android.PathForModuleInPartitionInstall(ctx, "apex").String() + "/",
Jiyong Park09d77522019-11-18 11:16:27 +0900764 })
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900765 noticeAssetPath := android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
766 builder := android.NewRuleBuilder(pctx, ctx)
767 builder.Command().Text("cp").
768 Input(htmlGzNotice).
769 Output(noticeAssetPath)
770 builder.Build("notice_dir", "Building notice dir")
771 implicitInputs = append(implicitInputs, noticeAssetPath)
772 optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeAssetPath.String()))
Jiyong Park09d77522019-11-18 11:16:27 +0900773
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900774 // Apexes which are supposed to be installed in builtin dirs(/system, etc)
775 // don't need hashtree for activation. Therefore, by removing hashtree from
776 // apex bundle (filesystem image in it, to be specific), we can save storage.
777 needHashTree := moduleMinSdkVersion.LessThanOrEqualTo(android.SdkVersion_Android10) ||
778 a.shouldGenerateHashtree()
779 if ctx.Config().ApexCompressionEnabled() && a.isCompressable() {
780 needHashTree = true
781 }
782 if !needHashTree {
783 optFlags = append(optFlags, "--no_hashtree")
784 }
sophiezc80a2b32020-11-12 16:39:19 +0000785
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900786 if a.testOnlyShouldSkipPayloadSign() {
787 optFlags = append(optFlags, "--unsigned_payload")
788 }
789
790 if moduleMinSdkVersion == android.SdkVersion_Android10 {
791 implicitInputs = append(implicitInputs, a.manifestJsonOut)
792 optFlags = append(optFlags, "--manifest_json "+a.manifestJsonOut.String())
793 }
794
795 optFlags = append(optFlags, "--payload_fs_type "+a.payloadFsType.string())
796
797 if a.dynamic_common_lib_apex() {
sophiezc80a2b32020-11-12 16:39:19 +0000798 ctx.Build(pctx, android.BuildParams{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900799 Rule: DCLAApexRule,
Jiyong Park09d77522019-11-18 11:16:27 +0900800 Implicits: implicitInputs,
801 Output: unsignedOutputFile,
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900802 Description: "apex",
Jiyong Park09d77522019-11-18 11:16:27 +0900803 Args: map[string]string{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900804 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
805 "image_dir": imageDir.String(),
806 "copy_commands": strings.Join(copyCommands, " && "),
807 "manifest": a.manifestPbOut.String(),
808 "file_contexts": fileContexts.String(),
809 "canned_fs_config": cannedFsConfig.String(),
810 "key": a.privateKeyFile.String(),
811 "opt_flags": strings.Join(optFlags, " "),
812 },
813 })
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900814 } else {
815 ctx.Build(pctx, android.BuildParams{
816 Rule: apexRule,
817 Implicits: implicitInputs,
818 Output: unsignedOutputFile,
819 Description: "apex",
820 Args: map[string]string{
821 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
822 "image_dir": imageDir.String(),
823 "copy_commands": strings.Join(copyCommands, " && "),
824 "manifest": a.manifestPbOut.String(),
825 "file_contexts": fileContexts.String(),
826 "canned_fs_config": cannedFsConfig.String(),
827 "key": a.privateKeyFile.String(),
828 "opt_flags": strings.Join(optFlags, " "),
Jiyong Park09d77522019-11-18 11:16:27 +0900829 },
830 })
831 }
832
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900833 // TODO(jiyong): make the two rules below as separate functions
834 apexProtoFile := android.PathForModuleOut(ctx, a.Name()+".pb"+suffix)
835 bundleModuleFile := android.PathForModuleOut(ctx, a.Name()+suffix+"-base.zip")
836 a.bundleModuleFile = bundleModuleFile
837
838 ctx.Build(pctx, android.BuildParams{
839 Rule: apexProtoConvertRule,
840 Input: unsignedOutputFile,
841 Output: apexProtoFile,
842 Description: "apex proto convert",
843 })
844
845 implicitInputs = append(implicitInputs, unsignedOutputFile)
846
847 // Run coverage analysis
848 apisUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.txt")
849 ctx.Build(pctx, android.BuildParams{
850 Rule: generateAPIsUsedbyApexRule,
851 Implicits: implicitInputs,
852 Description: "coverage",
853 Output: apisUsedbyOutputFile,
854 Args: map[string]string{
855 "image_dir": imageDir.String(),
856 "readelf": "${config.ClangBin}/llvm-readelf",
857 },
858 })
859 a.nativeApisUsedByModuleFile = apisUsedbyOutputFile
860
861 var nativeLibNames []string
862 for _, f := range a.filesInfo {
863 if f.class == nativeSharedLib {
864 nativeLibNames = append(nativeLibNames, f.stem())
865 }
866 }
867 apisBackedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_backing.txt")
868 rb := android.NewRuleBuilder(pctx, ctx)
869 rb.Command().
870 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_ndk_backedby_apex.sh")).
871 Output(apisBackedbyOutputFile).
872 Flags(nativeLibNames)
873 rb.Build("ndk_backedby_list", "Generate API libraries backed by Apex")
874 a.nativeApisBackedByModuleFile = apisBackedbyOutputFile
875
876 var javaLibOrApkPath []android.Path
877 for _, f := range a.filesInfo {
878 if f.class == javaSharedLib || f.class == app {
879 javaLibOrApkPath = append(javaLibOrApkPath, f.builtFile)
880 }
881 }
882 javaApiUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.xml")
883 javaUsedByRule := android.NewRuleBuilder(pctx, ctx)
884 javaUsedByRule.Command().
885 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_java_usedby_apex.sh")).
886 BuiltTool("dexdeps").
887 Output(javaApiUsedbyOutputFile).
888 Inputs(javaLibOrApkPath)
889 javaUsedByRule.Build("java_usedby_list", "Generate Java APIs used by Apex")
890 a.javaApisUsedByModuleFile = javaApiUsedbyOutputFile
891
892 bundleConfig := a.buildBundleConfig(ctx)
893
894 var abis []string
895 for _, target := range ctx.MultiTargets() {
896 if len(target.Arch.Abi) > 0 {
897 abis = append(abis, target.Arch.Abi[0])
898 }
899 }
900
901 abis = android.FirstUniqueStrings(abis)
902
903 ctx.Build(pctx, android.BuildParams{
904 Rule: apexBundleRule,
905 Input: apexProtoFile,
906 Implicit: bundleConfig,
907 Output: a.bundleModuleFile,
908 Description: "apex bundle module",
909 Args: map[string]string{
910 "abi": strings.Join(abis, "."),
911 "config": bundleConfig.String(),
912 },
913 })
914
Jiyong Parkb81b9902020-11-24 19:51:18 +0900915 ////////////////////////////////////////////////////////////////////////////////////
916 // Step 4: Sign the APEX using signapk
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000917 signedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900918
919 pem, key := a.getCertificateAndPrivateKey(ctx)
Kousik Kumar309b1c02020-05-28 06:13:33 -0700920 rule := java.Signapk
921 args := map[string]string{
Jiyong Parkb81b9902020-11-24 19:51:18 +0900922 "certificates": pem.String() + " " + key.String(),
Jooyung Han5d00f502021-07-11 07:26:22 +0900923 "flags": "-a 4096 --align-file-size", //alignment
Kousik Kumar309b1c02020-05-28 06:13:33 -0700924 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900925 implicits := android.Paths{pem, key}
Ramy Medhat16f23a42020-09-03 01:29:49 -0400926 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
Kousik Kumar309b1c02020-05-28 06:13:33 -0700927 rule = java.SignapkRE
928 args["implicits"] = strings.Join(implicits.Strings(), ",")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000929 args["outCommaList"] = signedOutputFile.String()
Kousik Kumar309b1c02020-05-28 06:13:33 -0700930 }
Jooyung Han01f5d652023-04-05 16:29:26 +0900931 var validations android.Paths
Cole Faust4e9f5922024-11-13 16:09:23 -0800932 validations = append(validations, runApexLinkerconfigValidation(ctx, unsignedOutputFile, imageDir))
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900933 // TODO(b/279688635) deapexer supports [ext4]
Jooyung Hanb9518072024-11-22 14:05:20 +0900934 if !a.skipValidation(apexSepolicyTests) && suffix == imageApexSuffix && ext4 == a.payloadFsType {
Cole Faust4e9f5922024-11-13 16:09:23 -0800935 validations = append(validations, runApexSepolicyTests(ctx, unsignedOutputFile))
Jooyung Han01f5d652023-04-05 16:29:26 +0900936 }
Jooyung Han55a73062023-11-07 13:09:56 +0900937 if !a.testApex && len(a.properties.Unwanted_transitive_deps) > 0 {
938 validations = append(validations,
Cole Faust4e9f5922024-11-13 16:09:23 -0800939 runApexElfCheckerUnwanted(ctx, unsignedOutputFile, a.properties.Unwanted_transitive_deps))
Jooyung Han55a73062023-11-07 13:09:56 +0900940 }
Jooyung Hanb9518072024-11-22 14:05:20 +0900941 if !a.skipValidation(hostApexVerifier) && android.InList(a.payloadFsType, []fsType{ext4, erofs}) {
Cole Faust4e9f5922024-11-13 16:09:23 -0800942 validations = append(validations, runApexHostVerifier(ctx, a, unsignedOutputFile))
Jooyung Han2adba482024-02-22 17:27:53 +0900943 }
Jiyong Park09d77522019-11-18 11:16:27 +0900944 ctx.Build(pctx, android.BuildParams{
Kousik Kumar309b1c02020-05-28 06:13:33 -0700945 Rule: rule,
Jiyong Park09d77522019-11-18 11:16:27 +0900946 Description: "signapk",
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000947 Output: signedOutputFile,
Jiyong Park09d77522019-11-18 11:16:27 +0900948 Input: unsignedOutputFile,
Kousik Kumar309b1c02020-05-28 06:13:33 -0700949 Implicits: implicits,
950 Args: args,
Jooyung Han01f5d652023-04-05 16:29:26 +0900951 Validations: validations,
Jiyong Park09d77522019-11-18 11:16:27 +0900952 })
Jooyung Hana6d36672022-02-24 13:58:07 +0900953 if suffix == imageApexSuffix {
954 a.outputApexFile = signedOutputFile
955 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000956 a.outputFile = signedOutputFile
957
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +0000958 if ctx.ModuleDir() != "system/apex/apexd/apexd_testdata" && a.testOnlyShouldForceCompression() {
959 ctx.PropertyErrorf("test_only_force_compression", "not available")
960 return
961 }
Nikita Ioffebc035882021-04-14 21:35:24 +0100962
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700963 installSuffix := suffix
964 a.setCompression(ctx)
965 if a.isCompressed {
Samiul Islam7c02e262021-09-08 17:48:28 +0100966 unsignedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix+".unsigned")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000967
968 compressRule := android.NewRuleBuilder(pctx, ctx)
969 compressRule.Command().
970 Text("rm").
971 FlagWithOutput("-f ", unsignedCompressedOutputFile)
972 compressRule.Command().
973 BuiltTool("apex_compression_tool").
974 Flag("compress").
975 FlagWithArg("--apex_compression_tool ", outHostBinDir+":"+prebuiltSdkToolsBinDir).
976 FlagWithInput("--input ", signedOutputFile).
977 FlagWithOutput("--output ", unsignedCompressedOutputFile)
978 compressRule.Build("compressRule", "Generate unsigned compressed APEX file")
979
Samiul Islam7c02e262021-09-08 17:48:28 +0100980 signedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix)
Mohammad Samiul Islam9ac0e322021-01-19 11:32:29 +0000981 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
982 args["outCommaList"] = signedCompressedOutputFile.String()
983 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000984 ctx.Build(pctx, android.BuildParams{
985 Rule: rule,
986 Description: "sign compressedApex",
987 Output: signedCompressedOutputFile,
988 Input: unsignedCompressedOutputFile,
989 Implicits: implicits,
990 Args: args,
991 })
992 a.outputFile = signedCompressedOutputFile
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000993 installSuffix = imageCapexSuffix
994 }
995
Colin Crossd9ccb6a2022-03-07 18:38:34 -0800996 if !a.installable() {
997 a.SkipInstall()
998 }
999
Jiyong Park17ff2832021-09-27 12:50:30 +09001000 // Install to $OUT/soong/{target,host}/.../apex.
Martin Stjernholm8a3c9142022-07-26 09:35:39 +00001001 a.installedFile = ctx.InstallFile(a.installDir, a.Name()+installSuffix, a.outputFile,
Colin Cross09ad3a62023-11-15 12:29:33 -08001002 a.compatSymlinks...)
Jiyong Park3a1602e2020-01-14 14:39:19 +09001003
1004 // installed-files.txt is dist'ed
1005 a.installedFilesFile = a.buildInstalledFilesFile(ctx, a.outputFile, imageDir)
Jooyung Han286957d2023-10-30 16:17:56 +09001006
1007 a.apexKeysPath = writeApexKeys(ctx, a)
Jiyong Park09d77522019-11-18 11:16:27 +09001008}
1009
Jiyong Parkb81b9902020-11-24 19:51:18 +09001010// getCertificateAndPrivateKey retrieves the cert and the private key that will be used to sign
1011// the zip container of this APEX. See the description of the 'certificate' property for how
1012// the cert and the private key are found.
1013func (a *apexBundle) getCertificateAndPrivateKey(ctx android.PathContext) (pem, key android.Path) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001014 if a.containerCertificateFile != nil {
1015 return a.containerCertificateFile, a.containerPrivateKeyFile
Jiyong Parkb81b9902020-11-24 19:51:18 +09001016 }
1017
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -07001018 cert := String(a.overridableProperties.Certificate)
Jiyong Parkb81b9902020-11-24 19:51:18 +09001019 if cert == "" {
1020 return ctx.Config().DefaultAppCertificate(ctx)
1021 }
1022
1023 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
1024 pem = defaultDir.Join(ctx, cert+".x509.pem")
1025 key = defaultDir.Join(ctx, cert+".pk8")
1026 return pem, key
Jiyong Park09d77522019-11-18 11:16:27 +09001027}
Jooyung Han27151d92019-12-16 17:45:32 +09001028
1029func (a *apexBundle) getOverrideManifestPackageName(ctx android.ModuleContext) string {
1030 // For VNDK APEXes, check "com.android.vndk" in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
1031 // to see if it should be overridden because their <apex name> is dynamically generated
1032 // according to its VNDK version.
1033 if a.vndkApex {
1034 overrideName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(vndkApexName)
1035 if overridden {
Kiyoung Kimfa13ff12024-03-18 16:01:19 +09001036 return overrideName + ".v" + a.vndkVersion()
Jooyung Han27151d92019-12-16 17:45:32 +09001037 }
1038 return ""
1039 }
Cole Faust12f6ec92024-10-03 13:32:43 -07001040 packageNameFromProp := a.overridableProperties.Package_name.GetOrDefault(ctx, "")
1041 if packageNameFromProp != "" {
1042 return packageNameFromProp
Baligh Uddin5b57dba2020-03-15 13:01:05 -07001043 }
Jiyong Park20bacab2020-03-03 11:45:41 +09001044 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jooyung Han27151d92019-12-16 17:45:32 +09001045 if overridden {
1046 return manifestPackageName
1047 }
1048 return ""
1049}
Jiyong Park83dc74b2020-01-14 18:38:44 +09001050
1051func (a *apexBundle) buildApexDependencyInfo(ctx android.ModuleContext) {
Jiyong Park83dc74b2020-01-14 18:38:44 +09001052 if a.properties.IsCoverageVariant {
1053 // Otherwise, we will have duplicated rules for coverage and
1054 // non-coverage variants of the same APEX
1055 return
1056 }
1057
Artur Satayev872a1442020-04-27 17:08:37 +01001058 depInfos := android.DepNameToDepInfoMap{}
Yu Liu8f2c5c02024-12-06 00:40:39 +00001059 a.WalkPayloadDepsProxy(ctx, func(ctx android.BaseModuleContext, from, to android.ModuleProxy, externalDep bool) bool {
Artur Satayev872a1442020-04-27 17:08:37 +01001060 if from.Name() == to.Name() {
1061 // This can happen for cc.reuseObjTag. We are not interested in tracking this.
1062 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1063 return !externalDep
Jiyong Park678c8812020-02-07 17:25:49 +09001064 }
Jiyong Park83dc74b2020-01-14 18:38:44 +09001065
Artur Satayev533b98c2021-03-11 18:03:42 +00001066 // Skip dependencies that are only available to APEXes; they are developed with updatability
1067 // in mind and don't need manual approval.
Yu Liu8f2c5c02024-12-06 00:40:39 +00001068 if android.OtherModuleProviderOrDefault(ctx, to, android.CommonModuleInfoKey).NotAvailableForPlatform {
Artur Satayev533b98c2021-03-11 18:03:42 +00001069 return !externalDep
1070 }
1071
Cindy Zhou18417cb2020-12-10 07:12:38 -08001072 depTag := ctx.OtherModuleDependencyTag(to)
Artur Satayev533b98c2021-03-11 18:03:42 +00001073 // Check to see if dependency been marked to skip the dependency check
Cindy Zhou18417cb2020-12-10 07:12:38 -08001074 if skipDepCheck, ok := depTag.(android.SkipApexAllowedDependenciesCheck); ok && skipDepCheck.SkipApexAllowedDependenciesCheck() {
Cindy Zhou18417cb2020-12-10 07:12:38 -08001075 return !externalDep
1076 }
1077
Artur Satayev872a1442020-04-27 17:08:37 +01001078 if info, exists := depInfos[to.Name()]; exists {
1079 if !android.InList(from.Name(), info.From) {
1080 info.From = append(info.From, from.Name())
1081 }
1082 info.IsExternal = info.IsExternal && externalDep
1083 depInfos[to.Name()] = info
1084 } else {
Artur Satayev480e25b2020-04-27 18:53:18 +01001085 toMinSdkVersion := "(no version)"
Yu Liu8f2c5c02024-12-06 00:40:39 +00001086 if info, ok := android.OtherModuleProvider(ctx, to, android.CommonModuleInfoKey); ok {
1087 if v := info.MinSdkVersion; v != "" {
Artur Satayev480e25b2020-04-27 18:53:18 +01001088 toMinSdkVersion = v
1089 }
1090 }
Artur Satayev872a1442020-04-27 17:08:37 +01001091 depInfos[to.Name()] = android.ApexModuleDepInfo{
Artur Satayev480e25b2020-04-27 18:53:18 +01001092 To: to.Name(),
1093 From: []string{from.Name()},
1094 IsExternal: externalDep,
1095 MinSdkVersion: toMinSdkVersion,
Artur Satayev872a1442020-04-27 17:08:37 +01001096 }
1097 }
1098
1099 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1100 return !externalDep
Jiyong Park83dc74b2020-01-14 18:38:44 +09001101 })
1102
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001103 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depInfos)
Artur Satayev872a1442020-04-27 17:08:37 +01001104
Jiyong Park83dc74b2020-01-14 18:38:44 +09001105 ctx.Build(pctx, android.BuildParams{
1106 Rule: android.Phony,
1107 Output: android.PathForPhony(ctx, a.Name()+"-deps-info"),
Artur Satayeva8bd1132020-04-27 18:07:06 +01001108 Inputs: []android.Path{
1109 a.ApexBundleDepsInfo.FullListPath(),
1110 a.ApexBundleDepsInfo.FlatListPath(),
1111 },
Jiyong Park83dc74b2020-01-14 18:38:44 +09001112 })
1113}
Colin Cross08dca382020-07-21 20:31:17 -07001114
1115func (a *apexBundle) buildLintReports(ctx android.ModuleContext) {
1116 depSetsBuilder := java.NewLintDepSetBuilder()
1117 for _, fi := range a.filesInfo {
Colin Crossb79aa8f2024-09-25 15:41:01 -07001118 if fi.lintInfo != nil {
1119 depSetsBuilder.Transitive(fi.lintInfo)
1120 }
Colin Cross08dca382020-07-21 20:31:17 -07001121 }
1122
Colin Cross87427352024-09-25 15:41:19 -07001123 depSets := depSetsBuilder.Build()
1124 var validations android.Paths
1125
1126 if a.checkStrictUpdatabilityLinting(ctx) {
1127 baselines := depSets.Baseline.ToList()
1128 if len(baselines) > 0 {
1129 outputFile := java.VerifyStrictUpdatabilityChecks(ctx, baselines)
1130 validations = append(validations, outputFile)
1131 }
1132 }
1133
1134 a.lintReports = java.BuildModuleLintReportZips(ctx, depSets, validations)
Colin Cross08dca382020-07-21 20:31:17 -07001135}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001136
Cole Faust4e9f5922024-11-13 16:09:23 -08001137func (a *apexBundle) buildCannedFsConfig(ctx android.ModuleContext) android.Path {
Jooyung Hana3fddf42024-09-03 13:22:21 +09001138 var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001139 var executablePaths []string // this also includes dirs
1140 var appSetDirs []string
1141 appSetFiles := make(map[string]android.Path)
1142 for _, f := range a.filesInfo {
1143 pathInApex := f.path()
1144 if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") {
1145 executablePaths = append(executablePaths, pathInApex)
1146 for _, d := range f.dataPaths {
Colin Crossd442a0e2023-11-16 11:19:26 -08001147 rel := d.ToRelativeInstallPath()
1148 readOnlyPaths = append(readOnlyPaths, filepath.Join(f.installDir, rel))
Jiyong Park1b0893e2021-12-13 23:40:17 +09001149 }
1150 for _, s := range f.symlinks {
1151 executablePaths = append(executablePaths, filepath.Join(f.installDir, s))
1152 }
1153 } else if f.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +09001154 // base APK
1155 readOnlyPaths = append(readOnlyPaths, pathInApex)
1156 // Additional APKs
Jiyong Park1b0893e2021-12-13 23:40:17 +09001157 appSetDirs = append(appSetDirs, f.installDir)
Jiyong Parke1b69142022-09-26 14:48:56 +09001158 appSetFiles[f.installDir] = f.module.(*java.AndroidAppSet).PackedAdditionalOutputs()
Jiyong Park1b0893e2021-12-13 23:40:17 +09001159 } else {
1160 readOnlyPaths = append(readOnlyPaths, pathInApex)
1161 }
1162 dir := f.installDir
1163 for !android.InList(dir, executablePaths) && dir != "" {
1164 executablePaths = append(executablePaths, dir)
1165 dir, _ = filepath.Split(dir) // move up to the parent
1166 if len(dir) > 0 {
1167 // remove trailing slash
1168 dir = dir[:len(dir)-1]
1169 }
1170 }
1171 }
1172 sort.Strings(readOnlyPaths)
1173 sort.Strings(executablePaths)
1174 sort.Strings(appSetDirs)
1175
1176 cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config")
1177 builder := android.NewRuleBuilder(pctx, ctx)
1178 cmd := builder.Command()
1179 cmd.Text("(")
1180 cmd.Text("echo '/ 1000 1000 0755';")
1181 for _, p := range readOnlyPaths {
1182 cmd.Textf("echo '/%s 1000 1000 0644';", p)
1183 }
1184 for _, p := range executablePaths {
1185 cmd.Textf("echo '/%s 0 2000 0755';", p)
1186 }
1187 for _, dir := range appSetDirs {
1188 cmd.Textf("echo '/%s 0 2000 0755';", dir)
1189 file := appSetFiles[dir]
1190 cmd.Text("zipinfo -1").Input(file).Textf(`| sed "s:\(.*\):/%s/\1 1000 1000 0644:";`, dir)
1191 }
Jiyong Park038e8522021-12-13 23:56:35 +09001192 // Custom fs_config is "appended" to the last so that entries from the file are preferred
1193 // over default ones set above.
Cole Faustbf1d92a2024-07-29 12:24:25 -07001194 customFsConfig := a.properties.Canned_fs_config.GetOrDefault(ctx, "")
Inseob Kimb1142342024-07-23 13:39:54 +09001195 if customFsConfig != "" {
1196 cmd.Text("cat").Input(android.PathForModuleSrc(ctx, customFsConfig))
Jiyong Park038e8522021-12-13 23:56:35 +09001197 }
Maciej Żenczykowski67e2f792023-03-27 07:03:43 +00001198 cmd.Text(")").FlagWithOutput("> ", cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +09001199 builder.Build("generateFsConfig", fmt.Sprintf("Generating canned fs config for %s", a.BaseModuleName()))
1200
Cole Faust4e9f5922024-11-13 16:09:23 -08001201 return cannedFsConfig
Jiyong Park1b0893e2021-12-13 23:40:17 +09001202}
Jooyung Han01f5d652023-04-05 16:29:26 +09001203
Cole Faust4e9f5922024-11-13 16:09:23 -08001204func runApexLinkerconfigValidation(ctx android.ModuleContext, apexFile android.Path, imageDir android.Path) android.Path {
Jooyung Han4bc10262023-09-08 11:51:45 +09001205 timestamp := android.PathForModuleOut(ctx, "apex_linkerconfig_validation.timestamp")
1206 ctx.Build(pctx, android.BuildParams{
1207 Rule: apexLinkerconfigValidationRule,
1208 Input: apexFile,
1209 Output: timestamp,
1210 Args: map[string]string{
1211 "image_dir": imageDir.String(),
1212 },
1213 })
1214 return timestamp
1215}
1216
Jooyung Han01f5d652023-04-05 16:29:26 +09001217// Runs apex_sepolicy_tests
1218//
1219// $ deapexer list -Z {apex_file} > {file_contexts}
1220// $ apex_sepolicy_tests -f {file_contexts}
Cole Faust4e9f5922024-11-13 16:09:23 -08001221func runApexSepolicyTests(ctx android.ModuleContext, apexFile android.Path) android.Path {
Jooyung Hanb9518072024-11-22 14:05:20 +09001222 timestamp := android.PathForModuleOut(ctx, "apex_sepolicy_tests.timestamp")
Jooyung Han01f5d652023-04-05 16:29:26 +09001223 ctx.Build(pctx, android.BuildParams{
1224 Rule: apexSepolicyTestsRule,
1225 Input: apexFile,
1226 Output: timestamp,
1227 })
1228 return timestamp
1229}
Jooyung Han55a73062023-11-07 13:09:56 +09001230
Cole Faust4e9f5922024-11-13 16:09:23 -08001231func runApexElfCheckerUnwanted(ctx android.ModuleContext, apexFile android.Path, unwanted []string) android.Path {
Jooyung Han55a73062023-11-07 13:09:56 +09001232 timestamp := android.PathForModuleOut(ctx, "apex_elf_unwanted.timestamp")
1233 ctx.Build(pctx, android.BuildParams{
1234 Rule: apexElfCheckerUnwantedRule,
1235 Input: apexFile,
1236 Output: timestamp,
1237 Args: map[string]string{
1238 "unwanted": android.JoinWithSuffixAndSeparator(unwanted, ".so", ":"),
1239 "tool_path": ctx.Config().HostToolPath(ctx, "").String() + ":${config.ClangBin}",
1240 },
1241 })
1242 return timestamp
1243}
Jooyung Han2adba482024-02-22 17:27:53 +09001244
Cole Faust4e9f5922024-11-13 16:09:23 -08001245func runApexHostVerifier(ctx android.ModuleContext, a *apexBundle, apexFile android.Path) android.Path {
Jooyung Han2adba482024-02-22 17:27:53 +09001246 timestamp := android.PathForModuleOut(ctx, "host_apex_verifier.timestamp")
1247 ctx.Build(pctx, android.BuildParams{
1248 Rule: apexHostVerifierRule,
1249 Input: apexFile,
1250 Output: timestamp,
Jooyung Hanb6ac8222024-10-14 18:20:14 +09001251 Args: map[string]string{
1252 "partition_tag": a.PartitionTag(ctx.DeviceConfig()),
1253 },
Jooyung Han2adba482024-02-22 17:27:53 +09001254 })
1255 return timestamp
1256}