blob: 8ec07fab5239e6ecb62e5c6c953deb1abd1baa37 [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
27 "android/soong/android"
28 "android/soong/java"
29
30 "github.com/google/blueprint"
31 "github.com/google/blueprint/proptools"
32)
33
34var (
35 pctx = android.NewPackageContext("android/apex")
36)
37
38func init() {
39 pctx.Import("android/soong/android")
sophiezc80a2b32020-11-12 16:39:19 +000040 pctx.Import("android/soong/cc/config")
Jiyong Park09d77522019-11-18 11:16:27 +090041 pctx.Import("android/soong/java")
42 pctx.HostBinToolVariable("apexer", "apexer")
Dennis Shenaf41bc12022-08-03 16:46:43 +000043 pctx.HostBinToolVariable("apexer_with_DCLA_preprocessing", "apexer_with_DCLA_preprocessing")
Dennis Shene2ed70c2023-01-11 14:15:43 +000044 pctx.HostBinToolVariable("apexer_with_trim_preprocessing", "apexer_with_trim_preprocessing")
45
Jiyong Park09d77522019-11-18 11:16:27 +090046 // ART minimal builds (using the master-art manifest) do not have the "frameworks/base"
Jiyong Parkb81b9902020-11-24 19:51:18 +090047 // projects, and hence cannot build 'aapt2'. Use the SDK prebuilt instead.
Jiyong Park09d77522019-11-18 11:16:27 +090048 hostBinToolVariableWithPrebuilt := func(name, prebuiltDir, tool string) {
49 pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
50 if !ctx.Config().FrameworksBaseDirExists(ctx) {
51 return filepath.Join(prebuiltDir, runtime.GOOS, "bin", tool)
52 } else {
Martin Stjernholm7260d062019-12-09 21:47:14 +000053 return ctx.Config().HostToolPath(ctx, tool).String()
Jiyong Park09d77522019-11-18 11:16:27 +090054 }
55 })
56 }
57 hostBinToolVariableWithPrebuilt("aapt2", "prebuilts/sdk/tools", "aapt2")
58 pctx.HostBinToolVariable("avbtool", "avbtool")
59 pctx.HostBinToolVariable("e2fsdroid", "e2fsdroid")
60 pctx.HostBinToolVariable("merge_zips", "merge_zips")
61 pctx.HostBinToolVariable("mke2fs", "mke2fs")
62 pctx.HostBinToolVariable("resize2fs", "resize2fs")
63 pctx.HostBinToolVariable("sefcontext_compile", "sefcontext_compile")
64 pctx.HostBinToolVariable("soong_zip", "soong_zip")
65 pctx.HostBinToolVariable("zip2zip", "zip2zip")
66 pctx.HostBinToolVariable("zipalign", "zipalign")
67 pctx.HostBinToolVariable("jsonmodify", "jsonmodify")
68 pctx.HostBinToolVariable("conv_apex_manifest", "conv_apex_manifest")
Jaewoong Jungfa00c062020-05-14 14:15:24 -070069 pctx.HostBinToolVariable("extract_apks", "extract_apks")
Theotime Combes4ba38c12020-06-12 12:46:59 +000070 pctx.HostBinToolVariable("make_f2fs", "make_f2fs")
71 pctx.HostBinToolVariable("sload_f2fs", "sload_f2fs")
Huang Jianan13cac632021-08-02 15:02:17 +080072 pctx.HostBinToolVariable("make_erofs", "make_erofs")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +000073 pctx.HostBinToolVariable("apex_compression_tool", "apex_compression_tool")
sophiez02347372021-11-02 17:58:02 -070074 pctx.HostBinToolVariable("dexdeps", "dexdeps")
Jooyung Han01f5d652023-04-05 16:29:26 +090075 pctx.HostBinToolVariable("apex_sepolicy_tests", "apex_sepolicy_tests")
76 pctx.HostBinToolVariable("deapexer", "deapexer")
77 pctx.HostBinToolVariable("debugfs_static", "debugfs_static")
Jooyung Han55a73062023-11-07 13:09:56 +090078 pctx.HostBinToolVariable("fsck_erofs", "fsck.erofs")
sophiezc80a2b32020-11-12 16:39:19 +000079 pctx.SourcePathVariable("genNdkUsedbyApexPath", "build/soong/scripts/gen_ndk_usedby_apex.sh")
Jooyung Han4bc10262023-09-08 11:51:45 +090080 pctx.HostBinToolVariable("conv_linker_config", "conv_linker_config")
Jooyung Hane6154412023-09-08 15:25:59 +090081 pctx.HostBinToolVariable("assemble_vintf", "assemble_vintf")
Jooyung Han55a73062023-11-07 13:09:56 +090082 pctx.HostBinToolVariable("apex_elf_checker", "apex_elf_checker")
Jiyong Park09d77522019-11-18 11:16:27 +090083}
84
85var (
Jiyong Park09d77522019-11-18 11:16:27 +090086 apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{
87 Command: `rm -f $out && ${jsonmodify} $in ` +
88 `-a provideNativeLibs ${provideNativeLibs} ` +
89 `-a requireNativeLibs ${requireNativeLibs} ` +
Alexei Nicoarad887e242022-07-11 14:16:28 +010090 `-se version 0 ${default_version} ` +
Jiyong Park09d77522019-11-18 11:16:27 +090091 `${opt} ` +
92 `-o $out`,
93 CommandDeps: []string{"${jsonmodify}"},
94 Description: "prepare ${out}",
Alexei Nicoarad887e242022-07-11 14:16:28 +010095 }, "provideNativeLibs", "requireNativeLibs", "default_version", "opt")
Jiyong Park09d77522019-11-18 11:16:27 +090096
97 stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{
98 Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`,
99 CommandDeps: []string{"${conv_apex_manifest}"},
100 Description: "strip ${in}=>${out}",
101 })
102
103 pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{
104 Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`,
105 CommandDeps: []string{"${conv_apex_manifest}"},
106 Description: "convert ${in}=>${out}",
107 })
108
Joe Onoratob4638c12021-10-27 15:47:06 -0700109 // TODO(b/113233103): make sure that file_contexts is as expected, i.e., validate
Jiyong Park09d77522019-11-18 11:16:27 +0900110 // against the binary policy using sefcontext_compiler -p <policy>.
111
112 // TODO(b/114327326): automate the generation of file_contexts
113 apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{
114 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
115 `(. ${out}.copy_commands) && ` +
116 `APEXER_TOOL_PATH=${tool_path} ` +
117 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900118 `--file_contexts ${file_contexts} ` +
119 `--canned_fs_config ${canned_fs_config} ` +
Dario Freni0f4ae072020-01-02 15:24:12 +0000120 `--include_build_info ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900121 `--payload_type image ` +
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000122 `--key ${key} ${opt_flags} ${image_dir} ${out} `,
Jiyong Park09d77522019-11-18 11:16:27 +0900123 CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}",
Huang Jianan13cac632021-08-02 15:02:17 +0800124 "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}", "${sload_f2fs}", "${make_erofs}",
Jiyong Park09d77522019-11-18 11:16:27 +0900125 "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"},
126 Rspfile: "${out}.copy_commands",
127 RspfileContent: "${copy_commands}",
128 Description: "APEX ${image_dir} => ${out}",
Dennis Shenaf41bc12022-08-03 16:46:43 +0000129 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
130 "opt_flags", "manifest")
131
132 DCLAApexRule = pctx.StaticRule("DCLAApexRule", blueprint.RuleParams{
133 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
134 `(. ${out}.copy_commands) && ` +
135 `APEXER_TOOL_PATH=${tool_path} ` +
136 `${apexer_with_DCLA_preprocessing} ` +
137 `--apexer ${apexer} ` +
138 `--canned_fs_config ${canned_fs_config} ` +
139 `${image_dir} ` +
140 `${out} ` +
141 `-- ` +
142 `--include_build_info ` +
143 `--force ` +
144 `--payload_type image ` +
145 `--key ${key} ` +
146 `--file_contexts ${file_contexts} ` +
147 `--manifest ${manifest} ` +
148 `${opt_flags} `,
149 CommandDeps: []string{"${apexer_with_DCLA_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
150 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
151 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
152 "prebuilts/sdk/current/public/android.jar"},
153 Rspfile: "${out}.copy_commands",
154 RspfileContent: "${copy_commands}",
155 Description: "APEX ${image_dir} => ${out}",
156 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
157 "opt_flags", "manifest", "is_DCLA")
Jiyong Park09d77522019-11-18 11:16:27 +0900158
Dennis Shene2ed70c2023-01-11 14:15:43 +0000159 TrimmedApexRule = pctx.StaticRule("TrimmedApexRule", blueprint.RuleParams{
160 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
161 `(. ${out}.copy_commands) && ` +
162 `APEXER_TOOL_PATH=${tool_path} ` +
163 `${apexer_with_trim_preprocessing} ` +
164 `--apexer ${apexer} ` +
165 `--canned_fs_config ${canned_fs_config} ` +
166 `--manifest ${manifest} ` +
167 `--libs_to_trim ${libs_to_trim} ` +
168 `${image_dir} ` +
169 `${out} ` +
170 `-- ` +
171 `--include_build_info ` +
172 `--force ` +
173 `--payload_type image ` +
174 `--key ${key} ` +
175 `--file_contexts ${file_contexts} ` +
176 `${opt_flags} `,
177 CommandDeps: []string{"${apexer_with_trim_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
178 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
179 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
180 "prebuilts/sdk/current/public/android.jar"},
181 Rspfile: "${out}.copy_commands",
182 RspfileContent: "${copy_commands}",
183 Description: "APEX ${image_dir} => ${out}",
184 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
185 "opt_flags", "manifest", "libs_to_trim")
186
Jiyong Park09d77522019-11-18 11:16:27 +0900187 apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule",
188 blueprint.RuleParams{
189 Command: `${aapt2} convert --output-format proto $in -o $out`,
190 CommandDeps: []string{"${aapt2}"},
191 })
192
193 apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{
Jiyong Parkbd159612020-02-28 15:22:21 +0900194 Command: `${zip2zip} -i $in -o $out.base ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900195 `apex_payload.img:apex/${abi}.img ` +
Dario Frenida1aefe2020-03-02 21:47:09 +0000196 `apex_build_info.pb:apex/${abi}.build_info.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900197 `apex_manifest.json:root/apex_manifest.json ` +
Jiyong Park53ae3342019-12-08 02:06:24 +0900198 `apex_manifest.pb:root/apex_manifest.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900199 `AndroidManifest.xml:manifest/AndroidManifest.xml ` +
Jiyong Parkbd159612020-02-28 15:22:21 +0900200 `assets/NOTICE.html.gz:assets/NOTICE.html.gz &&` +
201 `${soong_zip} -o $out.config -C $$(dirname ${config}) -f ${config} && ` +
202 `${merge_zips} $out $out.base $out.config`,
203 CommandDeps: []string{"${zip2zip}", "${soong_zip}", "${merge_zips}"},
Jiyong Park09d77522019-11-18 11:16:27 +0900204 Description: "app bundle",
Jiyong Parkbd159612020-02-28 15:22:21 +0900205 }, "abi", "config")
Jiyong Park09d77522019-11-18 11:16:27 +0900206
Jiyong Park09d77522019-11-18 11:16:27 +0900207 diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{
208 Command: `diff --unchanged-group-format='' \` +
209 `--changed-group-format='%<' \` +
Colin Cross440e0d02020-06-11 11:32:11 -0700210 `${image_content_file} ${allowed_files_file} || (` +
Jiyong Park09d77522019-11-18 11:16:27 +0900211 `echo -e "New unexpected files were added to ${apex_module_name}." ` +
212 ` "To fix the build run following command:" && ` +
Colin Cross440e0d02020-06-11 11:32:11 -0700213 `echo "system/apex/tools/update_allowed_list.sh ${allowed_files_file} ${image_content_file}" && ` +
Dan Willemsen81e43c52020-01-28 15:40:19 -0800214 `exit 1); touch ${out}`,
Colin Cross440e0d02020-06-11 11:32:11 -0700215 Description: "Diff ${image_content_file} and ${allowed_files_file}",
216 }, "image_content_file", "allowed_files_file", "apex_module_name")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900217
sophiezc80a2b32020-11-12 16:39:19 +0000218 generateAPIsUsedbyApexRule = pctx.StaticRule("generateAPIsUsedbyApexRule", blueprint.RuleParams{
219 Command: "$genNdkUsedbyApexPath ${image_dir} ${readelf} ${out}",
220 CommandDeps: []string{"${genNdkUsedbyApexPath}"},
221 Description: "Generate symbol list used by Apex",
222 }, "image_dir", "readelf")
223
Jooyung Han01f5d652023-04-05 16:29:26 +0900224 apexSepolicyTestsRule = pctx.StaticRule("apexSepolicyTestsRule", blueprint.RuleParams{
225 Command: `${deapexer} --debugfs_path ${debugfs_static} list -Z ${in} > ${out}.fc` +
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900226 ` && ${apex_sepolicy_tests} -f ${out}.fc && touch ${out}`,
Jooyung Han01f5d652023-04-05 16:29:26 +0900227 CommandDeps: []string{"${apex_sepolicy_tests}", "${deapexer}", "${debugfs_static}"},
228 Description: "run apex_sepolicy_tests",
229 })
Jooyung Han4bc10262023-09-08 11:51:45 +0900230
231 apexLinkerconfigValidationRule = pctx.StaticRule("apexLinkerconfigValidationRule", blueprint.RuleParams{
232 Command: `${conv_linker_config} validate --type apex ${image_dir} && touch ${out}`,
233 CommandDeps: []string{"${conv_linker_config}"},
234 Description: "run apex_linkerconfig_validation",
235 }, "image_dir")
Jooyung Hane6154412023-09-08 15:25:59 +0900236
Jooyung Han90934ac2023-09-22 14:52:06 +0900237 assembleVintfRule = pctx.StaticRule("assembleVintfRule", blueprint.RuleParams{
238 Command: `rm -f $out && VINTF_IGNORE_TARGET_FCM_VERSION=true ${assemble_vintf} -i $in -o $out`,
Jooyung Hane6154412023-09-08 15:25:59 +0900239 CommandDeps: []string{"${assemble_vintf}"},
Jooyung Han90934ac2023-09-22 14:52:06 +0900240 Description: "run assemble_vintf",
241 })
Jooyung Han55a73062023-11-07 13:09:56 +0900242
243 apexElfCheckerUnwantedRule = pctx.StaticRule("apexElfCheckerUnwantedRule", blueprint.RuleParams{
244 Command: `${apex_elf_checker} --tool_path ${tool_path} --unwanted ${unwanted} ${in} && touch ${out}`,
245 CommandDeps: []string{"${apex_elf_checker}", "${deapexer}", "${debugfs_static}", "${fsck_erofs}", "${config.ClangBin}/llvm-readelf"},
246 Description: "run apex_elf_checker --unwanted",
247 }, "tool_path", "unwanted")
Jiyong Park09d77522019-11-18 11:16:27 +0900248)
249
Jiyong Parkb81b9902020-11-24 19:51:18 +0900250// buildManifest creates buile rules to modify the input apex_manifest.json to add information
251// gathered by the build system such as provided/required native libraries. Two output files having
252// different formats are generated. a.manifestJsonOut is JSON format for Q devices, and
253// a.manifest.PbOut is protobuf format for R+ devices.
254// TODO(jiyong): make this to return paths instead of directly storing the paths to apexBundle
Jiyong Park09d77522019-11-18 11:16:27 +0900255func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900256 src := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json"))
Jiyong Park09d77522019-11-18 11:16:27 +0900257
Jiyong Parkb81b9902020-11-24 19:51:18 +0900258 // Put dependency({provide|require}NativeLibs) in apex_manifest.json
Jiyong Park09d77522019-11-18 11:16:27 +0900259 provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs)
260 requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs))
261
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900262 // VNDK APEX name is determined at runtime, so update "name" in apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900263 optCommands := []string{}
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900264 if a.vndkApex {
265 apexName := vndkApexNamePrefix + a.vndkVersion(ctx.DeviceConfig())
266 optCommands = append(optCommands, "-v name "+apexName)
Jiyong Park09d77522019-11-18 11:16:27 +0900267 }
268
Jiyong Parkb81b9902020-11-24 19:51:18 +0900269 // Collect jniLibs. Notice that a.filesInfo is already sorted
Jooyung Han643adc42020-02-27 13:50:06 +0900270 var jniLibs []string
271 for _, fi := range a.filesInfo {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900272 if fi.isJniLib && !android.InList(fi.stem(), jniLibs) {
273 jniLibs = append(jniLibs, fi.stem())
Jooyung Han643adc42020-02-27 13:50:06 +0900274 }
275 }
276 if len(jniLibs) > 0 {
277 optCommands = append(optCommands, "-a jniLibs "+strings.Join(jniLibs, " "))
278 }
279
Jooyung Hand045ebc2022-12-06 15:23:57 +0900280 if android.InList(":vndk", requireNativeLibs) {
281 if _, vndkVersion := a.getImageVariationPair(ctx.DeviceConfig()); vndkVersion != "" {
282 optCommands = append(optCommands, "-v vndkVersion "+vndkVersion)
283 }
284 }
285
Jiyong Parkb81b9902020-11-24 19:51:18 +0900286 manifestJsonFullOut := android.PathForModuleOut(ctx, "apex_manifest_full.json")
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000287 defaultVersion := android.DefaultUpdatableModuleVersion
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400288 if a.properties.Variant_version != nil {
289 defaultVersionInt, err := strconv.Atoi(defaultVersion)
290 if err != nil {
291 ctx.ModuleErrorf("expected DefaultUpdatableModuleVersion to be an int, but got %s", defaultVersion)
292 }
293 if defaultVersionInt%10 != 0 {
294 ctx.ModuleErrorf("expected DefaultUpdatableModuleVersion to end in a zero, but got %s", defaultVersion)
295 }
296 variantVersion := []rune(*a.properties.Variant_version)
297 if len(variantVersion) != 1 || variantVersion[0] < '0' || variantVersion[0] > '9' {
298 ctx.PropertyErrorf("variant_version", "expected an integer between 0-9; got %s", *a.properties.Variant_version)
299 }
300 defaultVersionRunes := []rune(defaultVersion)
301 defaultVersionRunes[len(defaultVersion)-1] = []rune(variantVersion)[0]
302 defaultVersion = string(defaultVersionRunes)
303 }
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000304 if override := ctx.Config().Getenv("OVERRIDE_APEX_MANIFEST_DEFAULT_VERSION"); override != "" {
305 defaultVersion = override
306 }
Jiyong Park09d77522019-11-18 11:16:27 +0900307 ctx.Build(pctx, android.BuildParams{
308 Rule: apexManifestRule,
Alexei Nicoara0a389202022-07-12 14:35:39 +0100309 Input: src,
Jooyung Han214bf372019-11-12 13:03:50 +0900310 Output: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900311 Args: map[string]string{
312 "provideNativeLibs": strings.Join(provideNativeLibs, " "),
313 "requireNativeLibs": strings.Join(requireNativeLibs, " "),
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000314 "default_version": defaultVersion,
Jiyong Park09d77522019-11-18 11:16:27 +0900315 "opt": strings.Join(optCommands, " "),
316 },
317 })
318
Jiyong Parkb81b9902020-11-24 19:51:18 +0900319 // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json prepare
320 // stripped-down version so that APEX modules built from R+ can be installed to Q
Dan Albertc8060532020-07-22 22:32:17 -0700321 minSdkVersion := a.minSdkVersion(ctx)
322 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Jooyung Han214bf372019-11-12 13:03:50 +0900323 a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json")
324 ctx.Build(pctx, android.BuildParams{
325 Rule: stripApexManifestRule,
326 Input: manifestJsonFullOut,
327 Output: a.manifestJsonOut,
328 })
329 }
Jiyong Park09d77522019-11-18 11:16:27 +0900330
Jiyong Parkb81b9902020-11-24 19:51:18 +0900331 // From R+, protobuf binary format (.pb) is the standard format for apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900332 a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb")
333 ctx.Build(pctx, android.BuildParams{
334 Rule: pbApexManifestRule,
Jooyung Han214bf372019-11-12 13:03:50 +0900335 Input: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900336 Output: a.manifestPbOut,
337 })
338}
339
Jiyong Parkb81b9902020-11-24 19:51:18 +0900340// buildFileContexts create build rules to append an entry for apex_manifest.pb to the file_contexts
341// file for this APEX which is either from /systme/sepolicy/apex/<apexname>-file_contexts or from
342// 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 +0900343// labeled as system_file or vendor_apex_metadata_file.
Jiyong Parkb81b9902020-11-24 19:51:18 +0900344func (a *apexBundle) buildFileContexts(ctx android.ModuleContext) android.OutputPath {
Jooyung Han580eb4f2020-06-24 19:33:06 +0900345 var fileContexts android.Path
Liz Kammer37997c42021-09-14 17:53:38 -0400346 var fileContextsDir string
Inseob Kim28d06d22023-11-17 18:04:42 +0900347 isFileContextsModule := false
Jooyung Han580eb4f2020-06-24 19:33:06 +0900348 if a.properties.File_contexts == nil {
349 fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
350 } else {
Liz Kammer37997c42021-09-14 17:53:38 -0400351 if m, t := android.SrcIsModuleWithTag(*a.properties.File_contexts); m != "" {
Inseob Kim28d06d22023-11-17 18:04:42 +0900352 isFileContextsModule = true
Liz Kammer37997c42021-09-14 17:53:38 -0400353 otherModule := android.GetModuleFromPathDep(ctx, m, t)
354 fileContextsDir = ctx.OtherModuleDir(otherModule)
355 }
Jooyung Han580eb4f2020-06-24 19:33:06 +0900356 fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
357 }
Liz Kammer37997c42021-09-14 17:53:38 -0400358 if fileContextsDir == "" {
359 fileContextsDir = filepath.Dir(fileContexts.String())
360 }
361 fileContextsDir += string(filepath.Separator)
362
Jooyung Han580eb4f2020-06-24 19:33:06 +0900363 if a.Platform() {
Liz Kammer37997c42021-09-14 17:53:38 -0400364 if !strings.HasPrefix(fileContextsDir, "system/sepolicy/") {
365 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but found in %q", fileContextsDir)
Jooyung Han580eb4f2020-06-24 19:33:06 +0900366 }
367 }
Inseob Kim28d06d22023-11-17 18:04:42 +0900368 if !isFileContextsModule && !android.ExistentPathForSource(ctx, fileContexts.String()).Valid() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900369 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", fileContexts.String())
Jooyung Han580eb4f2020-06-24 19:33:06 +0900370 }
371
Jooyung Hanaf730952023-02-28 14:13:38 +0900372 useFileContextsAsIs := proptools.Bool(a.properties.Use_file_contexts_as_is)
373
Jooyung Han580eb4f2020-06-24 19:33:06 +0900374 output := android.PathForModuleOut(ctx, "file_contexts")
Colin Crossf1a035e2020-11-16 17:32:30 -0800375 rule := android.NewRuleBuilder(pctx, ctx)
Jooyung Han7f146c02020-09-23 19:15:55 +0900376
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900377 labelForRoot := "u:object_r:system_file:s0"
378 labelForManifest := "u:object_r:system_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900379 if a.SocSpecific() && !a.vndkApex {
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900380 // APEX on /vendor should label ./ and ./apex_manifest.pb as vendor file.
381 labelForRoot = "u:object_r:vendor_file:s0"
382 labelForManifest = "u:object_r:vendor_apex_metadata_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900383 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900384 // remove old file
385 rule.Command().Text("rm").FlagWithOutput("-f ", output)
386 // copy file_contexts
387 rule.Command().Text("cat").Input(fileContexts).Text(">>").Output(output)
388 // new line
389 rule.Command().Text("echo").Text(">>").Output(output)
390 if !useFileContextsAsIs {
391 // force-label /apex_manifest.pb and /
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900392 rule.Command().Text("echo").Text("/apex_manifest\\\\.pb").Text(labelForManifest).Text(">>").Output(output)
393 rule.Command().Text("echo").Text("/").Text(labelForRoot).Text(">>").Output(output)
Jooyung Han7f146c02020-09-23 19:15:55 +0900394 }
395
Colin Crossf1a035e2020-11-16 17:32:30 -0800396 rule.Build("file_contexts."+a.Name(), "Generate file_contexts")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900397 return output.OutputPath
Jooyung Han580eb4f2020-06-24 19:33:06 +0900398}
399
Jiyong Parkb81b9902020-11-24 19:51:18 +0900400// buildInstalledFilesFile creates a build rule for the installed-files.txt file where the list of
401// files included in this APEX is shown. The text file is dist'ed so that people can see what's
402// included in the APEX without actually downloading and extracting it.
Jiyong Park3a1602e2020-01-14 14:39:19 +0900403func (a *apexBundle) buildInstalledFilesFile(ctx android.ModuleContext, builtApex android.Path, imageDir android.Path) android.OutputPath {
404 output := android.PathForModuleOut(ctx, "installed-files.txt")
Colin Crossf1a035e2020-11-16 17:32:30 -0800405 rule := android.NewRuleBuilder(pctx, ctx)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900406 rule.Command().
407 Implicit(builtApex).
408 Text("(cd " + imageDir.String() + " ; ").
Jiyong Parkbd63a102020-02-08 12:40:05 +0900409 Text("find . \\( -type f -o -type l \\) -printf \"%s %p\\n\") ").
Jiyong Park3a1602e2020-01-14 14:39:19 +0900410 Text(" | sort -nr > ").
411 Output(output)
Colin Crossf1a035e2020-11-16 17:32:30 -0800412 rule.Build("installed-files."+a.Name(), "Installed files")
Jiyong Park3a1602e2020-01-14 14:39:19 +0900413 return output.OutputPath
414}
415
Jiyong Parkb81b9902020-11-24 19:51:18 +0900416// buildBundleConfig creates a build rule for the bundle config file that will control the bundle
417// creation process.
Jiyong Parkbd159612020-02-28 15:22:21 +0900418func (a *apexBundle) buildBundleConfig(ctx android.ModuleContext) android.OutputPath {
419 output := android.PathForModuleOut(ctx, "bundle_config.json")
420
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900421 type ApkConfig struct {
422 Package_name string `json:"package_name"`
423 Apk_path string `json:"path"`
424 }
Jiyong Parkbd159612020-02-28 15:22:21 +0900425 config := struct {
426 Compression struct {
427 Uncompressed_glob []string `json:"uncompressed_glob"`
428 } `json:"compression"`
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900429 Apex_config struct {
430 Apex_embedded_apk_config []ApkConfig `json:"apex_embedded_apk_config,omitempty"`
431 } `json:"apex_config,omitempty"`
Jiyong Parkbd159612020-02-28 15:22:21 +0900432 }{}
433
434 config.Compression.Uncompressed_glob = []string{
435 "apex_payload.img",
436 "apex_manifest.*",
437 }
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900438
Jiyong Parkb81b9902020-11-24 19:51:18 +0900439 // Collect the manifest names and paths of android apps if their manifest names are
440 // overridden.
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900441 for _, fi := range a.filesInfo {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700442 if fi.class != app && fi.class != appSet {
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900443 continue
444 }
445 packageName := fi.overriddenPackageName
446 if packageName != "" {
447 config.Apex_config.Apex_embedded_apk_config = append(
448 config.Apex_config.Apex_embedded_apk_config,
449 ApkConfig{
450 Package_name: packageName,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900451 Apk_path: fi.path(),
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900452 })
453 }
454 }
455
Jiyong Parkbd159612020-02-28 15:22:21 +0900456 j, err := json.Marshal(config)
457 if err != nil {
458 panic(fmt.Errorf("error while marshalling to %q: %#v", output, err))
459 }
460
Colin Crosscf371cc2020-11-13 11:48:42 -0800461 android.WriteFileRule(ctx, output, string(j))
Jiyong Parkbd159612020-02-28 15:22:21 +0900462
463 return output.OutputPath
464}
465
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000466func markManifestTestOnly(ctx android.ModuleContext, androidManifestFile android.Path) android.Path {
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000467 return java.ManifestFixer(ctx, androidManifestFile, java.ManifestFixerParams{
468 TestOnly: true,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000469 })
470}
471
Jooyung Han90934ac2023-09-22 14:52:06 +0900472func isVintfFragment(fi apexFile) bool {
473 isVintfFragment, _ := path.Match("etc/vintf/*.xml", fi.path())
474 return isVintfFragment
475}
476
477func runAssembleVintf(ctx android.ModuleContext, vintfFragment android.Path) android.Path {
478 processed := android.PathForModuleOut(ctx, "vintf", vintfFragment.Base())
479 ctx.Build(pctx, android.BuildParams{
480 Rule: assembleVintfRule,
481 Input: vintfFragment,
482 Output: processed,
483 Description: "run assemble_vintf for VINTF in APEX",
484 })
485 return processed
486}
487
Jooyung Haneec1b3f2023-06-20 16:25:59 +0900488// buildApex creates build rules to build an APEX using apexer.
489func (a *apexBundle) buildApex(ctx android.ModuleContext) {
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900490 suffix := imageApexSuffix
Jooyung Han63dff462023-02-09 00:11:27 +0000491 apexName := a.BaseModuleName()
Jiyong Park09d77522019-11-18 11:16:27 +0900492
Jiyong Parkb81b9902020-11-24 19:51:18 +0900493 ////////////////////////////////////////////////////////////////////////////////////////////
494 // Step 1: copy built files to appropriate directories under the image directory
495
496 imageDir := android.PathForModuleOut(ctx, "image"+suffix)
497
Colin Cross02730b92022-04-18 17:42:27 -0700498 installSymbolFiles := (!ctx.Config().KatiEnabled() || a.ExportedToMake()) && a.installable()
Colin Cross6340ea52021-11-04 12:01:18 -0700499
Colin Cross4acaea92021-12-10 23:05:02 +0000500 // set of dependency module:location mappings
501 installMapSet := make(map[string]bool)
Colin Cross6340ea52021-11-04 12:01:18 -0700502
Jiyong Parkb81b9902020-11-24 19:51:18 +0900503 // TODO(jiyong): use the RuleBuilder
Jiyong Park7cd10e32020-01-14 09:22:18 +0900504 var copyCommands []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900505 var implicitInputs []android.Path
Jooyung Han63dff462023-02-09 00:11:27 +0000506 apexDir := android.PathForModuleInPartitionInstall(ctx, "apex", apexName)
Jiyong Park7cd10e32020-01-14 09:22:18 +0900507 for _, fi := range a.filesInfo {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900508 destPath := imageDir.Join(ctx, fi.path()).String()
Jiyong Parkb81b9902020-11-24 19:51:18 +0900509 // Prepare the destination path
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700510 destPathDir := filepath.Dir(destPath)
511 if fi.class == appSet {
512 copyCommands = append(copyCommands, "rm -rf "+destPathDir)
513 }
514 copyCommands = append(copyCommands, "mkdir -p "+destPathDir)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900515
Colin Cross4acaea92021-12-10 23:05:02 +0000516 installMapPath := fi.builtFile
517
Jiyong Parkb81b9902020-11-24 19:51:18 +0900518 // Copy the built file to the directory. But if the symlink optimization is turned
519 // on, place a symlink to the corresponding file in /system partition instead.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900520 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900521 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Jiyong Park7cd10e32020-01-14 09:22:18 +0900522 copyCommands = append(copyCommands, "ln -sfn "+pathOnDevice+" "+destPath)
523 } else {
Jiyong Park4169a252022-09-29 21:30:25 +0900524 // Copy the file into APEX
Jooyung Han90934ac2023-09-22 14:52:06 +0900525 if !a.testApex && isVintfFragment(fi) {
526 // copy the output of assemble_vintf instead of the original
527 vintfFragment := runAssembleVintf(ctx, fi.builtFile)
528 copyCommands = append(copyCommands, "cp -f "+vintfFragment.String()+" "+destPath)
529 implicitInputs = append(implicitInputs, vintfFragment)
530 } else {
531 copyCommands = append(copyCommands, "cp -f "+fi.builtFile.String()+" "+destPath)
532 implicitInputs = append(implicitInputs, fi.builtFile)
533 }
Jiyong Park4169a252022-09-29 21:30:25 +0900534
Colin Cross4acaea92021-12-10 23:05:02 +0000535 var installedPath android.InstallPath
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700536 if fi.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +0900537 // In case of AppSet, we need to copy additional APKs as well. They
538 // are zipped. So we need to unzip them.
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700539 copyCommands = append(copyCommands,
Colin Crossffbcd1d2021-11-12 12:19:42 -0800540 fmt.Sprintf("unzip -qDD -d %s %s", destPathDir,
541 fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs().String()))
Colin Cross6340ea52021-11-04 12:01:18 -0700542 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000543 installedPath = ctx.InstallFileWithExtraFilesZip(apexDir.Join(ctx, fi.installDir),
Colin Cross6340ea52021-11-04 12:01:18 -0700544 fi.stem(), fi.builtFile, fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs())
545 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700546 } else {
Colin Cross6340ea52021-11-04 12:01:18 -0700547 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000548 installedPath = ctx.InstallFile(apexDir.Join(ctx, fi.installDir), fi.stem(), fi.builtFile)
Colin Cross6340ea52021-11-04 12:01:18 -0700549 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700550 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900551
Colin Cross4acaea92021-12-10 23:05:02 +0000552 // Create additional symlinks pointing the file inside the APEX (if any). Note that
553 // this is independent from the symlink optimization.
554 for _, symlinkPath := range fi.symlinkPaths() {
555 symlinkDest := imageDir.Join(ctx, symlinkPath).String()
556 copyCommands = append(copyCommands, "ln -sfn "+filepath.Base(destPath)+" "+symlinkDest)
557 if installSymbolFiles {
Inseob Kim5bedfee2023-04-20 10:16:14 +0900558 ctx.InstallSymlink(apexDir.Join(ctx, filepath.Dir(symlinkPath)), filepath.Base(symlinkPath), installedPath)
Colin Cross4acaea92021-12-10 23:05:02 +0000559 }
Colin Cross6340ea52021-11-04 12:01:18 -0700560 }
Colin Cross4acaea92021-12-10 23:05:02 +0000561
562 installMapPath = installedPath
Jiyong Park7cd10e32020-01-14 09:22:18 +0900563 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900564
565 // Copy the test files (if any)
Liz Kammer1c14a212020-05-12 15:26:55 -0700566 for _, d := range fi.dataPaths {
567 // TODO(eakammer): This is now the third repetition of ~this logic for test paths, refactoring should be possible
Chris Parsons216e10a2020-07-09 17:12:52 -0400568 relPath := d.SrcPath.Rel()
569 dataPath := d.SrcPath.String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700570 if !strings.HasSuffix(dataPath, relPath) {
571 panic(fmt.Errorf("path %q does not end with %q", dataPath, relPath))
572 }
573
Jiyong Parkb81b9902020-11-24 19:51:18 +0900574 dataDest := imageDir.Join(ctx, fi.apexRelativePath(relPath), d.RelativeInstallPath).String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700575
Chris Parsons216e10a2020-07-09 17:12:52 -0400576 copyCommands = append(copyCommands, "cp -f "+d.SrcPath.String()+" "+dataDest)
577 implicitInputs = append(implicitInputs, d.SrcPath)
Liz Kammer1c14a212020-05-12 15:26:55 -0700578 }
Colin Cross4acaea92021-12-10 23:05:02 +0000579
580 installMapSet[installMapPath.String()+":"+fi.installDir+"/"+fi.builtFile.Base()] = true
Jiyong Park09d77522019-11-18 11:16:27 +0900581 }
Jooyung Han214bf372019-11-12 13:03:50 +0900582 implicitInputs = append(implicitInputs, a.manifestPbOut)
Jiyong Park09d77522019-11-18 11:16:27 +0900583
Colin Cross4acaea92021-12-10 23:05:02 +0000584 if len(installMapSet) > 0 {
585 var installs []string
Cole Faust18994c72023-02-28 16:02:16 -0800586 installs = append(installs, android.SortedKeys(installMapSet)...)
Colin Cross4acaea92021-12-10 23:05:02 +0000587 a.SetLicenseInstallMap(installs)
588 }
589
Jiyong Parkb81b9902020-11-24 19:51:18 +0900590 ////////////////////////////////////////////////////////////////////////////////////////////
591 // Step 1.a: Write the list of files in this APEX to a txt file and compare it against
592 // the allowed list given via the allowed_files property. Build fails when the two lists
593 // differ.
594 //
595 // TODO(jiyong): consider removing this. Nobody other than com.android.apex.cts.shim.* seems
596 // to be using this at this moment. Furthermore, this looks very similar to what
597 // buildInstalledFilesFile does. At least, move this to somewhere else so that this doesn't
598 // hurt readability.
Jooyung Han938b5932020-06-20 12:47:47 +0900599 if a.overridableProperties.Allowed_files != nil {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900600 // Build content.txt
Cole Fausta7347492022-12-16 10:56:24 -0800601 var contentLines []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900602 imageContentFile := android.PathForModuleOut(ctx, "content.txt")
Cole Fausta7347492022-12-16 10:56:24 -0800603 contentLines = append(contentLines, "./apex_manifest.pb")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900604 minSdkVersion := a.minSdkVersion(ctx)
605 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Cole Fausta7347492022-12-16 10:56:24 -0800606 contentLines = append(contentLines, "./apex_manifest.json")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900607 }
608 for _, fi := range a.filesInfo {
Cole Fausta7347492022-12-16 10:56:24 -0800609 contentLines = append(contentLines, "./"+fi.path())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900610 }
Cole Fausta7347492022-12-16 10:56:24 -0800611 sort.Strings(contentLines)
612 android.WriteFileRule(ctx, imageContentFile, strings.Join(contentLines, "\n"))
Jiyong Park09d77522019-11-18 11:16:27 +0900613 implicitInputs = append(implicitInputs, imageContentFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900614
Jiyong Parkb81b9902020-11-24 19:51:18 +0900615 // Compare content.txt against allowed_files.
616 allowedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.overridableProperties.Allowed_files))
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800617 phonyOutput := android.PathForModuleOut(ctx, a.Name()+"-diff-phony-output")
Jiyong Park09d77522019-11-18 11:16:27 +0900618 ctx.Build(pctx, android.BuildParams{
619 Rule: diffApexContentRule,
620 Implicits: implicitInputs,
621 Output: phonyOutput,
622 Description: "diff apex image content",
623 Args: map[string]string{
Colin Cross440e0d02020-06-11 11:32:11 -0700624 "allowed_files_file": allowedFilesFile.String(),
625 "image_content_file": imageContentFile.String(),
626 "apex_module_name": a.Name(),
Jiyong Park09d77522019-11-18 11:16:27 +0900627 },
628 })
Jiyong Park09d77522019-11-18 11:16:27 +0900629 implicitInputs = append(implicitInputs, phonyOutput)
630 }
631
Jiyong Parkb81b9902020-11-24 19:51:18 +0900632 unsignedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix+".unsigned")
Colin Cross790ef352021-10-25 19:15:55 -0700633 outHostBinDir := ctx.Config().HostToolPath(ctx, "").String()
Jiyong Park09d77522019-11-18 11:16:27 +0900634 prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin")
635
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900636 ////////////////////////////////////////////////////////////////////////////////////
637 // Step 2: create canned_fs_config which encodes filemode,uid,gid of each files
638 // in this APEX. The file will be used by apexer in later steps.
639 cannedFsConfig := a.buildCannedFsConfig(ctx)
640 implicitInputs = append(implicitInputs, cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +0900641
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900642 ////////////////////////////////////////////////////////////////////////////////////
643 // Step 3: Prepare option flags for apexer and invoke it to create an unsigned APEX.
644 // TODO(jiyong): use the RuleBuilder
645 optFlags := []string{}
Jiyong Park09d77522019-11-18 11:16:27 +0900646
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900647 fileContexts := a.buildFileContexts(ctx)
648 implicitInputs = append(implicitInputs, fileContexts)
Jiyong Park09d77522019-11-18 11:16:27 +0900649
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900650 implicitInputs = append(implicitInputs, a.privateKeyFile, a.publicKeyFile)
651 optFlags = append(optFlags, "--pubkey "+a.publicKeyFile.String())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900652
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900653 manifestPackageName := a.getOverrideManifestPackageName(ctx)
654 if manifestPackageName != "" {
655 optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName)
656 }
Jiyong Park09d77522019-11-18 11:16:27 +0900657
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900658 if a.properties.AndroidManifest != nil {
659 androidManifestFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.AndroidManifest))
660
661 if a.testApex {
662 androidManifestFile = markManifestTestOnly(ctx, androidManifestFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900663 }
664
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900665 implicitInputs = append(implicitInputs, androidManifestFile)
666 optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String())
667 } else if a.testApex {
668 optFlags = append(optFlags, "--test_only")
669 }
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000670
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900671 // Determine target/min sdk version from the context
672 // TODO(jiyong): make this as a function
673 moduleMinSdkVersion := a.minSdkVersion(ctx)
674 minSdkVersion := moduleMinSdkVersion.String()
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000675
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900676 // bundletool doesn't understand what "current" is. We need to transform it to
677 // codename
678 if moduleMinSdkVersion.IsCurrent() || moduleMinSdkVersion.IsNone() {
679 minSdkVersion = ctx.Config().DefaultAppTargetSdk(ctx).String()
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000680
Nikita Ioffe1f4f3452020-03-02 16:58:11 +0000681 if java.UseApiFingerprint(ctx) {
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900682 minSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
Baligh Uddinf6201372020-01-24 23:15:44 +0000683 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
684 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900685 }
686 // apex module doesn't have a concept of target_sdk_version, hence for the time
687 // being targetSdkVersion == default targetSdkVersion of the branch.
688 targetSdkVersion := strconv.Itoa(ctx.Config().DefaultAppTargetSdk(ctx).FinalOrFutureInt())
Jiyong Park09d77522019-11-18 11:16:27 +0900689
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900690 if java.UseApiFingerprint(ctx) {
691 targetSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
692 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
693 }
694 optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion)
695 optFlags = append(optFlags, "--min_sdk_version "+minSdkVersion)
Baligh Uddin004d7172020-02-19 21:29:28 -0800696
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900697 if a.overridableProperties.Logging_parent != "" {
698 optFlags = append(optFlags, "--logging_parent ", a.overridableProperties.Logging_parent)
699 }
Jiyong Park09d77522019-11-18 11:16:27 +0900700
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900701 // Create a NOTICE file, and embed it as an asset file in the APEX.
702 htmlGzNotice := android.PathForModuleOut(ctx, "NOTICE.html.gz")
703 android.BuildNoticeHtmlOutputFromLicenseMetadata(
704 ctx, htmlGzNotice, "", "",
705 []string{
706 android.PathForModuleInstall(ctx).String() + "/",
707 android.PathForModuleInPartitionInstall(ctx, "apex").String() + "/",
Jiyong Park09d77522019-11-18 11:16:27 +0900708 })
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900709 noticeAssetPath := android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
710 builder := android.NewRuleBuilder(pctx, ctx)
711 builder.Command().Text("cp").
712 Input(htmlGzNotice).
713 Output(noticeAssetPath)
714 builder.Build("notice_dir", "Building notice dir")
715 implicitInputs = append(implicitInputs, noticeAssetPath)
716 optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeAssetPath.String()))
Jiyong Park09d77522019-11-18 11:16:27 +0900717
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900718 // Apexes which are supposed to be installed in builtin dirs(/system, etc)
719 // don't need hashtree for activation. Therefore, by removing hashtree from
720 // apex bundle (filesystem image in it, to be specific), we can save storage.
721 needHashTree := moduleMinSdkVersion.LessThanOrEqualTo(android.SdkVersion_Android10) ||
722 a.shouldGenerateHashtree()
723 if ctx.Config().ApexCompressionEnabled() && a.isCompressable() {
724 needHashTree = true
725 }
726 if !needHashTree {
727 optFlags = append(optFlags, "--no_hashtree")
728 }
sophiezc80a2b32020-11-12 16:39:19 +0000729
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900730 if a.testOnlyShouldSkipPayloadSign() {
731 optFlags = append(optFlags, "--unsigned_payload")
732 }
733
734 if moduleMinSdkVersion == android.SdkVersion_Android10 {
735 implicitInputs = append(implicitInputs, a.manifestJsonOut)
736 optFlags = append(optFlags, "--manifest_json "+a.manifestJsonOut.String())
737 }
738
739 optFlags = append(optFlags, "--payload_fs_type "+a.payloadFsType.string())
740
741 if a.dynamic_common_lib_apex() {
sophiezc80a2b32020-11-12 16:39:19 +0000742 ctx.Build(pctx, android.BuildParams{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900743 Rule: DCLAApexRule,
Jiyong Park09d77522019-11-18 11:16:27 +0900744 Implicits: implicitInputs,
745 Output: unsignedOutputFile,
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900746 Description: "apex",
Jiyong Park09d77522019-11-18 11:16:27 +0900747 Args: map[string]string{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900748 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
749 "image_dir": imageDir.String(),
750 "copy_commands": strings.Join(copyCommands, " && "),
751 "manifest": a.manifestPbOut.String(),
752 "file_contexts": fileContexts.String(),
753 "canned_fs_config": cannedFsConfig.String(),
754 "key": a.privateKeyFile.String(),
755 "opt_flags": strings.Join(optFlags, " "),
756 },
757 })
758 } else if ctx.Config().ApexTrimEnabled() && len(a.libs_to_trim(ctx)) > 0 {
759 ctx.Build(pctx, android.BuildParams{
760 Rule: TrimmedApexRule,
761 Implicits: implicitInputs,
762 Output: unsignedOutputFile,
763 Description: "apex",
764 Args: map[string]string{
765 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
766 "image_dir": imageDir.String(),
767 "copy_commands": strings.Join(copyCommands, " && "),
768 "manifest": a.manifestPbOut.String(),
769 "file_contexts": fileContexts.String(),
770 "canned_fs_config": cannedFsConfig.String(),
771 "key": a.privateKeyFile.String(),
772 "opt_flags": strings.Join(optFlags, " "),
773 "libs_to_trim": strings.Join(a.libs_to_trim(ctx), ","),
774 },
775 })
776 } else {
777 ctx.Build(pctx, android.BuildParams{
778 Rule: apexRule,
779 Implicits: implicitInputs,
780 Output: unsignedOutputFile,
781 Description: "apex",
782 Args: map[string]string{
783 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
784 "image_dir": imageDir.String(),
785 "copy_commands": strings.Join(copyCommands, " && "),
786 "manifest": a.manifestPbOut.String(),
787 "file_contexts": fileContexts.String(),
788 "canned_fs_config": cannedFsConfig.String(),
789 "key": a.privateKeyFile.String(),
790 "opt_flags": strings.Join(optFlags, " "),
Jiyong Park09d77522019-11-18 11:16:27 +0900791 },
792 })
793 }
794
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900795 // TODO(jiyong): make the two rules below as separate functions
796 apexProtoFile := android.PathForModuleOut(ctx, a.Name()+".pb"+suffix)
797 bundleModuleFile := android.PathForModuleOut(ctx, a.Name()+suffix+"-base.zip")
798 a.bundleModuleFile = bundleModuleFile
799
800 ctx.Build(pctx, android.BuildParams{
801 Rule: apexProtoConvertRule,
802 Input: unsignedOutputFile,
803 Output: apexProtoFile,
804 Description: "apex proto convert",
805 })
806
807 implicitInputs = append(implicitInputs, unsignedOutputFile)
808
809 // Run coverage analysis
810 apisUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.txt")
811 ctx.Build(pctx, android.BuildParams{
812 Rule: generateAPIsUsedbyApexRule,
813 Implicits: implicitInputs,
814 Description: "coverage",
815 Output: apisUsedbyOutputFile,
816 Args: map[string]string{
817 "image_dir": imageDir.String(),
818 "readelf": "${config.ClangBin}/llvm-readelf",
819 },
820 })
821 a.nativeApisUsedByModuleFile = apisUsedbyOutputFile
822
823 var nativeLibNames []string
824 for _, f := range a.filesInfo {
825 if f.class == nativeSharedLib {
826 nativeLibNames = append(nativeLibNames, f.stem())
827 }
828 }
829 apisBackedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_backing.txt")
830 rb := android.NewRuleBuilder(pctx, ctx)
831 rb.Command().
832 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_ndk_backedby_apex.sh")).
833 Output(apisBackedbyOutputFile).
834 Flags(nativeLibNames)
835 rb.Build("ndk_backedby_list", "Generate API libraries backed by Apex")
836 a.nativeApisBackedByModuleFile = apisBackedbyOutputFile
837
838 var javaLibOrApkPath []android.Path
839 for _, f := range a.filesInfo {
840 if f.class == javaSharedLib || f.class == app {
841 javaLibOrApkPath = append(javaLibOrApkPath, f.builtFile)
842 }
843 }
844 javaApiUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.xml")
845 javaUsedByRule := android.NewRuleBuilder(pctx, ctx)
846 javaUsedByRule.Command().
847 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_java_usedby_apex.sh")).
848 BuiltTool("dexdeps").
849 Output(javaApiUsedbyOutputFile).
850 Inputs(javaLibOrApkPath)
851 javaUsedByRule.Build("java_usedby_list", "Generate Java APIs used by Apex")
852 a.javaApisUsedByModuleFile = javaApiUsedbyOutputFile
853
854 bundleConfig := a.buildBundleConfig(ctx)
855
856 var abis []string
857 for _, target := range ctx.MultiTargets() {
858 if len(target.Arch.Abi) > 0 {
859 abis = append(abis, target.Arch.Abi[0])
860 }
861 }
862
863 abis = android.FirstUniqueStrings(abis)
864
865 ctx.Build(pctx, android.BuildParams{
866 Rule: apexBundleRule,
867 Input: apexProtoFile,
868 Implicit: bundleConfig,
869 Output: a.bundleModuleFile,
870 Description: "apex bundle module",
871 Args: map[string]string{
872 "abi": strings.Join(abis, "."),
873 "config": bundleConfig.String(),
874 },
875 })
876
Jiyong Parkb81b9902020-11-24 19:51:18 +0900877 ////////////////////////////////////////////////////////////////////////////////////
878 // Step 4: Sign the APEX using signapk
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000879 signedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900880
881 pem, key := a.getCertificateAndPrivateKey(ctx)
Kousik Kumar309b1c02020-05-28 06:13:33 -0700882 rule := java.Signapk
883 args := map[string]string{
Jiyong Parkb81b9902020-11-24 19:51:18 +0900884 "certificates": pem.String() + " " + key.String(),
Jooyung Han5d00f502021-07-11 07:26:22 +0900885 "flags": "-a 4096 --align-file-size", //alignment
Kousik Kumar309b1c02020-05-28 06:13:33 -0700886 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900887 implicits := android.Paths{pem, key}
Ramy Medhat16f23a42020-09-03 01:29:49 -0400888 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
Kousik Kumar309b1c02020-05-28 06:13:33 -0700889 rule = java.SignapkRE
890 args["implicits"] = strings.Join(implicits.Strings(), ",")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000891 args["outCommaList"] = signedOutputFile.String()
Kousik Kumar309b1c02020-05-28 06:13:33 -0700892 }
Jooyung Han01f5d652023-04-05 16:29:26 +0900893 var validations android.Paths
Jooyung Han4bc10262023-09-08 11:51:45 +0900894 validations = append(validations, runApexLinkerconfigValidation(ctx, unsignedOutputFile.OutputPath, imageDir.OutputPath))
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900895 // TODO(b/279688635) deapexer supports [ext4]
896 if suffix == imageApexSuffix && ext4 == a.payloadFsType {
Jooyung Han01f5d652023-04-05 16:29:26 +0900897 validations = append(validations, runApexSepolicyTests(ctx, unsignedOutputFile.OutputPath))
898 }
Jooyung Han55a73062023-11-07 13:09:56 +0900899 if !a.testApex && len(a.properties.Unwanted_transitive_deps) > 0 {
900 validations = append(validations,
901 runApexElfCheckerUnwanted(ctx, unsignedOutputFile.OutputPath, a.properties.Unwanted_transitive_deps))
902 }
Jiyong Park09d77522019-11-18 11:16:27 +0900903 ctx.Build(pctx, android.BuildParams{
Kousik Kumar309b1c02020-05-28 06:13:33 -0700904 Rule: rule,
Jiyong Park09d77522019-11-18 11:16:27 +0900905 Description: "signapk",
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000906 Output: signedOutputFile,
Jiyong Park09d77522019-11-18 11:16:27 +0900907 Input: unsignedOutputFile,
Kousik Kumar309b1c02020-05-28 06:13:33 -0700908 Implicits: implicits,
909 Args: args,
Jooyung Han01f5d652023-04-05 16:29:26 +0900910 Validations: validations,
Jiyong Park09d77522019-11-18 11:16:27 +0900911 })
Jooyung Hana6d36672022-02-24 13:58:07 +0900912 if suffix == imageApexSuffix {
913 a.outputApexFile = signedOutputFile
914 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000915 a.outputFile = signedOutputFile
916
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +0000917 if ctx.ModuleDir() != "system/apex/apexd/apexd_testdata" && a.testOnlyShouldForceCompression() {
918 ctx.PropertyErrorf("test_only_force_compression", "not available")
919 return
920 }
Nikita Ioffebc035882021-04-14 21:35:24 +0100921
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700922 installSuffix := suffix
923 a.setCompression(ctx)
924 if a.isCompressed {
Samiul Islam7c02e262021-09-08 17:48:28 +0100925 unsignedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix+".unsigned")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000926
927 compressRule := android.NewRuleBuilder(pctx, ctx)
928 compressRule.Command().
929 Text("rm").
930 FlagWithOutput("-f ", unsignedCompressedOutputFile)
931 compressRule.Command().
932 BuiltTool("apex_compression_tool").
933 Flag("compress").
934 FlagWithArg("--apex_compression_tool ", outHostBinDir+":"+prebuiltSdkToolsBinDir).
935 FlagWithInput("--input ", signedOutputFile).
936 FlagWithOutput("--output ", unsignedCompressedOutputFile)
937 compressRule.Build("compressRule", "Generate unsigned compressed APEX file")
938
Samiul Islam7c02e262021-09-08 17:48:28 +0100939 signedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix)
Mohammad Samiul Islam9ac0e322021-01-19 11:32:29 +0000940 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
941 args["outCommaList"] = signedCompressedOutputFile.String()
942 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000943 ctx.Build(pctx, android.BuildParams{
944 Rule: rule,
945 Description: "sign compressedApex",
946 Output: signedCompressedOutputFile,
947 Input: unsignedCompressedOutputFile,
948 Implicits: implicits,
949 Args: args,
950 })
951 a.outputFile = signedCompressedOutputFile
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000952 installSuffix = imageCapexSuffix
953 }
954
Colin Crossd9ccb6a2022-03-07 18:38:34 -0800955 if !a.installable() {
956 a.SkipInstall()
957 }
958
Jiyong Park17ff2832021-09-27 12:50:30 +0900959 // Install to $OUT/soong/{target,host}/.../apex.
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000960 a.installedFile = ctx.InstallFile(a.installDir, a.Name()+installSuffix, a.outputFile,
Colin Cross6340ea52021-11-04 12:01:18 -0700961 a.compatSymlinks.Paths()...)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900962
963 // installed-files.txt is dist'ed
964 a.installedFilesFile = a.buildInstalledFilesFile(ctx, a.outputFile, imageDir)
Jooyung Han286957d2023-10-30 16:17:56 +0900965
966 a.apexKeysPath = writeApexKeys(ctx, a)
Jiyong Park09d77522019-11-18 11:16:27 +0900967}
968
Jiyong Parkb81b9902020-11-24 19:51:18 +0900969// getCertificateAndPrivateKey retrieves the cert and the private key that will be used to sign
970// the zip container of this APEX. See the description of the 'certificate' property for how
971// the cert and the private key are found.
972func (a *apexBundle) getCertificateAndPrivateKey(ctx android.PathContext) (pem, key android.Path) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800973 if a.containerCertificateFile != nil {
974 return a.containerCertificateFile, a.containerPrivateKeyFile
Jiyong Parkb81b9902020-11-24 19:51:18 +0900975 }
976
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -0700977 cert := String(a.overridableProperties.Certificate)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900978 if cert == "" {
979 return ctx.Config().DefaultAppCertificate(ctx)
980 }
981
982 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
983 pem = defaultDir.Join(ctx, cert+".x509.pem")
984 key = defaultDir.Join(ctx, cert+".pk8")
985 return pem, key
Jiyong Park09d77522019-11-18 11:16:27 +0900986}
Jooyung Han27151d92019-12-16 17:45:32 +0900987
988func (a *apexBundle) getOverrideManifestPackageName(ctx android.ModuleContext) string {
989 // For VNDK APEXes, check "com.android.vndk" in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
990 // to see if it should be overridden because their <apex name> is dynamically generated
991 // according to its VNDK version.
992 if a.vndkApex {
993 overrideName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(vndkApexName)
994 if overridden {
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900995 return overrideName + ".v" + a.vndkVersion(ctx.DeviceConfig())
Jooyung Han27151d92019-12-16 17:45:32 +0900996 }
997 return ""
998 }
Baligh Uddin5b57dba2020-03-15 13:01:05 -0700999 if a.overridableProperties.Package_name != "" {
1000 return a.overridableProperties.Package_name
1001 }
Jiyong Park20bacab2020-03-03 11:45:41 +09001002 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jooyung Han27151d92019-12-16 17:45:32 +09001003 if overridden {
1004 return manifestPackageName
1005 }
1006 return ""
1007}
Jiyong Park83dc74b2020-01-14 18:38:44 +09001008
1009func (a *apexBundle) buildApexDependencyInfo(ctx android.ModuleContext) {
Jiyong Park83dc74b2020-01-14 18:38:44 +09001010 if a.properties.IsCoverageVariant {
1011 // Otherwise, we will have duplicated rules for coverage and
1012 // non-coverage variants of the same APEX
1013 return
1014 }
1015
Artur Satayev872a1442020-04-27 17:08:37 +01001016 depInfos := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +09001017 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev872a1442020-04-27 17:08:37 +01001018 if from.Name() == to.Name() {
1019 // This can happen for cc.reuseObjTag. We are not interested in tracking this.
1020 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1021 return !externalDep
Jiyong Park678c8812020-02-07 17:25:49 +09001022 }
Jiyong Park83dc74b2020-01-14 18:38:44 +09001023
Artur Satayev533b98c2021-03-11 18:03:42 +00001024 // Skip dependencies that are only available to APEXes; they are developed with updatability
1025 // in mind and don't need manual approval.
1026 if to.(android.ApexModule).NotAvailableForPlatform() {
1027 return !externalDep
1028 }
1029
Cindy Zhou18417cb2020-12-10 07:12:38 -08001030 depTag := ctx.OtherModuleDependencyTag(to)
Artur Satayev533b98c2021-03-11 18:03:42 +00001031 // Check to see if dependency been marked to skip the dependency check
Cindy Zhou18417cb2020-12-10 07:12:38 -08001032 if skipDepCheck, ok := depTag.(android.SkipApexAllowedDependenciesCheck); ok && skipDepCheck.SkipApexAllowedDependenciesCheck() {
Cindy Zhou18417cb2020-12-10 07:12:38 -08001033 return !externalDep
1034 }
1035
Artur Satayev872a1442020-04-27 17:08:37 +01001036 if info, exists := depInfos[to.Name()]; exists {
1037 if !android.InList(from.Name(), info.From) {
1038 info.From = append(info.From, from.Name())
1039 }
1040 info.IsExternal = info.IsExternal && externalDep
1041 depInfos[to.Name()] = info
1042 } else {
Artur Satayev480e25b2020-04-27 18:53:18 +01001043 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001044 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001045 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +09001046 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001047 if v := m.MinSdkVersion(ctx); !v.IsNone() {
1048 toMinSdkVersion = v.String()
Jiyong Park92315372021-04-02 08:45:46 +09001049 }
1050 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1051 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1052 // string
Artur Satayev480e25b2020-04-27 18:53:18 +01001053 if v := m.MinSdkVersion(); v != "" {
1054 toMinSdkVersion = v
1055 }
1056 }
Artur Satayev872a1442020-04-27 17:08:37 +01001057 depInfos[to.Name()] = android.ApexModuleDepInfo{
Artur Satayev480e25b2020-04-27 18:53:18 +01001058 To: to.Name(),
1059 From: []string{from.Name()},
1060 IsExternal: externalDep,
1061 MinSdkVersion: toMinSdkVersion,
Artur Satayev872a1442020-04-27 17:08:37 +01001062 }
1063 }
1064
1065 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1066 return !externalDep
Jiyong Park83dc74b2020-01-14 18:38:44 +09001067 })
1068
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001069 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depInfos)
Artur Satayev872a1442020-04-27 17:08:37 +01001070
Jiyong Park83dc74b2020-01-14 18:38:44 +09001071 ctx.Build(pctx, android.BuildParams{
1072 Rule: android.Phony,
1073 Output: android.PathForPhony(ctx, a.Name()+"-deps-info"),
Artur Satayeva8bd1132020-04-27 18:07:06 +01001074 Inputs: []android.Path{
1075 a.ApexBundleDepsInfo.FullListPath(),
1076 a.ApexBundleDepsInfo.FlatListPath(),
1077 },
Jiyong Park83dc74b2020-01-14 18:38:44 +09001078 })
1079}
Colin Cross08dca382020-07-21 20:31:17 -07001080
1081func (a *apexBundle) buildLintReports(ctx android.ModuleContext) {
1082 depSetsBuilder := java.NewLintDepSetBuilder()
1083 for _, fi := range a.filesInfo {
1084 depSetsBuilder.Transitive(fi.lintDepSets)
1085 }
1086
1087 a.lintReports = java.BuildModuleLintReportZips(ctx, depSetsBuilder.Build())
1088}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001089
1090func (a *apexBundle) buildCannedFsConfig(ctx android.ModuleContext) android.OutputPath {
1091 var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"}
1092 var executablePaths []string // this also includes dirs
1093 var appSetDirs []string
1094 appSetFiles := make(map[string]android.Path)
1095 for _, f := range a.filesInfo {
1096 pathInApex := f.path()
1097 if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") {
1098 executablePaths = append(executablePaths, pathInApex)
1099 for _, d := range f.dataPaths {
1100 readOnlyPaths = append(readOnlyPaths, filepath.Join(f.installDir, d.RelativeInstallPath, d.SrcPath.Rel()))
1101 }
1102 for _, s := range f.symlinks {
1103 executablePaths = append(executablePaths, filepath.Join(f.installDir, s))
1104 }
1105 } else if f.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +09001106 // base APK
1107 readOnlyPaths = append(readOnlyPaths, pathInApex)
1108 // Additional APKs
Jiyong Park1b0893e2021-12-13 23:40:17 +09001109 appSetDirs = append(appSetDirs, f.installDir)
Jiyong Parke1b69142022-09-26 14:48:56 +09001110 appSetFiles[f.installDir] = f.module.(*java.AndroidAppSet).PackedAdditionalOutputs()
Jiyong Park1b0893e2021-12-13 23:40:17 +09001111 } else {
1112 readOnlyPaths = append(readOnlyPaths, pathInApex)
1113 }
1114 dir := f.installDir
1115 for !android.InList(dir, executablePaths) && dir != "" {
1116 executablePaths = append(executablePaths, dir)
1117 dir, _ = filepath.Split(dir) // move up to the parent
1118 if len(dir) > 0 {
1119 // remove trailing slash
1120 dir = dir[:len(dir)-1]
1121 }
1122 }
1123 }
1124 sort.Strings(readOnlyPaths)
1125 sort.Strings(executablePaths)
1126 sort.Strings(appSetDirs)
1127
1128 cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config")
1129 builder := android.NewRuleBuilder(pctx, ctx)
1130 cmd := builder.Command()
1131 cmd.Text("(")
1132 cmd.Text("echo '/ 1000 1000 0755';")
1133 for _, p := range readOnlyPaths {
1134 cmd.Textf("echo '/%s 1000 1000 0644';", p)
1135 }
1136 for _, p := range executablePaths {
1137 cmd.Textf("echo '/%s 0 2000 0755';", p)
1138 }
1139 for _, dir := range appSetDirs {
1140 cmd.Textf("echo '/%s 0 2000 0755';", dir)
1141 file := appSetFiles[dir]
1142 cmd.Text("zipinfo -1").Input(file).Textf(`| sed "s:\(.*\):/%s/\1 1000 1000 0644:";`, dir)
1143 }
Jiyong Park038e8522021-12-13 23:56:35 +09001144 // Custom fs_config is "appended" to the last so that entries from the file are preferred
1145 // over default ones set above.
1146 if a.properties.Canned_fs_config != nil {
1147 cmd.Text("cat").Input(android.PathForModuleSrc(ctx, *a.properties.Canned_fs_config))
1148 }
Maciej Żenczykowski67e2f792023-03-27 07:03:43 +00001149 cmd.Text(")").FlagWithOutput("> ", cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +09001150 builder.Build("generateFsConfig", fmt.Sprintf("Generating canned fs config for %s", a.BaseModuleName()))
1151
1152 return cannedFsConfig.OutputPath
1153}
Jooyung Han01f5d652023-04-05 16:29:26 +09001154
Jooyung Han4bc10262023-09-08 11:51:45 +09001155func runApexLinkerconfigValidation(ctx android.ModuleContext, apexFile android.OutputPath, imageDir android.OutputPath) android.Path {
1156 timestamp := android.PathForModuleOut(ctx, "apex_linkerconfig_validation.timestamp")
1157 ctx.Build(pctx, android.BuildParams{
1158 Rule: apexLinkerconfigValidationRule,
1159 Input: apexFile,
1160 Output: timestamp,
1161 Args: map[string]string{
1162 "image_dir": imageDir.String(),
1163 },
1164 })
1165 return timestamp
1166}
1167
Jooyung Han01f5d652023-04-05 16:29:26 +09001168// Runs apex_sepolicy_tests
1169//
1170// $ deapexer list -Z {apex_file} > {file_contexts}
1171// $ apex_sepolicy_tests -f {file_contexts}
1172func runApexSepolicyTests(ctx android.ModuleContext, apexFile android.OutputPath) android.Path {
1173 timestamp := android.PathForModuleOut(ctx, "sepolicy_tests.timestamp")
1174 ctx.Build(pctx, android.BuildParams{
1175 Rule: apexSepolicyTestsRule,
1176 Input: apexFile,
1177 Output: timestamp,
1178 })
1179 return timestamp
1180}
Jooyung Han55a73062023-11-07 13:09:56 +09001181
1182func runApexElfCheckerUnwanted(ctx android.ModuleContext, apexFile android.OutputPath, unwanted []string) android.Path {
1183 timestamp := android.PathForModuleOut(ctx, "apex_elf_unwanted.timestamp")
1184 ctx.Build(pctx, android.BuildParams{
1185 Rule: apexElfCheckerUnwantedRule,
1186 Input: apexFile,
1187 Output: timestamp,
1188 Args: map[string]string{
1189 "unwanted": android.JoinWithSuffixAndSeparator(unwanted, ".so", ":"),
1190 "tool_path": ctx.Config().HostToolPath(ctx, "").String() + ":${config.ClangBin}",
1191 },
1192 })
1193 return timestamp
1194}