blob: 4585cbbe3526a548267c2b5f69e1fa948d60bee3 [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} || (` +
Jiyong Park09d77522019-11-18 11:16:27 +0900199 `echo -e "New unexpected files were added to ${apex_module_name}." ` +
200 ` "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
278 for _, info := range createStorageInfo {
279 outputFile := android.PathForModuleOut(ctx, info.Output_file)
280 ctx.Build(pctx, android.BuildParams{
281 Rule: aconfig.CreateStorageRule,
282 Inputs: aconfigFiles,
283 Output: outputFile,
284 Description: info.Desc,
285 Args: map[string]string{
286 "container": ctx.ModuleName(),
287 "file_type": info.File_type,
288 "cache_files": android.JoinPathsWithPrefix(aconfigFiles, "--cache "),
289 },
290 })
291 files = append(files, newApexFile(ctx, outputFile, info.File_type, "etc", etc, nil))
292 }
293 }
294 return files
295}
296
Jiyong Parkb81b9902020-11-24 19:51:18 +0900297// buildManifest creates buile rules to modify the input apex_manifest.json to add information
298// gathered by the build system such as provided/required native libraries. Two output files having
299// different formats are generated. a.manifestJsonOut is JSON format for Q devices, and
300// a.manifest.PbOut is protobuf format for R+ devices.
301// TODO(jiyong): make this to return paths instead of directly storing the paths to apexBundle
Jiyong Park09d77522019-11-18 11:16:27 +0900302func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900303 src := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json"))
Jiyong Park09d77522019-11-18 11:16:27 +0900304
Jiyong Parkb81b9902020-11-24 19:51:18 +0900305 // Put dependency({provide|require}NativeLibs) in apex_manifest.json
Jiyong Park09d77522019-11-18 11:16:27 +0900306 provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs)
307 requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs))
308
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900309 // VNDK APEX name is determined at runtime, so update "name" in apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900310 optCommands := []string{}
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900311 if a.vndkApex {
Kiyoung Kimfa13ff12024-03-18 16:01:19 +0900312 apexName := vndkApexNamePrefix + a.vndkVersion()
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900313 optCommands = append(optCommands, "-v name "+apexName)
Jiyong Park09d77522019-11-18 11:16:27 +0900314 }
315
Jiyong Parkb81b9902020-11-24 19:51:18 +0900316 // Collect jniLibs. Notice that a.filesInfo is already sorted
Jooyung Han643adc42020-02-27 13:50:06 +0900317 var jniLibs []string
318 for _, fi := range a.filesInfo {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900319 if fi.isJniLib && !android.InList(fi.stem(), jniLibs) {
320 jniLibs = append(jniLibs, fi.stem())
Jooyung Han643adc42020-02-27 13:50:06 +0900321 }
322 }
323 if len(jniLibs) > 0 {
324 optCommands = append(optCommands, "-a jniLibs "+strings.Join(jniLibs, " "))
325 }
326
Jooyung Hand045ebc2022-12-06 15:23:57 +0900327 if android.InList(":vndk", requireNativeLibs) {
Kiyoung Kim4e765b12024-04-04 17:33:42 +0900328 if _, vndkVersion := a.getImageVariationPair(); vndkVersion != "" {
Jooyung Hand045ebc2022-12-06 15:23:57 +0900329 optCommands = append(optCommands, "-v vndkVersion "+vndkVersion)
330 }
331 }
332
Jiyong Parkb81b9902020-11-24 19:51:18 +0900333 manifestJsonFullOut := android.PathForModuleOut(ctx, "apex_manifest_full.json")
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000334 defaultVersion := ctx.Config().ReleaseDefaultUpdatableModuleVersion()
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400335 if a.properties.Variant_version != nil {
336 defaultVersionInt, err := strconv.Atoi(defaultVersion)
337 if err != nil {
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000338 ctx.ModuleErrorf("expected RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION to be an int, but got %s", defaultVersion)
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400339 }
340 if defaultVersionInt%10 != 0 {
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000341 ctx.ModuleErrorf("expected RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION to end in a zero, but got %s", defaultVersion)
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400342 }
343 variantVersion := []rune(*a.properties.Variant_version)
344 if len(variantVersion) != 1 || variantVersion[0] < '0' || variantVersion[0] > '9' {
345 ctx.PropertyErrorf("variant_version", "expected an integer between 0-9; got %s", *a.properties.Variant_version)
346 }
347 defaultVersionRunes := []rune(defaultVersion)
348 defaultVersionRunes[len(defaultVersion)-1] = []rune(variantVersion)[0]
349 defaultVersion = string(defaultVersionRunes)
350 }
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000351 if override := ctx.Config().Getenv("OVERRIDE_APEX_MANIFEST_DEFAULT_VERSION"); override != "" {
352 defaultVersion = override
353 }
Jiyong Park09d77522019-11-18 11:16:27 +0900354 ctx.Build(pctx, android.BuildParams{
355 Rule: apexManifestRule,
Alexei Nicoara0a389202022-07-12 14:35:39 +0100356 Input: src,
Jooyung Han214bf372019-11-12 13:03:50 +0900357 Output: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900358 Args: map[string]string{
359 "provideNativeLibs": strings.Join(provideNativeLibs, " "),
360 "requireNativeLibs": strings.Join(requireNativeLibs, " "),
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000361 "default_version": defaultVersion,
Jiyong Park09d77522019-11-18 11:16:27 +0900362 "opt": strings.Join(optCommands, " "),
363 },
364 })
365
Jiyong Parkb81b9902020-11-24 19:51:18 +0900366 // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json prepare
367 // stripped-down version so that APEX modules built from R+ can be installed to Q
Dan Albertc8060532020-07-22 22:32:17 -0700368 minSdkVersion := a.minSdkVersion(ctx)
369 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Jooyung Han214bf372019-11-12 13:03:50 +0900370 a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json")
371 ctx.Build(pctx, android.BuildParams{
372 Rule: stripApexManifestRule,
373 Input: manifestJsonFullOut,
374 Output: a.manifestJsonOut,
375 })
376 }
Jiyong Park09d77522019-11-18 11:16:27 +0900377
Jiyong Parkb81b9902020-11-24 19:51:18 +0900378 // From R+, protobuf binary format (.pb) is the standard format for apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900379 a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb")
380 ctx.Build(pctx, android.BuildParams{
381 Rule: pbApexManifestRule,
Jooyung Han214bf372019-11-12 13:03:50 +0900382 Input: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900383 Output: a.manifestPbOut,
384 })
385}
386
Jiyong Parkb81b9902020-11-24 19:51:18 +0900387// buildFileContexts create build rules to append an entry for apex_manifest.pb to the file_contexts
388// file for this APEX which is either from /systme/sepolicy/apex/<apexname>-file_contexts or from
389// 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 +0900390// labeled as system_file or vendor_apex_metadata_file.
Cole Faust4e9f5922024-11-13 16:09:23 -0800391func (a *apexBundle) buildFileContexts(ctx android.ModuleContext) android.Path {
Jooyung Han580eb4f2020-06-24 19:33:06 +0900392 var fileContexts android.Path
Liz Kammer37997c42021-09-14 17:53:38 -0400393 var fileContextsDir string
Inseob Kim28d06d22023-11-17 18:04:42 +0900394 isFileContextsModule := false
Jooyung Han580eb4f2020-06-24 19:33:06 +0900395 if a.properties.File_contexts == nil {
396 fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
397 } else {
Liz Kammer37997c42021-09-14 17:53:38 -0400398 if m, t := android.SrcIsModuleWithTag(*a.properties.File_contexts); m != "" {
Inseob Kim28d06d22023-11-17 18:04:42 +0900399 isFileContextsModule = true
Yu Liud3228ac2024-11-08 23:11:47 +0000400 otherModule := android.GetModuleProxyFromPathDep(ctx, m, t)
401 if otherModule != nil {
402 fileContextsDir = ctx.OtherModuleDir(*otherModule)
403 }
Liz Kammer37997c42021-09-14 17:53:38 -0400404 }
Jooyung Han580eb4f2020-06-24 19:33:06 +0900405 fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
406 }
Liz Kammer37997c42021-09-14 17:53:38 -0400407 if fileContextsDir == "" {
408 fileContextsDir = filepath.Dir(fileContexts.String())
409 }
410 fileContextsDir += string(filepath.Separator)
411
Jooyung Han580eb4f2020-06-24 19:33:06 +0900412 if a.Platform() {
Liz Kammer37997c42021-09-14 17:53:38 -0400413 if !strings.HasPrefix(fileContextsDir, "system/sepolicy/") {
414 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but found in %q", fileContextsDir)
Jooyung Han580eb4f2020-06-24 19:33:06 +0900415 }
416 }
Inseob Kim28d06d22023-11-17 18:04:42 +0900417 if !isFileContextsModule && !android.ExistentPathForSource(ctx, fileContexts.String()).Valid() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900418 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", fileContexts.String())
Jooyung Han580eb4f2020-06-24 19:33:06 +0900419 }
420
Jooyung Hanaf730952023-02-28 14:13:38 +0900421 useFileContextsAsIs := proptools.Bool(a.properties.Use_file_contexts_as_is)
422
Jooyung Han580eb4f2020-06-24 19:33:06 +0900423 output := android.PathForModuleOut(ctx, "file_contexts")
Colin Crossf1a035e2020-11-16 17:32:30 -0800424 rule := android.NewRuleBuilder(pctx, ctx)
Jooyung Han7f146c02020-09-23 19:15:55 +0900425
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900426 labelForRoot := "u:object_r:system_file:s0"
427 labelForManifest := "u:object_r:system_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900428 if a.SocSpecific() && !a.vndkApex {
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900429 // APEX on /vendor should label ./ and ./apex_manifest.pb as vendor file.
430 labelForRoot = "u:object_r:vendor_file:s0"
431 labelForManifest = "u:object_r:vendor_apex_metadata_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900432 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900433 // remove old file
434 rule.Command().Text("rm").FlagWithOutput("-f ", output)
435 // copy file_contexts
436 rule.Command().Text("cat").Input(fileContexts).Text(">>").Output(output)
437 // new line
438 rule.Command().Text("echo").Text(">>").Output(output)
439 if !useFileContextsAsIs {
440 // force-label /apex_manifest.pb and /
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900441 rule.Command().Text("echo").Text("/apex_manifest\\\\.pb").Text(labelForManifest).Text(">>").Output(output)
442 rule.Command().Text("echo").Text("/").Text(labelForRoot).Text(">>").Output(output)
Jooyung Han7f146c02020-09-23 19:15:55 +0900443 }
444
Colin Crossf1a035e2020-11-16 17:32:30 -0800445 rule.Build("file_contexts."+a.Name(), "Generate file_contexts")
Cole Faust4e9f5922024-11-13 16:09:23 -0800446 return output
Jooyung Han580eb4f2020-06-24 19:33:06 +0900447}
448
Jiyong Parkb81b9902020-11-24 19:51:18 +0900449// buildInstalledFilesFile creates a build rule for the installed-files.txt file where the list of
450// files included in this APEX is shown. The text file is dist'ed so that people can see what's
451// included in the APEX without actually downloading and extracting it.
Cole Faust4e9f5922024-11-13 16:09:23 -0800452func (a *apexBundle) buildInstalledFilesFile(ctx android.ModuleContext, builtApex android.Path, imageDir android.Path) android.Path {
Jiyong Park3a1602e2020-01-14 14:39:19 +0900453 output := android.PathForModuleOut(ctx, "installed-files.txt")
Colin Crossf1a035e2020-11-16 17:32:30 -0800454 rule := android.NewRuleBuilder(pctx, ctx)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900455 rule.Command().
456 Implicit(builtApex).
457 Text("(cd " + imageDir.String() + " ; ").
Jiyong Parkbd63a102020-02-08 12:40:05 +0900458 Text("find . \\( -type f -o -type l \\) -printf \"%s %p\\n\") ").
Jiyong Park3a1602e2020-01-14 14:39:19 +0900459 Text(" | sort -nr > ").
460 Output(output)
Colin Crossf1a035e2020-11-16 17:32:30 -0800461 rule.Build("installed-files."+a.Name(), "Installed files")
Cole Faust4e9f5922024-11-13 16:09:23 -0800462 return output
Jiyong Park3a1602e2020-01-14 14:39:19 +0900463}
464
Jiyong Parkb81b9902020-11-24 19:51:18 +0900465// buildBundleConfig creates a build rule for the bundle config file that will control the bundle
466// creation process.
Cole Faust4e9f5922024-11-13 16:09:23 -0800467func (a *apexBundle) buildBundleConfig(ctx android.ModuleContext) android.Path {
Jiyong Parkbd159612020-02-28 15:22:21 +0900468 output := android.PathForModuleOut(ctx, "bundle_config.json")
469
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900470 type ApkConfig struct {
471 Package_name string `json:"package_name"`
472 Apk_path string `json:"path"`
473 }
Jiyong Parkbd159612020-02-28 15:22:21 +0900474 config := struct {
475 Compression struct {
476 Uncompressed_glob []string `json:"uncompressed_glob"`
477 } `json:"compression"`
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900478 Apex_config struct {
479 Apex_embedded_apk_config []ApkConfig `json:"apex_embedded_apk_config,omitempty"`
480 } `json:"apex_config,omitempty"`
Jiyong Parkbd159612020-02-28 15:22:21 +0900481 }{}
482
483 config.Compression.Uncompressed_glob = []string{
484 "apex_payload.img",
485 "apex_manifest.*",
486 }
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900487
Jiyong Parkb81b9902020-11-24 19:51:18 +0900488 // Collect the manifest names and paths of android apps if their manifest names are
489 // overridden.
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900490 for _, fi := range a.filesInfo {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700491 if fi.class != app && fi.class != appSet {
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900492 continue
493 }
494 packageName := fi.overriddenPackageName
495 if packageName != "" {
496 config.Apex_config.Apex_embedded_apk_config = append(
497 config.Apex_config.Apex_embedded_apk_config,
498 ApkConfig{
499 Package_name: packageName,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900500 Apk_path: fi.path(),
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900501 })
502 }
503 }
504
Jiyong Parkbd159612020-02-28 15:22:21 +0900505 j, err := json.Marshal(config)
506 if err != nil {
507 panic(fmt.Errorf("error while marshalling to %q: %#v", output, err))
508 }
509
Colin Crosscf371cc2020-11-13 11:48:42 -0800510 android.WriteFileRule(ctx, output, string(j))
Jiyong Parkbd159612020-02-28 15:22:21 +0900511
Cole Faust4e9f5922024-11-13 16:09:23 -0800512 return output
Jiyong Parkbd159612020-02-28 15:22:21 +0900513}
514
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000515func markManifestTestOnly(ctx android.ModuleContext, androidManifestFile android.Path) android.Path {
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000516 return java.ManifestFixer(ctx, androidManifestFile, java.ManifestFixerParams{
517 TestOnly: true,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000518 })
519}
520
Jooyung Han90934ac2023-09-22 14:52:06 +0900521func isVintfFragment(fi apexFile) bool {
Jooyung Han262f73c2024-03-28 11:29:47 +0900522 isVintfFragment, _ := path.Match("etc/vintf/*", fi.path())
Jooyung Han90934ac2023-09-22 14:52:06 +0900523 return isVintfFragment
524}
525
526func runAssembleVintf(ctx android.ModuleContext, vintfFragment android.Path) android.Path {
527 processed := android.PathForModuleOut(ctx, "vintf", vintfFragment.Base())
528 ctx.Build(pctx, android.BuildParams{
529 Rule: assembleVintfRule,
530 Input: vintfFragment,
531 Output: processed,
532 Description: "run assemble_vintf for VINTF in APEX",
533 })
534 return processed
535}
536
Jooyung Haneec1b3f2023-06-20 16:25:59 +0900537// buildApex creates build rules to build an APEX using apexer.
538func (a *apexBundle) buildApex(ctx android.ModuleContext) {
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900539 suffix := imageApexSuffix
Jooyung Han63dff462023-02-09 00:11:27 +0000540 apexName := a.BaseModuleName()
Jiyong Park09d77522019-11-18 11:16:27 +0900541
Jiyong Parkb81b9902020-11-24 19:51:18 +0900542 ////////////////////////////////////////////////////////////////////////////////////////////
543 // Step 1: copy built files to appropriate directories under the image directory
544
545 imageDir := android.PathForModuleOut(ctx, "image"+suffix)
546
Colin Cross02730b92022-04-18 17:42:27 -0700547 installSymbolFiles := (!ctx.Config().KatiEnabled() || a.ExportedToMake()) && a.installable()
Colin Cross6340ea52021-11-04 12:01:18 -0700548
Colin Cross4acaea92021-12-10 23:05:02 +0000549 // set of dependency module:location mappings
550 installMapSet := make(map[string]bool)
Colin Cross6340ea52021-11-04 12:01:18 -0700551
Jiyong Parkb81b9902020-11-24 19:51:18 +0900552 // TODO(jiyong): use the RuleBuilder
Jiyong Park7cd10e32020-01-14 09:22:18 +0900553 var copyCommands []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900554 var implicitInputs []android.Path
Jooyung Han63dff462023-02-09 00:11:27 +0000555 apexDir := android.PathForModuleInPartitionInstall(ctx, "apex", apexName)
Jiyong Park7cd10e32020-01-14 09:22:18 +0900556 for _, fi := range a.filesInfo {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900557 destPath := imageDir.Join(ctx, fi.path()).String()
Jiyong Parkb81b9902020-11-24 19:51:18 +0900558 // Prepare the destination path
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700559 destPathDir := filepath.Dir(destPath)
560 if fi.class == appSet {
561 copyCommands = append(copyCommands, "rm -rf "+destPathDir)
562 }
563 copyCommands = append(copyCommands, "mkdir -p "+destPathDir)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900564
Colin Cross4acaea92021-12-10 23:05:02 +0000565 installMapPath := fi.builtFile
566
Jiyong Parkb81b9902020-11-24 19:51:18 +0900567 // Copy the built file to the directory. But if the symlink optimization is turned
568 // on, place a symlink to the corresponding file in /system partition instead.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900569 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900570 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Jiyong Park7cd10e32020-01-14 09:22:18 +0900571 copyCommands = append(copyCommands, "ln -sfn "+pathOnDevice+" "+destPath)
572 } else {
Jiyong Park4169a252022-09-29 21:30:25 +0900573 // Copy the file into APEX
Jooyung Han90934ac2023-09-22 14:52:06 +0900574 if !a.testApex && isVintfFragment(fi) {
575 // copy the output of assemble_vintf instead of the original
576 vintfFragment := runAssembleVintf(ctx, fi.builtFile)
577 copyCommands = append(copyCommands, "cp -f "+vintfFragment.String()+" "+destPath)
578 implicitInputs = append(implicitInputs, vintfFragment)
579 } else {
580 copyCommands = append(copyCommands, "cp -f "+fi.builtFile.String()+" "+destPath)
581 implicitInputs = append(implicitInputs, fi.builtFile)
582 }
Jiyong Park4169a252022-09-29 21:30:25 +0900583
Colin Cross4acaea92021-12-10 23:05:02 +0000584 var installedPath android.InstallPath
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700585 if fi.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +0900586 // In case of AppSet, we need to copy additional APKs as well. They
587 // are zipped. So we need to unzip them.
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700588 copyCommands = append(copyCommands,
Colin Crossffbcd1d2021-11-12 12:19:42 -0800589 fmt.Sprintf("unzip -qDD -d %s %s", destPathDir,
590 fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs().String()))
Colin Cross6340ea52021-11-04 12:01:18 -0700591 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000592 installedPath = ctx.InstallFileWithExtraFilesZip(apexDir.Join(ctx, fi.installDir),
Colin Cross6340ea52021-11-04 12:01:18 -0700593 fi.stem(), fi.builtFile, fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs())
594 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700595 } else {
Colin Cross6340ea52021-11-04 12:01:18 -0700596 if installSymbolFiles {
Spandan Das72d86c62024-10-15 19:27:41 +0000597 // store installedPath. symlinks might be created if required.
598 installedPath = apexDir.Join(ctx, fi.installDir, fi.stem())
Colin Cross6340ea52021-11-04 12:01:18 -0700599 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700600 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900601
Colin Cross4acaea92021-12-10 23:05:02 +0000602 // Create additional symlinks pointing the file inside the APEX (if any). Note that
603 // this is independent from the symlink optimization.
604 for _, symlinkPath := range fi.symlinkPaths() {
605 symlinkDest := imageDir.Join(ctx, symlinkPath).String()
606 copyCommands = append(copyCommands, "ln -sfn "+filepath.Base(destPath)+" "+symlinkDest)
607 if installSymbolFiles {
Inseob Kim5bedfee2023-04-20 10:16:14 +0900608 ctx.InstallSymlink(apexDir.Join(ctx, filepath.Dir(symlinkPath)), filepath.Base(symlinkPath), installedPath)
Colin Cross4acaea92021-12-10 23:05:02 +0000609 }
Colin Cross6340ea52021-11-04 12:01:18 -0700610 }
Colin Cross4acaea92021-12-10 23:05:02 +0000611
612 installMapPath = installedPath
Jiyong Park7cd10e32020-01-14 09:22:18 +0900613 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900614
615 // Copy the test files (if any)
Liz Kammer1c14a212020-05-12 15:26:55 -0700616 for _, d := range fi.dataPaths {
617 // 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 -0800618 relPath := d.ToRelativeInstallPath()
619 dataDest := imageDir.Join(ctx, fi.apexRelativePath(relPath)).String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700620
Chris Parsons216e10a2020-07-09 17:12:52 -0400621 copyCommands = append(copyCommands, "cp -f "+d.SrcPath.String()+" "+dataDest)
622 implicitInputs = append(implicitInputs, d.SrcPath)
Liz Kammer1c14a212020-05-12 15:26:55 -0700623 }
Colin Cross4acaea92021-12-10 23:05:02 +0000624
625 installMapSet[installMapPath.String()+":"+fi.installDir+"/"+fi.builtFile.Base()] = true
Jiyong Park09d77522019-11-18 11:16:27 +0900626 }
Yu Liueae7b362023-11-16 17:05:47 -0800627
Jooyung Han214bf372019-11-12 13:03:50 +0900628 implicitInputs = append(implicitInputs, a.manifestPbOut)
Jiyong Park09d77522019-11-18 11:16:27 +0900629
Colin Cross4acaea92021-12-10 23:05:02 +0000630 if len(installMapSet) > 0 {
631 var installs []string
Cole Faust18994c72023-02-28 16:02:16 -0800632 installs = append(installs, android.SortedKeys(installMapSet)...)
Yu Liubad1eef2024-08-21 22:37:35 +0000633 ctx.SetLicenseInstallMap(installs)
Colin Cross4acaea92021-12-10 23:05:02 +0000634 }
635
Jiyong Parkb81b9902020-11-24 19:51:18 +0900636 ////////////////////////////////////////////////////////////////////////////////////////////
637 // Step 1.a: Write the list of files in this APEX to a txt file and compare it against
638 // the allowed list given via the allowed_files property. Build fails when the two lists
639 // differ.
640 //
641 // TODO(jiyong): consider removing this. Nobody other than com.android.apex.cts.shim.* seems
642 // to be using this at this moment. Furthermore, this looks very similar to what
643 // buildInstalledFilesFile does. At least, move this to somewhere else so that this doesn't
644 // hurt readability.
Jooyung Han938b5932020-06-20 12:47:47 +0900645 if a.overridableProperties.Allowed_files != nil {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900646 // Build content.txt
Cole Fausta7347492022-12-16 10:56:24 -0800647 var contentLines []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900648 imageContentFile := android.PathForModuleOut(ctx, "content.txt")
Cole Fausta7347492022-12-16 10:56:24 -0800649 contentLines = append(contentLines, "./apex_manifest.pb")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900650 minSdkVersion := a.minSdkVersion(ctx)
651 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Cole Fausta7347492022-12-16 10:56:24 -0800652 contentLines = append(contentLines, "./apex_manifest.json")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900653 }
654 for _, fi := range a.filesInfo {
Cole Fausta7347492022-12-16 10:56:24 -0800655 contentLines = append(contentLines, "./"+fi.path())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900656 }
Cole Fausta7347492022-12-16 10:56:24 -0800657 sort.Strings(contentLines)
658 android.WriteFileRule(ctx, imageContentFile, strings.Join(contentLines, "\n"))
Jiyong Park09d77522019-11-18 11:16:27 +0900659 implicitInputs = append(implicitInputs, imageContentFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900660
Jiyong Parkb81b9902020-11-24 19:51:18 +0900661 // Compare content.txt against allowed_files.
662 allowedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.overridableProperties.Allowed_files))
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800663 phonyOutput := android.PathForModuleOut(ctx, a.Name()+"-diff-phony-output")
Jiyong Park09d77522019-11-18 11:16:27 +0900664 ctx.Build(pctx, android.BuildParams{
665 Rule: diffApexContentRule,
666 Implicits: implicitInputs,
667 Output: phonyOutput,
668 Description: "diff apex image content",
669 Args: map[string]string{
Colin Cross440e0d02020-06-11 11:32:11 -0700670 "allowed_files_file": allowedFilesFile.String(),
671 "image_content_file": imageContentFile.String(),
672 "apex_module_name": a.Name(),
Jiyong Park09d77522019-11-18 11:16:27 +0900673 },
674 })
Jiyong Park09d77522019-11-18 11:16:27 +0900675 implicitInputs = append(implicitInputs, phonyOutput)
676 }
677
Jiyong Parkb81b9902020-11-24 19:51:18 +0900678 unsignedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix+".unsigned")
Colin Cross790ef352021-10-25 19:15:55 -0700679 outHostBinDir := ctx.Config().HostToolPath(ctx, "").String()
Jiyong Park09d77522019-11-18 11:16:27 +0900680 prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin")
681
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900682 ////////////////////////////////////////////////////////////////////////////////////
683 // Step 2: create canned_fs_config which encodes filemode,uid,gid of each files
684 // in this APEX. The file will be used by apexer in later steps.
Jooyung Hana3fddf42024-09-03 13:22:21 +0900685 cannedFsConfig := a.buildCannedFsConfig(ctx)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900686 implicitInputs = append(implicitInputs, cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +0900687
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900688 ////////////////////////////////////////////////////////////////////////////////////
689 // Step 3: Prepare option flags for apexer and invoke it to create an unsigned APEX.
690 // TODO(jiyong): use the RuleBuilder
691 optFlags := []string{}
Jiyong Park09d77522019-11-18 11:16:27 +0900692
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900693 fileContexts := a.buildFileContexts(ctx)
694 implicitInputs = append(implicitInputs, fileContexts)
Jiyong Park09d77522019-11-18 11:16:27 +0900695
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900696 implicitInputs = append(implicitInputs, a.privateKeyFile, a.publicKeyFile)
697 optFlags = append(optFlags, "--pubkey "+a.publicKeyFile.String())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900698
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900699 manifestPackageName := a.getOverrideManifestPackageName(ctx)
700 if manifestPackageName != "" {
701 optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName)
702 }
Jiyong Park09d77522019-11-18 11:16:27 +0900703
Cole Faustbf1d92a2024-07-29 12:24:25 -0700704 androidManifest := a.properties.AndroidManifest.GetOrDefault(ctx, "")
Inseob Kimb1142342024-07-23 13:39:54 +0900705 if androidManifest != "" {
706 androidManifestFile := android.PathForModuleSrc(ctx, androidManifest)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900707
708 if a.testApex {
709 androidManifestFile = markManifestTestOnly(ctx, androidManifestFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900710 }
711
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900712 implicitInputs = append(implicitInputs, androidManifestFile)
713 optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String())
714 } else if a.testApex {
715 optFlags = append(optFlags, "--test_only")
716 }
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000717
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900718 // Determine target/min sdk version from the context
719 // TODO(jiyong): make this as a function
720 moduleMinSdkVersion := a.minSdkVersion(ctx)
721 minSdkVersion := moduleMinSdkVersion.String()
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000722
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900723 // bundletool doesn't understand what "current" is. We need to transform it to
724 // codename
725 if moduleMinSdkVersion.IsCurrent() || moduleMinSdkVersion.IsNone() {
726 minSdkVersion = ctx.Config().DefaultAppTargetSdk(ctx).String()
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000727
Jihoon Kang842b9992024-02-08 01:41:51 +0000728 if useApiFingerprint, fingerprintMinSdkVersion, fingerprintDeps :=
729 java.UseApiFingerprint(ctx); useApiFingerprint {
730 minSdkVersion = fingerprintMinSdkVersion
731 implicitInputs = append(implicitInputs, fingerprintDeps)
Baligh Uddinf6201372020-01-24 23:15:44 +0000732 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900733 }
734 // apex module doesn't have a concept of target_sdk_version, hence for the time
735 // being targetSdkVersion == default targetSdkVersion of the branch.
736 targetSdkVersion := strconv.Itoa(ctx.Config().DefaultAppTargetSdk(ctx).FinalOrFutureInt())
Jiyong Park09d77522019-11-18 11:16:27 +0900737
Jihoon Kang842b9992024-02-08 01:41:51 +0000738 if useApiFingerprint, fingerprintTargetSdkVersion, fingerprintDeps :=
739 java.UseApiFingerprint(ctx); useApiFingerprint {
740 targetSdkVersion = fingerprintTargetSdkVersion
741 implicitInputs = append(implicitInputs, fingerprintDeps)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900742 }
743 optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion)
744 optFlags = append(optFlags, "--min_sdk_version "+minSdkVersion)
Baligh Uddin004d7172020-02-19 21:29:28 -0800745
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900746 if a.overridableProperties.Logging_parent != "" {
747 optFlags = append(optFlags, "--logging_parent ", a.overridableProperties.Logging_parent)
748 }
Jiyong Park09d77522019-11-18 11:16:27 +0900749
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900750 // Create a NOTICE file, and embed it as an asset file in the APEX.
751 htmlGzNotice := android.PathForModuleOut(ctx, "NOTICE.html.gz")
752 android.BuildNoticeHtmlOutputFromLicenseMetadata(
753 ctx, htmlGzNotice, "", "",
754 []string{
755 android.PathForModuleInstall(ctx).String() + "/",
756 android.PathForModuleInPartitionInstall(ctx, "apex").String() + "/",
Jiyong Park09d77522019-11-18 11:16:27 +0900757 })
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900758 noticeAssetPath := android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
759 builder := android.NewRuleBuilder(pctx, ctx)
760 builder.Command().Text("cp").
761 Input(htmlGzNotice).
762 Output(noticeAssetPath)
763 builder.Build("notice_dir", "Building notice dir")
764 implicitInputs = append(implicitInputs, noticeAssetPath)
765 optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeAssetPath.String()))
Jiyong Park09d77522019-11-18 11:16:27 +0900766
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900767 // Apexes which are supposed to be installed in builtin dirs(/system, etc)
768 // don't need hashtree for activation. Therefore, by removing hashtree from
769 // apex bundle (filesystem image in it, to be specific), we can save storage.
770 needHashTree := moduleMinSdkVersion.LessThanOrEqualTo(android.SdkVersion_Android10) ||
771 a.shouldGenerateHashtree()
772 if ctx.Config().ApexCompressionEnabled() && a.isCompressable() {
773 needHashTree = true
774 }
775 if !needHashTree {
776 optFlags = append(optFlags, "--no_hashtree")
777 }
sophiezc80a2b32020-11-12 16:39:19 +0000778
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900779 if a.testOnlyShouldSkipPayloadSign() {
780 optFlags = append(optFlags, "--unsigned_payload")
781 }
782
783 if moduleMinSdkVersion == android.SdkVersion_Android10 {
784 implicitInputs = append(implicitInputs, a.manifestJsonOut)
785 optFlags = append(optFlags, "--manifest_json "+a.manifestJsonOut.String())
786 }
787
788 optFlags = append(optFlags, "--payload_fs_type "+a.payloadFsType.string())
789
790 if a.dynamic_common_lib_apex() {
sophiezc80a2b32020-11-12 16:39:19 +0000791 ctx.Build(pctx, android.BuildParams{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900792 Rule: DCLAApexRule,
Jiyong Park09d77522019-11-18 11:16:27 +0900793 Implicits: implicitInputs,
794 Output: unsignedOutputFile,
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900795 Description: "apex",
Jiyong Park09d77522019-11-18 11:16:27 +0900796 Args: map[string]string{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900797 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
798 "image_dir": imageDir.String(),
799 "copy_commands": strings.Join(copyCommands, " && "),
800 "manifest": a.manifestPbOut.String(),
801 "file_contexts": fileContexts.String(),
802 "canned_fs_config": cannedFsConfig.String(),
803 "key": a.privateKeyFile.String(),
804 "opt_flags": strings.Join(optFlags, " "),
805 },
806 })
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900807 } else {
808 ctx.Build(pctx, android.BuildParams{
809 Rule: apexRule,
810 Implicits: implicitInputs,
811 Output: unsignedOutputFile,
812 Description: "apex",
813 Args: map[string]string{
814 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
815 "image_dir": imageDir.String(),
816 "copy_commands": strings.Join(copyCommands, " && "),
817 "manifest": a.manifestPbOut.String(),
818 "file_contexts": fileContexts.String(),
819 "canned_fs_config": cannedFsConfig.String(),
820 "key": a.privateKeyFile.String(),
821 "opt_flags": strings.Join(optFlags, " "),
Jiyong Park09d77522019-11-18 11:16:27 +0900822 },
823 })
824 }
825
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900826 // TODO(jiyong): make the two rules below as separate functions
827 apexProtoFile := android.PathForModuleOut(ctx, a.Name()+".pb"+suffix)
828 bundleModuleFile := android.PathForModuleOut(ctx, a.Name()+suffix+"-base.zip")
829 a.bundleModuleFile = bundleModuleFile
830
831 ctx.Build(pctx, android.BuildParams{
832 Rule: apexProtoConvertRule,
833 Input: unsignedOutputFile,
834 Output: apexProtoFile,
835 Description: "apex proto convert",
836 })
837
838 implicitInputs = append(implicitInputs, unsignedOutputFile)
839
840 // Run coverage analysis
841 apisUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.txt")
842 ctx.Build(pctx, android.BuildParams{
843 Rule: generateAPIsUsedbyApexRule,
844 Implicits: implicitInputs,
845 Description: "coverage",
846 Output: apisUsedbyOutputFile,
847 Args: map[string]string{
848 "image_dir": imageDir.String(),
849 "readelf": "${config.ClangBin}/llvm-readelf",
850 },
851 })
852 a.nativeApisUsedByModuleFile = apisUsedbyOutputFile
853
854 var nativeLibNames []string
855 for _, f := range a.filesInfo {
856 if f.class == nativeSharedLib {
857 nativeLibNames = append(nativeLibNames, f.stem())
858 }
859 }
860 apisBackedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_backing.txt")
861 rb := android.NewRuleBuilder(pctx, ctx)
862 rb.Command().
863 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_ndk_backedby_apex.sh")).
864 Output(apisBackedbyOutputFile).
865 Flags(nativeLibNames)
866 rb.Build("ndk_backedby_list", "Generate API libraries backed by Apex")
867 a.nativeApisBackedByModuleFile = apisBackedbyOutputFile
868
869 var javaLibOrApkPath []android.Path
870 for _, f := range a.filesInfo {
871 if f.class == javaSharedLib || f.class == app {
872 javaLibOrApkPath = append(javaLibOrApkPath, f.builtFile)
873 }
874 }
875 javaApiUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.xml")
876 javaUsedByRule := android.NewRuleBuilder(pctx, ctx)
877 javaUsedByRule.Command().
878 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_java_usedby_apex.sh")).
879 BuiltTool("dexdeps").
880 Output(javaApiUsedbyOutputFile).
881 Inputs(javaLibOrApkPath)
882 javaUsedByRule.Build("java_usedby_list", "Generate Java APIs used by Apex")
883 a.javaApisUsedByModuleFile = javaApiUsedbyOutputFile
884
885 bundleConfig := a.buildBundleConfig(ctx)
886
887 var abis []string
888 for _, target := range ctx.MultiTargets() {
889 if len(target.Arch.Abi) > 0 {
890 abis = append(abis, target.Arch.Abi[0])
891 }
892 }
893
894 abis = android.FirstUniqueStrings(abis)
895
896 ctx.Build(pctx, android.BuildParams{
897 Rule: apexBundleRule,
898 Input: apexProtoFile,
899 Implicit: bundleConfig,
900 Output: a.bundleModuleFile,
901 Description: "apex bundle module",
902 Args: map[string]string{
903 "abi": strings.Join(abis, "."),
904 "config": bundleConfig.String(),
905 },
906 })
907
Jiyong Parkb81b9902020-11-24 19:51:18 +0900908 ////////////////////////////////////////////////////////////////////////////////////
909 // Step 4: Sign the APEX using signapk
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000910 signedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900911
912 pem, key := a.getCertificateAndPrivateKey(ctx)
Kousik Kumar309b1c02020-05-28 06:13:33 -0700913 rule := java.Signapk
914 args := map[string]string{
Jiyong Parkb81b9902020-11-24 19:51:18 +0900915 "certificates": pem.String() + " " + key.String(),
Jooyung Han5d00f502021-07-11 07:26:22 +0900916 "flags": "-a 4096 --align-file-size", //alignment
Kousik Kumar309b1c02020-05-28 06:13:33 -0700917 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900918 implicits := android.Paths{pem, key}
Ramy Medhat16f23a42020-09-03 01:29:49 -0400919 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
Kousik Kumar309b1c02020-05-28 06:13:33 -0700920 rule = java.SignapkRE
921 args["implicits"] = strings.Join(implicits.Strings(), ",")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000922 args["outCommaList"] = signedOutputFile.String()
Kousik Kumar309b1c02020-05-28 06:13:33 -0700923 }
Jooyung Han01f5d652023-04-05 16:29:26 +0900924 var validations android.Paths
Cole Faust4e9f5922024-11-13 16:09:23 -0800925 validations = append(validations, runApexLinkerconfigValidation(ctx, unsignedOutputFile, imageDir))
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900926 // TODO(b/279688635) deapexer supports [ext4]
Jooyung Han1f4531e2024-02-07 16:27:57 +0900927 if !a.testApex && suffix == imageApexSuffix && ext4 == a.payloadFsType {
Cole Faust4e9f5922024-11-13 16:09:23 -0800928 validations = append(validations, runApexSepolicyTests(ctx, unsignedOutputFile))
Jooyung Han01f5d652023-04-05 16:29:26 +0900929 }
Jooyung Han55a73062023-11-07 13:09:56 +0900930 if !a.testApex && len(a.properties.Unwanted_transitive_deps) > 0 {
931 validations = append(validations,
Cole Faust4e9f5922024-11-13 16:09:23 -0800932 runApexElfCheckerUnwanted(ctx, unsignedOutputFile, a.properties.Unwanted_transitive_deps))
Jooyung Han55a73062023-11-07 13:09:56 +0900933 }
Jooyung Han2adba482024-02-22 17:27:53 +0900934 if !a.testApex && android.InList(a.payloadFsType, []fsType{ext4, erofs}) {
Cole Faust4e9f5922024-11-13 16:09:23 -0800935 validations = append(validations, runApexHostVerifier(ctx, a, unsignedOutputFile))
Jooyung Han2adba482024-02-22 17:27:53 +0900936 }
Jiyong Park09d77522019-11-18 11:16:27 +0900937 ctx.Build(pctx, android.BuildParams{
Kousik Kumar309b1c02020-05-28 06:13:33 -0700938 Rule: rule,
Jiyong Park09d77522019-11-18 11:16:27 +0900939 Description: "signapk",
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000940 Output: signedOutputFile,
Jiyong Park09d77522019-11-18 11:16:27 +0900941 Input: unsignedOutputFile,
Kousik Kumar309b1c02020-05-28 06:13:33 -0700942 Implicits: implicits,
943 Args: args,
Jooyung Han01f5d652023-04-05 16:29:26 +0900944 Validations: validations,
Jiyong Park09d77522019-11-18 11:16:27 +0900945 })
Jooyung Hana6d36672022-02-24 13:58:07 +0900946 if suffix == imageApexSuffix {
947 a.outputApexFile = signedOutputFile
948 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000949 a.outputFile = signedOutputFile
950
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +0000951 if ctx.ModuleDir() != "system/apex/apexd/apexd_testdata" && a.testOnlyShouldForceCompression() {
952 ctx.PropertyErrorf("test_only_force_compression", "not available")
953 return
954 }
Nikita Ioffebc035882021-04-14 21:35:24 +0100955
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700956 installSuffix := suffix
957 a.setCompression(ctx)
958 if a.isCompressed {
Samiul Islam7c02e262021-09-08 17:48:28 +0100959 unsignedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix+".unsigned")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000960
961 compressRule := android.NewRuleBuilder(pctx, ctx)
962 compressRule.Command().
963 Text("rm").
964 FlagWithOutput("-f ", unsignedCompressedOutputFile)
965 compressRule.Command().
966 BuiltTool("apex_compression_tool").
967 Flag("compress").
968 FlagWithArg("--apex_compression_tool ", outHostBinDir+":"+prebuiltSdkToolsBinDir).
969 FlagWithInput("--input ", signedOutputFile).
970 FlagWithOutput("--output ", unsignedCompressedOutputFile)
971 compressRule.Build("compressRule", "Generate unsigned compressed APEX file")
972
Samiul Islam7c02e262021-09-08 17:48:28 +0100973 signedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix)
Mohammad Samiul Islam9ac0e322021-01-19 11:32:29 +0000974 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
975 args["outCommaList"] = signedCompressedOutputFile.String()
976 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000977 ctx.Build(pctx, android.BuildParams{
978 Rule: rule,
979 Description: "sign compressedApex",
980 Output: signedCompressedOutputFile,
981 Input: unsignedCompressedOutputFile,
982 Implicits: implicits,
983 Args: args,
984 })
985 a.outputFile = signedCompressedOutputFile
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000986 installSuffix = imageCapexSuffix
987 }
988
Colin Crossd9ccb6a2022-03-07 18:38:34 -0800989 if !a.installable() {
990 a.SkipInstall()
991 }
992
Jiyong Park17ff2832021-09-27 12:50:30 +0900993 // Install to $OUT/soong/{target,host}/.../apex.
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000994 a.installedFile = ctx.InstallFile(a.installDir, a.Name()+installSuffix, a.outputFile,
Colin Cross09ad3a62023-11-15 12:29:33 -0800995 a.compatSymlinks...)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900996
997 // installed-files.txt is dist'ed
998 a.installedFilesFile = a.buildInstalledFilesFile(ctx, a.outputFile, imageDir)
Jooyung Han286957d2023-10-30 16:17:56 +0900999
1000 a.apexKeysPath = writeApexKeys(ctx, a)
Jiyong Park09d77522019-11-18 11:16:27 +09001001}
1002
Jiyong Parkb81b9902020-11-24 19:51:18 +09001003// getCertificateAndPrivateKey retrieves the cert and the private key that will be used to sign
1004// the zip container of this APEX. See the description of the 'certificate' property for how
1005// the cert and the private key are found.
1006func (a *apexBundle) getCertificateAndPrivateKey(ctx android.PathContext) (pem, key android.Path) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001007 if a.containerCertificateFile != nil {
1008 return a.containerCertificateFile, a.containerPrivateKeyFile
Jiyong Parkb81b9902020-11-24 19:51:18 +09001009 }
1010
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -07001011 cert := String(a.overridableProperties.Certificate)
Jiyong Parkb81b9902020-11-24 19:51:18 +09001012 if cert == "" {
1013 return ctx.Config().DefaultAppCertificate(ctx)
1014 }
1015
1016 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
1017 pem = defaultDir.Join(ctx, cert+".x509.pem")
1018 key = defaultDir.Join(ctx, cert+".pk8")
1019 return pem, key
Jiyong Park09d77522019-11-18 11:16:27 +09001020}
Jooyung Han27151d92019-12-16 17:45:32 +09001021
1022func (a *apexBundle) getOverrideManifestPackageName(ctx android.ModuleContext) string {
1023 // For VNDK APEXes, check "com.android.vndk" in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
1024 // to see if it should be overridden because their <apex name> is dynamically generated
1025 // according to its VNDK version.
1026 if a.vndkApex {
1027 overrideName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(vndkApexName)
1028 if overridden {
Kiyoung Kimfa13ff12024-03-18 16:01:19 +09001029 return overrideName + ".v" + a.vndkVersion()
Jooyung Han27151d92019-12-16 17:45:32 +09001030 }
1031 return ""
1032 }
Cole Faust12f6ec92024-10-03 13:32:43 -07001033 packageNameFromProp := a.overridableProperties.Package_name.GetOrDefault(ctx, "")
1034 if packageNameFromProp != "" {
1035 return packageNameFromProp
Baligh Uddin5b57dba2020-03-15 13:01:05 -07001036 }
Jiyong Park20bacab2020-03-03 11:45:41 +09001037 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jooyung Han27151d92019-12-16 17:45:32 +09001038 if overridden {
1039 return manifestPackageName
1040 }
1041 return ""
1042}
Jiyong Park83dc74b2020-01-14 18:38:44 +09001043
1044func (a *apexBundle) buildApexDependencyInfo(ctx android.ModuleContext) {
Jiyong Park83dc74b2020-01-14 18:38:44 +09001045 if a.properties.IsCoverageVariant {
1046 // Otherwise, we will have duplicated rules for coverage and
1047 // non-coverage variants of the same APEX
1048 return
1049 }
1050
Artur Satayev872a1442020-04-27 17:08:37 +01001051 depInfos := android.DepNameToDepInfoMap{}
Colin Cross8bf14fc2024-09-25 16:41:31 -07001052 a.WalkPayloadDeps(ctx, func(ctx android.BaseModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev872a1442020-04-27 17:08:37 +01001053 if from.Name() == to.Name() {
1054 // This can happen for cc.reuseObjTag. We are not interested in tracking this.
1055 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1056 return !externalDep
Jiyong Park678c8812020-02-07 17:25:49 +09001057 }
Jiyong Park83dc74b2020-01-14 18:38:44 +09001058
Artur Satayev533b98c2021-03-11 18:03:42 +00001059 // Skip dependencies that are only available to APEXes; they are developed with updatability
1060 // in mind and don't need manual approval.
1061 if to.(android.ApexModule).NotAvailableForPlatform() {
1062 return !externalDep
1063 }
1064
Cindy Zhou18417cb2020-12-10 07:12:38 -08001065 depTag := ctx.OtherModuleDependencyTag(to)
Artur Satayev533b98c2021-03-11 18:03:42 +00001066 // Check to see if dependency been marked to skip the dependency check
Cindy Zhou18417cb2020-12-10 07:12:38 -08001067 if skipDepCheck, ok := depTag.(android.SkipApexAllowedDependenciesCheck); ok && skipDepCheck.SkipApexAllowedDependenciesCheck() {
Cindy Zhou18417cb2020-12-10 07:12:38 -08001068 return !externalDep
1069 }
1070
Artur Satayev872a1442020-04-27 17:08:37 +01001071 if info, exists := depInfos[to.Name()]; exists {
1072 if !android.InList(from.Name(), info.From) {
1073 info.From = append(info.From, from.Name())
1074 }
1075 info.IsExternal = info.IsExternal && externalDep
1076 depInfos[to.Name()] = info
1077 } else {
Artur Satayev480e25b2020-04-27 18:53:18 +01001078 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001079 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001080 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +09001081 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001082 if v := m.MinSdkVersion(ctx); !v.IsNone() {
1083 toMinSdkVersion = v.String()
Jiyong Park92315372021-04-02 08:45:46 +09001084 }
1085 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1086 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1087 // string
Artur Satayev480e25b2020-04-27 18:53:18 +01001088 if v := m.MinSdkVersion(); v != "" {
1089 toMinSdkVersion = v
1090 }
1091 }
Artur Satayev872a1442020-04-27 17:08:37 +01001092 depInfos[to.Name()] = android.ApexModuleDepInfo{
Artur Satayev480e25b2020-04-27 18:53:18 +01001093 To: to.Name(),
1094 From: []string{from.Name()},
1095 IsExternal: externalDep,
1096 MinSdkVersion: toMinSdkVersion,
Artur Satayev872a1442020-04-27 17:08:37 +01001097 }
1098 }
1099
1100 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1101 return !externalDep
Jiyong Park83dc74b2020-01-14 18:38:44 +09001102 })
1103
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001104 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depInfos)
Artur Satayev872a1442020-04-27 17:08:37 +01001105
Jiyong Park83dc74b2020-01-14 18:38:44 +09001106 ctx.Build(pctx, android.BuildParams{
1107 Rule: android.Phony,
1108 Output: android.PathForPhony(ctx, a.Name()+"-deps-info"),
Artur Satayeva8bd1132020-04-27 18:07:06 +01001109 Inputs: []android.Path{
1110 a.ApexBundleDepsInfo.FullListPath(),
1111 a.ApexBundleDepsInfo.FlatListPath(),
1112 },
Jiyong Park83dc74b2020-01-14 18:38:44 +09001113 })
1114}
Colin Cross08dca382020-07-21 20:31:17 -07001115
1116func (a *apexBundle) buildLintReports(ctx android.ModuleContext) {
1117 depSetsBuilder := java.NewLintDepSetBuilder()
1118 for _, fi := range a.filesInfo {
Colin Crossb79aa8f2024-09-25 15:41:01 -07001119 if fi.lintInfo != nil {
1120 depSetsBuilder.Transitive(fi.lintInfo)
1121 }
Colin Cross08dca382020-07-21 20:31:17 -07001122 }
1123
Colin Cross87427352024-09-25 15:41:19 -07001124 depSets := depSetsBuilder.Build()
1125 var validations android.Paths
1126
1127 if a.checkStrictUpdatabilityLinting(ctx) {
1128 baselines := depSets.Baseline.ToList()
1129 if len(baselines) > 0 {
1130 outputFile := java.VerifyStrictUpdatabilityChecks(ctx, baselines)
1131 validations = append(validations, outputFile)
1132 }
1133 }
1134
1135 a.lintReports = java.BuildModuleLintReportZips(ctx, depSets, validations)
Colin Cross08dca382020-07-21 20:31:17 -07001136}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001137
Cole Faust4e9f5922024-11-13 16:09:23 -08001138func (a *apexBundle) buildCannedFsConfig(ctx android.ModuleContext) android.Path {
Jooyung Hana3fddf42024-09-03 13:22:21 +09001139 var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001140 var executablePaths []string // this also includes dirs
1141 var appSetDirs []string
1142 appSetFiles := make(map[string]android.Path)
1143 for _, f := range a.filesInfo {
1144 pathInApex := f.path()
1145 if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") {
1146 executablePaths = append(executablePaths, pathInApex)
1147 for _, d := range f.dataPaths {
Colin Crossd442a0e2023-11-16 11:19:26 -08001148 rel := d.ToRelativeInstallPath()
1149 readOnlyPaths = append(readOnlyPaths, filepath.Join(f.installDir, rel))
Jiyong Park1b0893e2021-12-13 23:40:17 +09001150 }
1151 for _, s := range f.symlinks {
1152 executablePaths = append(executablePaths, filepath.Join(f.installDir, s))
1153 }
1154 } else if f.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +09001155 // base APK
1156 readOnlyPaths = append(readOnlyPaths, pathInApex)
1157 // Additional APKs
Jiyong Park1b0893e2021-12-13 23:40:17 +09001158 appSetDirs = append(appSetDirs, f.installDir)
Jiyong Parke1b69142022-09-26 14:48:56 +09001159 appSetFiles[f.installDir] = f.module.(*java.AndroidAppSet).PackedAdditionalOutputs()
Jiyong Park1b0893e2021-12-13 23:40:17 +09001160 } else {
1161 readOnlyPaths = append(readOnlyPaths, pathInApex)
1162 }
1163 dir := f.installDir
1164 for !android.InList(dir, executablePaths) && dir != "" {
1165 executablePaths = append(executablePaths, dir)
1166 dir, _ = filepath.Split(dir) // move up to the parent
1167 if len(dir) > 0 {
1168 // remove trailing slash
1169 dir = dir[:len(dir)-1]
1170 }
1171 }
1172 }
1173 sort.Strings(readOnlyPaths)
1174 sort.Strings(executablePaths)
1175 sort.Strings(appSetDirs)
1176
1177 cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config")
1178 builder := android.NewRuleBuilder(pctx, ctx)
1179 cmd := builder.Command()
1180 cmd.Text("(")
1181 cmd.Text("echo '/ 1000 1000 0755';")
1182 for _, p := range readOnlyPaths {
1183 cmd.Textf("echo '/%s 1000 1000 0644';", p)
1184 }
1185 for _, p := range executablePaths {
1186 cmd.Textf("echo '/%s 0 2000 0755';", p)
1187 }
1188 for _, dir := range appSetDirs {
1189 cmd.Textf("echo '/%s 0 2000 0755';", dir)
1190 file := appSetFiles[dir]
1191 cmd.Text("zipinfo -1").Input(file).Textf(`| sed "s:\(.*\):/%s/\1 1000 1000 0644:";`, dir)
1192 }
Jiyong Park038e8522021-12-13 23:56:35 +09001193 // Custom fs_config is "appended" to the last so that entries from the file are preferred
1194 // over default ones set above.
Cole Faustbf1d92a2024-07-29 12:24:25 -07001195 customFsConfig := a.properties.Canned_fs_config.GetOrDefault(ctx, "")
Inseob Kimb1142342024-07-23 13:39:54 +09001196 if customFsConfig != "" {
1197 cmd.Text("cat").Input(android.PathForModuleSrc(ctx, customFsConfig))
Jiyong Park038e8522021-12-13 23:56:35 +09001198 }
Maciej Żenczykowski67e2f792023-03-27 07:03:43 +00001199 cmd.Text(")").FlagWithOutput("> ", cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +09001200 builder.Build("generateFsConfig", fmt.Sprintf("Generating canned fs config for %s", a.BaseModuleName()))
1201
Cole Faust4e9f5922024-11-13 16:09:23 -08001202 return cannedFsConfig
Jiyong Park1b0893e2021-12-13 23:40:17 +09001203}
Jooyung Han01f5d652023-04-05 16:29:26 +09001204
Cole Faust4e9f5922024-11-13 16:09:23 -08001205func runApexLinkerconfigValidation(ctx android.ModuleContext, apexFile android.Path, imageDir android.Path) android.Path {
Jooyung Han4bc10262023-09-08 11:51:45 +09001206 timestamp := android.PathForModuleOut(ctx, "apex_linkerconfig_validation.timestamp")
1207 ctx.Build(pctx, android.BuildParams{
1208 Rule: apexLinkerconfigValidationRule,
1209 Input: apexFile,
1210 Output: timestamp,
1211 Args: map[string]string{
1212 "image_dir": imageDir.String(),
1213 },
1214 })
1215 return timestamp
1216}
1217
Jooyung Han01f5d652023-04-05 16:29:26 +09001218// Runs apex_sepolicy_tests
1219//
1220// $ deapexer list -Z {apex_file} > {file_contexts}
1221// $ apex_sepolicy_tests -f {file_contexts}
Cole Faust4e9f5922024-11-13 16:09:23 -08001222func runApexSepolicyTests(ctx android.ModuleContext, apexFile android.Path) android.Path {
Jooyung Han01f5d652023-04-05 16:29:26 +09001223 timestamp := android.PathForModuleOut(ctx, "sepolicy_tests.timestamp")
1224 ctx.Build(pctx, android.BuildParams{
1225 Rule: apexSepolicyTestsRule,
1226 Input: apexFile,
1227 Output: timestamp,
1228 })
1229 return timestamp
1230}
Jooyung Han55a73062023-11-07 13:09:56 +09001231
Cole Faust4e9f5922024-11-13 16:09:23 -08001232func runApexElfCheckerUnwanted(ctx android.ModuleContext, apexFile android.Path, unwanted []string) android.Path {
Jooyung Han55a73062023-11-07 13:09:56 +09001233 timestamp := android.PathForModuleOut(ctx, "apex_elf_unwanted.timestamp")
1234 ctx.Build(pctx, android.BuildParams{
1235 Rule: apexElfCheckerUnwantedRule,
1236 Input: apexFile,
1237 Output: timestamp,
1238 Args: map[string]string{
1239 "unwanted": android.JoinWithSuffixAndSeparator(unwanted, ".so", ":"),
1240 "tool_path": ctx.Config().HostToolPath(ctx, "").String() + ":${config.ClangBin}",
1241 },
1242 })
1243 return timestamp
1244}
Jooyung Han2adba482024-02-22 17:27:53 +09001245
Cole Faust4e9f5922024-11-13 16:09:23 -08001246func runApexHostVerifier(ctx android.ModuleContext, a *apexBundle, apexFile android.Path) android.Path {
Jooyung Han2adba482024-02-22 17:27:53 +09001247 timestamp := android.PathForModuleOut(ctx, "host_apex_verifier.timestamp")
1248 ctx.Build(pctx, android.BuildParams{
1249 Rule: apexHostVerifierRule,
1250 Input: apexFile,
1251 Output: timestamp,
Jooyung Hanb6ac8222024-10-14 18:20:14 +09001252 Args: map[string]string{
1253 "partition_tag": a.PartitionTag(ctx.DeviceConfig()),
1254 },
Jooyung Han2adba482024-02-22 17:27:53 +09001255 })
1256 return timestamp
1257}