blob: 413295478a3088ce983613a5ed3535a7bfe14d1b [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"
20 "path/filepath"
21 "runtime"
22 "sort"
Nikita Ioffe5335bc42020-10-20 00:02:15 +010023 "strconv"
Jiyong Park09d77522019-11-18 11:16:27 +090024 "strings"
25
26 "android/soong/android"
27 "android/soong/java"
28
29 "github.com/google/blueprint"
30 "github.com/google/blueprint/proptools"
31)
32
33var (
34 pctx = android.NewPackageContext("android/apex")
35)
36
37func init() {
38 pctx.Import("android/soong/android")
sophiezc80a2b32020-11-12 16:39:19 +000039 pctx.Import("android/soong/cc/config")
Jiyong Park09d77522019-11-18 11:16:27 +090040 pctx.Import("android/soong/java")
41 pctx.HostBinToolVariable("apexer", "apexer")
Dennis Shenaf41bc12022-08-03 16:46:43 +000042 pctx.HostBinToolVariable("apexer_with_DCLA_preprocessing", "apexer_with_DCLA_preprocessing")
Dennis Shene2ed70c2023-01-11 14:15:43 +000043 pctx.HostBinToolVariable("apexer_with_trim_preprocessing", "apexer_with_trim_preprocessing")
44
Jiyong Park09d77522019-11-18 11:16:27 +090045 // ART minimal builds (using the master-art manifest) do not have the "frameworks/base"
Jiyong Parkb81b9902020-11-24 19:51:18 +090046 // projects, and hence cannot build 'aapt2'. Use the SDK prebuilt instead.
Jiyong Park09d77522019-11-18 11:16:27 +090047 hostBinToolVariableWithPrebuilt := func(name, prebuiltDir, tool string) {
48 pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
49 if !ctx.Config().FrameworksBaseDirExists(ctx) {
50 return filepath.Join(prebuiltDir, runtime.GOOS, "bin", tool)
51 } else {
Martin Stjernholm7260d062019-12-09 21:47:14 +000052 return ctx.Config().HostToolPath(ctx, tool).String()
Jiyong Park09d77522019-11-18 11:16:27 +090053 }
54 })
55 }
56 hostBinToolVariableWithPrebuilt("aapt2", "prebuilts/sdk/tools", "aapt2")
57 pctx.HostBinToolVariable("avbtool", "avbtool")
58 pctx.HostBinToolVariable("e2fsdroid", "e2fsdroid")
59 pctx.HostBinToolVariable("merge_zips", "merge_zips")
60 pctx.HostBinToolVariable("mke2fs", "mke2fs")
61 pctx.HostBinToolVariable("resize2fs", "resize2fs")
62 pctx.HostBinToolVariable("sefcontext_compile", "sefcontext_compile")
63 pctx.HostBinToolVariable("soong_zip", "soong_zip")
64 pctx.HostBinToolVariable("zip2zip", "zip2zip")
65 pctx.HostBinToolVariable("zipalign", "zipalign")
66 pctx.HostBinToolVariable("jsonmodify", "jsonmodify")
67 pctx.HostBinToolVariable("conv_apex_manifest", "conv_apex_manifest")
Jaewoong Jungfa00c062020-05-14 14:15:24 -070068 pctx.HostBinToolVariable("extract_apks", "extract_apks")
Theotime Combes4ba38c12020-06-12 12:46:59 +000069 pctx.HostBinToolVariable("make_f2fs", "make_f2fs")
70 pctx.HostBinToolVariable("sload_f2fs", "sload_f2fs")
Huang Jianan13cac632021-08-02 15:02:17 +080071 pctx.HostBinToolVariable("make_erofs", "make_erofs")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +000072 pctx.HostBinToolVariable("apex_compression_tool", "apex_compression_tool")
sophiez02347372021-11-02 17:58:02 -070073 pctx.HostBinToolVariable("dexdeps", "dexdeps")
Jooyung Han01f5d652023-04-05 16:29:26 +090074 pctx.HostBinToolVariable("apex_sepolicy_tests", "apex_sepolicy_tests")
75 pctx.HostBinToolVariable("deapexer", "deapexer")
76 pctx.HostBinToolVariable("debugfs_static", "debugfs_static")
sophiezc80a2b32020-11-12 16:39:19 +000077 pctx.SourcePathVariable("genNdkUsedbyApexPath", "build/soong/scripts/gen_ndk_usedby_apex.sh")
Jiyong Park09d77522019-11-18 11:16:27 +090078}
79
80var (
Jiyong Park09d77522019-11-18 11:16:27 +090081 apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{
82 Command: `rm -f $out && ${jsonmodify} $in ` +
83 `-a provideNativeLibs ${provideNativeLibs} ` +
84 `-a requireNativeLibs ${requireNativeLibs} ` +
Alexei Nicoarad887e242022-07-11 14:16:28 +010085 `-se version 0 ${default_version} ` +
Jiyong Park09d77522019-11-18 11:16:27 +090086 `${opt} ` +
87 `-o $out`,
88 CommandDeps: []string{"${jsonmodify}"},
89 Description: "prepare ${out}",
Alexei Nicoarad887e242022-07-11 14:16:28 +010090 }, "provideNativeLibs", "requireNativeLibs", "default_version", "opt")
Jiyong Park09d77522019-11-18 11:16:27 +090091
92 stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{
93 Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`,
94 CommandDeps: []string{"${conv_apex_manifest}"},
95 Description: "strip ${in}=>${out}",
96 })
97
98 pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{
99 Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`,
100 CommandDeps: []string{"${conv_apex_manifest}"},
101 Description: "convert ${in}=>${out}",
102 })
103
Joe Onoratob4638c12021-10-27 15:47:06 -0700104 // TODO(b/113233103): make sure that file_contexts is as expected, i.e., validate
Jiyong Park09d77522019-11-18 11:16:27 +0900105 // against the binary policy using sefcontext_compiler -p <policy>.
106
107 // TODO(b/114327326): automate the generation of file_contexts
108 apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{
109 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
110 `(. ${out}.copy_commands) && ` +
111 `APEXER_TOOL_PATH=${tool_path} ` +
112 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900113 `--file_contexts ${file_contexts} ` +
114 `--canned_fs_config ${canned_fs_config} ` +
Dario Freni0f4ae072020-01-02 15:24:12 +0000115 `--include_build_info ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900116 `--payload_type image ` +
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000117 `--key ${key} ${opt_flags} ${image_dir} ${out} `,
Jiyong Park09d77522019-11-18 11:16:27 +0900118 CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}",
Huang Jianan13cac632021-08-02 15:02:17 +0800119 "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}", "${sload_f2fs}", "${make_erofs}",
Jiyong Park09d77522019-11-18 11:16:27 +0900120 "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"},
121 Rspfile: "${out}.copy_commands",
122 RspfileContent: "${copy_commands}",
123 Description: "APEX ${image_dir} => ${out}",
Dennis Shenaf41bc12022-08-03 16:46:43 +0000124 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
125 "opt_flags", "manifest")
126
127 DCLAApexRule = pctx.StaticRule("DCLAApexRule", blueprint.RuleParams{
128 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
129 `(. ${out}.copy_commands) && ` +
130 `APEXER_TOOL_PATH=${tool_path} ` +
131 `${apexer_with_DCLA_preprocessing} ` +
132 `--apexer ${apexer} ` +
133 `--canned_fs_config ${canned_fs_config} ` +
134 `${image_dir} ` +
135 `${out} ` +
136 `-- ` +
137 `--include_build_info ` +
138 `--force ` +
139 `--payload_type image ` +
140 `--key ${key} ` +
141 `--file_contexts ${file_contexts} ` +
142 `--manifest ${manifest} ` +
143 `${opt_flags} `,
144 CommandDeps: []string{"${apexer_with_DCLA_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
145 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
146 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
147 "prebuilts/sdk/current/public/android.jar"},
148 Rspfile: "${out}.copy_commands",
149 RspfileContent: "${copy_commands}",
150 Description: "APEX ${image_dir} => ${out}",
151 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
152 "opt_flags", "manifest", "is_DCLA")
Jiyong Park09d77522019-11-18 11:16:27 +0900153
Dennis Shene2ed70c2023-01-11 14:15:43 +0000154 TrimmedApexRule = pctx.StaticRule("TrimmedApexRule", blueprint.RuleParams{
155 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
156 `(. ${out}.copy_commands) && ` +
157 `APEXER_TOOL_PATH=${tool_path} ` +
158 `${apexer_with_trim_preprocessing} ` +
159 `--apexer ${apexer} ` +
160 `--canned_fs_config ${canned_fs_config} ` +
161 `--manifest ${manifest} ` +
162 `--libs_to_trim ${libs_to_trim} ` +
163 `${image_dir} ` +
164 `${out} ` +
165 `-- ` +
166 `--include_build_info ` +
167 `--force ` +
168 `--payload_type image ` +
169 `--key ${key} ` +
170 `--file_contexts ${file_contexts} ` +
171 `${opt_flags} `,
172 CommandDeps: []string{"${apexer_with_trim_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
173 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
174 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
175 "prebuilts/sdk/current/public/android.jar"},
176 Rspfile: "${out}.copy_commands",
177 RspfileContent: "${copy_commands}",
178 Description: "APEX ${image_dir} => ${out}",
179 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
180 "opt_flags", "manifest", "libs_to_trim")
181
Jiyong Park09d77522019-11-18 11:16:27 +0900182 zipApexRule = pctx.StaticRule("zipApexRule", blueprint.RuleParams{
183 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
184 `(. ${out}.copy_commands) && ` +
185 `APEXER_TOOL_PATH=${tool_path} ` +
Jooyung Han214bf372019-11-12 13:03:50 +0900186 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900187 `--payload_type zip ` +
188 `${image_dir} ${out} `,
189 CommandDeps: []string{"${apexer}", "${merge_zips}", "${soong_zip}", "${zipalign}", "${aapt2}"},
190 Rspfile: "${out}.copy_commands",
191 RspfileContent: "${copy_commands}",
192 Description: "ZipAPEX ${image_dir} => ${out}",
Alexei Nicoara0a389202022-07-12 14:35:39 +0100193 }, "tool_path", "image_dir", "copy_commands", "manifest")
Jiyong Park09d77522019-11-18 11:16:27 +0900194
195 apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule",
196 blueprint.RuleParams{
197 Command: `${aapt2} convert --output-format proto $in -o $out`,
198 CommandDeps: []string{"${aapt2}"},
199 })
200
201 apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{
Jiyong Parkbd159612020-02-28 15:22:21 +0900202 Command: `${zip2zip} -i $in -o $out.base ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900203 `apex_payload.img:apex/${abi}.img ` +
Dario Frenida1aefe2020-03-02 21:47:09 +0000204 `apex_build_info.pb:apex/${abi}.build_info.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900205 `apex_manifest.json:root/apex_manifest.json ` +
Jiyong Park53ae3342019-12-08 02:06:24 +0900206 `apex_manifest.pb:root/apex_manifest.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900207 `AndroidManifest.xml:manifest/AndroidManifest.xml ` +
Jiyong Parkbd159612020-02-28 15:22:21 +0900208 `assets/NOTICE.html.gz:assets/NOTICE.html.gz &&` +
209 `${soong_zip} -o $out.config -C $$(dirname ${config}) -f ${config} && ` +
210 `${merge_zips} $out $out.base $out.config`,
211 CommandDeps: []string{"${zip2zip}", "${soong_zip}", "${merge_zips}"},
Jiyong Park09d77522019-11-18 11:16:27 +0900212 Description: "app bundle",
Jiyong Parkbd159612020-02-28 15:22:21 +0900213 }, "abi", "config")
Jiyong Park09d77522019-11-18 11:16:27 +0900214
Jiyong Park09d77522019-11-18 11:16:27 +0900215 diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{
216 Command: `diff --unchanged-group-format='' \` +
217 `--changed-group-format='%<' \` +
Colin Cross440e0d02020-06-11 11:32:11 -0700218 `${image_content_file} ${allowed_files_file} || (` +
Jiyong Park09d77522019-11-18 11:16:27 +0900219 `echo -e "New unexpected files were added to ${apex_module_name}." ` +
220 ` "To fix the build run following command:" && ` +
Colin Cross440e0d02020-06-11 11:32:11 -0700221 `echo "system/apex/tools/update_allowed_list.sh ${allowed_files_file} ${image_content_file}" && ` +
Dan Willemsen81e43c52020-01-28 15:40:19 -0800222 `exit 1); touch ${out}`,
Colin Cross440e0d02020-06-11 11:32:11 -0700223 Description: "Diff ${image_content_file} and ${allowed_files_file}",
224 }, "image_content_file", "allowed_files_file", "apex_module_name")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900225
sophiezc80a2b32020-11-12 16:39:19 +0000226 generateAPIsUsedbyApexRule = pctx.StaticRule("generateAPIsUsedbyApexRule", blueprint.RuleParams{
227 Command: "$genNdkUsedbyApexPath ${image_dir} ${readelf} ${out}",
228 CommandDeps: []string{"${genNdkUsedbyApexPath}"},
229 Description: "Generate symbol list used by Apex",
230 }, "image_dir", "readelf")
231
Jooyung Han01f5d652023-04-05 16:29:26 +0900232 apexSepolicyTestsRule = pctx.StaticRule("apexSepolicyTestsRule", blueprint.RuleParams{
233 Command: `${deapexer} --debugfs_path ${debugfs_static} list -Z ${in} > ${out}.fc` +
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900234 ` && ${apex_sepolicy_tests} -f ${out}.fc && touch ${out}`,
Jooyung Han01f5d652023-04-05 16:29:26 +0900235 CommandDeps: []string{"${apex_sepolicy_tests}", "${deapexer}", "${debugfs_static}"},
236 Description: "run apex_sepolicy_tests",
237 })
Jiyong Park09d77522019-11-18 11:16:27 +0900238)
239
Jiyong Parkb81b9902020-11-24 19:51:18 +0900240// buildManifest creates buile rules to modify the input apex_manifest.json to add information
241// gathered by the build system such as provided/required native libraries. Two output files having
242// different formats are generated. a.manifestJsonOut is JSON format for Q devices, and
243// a.manifest.PbOut is protobuf format for R+ devices.
244// TODO(jiyong): make this to return paths instead of directly storing the paths to apexBundle
Jiyong Park09d77522019-11-18 11:16:27 +0900245func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900246 src := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json"))
Jiyong Park09d77522019-11-18 11:16:27 +0900247
Jiyong Parkb81b9902020-11-24 19:51:18 +0900248 // Put dependency({provide|require}NativeLibs) in apex_manifest.json
Jiyong Park09d77522019-11-18 11:16:27 +0900249 provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs)
250 requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs))
251
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900252 // VNDK APEX name is determined at runtime, so update "name" in apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900253 optCommands := []string{}
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900254 if a.vndkApex {
255 apexName := vndkApexNamePrefix + a.vndkVersion(ctx.DeviceConfig())
256 optCommands = append(optCommands, "-v name "+apexName)
Jiyong Park09d77522019-11-18 11:16:27 +0900257 }
258
Jiyong Parkb81b9902020-11-24 19:51:18 +0900259 // Collect jniLibs. Notice that a.filesInfo is already sorted
Jooyung Han643adc42020-02-27 13:50:06 +0900260 var jniLibs []string
261 for _, fi := range a.filesInfo {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900262 if fi.isJniLib && !android.InList(fi.stem(), jniLibs) {
263 jniLibs = append(jniLibs, fi.stem())
Jooyung Han643adc42020-02-27 13:50:06 +0900264 }
265 }
266 if len(jniLibs) > 0 {
267 optCommands = append(optCommands, "-a jniLibs "+strings.Join(jniLibs, " "))
268 }
269
Jooyung Hand045ebc2022-12-06 15:23:57 +0900270 if android.InList(":vndk", requireNativeLibs) {
271 if _, vndkVersion := a.getImageVariationPair(ctx.DeviceConfig()); vndkVersion != "" {
272 optCommands = append(optCommands, "-v vndkVersion "+vndkVersion)
273 }
274 }
275
Jiyong Parkb81b9902020-11-24 19:51:18 +0900276 manifestJsonFullOut := android.PathForModuleOut(ctx, "apex_manifest_full.json")
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000277 defaultVersion := android.DefaultUpdatableModuleVersion
278 if override := ctx.Config().Getenv("OVERRIDE_APEX_MANIFEST_DEFAULT_VERSION"); override != "" {
279 defaultVersion = override
280 }
Jiyong Park09d77522019-11-18 11:16:27 +0900281 ctx.Build(pctx, android.BuildParams{
282 Rule: apexManifestRule,
Alexei Nicoara0a389202022-07-12 14:35:39 +0100283 Input: src,
Jooyung Han214bf372019-11-12 13:03:50 +0900284 Output: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900285 Args: map[string]string{
286 "provideNativeLibs": strings.Join(provideNativeLibs, " "),
287 "requireNativeLibs": strings.Join(requireNativeLibs, " "),
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000288 "default_version": defaultVersion,
Jiyong Park09d77522019-11-18 11:16:27 +0900289 "opt": strings.Join(optCommands, " "),
290 },
291 })
292
Jiyong Parkb81b9902020-11-24 19:51:18 +0900293 // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json prepare
294 // stripped-down version so that APEX modules built from R+ can be installed to Q
Dan Albertc8060532020-07-22 22:32:17 -0700295 minSdkVersion := a.minSdkVersion(ctx)
296 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Jooyung Han214bf372019-11-12 13:03:50 +0900297 a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json")
298 ctx.Build(pctx, android.BuildParams{
299 Rule: stripApexManifestRule,
300 Input: manifestJsonFullOut,
301 Output: a.manifestJsonOut,
302 })
303 }
Jiyong Park09d77522019-11-18 11:16:27 +0900304
Jiyong Parkb81b9902020-11-24 19:51:18 +0900305 // From R+, protobuf binary format (.pb) is the standard format for apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900306 a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb")
307 ctx.Build(pctx, android.BuildParams{
308 Rule: pbApexManifestRule,
Jooyung Han214bf372019-11-12 13:03:50 +0900309 Input: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900310 Output: a.manifestPbOut,
311 })
312}
313
Jiyong Parkb81b9902020-11-24 19:51:18 +0900314// buildFileContexts create build rules to append an entry for apex_manifest.pb to the file_contexts
315// file for this APEX which is either from /systme/sepolicy/apex/<apexname>-file_contexts or from
316// 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 +0900317// labeled as system_file or vendor_apex_metadata_file.
Jiyong Parkb81b9902020-11-24 19:51:18 +0900318func (a *apexBundle) buildFileContexts(ctx android.ModuleContext) android.OutputPath {
Jooyung Han580eb4f2020-06-24 19:33:06 +0900319 var fileContexts android.Path
Liz Kammer37997c42021-09-14 17:53:38 -0400320 var fileContextsDir string
Jooyung Han580eb4f2020-06-24 19:33:06 +0900321 if a.properties.File_contexts == nil {
322 fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
323 } else {
Liz Kammer37997c42021-09-14 17:53:38 -0400324 if m, t := android.SrcIsModuleWithTag(*a.properties.File_contexts); m != "" {
325 otherModule := android.GetModuleFromPathDep(ctx, m, t)
326 fileContextsDir = ctx.OtherModuleDir(otherModule)
327 }
Jooyung Han580eb4f2020-06-24 19:33:06 +0900328 fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
329 }
Liz Kammer37997c42021-09-14 17:53:38 -0400330 if fileContextsDir == "" {
331 fileContextsDir = filepath.Dir(fileContexts.String())
332 }
333 fileContextsDir += string(filepath.Separator)
334
Jooyung Han580eb4f2020-06-24 19:33:06 +0900335 if a.Platform() {
Liz Kammer37997c42021-09-14 17:53:38 -0400336 if !strings.HasPrefix(fileContextsDir, "system/sepolicy/") {
337 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but found in %q", fileContextsDir)
Jooyung Han580eb4f2020-06-24 19:33:06 +0900338 }
339 }
340 if !android.ExistentPathForSource(ctx, fileContexts.String()).Valid() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900341 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", fileContexts.String())
Jooyung Han580eb4f2020-06-24 19:33:06 +0900342 }
343
Jooyung Hanaf730952023-02-28 14:13:38 +0900344 useFileContextsAsIs := proptools.Bool(a.properties.Use_file_contexts_as_is)
345
Jooyung Han580eb4f2020-06-24 19:33:06 +0900346 output := android.PathForModuleOut(ctx, "file_contexts")
Colin Crossf1a035e2020-11-16 17:32:30 -0800347 rule := android.NewRuleBuilder(pctx, ctx)
Jooyung Han7f146c02020-09-23 19:15:55 +0900348
Jooyung Hanbe953902023-05-31 16:42:16 +0900349 forceLabel := "u:object_r:system_file:s0"
350 if a.SocSpecific() && !a.vndkApex {
351 // APEX on /vendor should label ./ and ./apex_manifest.pb as vendor_apex_metadata_file.
352 // The reason why we skip VNDK APEX is that aosp_{pixel device} targets install VNDK APEX on /vendor
353 // even though VNDK APEX is supposed to be installed on /system. (See com.android.vndk.current.on_vendor)
354 forceLabel = "u:object_r:vendor_apex_metadata_file:s0"
355 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900356 switch a.properties.ApexType {
357 case imageApex:
Jooyung Han7f146c02020-09-23 19:15:55 +0900358 // remove old file
359 rule.Command().Text("rm").FlagWithOutput("-f ", output)
360 // copy file_contexts
361 rule.Command().Text("cat").Input(fileContexts).Text(">>").Output(output)
362 // new line
363 rule.Command().Text("echo").Text(">>").Output(output)
Jooyung Hanaf730952023-02-28 14:13:38 +0900364 if !useFileContextsAsIs {
Jooyung Hanbe953902023-05-31 16:42:16 +0900365 // force-label /apex_manifest.pb and /
366 rule.Command().Text("echo").Text("/apex_manifest\\\\.pb").Text(forceLabel).Text(">>").Output(output)
367 rule.Command().Text("echo").Text("/").Text(forceLabel).Text(">>").Output(output)
Jooyung Hanaf730952023-02-28 14:13:38 +0900368 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900369 case flattenedApex:
Jooyung Han7f146c02020-09-23 19:15:55 +0900370 // For flattened apexes, install path should be prepended.
371 // File_contexts file should be emiited to make via LOCAL_FILE_CONTEXTS
372 // so that it can be merged into file_contexts.bin
373 apexPath := android.InstallPathToOnDevicePath(ctx, a.installDir.Join(ctx, a.Name()))
374 apexPath = strings.ReplaceAll(apexPath, ".", `\\.`)
375 // remove old file
376 rule.Command().Text("rm").FlagWithOutput("-f ", output)
377 // copy file_contexts
378 rule.Command().Text("awk").Text(`'/object_r/{printf("` + apexPath + `%s\n", $0)}'`).Input(fileContexts).Text(">").Output(output)
379 // new line
380 rule.Command().Text("echo").Text(">>").Output(output)
Jooyung Hanaf730952023-02-28 14:13:38 +0900381 if !useFileContextsAsIs {
Jooyung Hanbe953902023-05-31 16:42:16 +0900382 // force-label /apex_manifest.pb and /
383 rule.Command().Text("echo").Text(apexPath + "/apex_manifest\\\\.pb").Text(forceLabel).Text(">>").Output(output)
384 rule.Command().Text("echo").Text(apexPath + "/").Text(forceLabel).Text(">>").Output(output)
Jooyung Hanaf730952023-02-28 14:13:38 +0900385 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900386 default:
387 panic(fmt.Errorf("unsupported type %v", a.properties.ApexType))
Jooyung Han7f146c02020-09-23 19:15:55 +0900388 }
389
Colin Crossf1a035e2020-11-16 17:32:30 -0800390 rule.Build("file_contexts."+a.Name(), "Generate file_contexts")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900391 return output.OutputPath
Jooyung Han580eb4f2020-06-24 19:33:06 +0900392}
393
Jiyong Parkb81b9902020-11-24 19:51:18 +0900394// buildInstalledFilesFile creates a build rule for the installed-files.txt file where the list of
395// files included in this APEX is shown. The text file is dist'ed so that people can see what's
396// included in the APEX without actually downloading and extracting it.
Jiyong Park3a1602e2020-01-14 14:39:19 +0900397func (a *apexBundle) buildInstalledFilesFile(ctx android.ModuleContext, builtApex android.Path, imageDir android.Path) android.OutputPath {
398 output := android.PathForModuleOut(ctx, "installed-files.txt")
Colin Crossf1a035e2020-11-16 17:32:30 -0800399 rule := android.NewRuleBuilder(pctx, ctx)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900400 rule.Command().
401 Implicit(builtApex).
402 Text("(cd " + imageDir.String() + " ; ").
Jiyong Parkbd63a102020-02-08 12:40:05 +0900403 Text("find . \\( -type f -o -type l \\) -printf \"%s %p\\n\") ").
Jiyong Park3a1602e2020-01-14 14:39:19 +0900404 Text(" | sort -nr > ").
405 Output(output)
Colin Crossf1a035e2020-11-16 17:32:30 -0800406 rule.Build("installed-files."+a.Name(), "Installed files")
Jiyong Park3a1602e2020-01-14 14:39:19 +0900407 return output.OutputPath
408}
409
Jiyong Parkb81b9902020-11-24 19:51:18 +0900410// buildBundleConfig creates a build rule for the bundle config file that will control the bundle
411// creation process.
Jiyong Parkbd159612020-02-28 15:22:21 +0900412func (a *apexBundle) buildBundleConfig(ctx android.ModuleContext) android.OutputPath {
413 output := android.PathForModuleOut(ctx, "bundle_config.json")
414
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900415 type ApkConfig struct {
416 Package_name string `json:"package_name"`
417 Apk_path string `json:"path"`
418 }
Jiyong Parkbd159612020-02-28 15:22:21 +0900419 config := struct {
420 Compression struct {
421 Uncompressed_glob []string `json:"uncompressed_glob"`
422 } `json:"compression"`
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900423 Apex_config struct {
424 Apex_embedded_apk_config []ApkConfig `json:"apex_embedded_apk_config,omitempty"`
425 } `json:"apex_config,omitempty"`
Jiyong Parkbd159612020-02-28 15:22:21 +0900426 }{}
427
428 config.Compression.Uncompressed_glob = []string{
429 "apex_payload.img",
430 "apex_manifest.*",
431 }
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900432
Jiyong Parkb81b9902020-11-24 19:51:18 +0900433 // Collect the manifest names and paths of android apps if their manifest names are
434 // overridden.
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900435 for _, fi := range a.filesInfo {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700436 if fi.class != app && fi.class != appSet {
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900437 continue
438 }
439 packageName := fi.overriddenPackageName
440 if packageName != "" {
441 config.Apex_config.Apex_embedded_apk_config = append(
442 config.Apex_config.Apex_embedded_apk_config,
443 ApkConfig{
444 Package_name: packageName,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900445 Apk_path: fi.path(),
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900446 })
447 }
448 }
449
Jiyong Parkbd159612020-02-28 15:22:21 +0900450 j, err := json.Marshal(config)
451 if err != nil {
452 panic(fmt.Errorf("error while marshalling to %q: %#v", output, err))
453 }
454
Colin Crosscf371cc2020-11-13 11:48:42 -0800455 android.WriteFileRule(ctx, output, string(j))
Jiyong Parkbd159612020-02-28 15:22:21 +0900456
457 return output.OutputPath
458}
459
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000460func markManifestTestOnly(ctx android.ModuleContext, androidManifestFile android.Path) android.Path {
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000461 return java.ManifestFixer(ctx, androidManifestFile, java.ManifestFixerParams{
462 TestOnly: true,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000463 })
464}
465
Jiyong Parkb81b9902020-11-24 19:51:18 +0900466// buildUnflattendApex creates build rules to build an APEX using apexer.
Jiyong Park09d77522019-11-18 11:16:27 +0900467func (a *apexBundle) buildUnflattenedApex(ctx android.ModuleContext) {
Jiyong Park09d77522019-11-18 11:16:27 +0900468 apexType := a.properties.ApexType
469 suffix := apexType.suffix()
Jooyung Han63dff462023-02-09 00:11:27 +0000470 apexName := a.BaseModuleName()
Jiyong Park09d77522019-11-18 11:16:27 +0900471
Jiyong Parkb81b9902020-11-24 19:51:18 +0900472 ////////////////////////////////////////////////////////////////////////////////////////////
473 // Step 1: copy built files to appropriate directories under the image directory
474
475 imageDir := android.PathForModuleOut(ctx, "image"+suffix)
476
Colin Cross02730b92022-04-18 17:42:27 -0700477 installSymbolFiles := (!ctx.Config().KatiEnabled() || a.ExportedToMake()) && a.installable()
Colin Cross6340ea52021-11-04 12:01:18 -0700478
Colin Cross4acaea92021-12-10 23:05:02 +0000479 // set of dependency module:location mappings
480 installMapSet := make(map[string]bool)
Colin Cross6340ea52021-11-04 12:01:18 -0700481
Jiyong Parkb81b9902020-11-24 19:51:18 +0900482 // TODO(jiyong): use the RuleBuilder
Jiyong Park7cd10e32020-01-14 09:22:18 +0900483 var copyCommands []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900484 var implicitInputs []android.Path
Jooyung Han63dff462023-02-09 00:11:27 +0000485 apexDir := android.PathForModuleInPartitionInstall(ctx, "apex", apexName)
Jiyong Park7cd10e32020-01-14 09:22:18 +0900486 for _, fi := range a.filesInfo {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900487 destPath := imageDir.Join(ctx, fi.path()).String()
Jiyong Parkb81b9902020-11-24 19:51:18 +0900488 // Prepare the destination path
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700489 destPathDir := filepath.Dir(destPath)
490 if fi.class == appSet {
491 copyCommands = append(copyCommands, "rm -rf "+destPathDir)
492 }
493 copyCommands = append(copyCommands, "mkdir -p "+destPathDir)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900494
Colin Cross4acaea92021-12-10 23:05:02 +0000495 installMapPath := fi.builtFile
496
Jiyong Parkb81b9902020-11-24 19:51:18 +0900497 // Copy the built file to the directory. But if the symlink optimization is turned
498 // on, place a symlink to the corresponding file in /system partition instead.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900499 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900500 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Jiyong Park7cd10e32020-01-14 09:22:18 +0900501 copyCommands = append(copyCommands, "ln -sfn "+pathOnDevice+" "+destPath)
502 } else {
Jiyong Park4169a252022-09-29 21:30:25 +0900503 // Copy the file into APEX
504 copyCommands = append(copyCommands, "cp -f "+fi.builtFile.String()+" "+destPath)
505
Colin Cross4acaea92021-12-10 23:05:02 +0000506 var installedPath android.InstallPath
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700507 if fi.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +0900508 // In case of AppSet, we need to copy additional APKs as well. They
509 // are zipped. So we need to unzip them.
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700510 copyCommands = append(copyCommands,
Colin Crossffbcd1d2021-11-12 12:19:42 -0800511 fmt.Sprintf("unzip -qDD -d %s %s", destPathDir,
512 fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs().String()))
Colin Cross6340ea52021-11-04 12:01:18 -0700513 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000514 installedPath = ctx.InstallFileWithExtraFilesZip(apexDir.Join(ctx, fi.installDir),
Colin Cross6340ea52021-11-04 12:01:18 -0700515 fi.stem(), fi.builtFile, fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs())
516 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700517 } else {
Colin Cross6340ea52021-11-04 12:01:18 -0700518 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000519 installedPath = ctx.InstallFile(apexDir.Join(ctx, fi.installDir), fi.stem(), fi.builtFile)
Colin Cross6340ea52021-11-04 12:01:18 -0700520 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700521 }
Jiyong Park7cd10e32020-01-14 09:22:18 +0900522 implicitInputs = append(implicitInputs, fi.builtFile)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900523
Colin Cross4acaea92021-12-10 23:05:02 +0000524 // Create additional symlinks pointing the file inside the APEX (if any). Note that
525 // this is independent from the symlink optimization.
526 for _, symlinkPath := range fi.symlinkPaths() {
527 symlinkDest := imageDir.Join(ctx, symlinkPath).String()
528 copyCommands = append(copyCommands, "ln -sfn "+filepath.Base(destPath)+" "+symlinkDest)
529 if installSymbolFiles {
Inseob Kim5bedfee2023-04-20 10:16:14 +0900530 ctx.InstallSymlink(apexDir.Join(ctx, filepath.Dir(symlinkPath)), filepath.Base(symlinkPath), installedPath)
Colin Cross4acaea92021-12-10 23:05:02 +0000531 }
Colin Cross6340ea52021-11-04 12:01:18 -0700532 }
Colin Cross4acaea92021-12-10 23:05:02 +0000533
534 installMapPath = installedPath
Jiyong Park7cd10e32020-01-14 09:22:18 +0900535 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900536
537 // Copy the test files (if any)
Liz Kammer1c14a212020-05-12 15:26:55 -0700538 for _, d := range fi.dataPaths {
539 // 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 -0400540 relPath := d.SrcPath.Rel()
541 dataPath := d.SrcPath.String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700542 if !strings.HasSuffix(dataPath, relPath) {
543 panic(fmt.Errorf("path %q does not end with %q", dataPath, relPath))
544 }
545
Jiyong Parkb81b9902020-11-24 19:51:18 +0900546 dataDest := imageDir.Join(ctx, fi.apexRelativePath(relPath), d.RelativeInstallPath).String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700547
Chris Parsons216e10a2020-07-09 17:12:52 -0400548 copyCommands = append(copyCommands, "cp -f "+d.SrcPath.String()+" "+dataDest)
549 implicitInputs = append(implicitInputs, d.SrcPath)
Liz Kammer1c14a212020-05-12 15:26:55 -0700550 }
Colin Cross4acaea92021-12-10 23:05:02 +0000551
552 installMapSet[installMapPath.String()+":"+fi.installDir+"/"+fi.builtFile.Base()] = true
Jiyong Park09d77522019-11-18 11:16:27 +0900553 }
Jooyung Han214bf372019-11-12 13:03:50 +0900554 implicitInputs = append(implicitInputs, a.manifestPbOut)
Jiyong Park09d77522019-11-18 11:16:27 +0900555
Colin Cross4acaea92021-12-10 23:05:02 +0000556 if len(installMapSet) > 0 {
557 var installs []string
Cole Faust18994c72023-02-28 16:02:16 -0800558 installs = append(installs, android.SortedKeys(installMapSet)...)
Colin Cross4acaea92021-12-10 23:05:02 +0000559 a.SetLicenseInstallMap(installs)
560 }
561
Jiyong Parkb81b9902020-11-24 19:51:18 +0900562 ////////////////////////////////////////////////////////////////////////////////////////////
563 // Step 1.a: Write the list of files in this APEX to a txt file and compare it against
564 // the allowed list given via the allowed_files property. Build fails when the two lists
565 // differ.
566 //
567 // TODO(jiyong): consider removing this. Nobody other than com.android.apex.cts.shim.* seems
568 // to be using this at this moment. Furthermore, this looks very similar to what
569 // buildInstalledFilesFile does. At least, move this to somewhere else so that this doesn't
570 // hurt readability.
Jooyung Han938b5932020-06-20 12:47:47 +0900571 if a.overridableProperties.Allowed_files != nil {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900572 // Build content.txt
Cole Fausta7347492022-12-16 10:56:24 -0800573 var contentLines []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900574 imageContentFile := android.PathForModuleOut(ctx, "content.txt")
Cole Fausta7347492022-12-16 10:56:24 -0800575 contentLines = append(contentLines, "./apex_manifest.pb")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900576 minSdkVersion := a.minSdkVersion(ctx)
577 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Cole Fausta7347492022-12-16 10:56:24 -0800578 contentLines = append(contentLines, "./apex_manifest.json")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900579 }
580 for _, fi := range a.filesInfo {
Cole Fausta7347492022-12-16 10:56:24 -0800581 contentLines = append(contentLines, "./"+fi.path())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900582 }
Cole Fausta7347492022-12-16 10:56:24 -0800583 sort.Strings(contentLines)
584 android.WriteFileRule(ctx, imageContentFile, strings.Join(contentLines, "\n"))
Jiyong Park09d77522019-11-18 11:16:27 +0900585 implicitInputs = append(implicitInputs, imageContentFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900586
Jiyong Parkb81b9902020-11-24 19:51:18 +0900587 // Compare content.txt against allowed_files.
588 allowedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.overridableProperties.Allowed_files))
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800589 phonyOutput := android.PathForModuleOut(ctx, a.Name()+"-diff-phony-output")
Jiyong Park09d77522019-11-18 11:16:27 +0900590 ctx.Build(pctx, android.BuildParams{
591 Rule: diffApexContentRule,
592 Implicits: implicitInputs,
593 Output: phonyOutput,
594 Description: "diff apex image content",
595 Args: map[string]string{
Colin Cross440e0d02020-06-11 11:32:11 -0700596 "allowed_files_file": allowedFilesFile.String(),
597 "image_content_file": imageContentFile.String(),
598 "apex_module_name": a.Name(),
Jiyong Park09d77522019-11-18 11:16:27 +0900599 },
600 })
Jiyong Park09d77522019-11-18 11:16:27 +0900601 implicitInputs = append(implicitInputs, phonyOutput)
602 }
603
Jiyong Parkb81b9902020-11-24 19:51:18 +0900604 unsignedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix+".unsigned")
Colin Cross790ef352021-10-25 19:15:55 -0700605 outHostBinDir := ctx.Config().HostToolPath(ctx, "").String()
Jiyong Park09d77522019-11-18 11:16:27 +0900606 prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin")
607
608 if apexType == imageApex {
Jiyong Park1b0893e2021-12-13 23:40:17 +0900609
Jiyong Parkb81b9902020-11-24 19:51:18 +0900610 ////////////////////////////////////////////////////////////////////////////////////
611 // Step 2: create canned_fs_config which encodes filemode,uid,gid of each files
612 // in this APEX. The file will be used by apexer in later steps.
Jiyong Park1b0893e2021-12-13 23:40:17 +0900613 cannedFsConfig := a.buildCannedFsConfig(ctx)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900614 implicitInputs = append(implicitInputs, cannedFsConfig)
Jiyong Park09d77522019-11-18 11:16:27 +0900615
Jiyong Parkb81b9902020-11-24 19:51:18 +0900616 ////////////////////////////////////////////////////////////////////////////////////
617 // Step 3: Prepare option flags for apexer and invoke it to create an unsigned APEX.
618 // TODO(jiyong): use the RuleBuilder
Jiyong Park09d77522019-11-18 11:16:27 +0900619 optFlags := []string{}
620
Jiyong Parkb81b9902020-11-24 19:51:18 +0900621 fileContexts := a.buildFileContexts(ctx)
622 implicitInputs = append(implicitInputs, fileContexts)
623
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800624 implicitInputs = append(implicitInputs, a.privateKeyFile, a.publicKeyFile)
625 optFlags = append(optFlags, "--pubkey "+a.publicKeyFile.String())
Jiyong Park09d77522019-11-18 11:16:27 +0900626
Jooyung Han27151d92019-12-16 17:45:32 +0900627 manifestPackageName := a.getOverrideManifestPackageName(ctx)
628 if manifestPackageName != "" {
Jiyong Park09d77522019-11-18 11:16:27 +0900629 optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName)
630 }
631
632 if a.properties.AndroidManifest != nil {
633 androidManifestFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.AndroidManifest))
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000634
635 if a.testApex {
636 androidManifestFile = markManifestTestOnly(ctx, androidManifestFile)
637 }
638
Jiyong Park09d77522019-11-18 11:16:27 +0900639 implicitInputs = append(implicitInputs, androidManifestFile)
640 optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String())
Gurpreet Singha76f8742022-02-03 21:01:51 +0000641 } else if a.testApex {
642 optFlags = append(optFlags, "--test_only")
Jiyong Park09d77522019-11-18 11:16:27 +0900643 }
644
Jiyong Parkb81b9902020-11-24 19:51:18 +0900645 // Determine target/min sdk version from the context
646 // TODO(jiyong): make this as a function
Dan Albertc8060532020-07-22 22:32:17 -0700647 moduleMinSdkVersion := a.minSdkVersion(ctx)
Nikita Ioffe5335bc42020-10-20 00:02:15 +0100648 minSdkVersion := moduleMinSdkVersion.String()
649
Jiyong Parkb81b9902020-11-24 19:51:18 +0900650 // bundletool doesn't understand what "current" is. We need to transform it to
651 // codename
Jooyung Haned124c32021-01-26 11:43:46 +0900652 if moduleMinSdkVersion.IsCurrent() || moduleMinSdkVersion.IsNone() {
Nikita Ioffe5335bc42020-10-20 00:02:15 +0100653 minSdkVersion = ctx.Config().DefaultAppTargetSdk(ctx).String()
Liz Kammer4854a7d2021-05-27 14:28:27 -0400654
655 if java.UseApiFingerprint(ctx) {
656 minSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
657 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
658 }
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000659 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900660 // apex module doesn't have a concept of target_sdk_version, hence for the time
661 // being targetSdkVersion == default targetSdkVersion of the branch.
Nikita Ioffe5335bc42020-10-20 00:02:15 +0100662 targetSdkVersion := strconv.Itoa(ctx.Config().DefaultAppTargetSdk(ctx).FinalOrFutureInt())
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000663
Nikita Ioffe1f4f3452020-03-02 16:58:11 +0000664 if java.UseApiFingerprint(ctx) {
665 targetSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
Baligh Uddinf6201372020-01-24 23:15:44 +0000666 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
667 }
Jiyong Park09d77522019-11-18 11:16:27 +0900668 optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion)
Baligh Uddinf6201372020-01-24 23:15:44 +0000669 optFlags = append(optFlags, "--min_sdk_version "+minSdkVersion)
Jiyong Park09d77522019-11-18 11:16:27 +0900670
Baligh Uddin004d7172020-02-19 21:29:28 -0800671 if a.overridableProperties.Logging_parent != "" {
672 optFlags = append(optFlags, "--logging_parent ", a.overridableProperties.Logging_parent)
673 }
674
Bob Badourde6a0872022-04-01 18:00:00 +0000675 // Create a NOTICE file, and embed it as an asset file in the APEX.
Jingwen Chen4a9630b2022-11-16 19:12:35 +0000676 htmlGzNotice := android.PathForModuleOut(ctx, "NOTICE.html.gz")
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700677 android.BuildNoticeHtmlOutputFromLicenseMetadata(
Jingwen Chen4a9630b2022-11-16 19:12:35 +0000678 ctx, htmlGzNotice, "", "",
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700679 []string{
680 android.PathForModuleInstall(ctx).String() + "/",
681 android.PathForModuleInPartitionInstall(ctx, "apex").String() + "/",
682 })
Bob Badour2c8888e2022-04-04 16:12:21 -0700683 noticeAssetPath := android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
684 builder := android.NewRuleBuilder(pctx, ctx)
685 builder.Command().Text("cp").
Jingwen Chen4a9630b2022-11-16 19:12:35 +0000686 Input(htmlGzNotice).
Bob Badour2c8888e2022-04-04 16:12:21 -0700687 Output(noticeAssetPath)
688 builder.Build("notice_dir", "Building notice dir")
689 implicitInputs = append(implicitInputs, noticeAssetPath)
690 optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeAssetPath.String()))
Jiyong Park09d77522019-11-18 11:16:27 +0900691
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700692 // Apexes which are supposed to be installed in builtin dirs(/system, etc)
693 // don't need hashtree for activation. Therefore, by removing hashtree from
694 // apex bundle (filesystem image in it, to be specific), we can save storage.
695 needHashTree := moduleMinSdkVersion.LessThanOrEqualTo(android.SdkVersion_Android10) ||
696 a.shouldGenerateHashtree()
697 if ctx.Config().ApexCompressionEnabled() && a.isCompressable() {
698 needHashTree = true
699 }
700 if !needHashTree {
Jiyong Park09d77522019-11-18 11:16:27 +0900701 optFlags = append(optFlags, "--no_hashtree")
702 }
703
Dario Frenica913392020-04-27 18:21:11 +0100704 if a.testOnlyShouldSkipPayloadSign() {
705 optFlags = append(optFlags, "--unsigned_payload")
706 }
707
Dan Albertc8060532020-07-22 22:32:17 -0700708 if moduleMinSdkVersion == android.SdkVersion_Android10 {
Jooyung Han214bf372019-11-12 13:03:50 +0900709 implicitInputs = append(implicitInputs, a.manifestJsonOut)
710 optFlags = append(optFlags, "--manifest_json "+a.manifestJsonOut.String())
711 }
712
Theotime Combes4ba38c12020-06-12 12:46:59 +0000713 optFlags = append(optFlags, "--payload_fs_type "+a.payloadFsType.string())
714
Dennis Shenaf41bc12022-08-03 16:46:43 +0000715 if a.dynamic_common_lib_apex() {
716 ctx.Build(pctx, android.BuildParams{
717 Rule: DCLAApexRule,
718 Implicits: implicitInputs,
719 Output: unsignedOutputFile,
720 Description: "apex (" + apexType.name() + ")",
721 Args: map[string]string{
722 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
723 "image_dir": imageDir.String(),
724 "copy_commands": strings.Join(copyCommands, " && "),
725 "manifest": a.manifestPbOut.String(),
726 "file_contexts": fileContexts.String(),
727 "canned_fs_config": cannedFsConfig.String(),
728 "key": a.privateKeyFile.String(),
729 "opt_flags": strings.Join(optFlags, " "),
730 },
731 })
Dennis Shene2ed70c2023-01-11 14:15:43 +0000732 } else if ctx.Config().ApexTrimEnabled() && len(a.libs_to_trim(ctx)) > 0 {
733 ctx.Build(pctx, android.BuildParams{
734 Rule: TrimmedApexRule,
735 Implicits: implicitInputs,
736 Output: unsignedOutputFile,
737 Description: "apex (" + apexType.name() + ")",
738 Args: map[string]string{
739 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
740 "image_dir": imageDir.String(),
741 "copy_commands": strings.Join(copyCommands, " && "),
742 "manifest": a.manifestPbOut.String(),
743 "file_contexts": fileContexts.String(),
744 "canned_fs_config": cannedFsConfig.String(),
745 "key": a.privateKeyFile.String(),
746 "opt_flags": strings.Join(optFlags, " "),
747 "libs_to_trim": strings.Join(a.libs_to_trim(ctx), ","),
748 },
749 })
Dennis Shenaf41bc12022-08-03 16:46:43 +0000750 } else {
751 ctx.Build(pctx, android.BuildParams{
752 Rule: apexRule,
753 Implicits: implicitInputs,
754 Output: unsignedOutputFile,
755 Description: "apex (" + apexType.name() + ")",
756 Args: map[string]string{
757 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
758 "image_dir": imageDir.String(),
759 "copy_commands": strings.Join(copyCommands, " && "),
760 "manifest": a.manifestPbOut.String(),
761 "file_contexts": fileContexts.String(),
762 "canned_fs_config": cannedFsConfig.String(),
763 "key": a.privateKeyFile.String(),
764 "opt_flags": strings.Join(optFlags, " "),
765 },
766 })
767 }
Jiyong Park09d77522019-11-18 11:16:27 +0900768
Jiyong Parkb81b9902020-11-24 19:51:18 +0900769 // TODO(jiyong): make the two rules below as separate functions
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800770 apexProtoFile := android.PathForModuleOut(ctx, a.Name()+".pb"+suffix)
771 bundleModuleFile := android.PathForModuleOut(ctx, a.Name()+suffix+"-base.zip")
Jiyong Park09d77522019-11-18 11:16:27 +0900772 a.bundleModuleFile = bundleModuleFile
773
774 ctx.Build(pctx, android.BuildParams{
775 Rule: apexProtoConvertRule,
776 Input: unsignedOutputFile,
777 Output: apexProtoFile,
778 Description: "apex proto convert",
779 })
780
sophiezc80a2b32020-11-12 16:39:19 +0000781 implicitInputs = append(implicitInputs, unsignedOutputFile)
782
783 // Run coverage analysis
sophiez6bde0b52021-01-09 01:03:42 +0000784 apisUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.txt")
sophiezc80a2b32020-11-12 16:39:19 +0000785 ctx.Build(pctx, android.BuildParams{
786 Rule: generateAPIsUsedbyApexRule,
787 Implicits: implicitInputs,
788 Description: "coverage",
789 Output: apisUsedbyOutputFile,
790 Args: map[string]string{
791 "image_dir": imageDir.String(),
792 "readelf": "${config.ClangBin}/llvm-readelf",
793 },
794 })
sophiez02347372021-11-02 17:58:02 -0700795 a.nativeApisUsedByModuleFile = apisUsedbyOutputFile
sophiez6bde0b52021-01-09 01:03:42 +0000796
sophiez02347372021-11-02 17:58:02 -0700797 var nativeLibNames []string
Colin Cross69f0a242021-02-08 16:49:57 -0800798 for _, f := range a.filesInfo {
799 if f.class == nativeSharedLib {
sophiez02347372021-11-02 17:58:02 -0700800 nativeLibNames = append(nativeLibNames, f.stem())
Colin Cross69f0a242021-02-08 16:49:57 -0800801 }
802 }
sophiez6bde0b52021-01-09 01:03:42 +0000803 apisBackedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_backing.txt")
sophiez6bde0b52021-01-09 01:03:42 +0000804 rule := android.NewRuleBuilder(pctx, ctx)
805 rule.Command().
806 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_ndk_backedby_apex.sh")).
sophiez6bde0b52021-01-09 01:03:42 +0000807 Output(apisBackedbyOutputFile).
sophiez02347372021-11-02 17:58:02 -0700808 Flags(nativeLibNames)
sophiez6bde0b52021-01-09 01:03:42 +0000809 rule.Build("ndk_backedby_list", "Generate API libraries backed by Apex")
sophiez02347372021-11-02 17:58:02 -0700810 a.nativeApisBackedByModuleFile = apisBackedbyOutputFile
811
812 var javaLibOrApkPath []android.Path
813 for _, f := range a.filesInfo {
814 if f.class == javaSharedLib || f.class == app {
815 javaLibOrApkPath = append(javaLibOrApkPath, f.builtFile)
816 }
817 }
818 javaApiUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.xml")
819 javaUsedByRule := android.NewRuleBuilder(pctx, ctx)
820 javaUsedByRule.Command().
821 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_java_usedby_apex.sh")).
822 BuiltTool("dexdeps").
823 Output(javaApiUsedbyOutputFile).
824 Inputs(javaLibOrApkPath)
825 javaUsedByRule.Build("java_usedby_list", "Generate Java APIs used by Apex")
826 a.javaApisUsedByModuleFile = javaApiUsedbyOutputFile
sophiezc80a2b32020-11-12 16:39:19 +0000827
Jiyong Parkbd159612020-02-28 15:22:21 +0900828 bundleConfig := a.buildBundleConfig(ctx)
829
Jiyong Parkb81b9902020-11-24 19:51:18 +0900830 var abis []string
831 for _, target := range ctx.MultiTargets() {
832 if len(target.Arch.Abi) > 0 {
833 abis = append(abis, target.Arch.Abi[0])
834 }
835 }
836
837 abis = android.FirstUniqueStrings(abis)
838
Jiyong Park09d77522019-11-18 11:16:27 +0900839 ctx.Build(pctx, android.BuildParams{
840 Rule: apexBundleRule,
841 Input: apexProtoFile,
Jiyong Parkbd159612020-02-28 15:22:21 +0900842 Implicit: bundleConfig,
Jiyong Park09d77522019-11-18 11:16:27 +0900843 Output: a.bundleModuleFile,
844 Description: "apex bundle module",
845 Args: map[string]string{
Jiyong Parkbd159612020-02-28 15:22:21 +0900846 "abi": strings.Join(abis, "."),
847 "config": bundleConfig.String(),
Jiyong Park09d77522019-11-18 11:16:27 +0900848 },
849 })
Jiyong Parkb81b9902020-11-24 19:51:18 +0900850 } else { // zipApex
Jiyong Park09d77522019-11-18 11:16:27 +0900851 ctx.Build(pctx, android.BuildParams{
852 Rule: zipApexRule,
853 Implicits: implicitInputs,
854 Output: unsignedOutputFile,
855 Description: "apex (" + apexType.name() + ")",
856 Args: map[string]string{
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000857 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
858 "image_dir": imageDir.String(),
859 "copy_commands": strings.Join(copyCommands, " && "),
860 "manifest": a.manifestPbOut.String(),
Jiyong Park09d77522019-11-18 11:16:27 +0900861 },
862 })
863 }
864
Jiyong Parkb81b9902020-11-24 19:51:18 +0900865 ////////////////////////////////////////////////////////////////////////////////////
866 // Step 4: Sign the APEX using signapk
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000867 signedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900868
869 pem, key := a.getCertificateAndPrivateKey(ctx)
Kousik Kumar309b1c02020-05-28 06:13:33 -0700870 rule := java.Signapk
871 args := map[string]string{
Jiyong Parkb81b9902020-11-24 19:51:18 +0900872 "certificates": pem.String() + " " + key.String(),
Jooyung Han5d00f502021-07-11 07:26:22 +0900873 "flags": "-a 4096 --align-file-size", //alignment
Kousik Kumar309b1c02020-05-28 06:13:33 -0700874 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900875 implicits := android.Paths{pem, key}
Ramy Medhat16f23a42020-09-03 01:29:49 -0400876 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
Kousik Kumar309b1c02020-05-28 06:13:33 -0700877 rule = java.SignapkRE
878 args["implicits"] = strings.Join(implicits.Strings(), ",")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000879 args["outCommaList"] = signedOutputFile.String()
Kousik Kumar309b1c02020-05-28 06:13:33 -0700880 }
Jooyung Han01f5d652023-04-05 16:29:26 +0900881 var validations android.Paths
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900882 // TODO(b/279688635) deapexer supports [ext4]
883 if suffix == imageApexSuffix && ext4 == a.payloadFsType {
Jooyung Han01f5d652023-04-05 16:29:26 +0900884 validations = append(validations, runApexSepolicyTests(ctx, unsignedOutputFile.OutputPath))
885 }
Jiyong Park09d77522019-11-18 11:16:27 +0900886 ctx.Build(pctx, android.BuildParams{
Kousik Kumar309b1c02020-05-28 06:13:33 -0700887 Rule: rule,
Jiyong Park09d77522019-11-18 11:16:27 +0900888 Description: "signapk",
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000889 Output: signedOutputFile,
Jiyong Park09d77522019-11-18 11:16:27 +0900890 Input: unsignedOutputFile,
Kousik Kumar309b1c02020-05-28 06:13:33 -0700891 Implicits: implicits,
892 Args: args,
Jooyung Han01f5d652023-04-05 16:29:26 +0900893 Validations: validations,
Jiyong Park09d77522019-11-18 11:16:27 +0900894 })
Jooyung Hana6d36672022-02-24 13:58:07 +0900895 if suffix == imageApexSuffix {
896 a.outputApexFile = signedOutputFile
897 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000898 a.outputFile = signedOutputFile
899
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +0000900 if ctx.ModuleDir() != "system/apex/apexd/apexd_testdata" && a.testOnlyShouldForceCompression() {
901 ctx.PropertyErrorf("test_only_force_compression", "not available")
902 return
903 }
Nikita Ioffebc035882021-04-14 21:35:24 +0100904
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700905 installSuffix := suffix
906 a.setCompression(ctx)
907 if a.isCompressed {
Samiul Islam7c02e262021-09-08 17:48:28 +0100908 unsignedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix+".unsigned")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000909
910 compressRule := android.NewRuleBuilder(pctx, ctx)
911 compressRule.Command().
912 Text("rm").
913 FlagWithOutput("-f ", unsignedCompressedOutputFile)
914 compressRule.Command().
915 BuiltTool("apex_compression_tool").
916 Flag("compress").
917 FlagWithArg("--apex_compression_tool ", outHostBinDir+":"+prebuiltSdkToolsBinDir).
918 FlagWithInput("--input ", signedOutputFile).
919 FlagWithOutput("--output ", unsignedCompressedOutputFile)
920 compressRule.Build("compressRule", "Generate unsigned compressed APEX file")
921
Samiul Islam7c02e262021-09-08 17:48:28 +0100922 signedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix)
Mohammad Samiul Islam9ac0e322021-01-19 11:32:29 +0000923 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
924 args["outCommaList"] = signedCompressedOutputFile.String()
925 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000926 ctx.Build(pctx, android.BuildParams{
927 Rule: rule,
928 Description: "sign compressedApex",
929 Output: signedCompressedOutputFile,
930 Input: unsignedCompressedOutputFile,
931 Implicits: implicits,
932 Args: args,
933 })
934 a.outputFile = signedCompressedOutputFile
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000935 installSuffix = imageCapexSuffix
936 }
937
Colin Crossd9ccb6a2022-03-07 18:38:34 -0800938 if !a.installable() {
939 a.SkipInstall()
940 }
941
Jiyong Park17ff2832021-09-27 12:50:30 +0900942 // Install to $OUT/soong/{target,host}/.../apex.
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000943 a.installedFile = ctx.InstallFile(a.installDir, a.Name()+installSuffix, a.outputFile,
Colin Cross6340ea52021-11-04 12:01:18 -0700944 a.compatSymlinks.Paths()...)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900945
946 // installed-files.txt is dist'ed
947 a.installedFilesFile = a.buildInstalledFilesFile(ctx, a.outputFile, imageDir)
Jiyong Park09d77522019-11-18 11:16:27 +0900948}
949
Jiyong Parkb81b9902020-11-24 19:51:18 +0900950// buildFlattenedApex creates rules for a flattened APEX. Flattened APEX actually doesn't have a
951// single output file. It is a phony target for all the files under /system/apex/<name> directory.
952// This function creates the installation rules for the files.
Jiyong Park09d77522019-11-18 11:16:27 +0900953func (a *apexBundle) buildFlattenedApex(ctx android.ModuleContext) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900954 bundleName := a.Name()
Colin Cross6340ea52021-11-04 12:01:18 -0700955 installedSymlinks := append(android.InstallPaths(nil), a.compatSymlinks...)
Jiyong Park09d77522019-11-18 11:16:27 +0900956 if a.installable() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900957 for _, fi := range a.filesInfo {
958 dir := filepath.Join("apex", bundleName, fi.installDir)
Colin Cross6340ea52021-11-04 12:01:18 -0700959 installDir := android.PathForModuleInstall(ctx, dir)
960 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900961 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Colin Cross6340ea52021-11-04 12:01:18 -0700962 installedSymlinks = append(installedSymlinks,
963 ctx.InstallAbsoluteSymlink(installDir, fi.stem(), pathOnDevice))
964 } else {
Jiyong Parkf648d532022-10-19 18:18:56 +0900965 if fi.class == appSet {
966 as := fi.module.(*java.AndroidAppSet)
967 ctx.InstallFileWithExtraFilesZip(installDir, as.BaseModuleName()+".apk",
968 as.OutputFile(), as.PackedAdditionalOutputs())
969 } else {
970 target := ctx.InstallFile(installDir, fi.stem(), fi.builtFile)
971 for _, sym := range fi.symlinks {
972 installedSymlinks = append(installedSymlinks,
973 ctx.InstallSymlink(installDir, sym, target))
974 }
Colin Cross6340ea52021-11-04 12:01:18 -0700975 }
Jiyong Park09d77522019-11-18 11:16:27 +0900976 }
977 }
Colin Cross6340ea52021-11-04 12:01:18 -0700978
979 // Create install rules for the files added in GenerateAndroidBuildActions after
980 // buildFlattenedApex is called. Add the links to system libs (if any) as dependencies
981 // of the apex_manifest.pb file since it is always present.
982 dir := filepath.Join("apex", bundleName)
983 installDir := android.PathForModuleInstall(ctx, dir)
984 ctx.InstallFile(installDir, "apex_manifest.pb", a.manifestPbOut, installedSymlinks.Paths()...)
985 ctx.InstallFile(installDir, "apex_pubkey", a.publicKeyFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900986 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900987
988 a.fileContexts = a.buildFileContexts(ctx)
989
Colin Cross6340ea52021-11-04 12:01:18 -0700990 a.outputFile = android.PathForModuleInstall(ctx, "apex", bundleName)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900991}
992
993// getCertificateAndPrivateKey retrieves the cert and the private key that will be used to sign
994// the zip container of this APEX. See the description of the 'certificate' property for how
995// the cert and the private key are found.
996func (a *apexBundle) getCertificateAndPrivateKey(ctx android.PathContext) (pem, key android.Path) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800997 if a.containerCertificateFile != nil {
998 return a.containerCertificateFile, a.containerPrivateKeyFile
Jiyong Parkb81b9902020-11-24 19:51:18 +0900999 }
1000
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -07001001 cert := String(a.overridableProperties.Certificate)
Jiyong Parkb81b9902020-11-24 19:51:18 +09001002 if cert == "" {
1003 return ctx.Config().DefaultAppCertificate(ctx)
1004 }
1005
1006 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
1007 pem = defaultDir.Join(ctx, cert+".x509.pem")
1008 key = defaultDir.Join(ctx, cert+".pk8")
1009 return pem, key
Jiyong Park09d77522019-11-18 11:16:27 +09001010}
Jooyung Han27151d92019-12-16 17:45:32 +09001011
1012func (a *apexBundle) getOverrideManifestPackageName(ctx android.ModuleContext) string {
1013 // For VNDK APEXes, check "com.android.vndk" in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
1014 // to see if it should be overridden because their <apex name> is dynamically generated
1015 // according to its VNDK version.
1016 if a.vndkApex {
1017 overrideName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(vndkApexName)
1018 if overridden {
Jooyung Han2cd2f9a2023-02-06 18:29:08 +09001019 return overrideName + ".v" + a.vndkVersion(ctx.DeviceConfig())
Jooyung Han27151d92019-12-16 17:45:32 +09001020 }
1021 return ""
1022 }
Baligh Uddin5b57dba2020-03-15 13:01:05 -07001023 if a.overridableProperties.Package_name != "" {
1024 return a.overridableProperties.Package_name
1025 }
Jiyong Park20bacab2020-03-03 11:45:41 +09001026 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jooyung Han27151d92019-12-16 17:45:32 +09001027 if overridden {
1028 return manifestPackageName
1029 }
1030 return ""
1031}
Jiyong Park83dc74b2020-01-14 18:38:44 +09001032
1033func (a *apexBundle) buildApexDependencyInfo(ctx android.ModuleContext) {
1034 if !a.primaryApexType {
1035 return
1036 }
1037
1038 if a.properties.IsCoverageVariant {
1039 // Otherwise, we will have duplicated rules for coverage and
1040 // non-coverage variants of the same APEX
1041 return
1042 }
1043
1044 if ctx.Host() {
1045 // No need to generate dependency info for host variant
1046 return
1047 }
1048
Artur Satayev872a1442020-04-27 17:08:37 +01001049 depInfos := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +09001050 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev872a1442020-04-27 17:08:37 +01001051 if from.Name() == to.Name() {
1052 // This can happen for cc.reuseObjTag. We are not interested in tracking this.
1053 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1054 return !externalDep
Jiyong Park678c8812020-02-07 17:25:49 +09001055 }
Jiyong Park83dc74b2020-01-14 18:38:44 +09001056
Artur Satayev533b98c2021-03-11 18:03:42 +00001057 // Skip dependencies that are only available to APEXes; they are developed with updatability
1058 // in mind and don't need manual approval.
1059 if to.(android.ApexModule).NotAvailableForPlatform() {
1060 return !externalDep
1061 }
1062
Cindy Zhou18417cb2020-12-10 07:12:38 -08001063 depTag := ctx.OtherModuleDependencyTag(to)
Artur Satayev533b98c2021-03-11 18:03:42 +00001064 // Check to see if dependency been marked to skip the dependency check
Cindy Zhou18417cb2020-12-10 07:12:38 -08001065 if skipDepCheck, ok := depTag.(android.SkipApexAllowedDependenciesCheck); ok && skipDepCheck.SkipApexAllowedDependenciesCheck() {
Cindy Zhou18417cb2020-12-10 07:12:38 -08001066 return !externalDep
1067 }
1068
Artur Satayev872a1442020-04-27 17:08:37 +01001069 if info, exists := depInfos[to.Name()]; exists {
1070 if !android.InList(from.Name(), info.From) {
1071 info.From = append(info.From, from.Name())
1072 }
1073 info.IsExternal = info.IsExternal && externalDep
1074 depInfos[to.Name()] = info
1075 } else {
Artur Satayev480e25b2020-04-27 18:53:18 +01001076 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001077 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001078 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +09001079 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001080 if v := m.MinSdkVersion(ctx); !v.IsNone() {
1081 toMinSdkVersion = v.String()
Jiyong Park92315372021-04-02 08:45:46 +09001082 }
1083 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1084 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1085 // string
Artur Satayev480e25b2020-04-27 18:53:18 +01001086 if v := m.MinSdkVersion(); v != "" {
1087 toMinSdkVersion = v
1088 }
1089 }
Artur Satayev872a1442020-04-27 17:08:37 +01001090 depInfos[to.Name()] = android.ApexModuleDepInfo{
Artur Satayev480e25b2020-04-27 18:53:18 +01001091 To: to.Name(),
1092 From: []string{from.Name()},
1093 IsExternal: externalDep,
1094 MinSdkVersion: toMinSdkVersion,
Artur Satayev872a1442020-04-27 17:08:37 +01001095 }
1096 }
1097
1098 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1099 return !externalDep
Jiyong Park83dc74b2020-01-14 18:38:44 +09001100 })
1101
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001102 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depInfos)
Artur Satayev872a1442020-04-27 17:08:37 +01001103
Jiyong Park83dc74b2020-01-14 18:38:44 +09001104 ctx.Build(pctx, android.BuildParams{
1105 Rule: android.Phony,
1106 Output: android.PathForPhony(ctx, a.Name()+"-deps-info"),
Artur Satayeva8bd1132020-04-27 18:07:06 +01001107 Inputs: []android.Path{
1108 a.ApexBundleDepsInfo.FullListPath(),
1109 a.ApexBundleDepsInfo.FlatListPath(),
1110 },
Jiyong Park83dc74b2020-01-14 18:38:44 +09001111 })
1112}
Colin Cross08dca382020-07-21 20:31:17 -07001113
1114func (a *apexBundle) buildLintReports(ctx android.ModuleContext) {
1115 depSetsBuilder := java.NewLintDepSetBuilder()
1116 for _, fi := range a.filesInfo {
1117 depSetsBuilder.Transitive(fi.lintDepSets)
1118 }
1119
1120 a.lintReports = java.BuildModuleLintReportZips(ctx, depSetsBuilder.Build())
1121}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001122
1123func (a *apexBundle) buildCannedFsConfig(ctx android.ModuleContext) android.OutputPath {
1124 var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"}
1125 var executablePaths []string // this also includes dirs
1126 var appSetDirs []string
1127 appSetFiles := make(map[string]android.Path)
1128 for _, f := range a.filesInfo {
1129 pathInApex := f.path()
1130 if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") {
1131 executablePaths = append(executablePaths, pathInApex)
1132 for _, d := range f.dataPaths {
1133 readOnlyPaths = append(readOnlyPaths, filepath.Join(f.installDir, d.RelativeInstallPath, d.SrcPath.Rel()))
1134 }
1135 for _, s := range f.symlinks {
1136 executablePaths = append(executablePaths, filepath.Join(f.installDir, s))
1137 }
1138 } else if f.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +09001139 // base APK
1140 readOnlyPaths = append(readOnlyPaths, pathInApex)
1141 // Additional APKs
Jiyong Park1b0893e2021-12-13 23:40:17 +09001142 appSetDirs = append(appSetDirs, f.installDir)
Jiyong Parke1b69142022-09-26 14:48:56 +09001143 appSetFiles[f.installDir] = f.module.(*java.AndroidAppSet).PackedAdditionalOutputs()
Jiyong Park1b0893e2021-12-13 23:40:17 +09001144 } else {
1145 readOnlyPaths = append(readOnlyPaths, pathInApex)
1146 }
1147 dir := f.installDir
1148 for !android.InList(dir, executablePaths) && dir != "" {
1149 executablePaths = append(executablePaths, dir)
1150 dir, _ = filepath.Split(dir) // move up to the parent
1151 if len(dir) > 0 {
1152 // remove trailing slash
1153 dir = dir[:len(dir)-1]
1154 }
1155 }
1156 }
1157 sort.Strings(readOnlyPaths)
1158 sort.Strings(executablePaths)
1159 sort.Strings(appSetDirs)
1160
1161 cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config")
1162 builder := android.NewRuleBuilder(pctx, ctx)
1163 cmd := builder.Command()
1164 cmd.Text("(")
1165 cmd.Text("echo '/ 1000 1000 0755';")
1166 for _, p := range readOnlyPaths {
1167 cmd.Textf("echo '/%s 1000 1000 0644';", p)
1168 }
1169 for _, p := range executablePaths {
1170 cmd.Textf("echo '/%s 0 2000 0755';", p)
1171 }
1172 for _, dir := range appSetDirs {
1173 cmd.Textf("echo '/%s 0 2000 0755';", dir)
1174 file := appSetFiles[dir]
1175 cmd.Text("zipinfo -1").Input(file).Textf(`| sed "s:\(.*\):/%s/\1 1000 1000 0644:";`, dir)
1176 }
Jiyong Park038e8522021-12-13 23:56:35 +09001177 // Custom fs_config is "appended" to the last so that entries from the file are preferred
1178 // over default ones set above.
1179 if a.properties.Canned_fs_config != nil {
1180 cmd.Text("cat").Input(android.PathForModuleSrc(ctx, *a.properties.Canned_fs_config))
1181 }
Maciej Żenczykowski67e2f792023-03-27 07:03:43 +00001182 cmd.Text(")").FlagWithOutput("> ", cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +09001183 builder.Build("generateFsConfig", fmt.Sprintf("Generating canned fs config for %s", a.BaseModuleName()))
1184
1185 return cannedFsConfig.OutputPath
1186}
Jooyung Han01f5d652023-04-05 16:29:26 +09001187
1188// Runs apex_sepolicy_tests
1189//
1190// $ deapexer list -Z {apex_file} > {file_contexts}
1191// $ apex_sepolicy_tests -f {file_contexts}
1192func runApexSepolicyTests(ctx android.ModuleContext, apexFile android.OutputPath) android.Path {
1193 timestamp := android.PathForModuleOut(ctx, "sepolicy_tests.timestamp")
1194 ctx.Build(pctx, android.BuildParams{
1195 Rule: apexSepolicyTestsRule,
1196 Input: apexFile,
1197 Output: timestamp,
1198 })
1199 return timestamp
1200}