blob: a62f63c612fa824830e17c28105f389a1fd23127 [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")
sophiezc80a2b32020-11-12 16:39:19 +000074 pctx.SourcePathVariable("genNdkUsedbyApexPath", "build/soong/scripts/gen_ndk_usedby_apex.sh")
Jiyong Park09d77522019-11-18 11:16:27 +090075}
76
77var (
Jiyong Park09d77522019-11-18 11:16:27 +090078 apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{
79 Command: `rm -f $out && ${jsonmodify} $in ` +
80 `-a provideNativeLibs ${provideNativeLibs} ` +
81 `-a requireNativeLibs ${requireNativeLibs} ` +
Alexei Nicoarad887e242022-07-11 14:16:28 +010082 `-se version 0 ${default_version} ` +
Jiyong Park09d77522019-11-18 11:16:27 +090083 `${opt} ` +
84 `-o $out`,
85 CommandDeps: []string{"${jsonmodify}"},
86 Description: "prepare ${out}",
Alexei Nicoarad887e242022-07-11 14:16:28 +010087 }, "provideNativeLibs", "requireNativeLibs", "default_version", "opt")
Jiyong Park09d77522019-11-18 11:16:27 +090088
89 stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{
90 Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`,
91 CommandDeps: []string{"${conv_apex_manifest}"},
92 Description: "strip ${in}=>${out}",
93 })
94
95 pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{
96 Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`,
97 CommandDeps: []string{"${conv_apex_manifest}"},
98 Description: "convert ${in}=>${out}",
99 })
100
Joe Onoratob4638c12021-10-27 15:47:06 -0700101 // TODO(b/113233103): make sure that file_contexts is as expected, i.e., validate
Jiyong Park09d77522019-11-18 11:16:27 +0900102 // against the binary policy using sefcontext_compiler -p <policy>.
103
104 // TODO(b/114327326): automate the generation of file_contexts
105 apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{
106 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
107 `(. ${out}.copy_commands) && ` +
108 `APEXER_TOOL_PATH=${tool_path} ` +
109 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900110 `--file_contexts ${file_contexts} ` +
111 `--canned_fs_config ${canned_fs_config} ` +
Dario Freni0f4ae072020-01-02 15:24:12 +0000112 `--include_build_info ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900113 `--payload_type image ` +
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000114 `--key ${key} ${opt_flags} ${image_dir} ${out} `,
Jiyong Park09d77522019-11-18 11:16:27 +0900115 CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}",
Huang Jianan13cac632021-08-02 15:02:17 +0800116 "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}", "${sload_f2fs}", "${make_erofs}",
Jiyong Park09d77522019-11-18 11:16:27 +0900117 "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"},
118 Rspfile: "${out}.copy_commands",
119 RspfileContent: "${copy_commands}",
120 Description: "APEX ${image_dir} => ${out}",
Dennis Shenaf41bc12022-08-03 16:46:43 +0000121 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
122 "opt_flags", "manifest")
123
124 DCLAApexRule = pctx.StaticRule("DCLAApexRule", blueprint.RuleParams{
125 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
126 `(. ${out}.copy_commands) && ` +
127 `APEXER_TOOL_PATH=${tool_path} ` +
128 `${apexer_with_DCLA_preprocessing} ` +
129 `--apexer ${apexer} ` +
130 `--canned_fs_config ${canned_fs_config} ` +
131 `${image_dir} ` +
132 `${out} ` +
133 `-- ` +
134 `--include_build_info ` +
135 `--force ` +
136 `--payload_type image ` +
137 `--key ${key} ` +
138 `--file_contexts ${file_contexts} ` +
139 `--manifest ${manifest} ` +
140 `${opt_flags} `,
141 CommandDeps: []string{"${apexer_with_DCLA_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
142 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
143 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
144 "prebuilts/sdk/current/public/android.jar"},
145 Rspfile: "${out}.copy_commands",
146 RspfileContent: "${copy_commands}",
147 Description: "APEX ${image_dir} => ${out}",
148 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
149 "opt_flags", "manifest", "is_DCLA")
Jiyong Park09d77522019-11-18 11:16:27 +0900150
Dennis Shene2ed70c2023-01-11 14:15:43 +0000151 TrimmedApexRule = pctx.StaticRule("TrimmedApexRule", blueprint.RuleParams{
152 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
153 `(. ${out}.copy_commands) && ` +
154 `APEXER_TOOL_PATH=${tool_path} ` +
155 `${apexer_with_trim_preprocessing} ` +
156 `--apexer ${apexer} ` +
157 `--canned_fs_config ${canned_fs_config} ` +
158 `--manifest ${manifest} ` +
159 `--libs_to_trim ${libs_to_trim} ` +
160 `${image_dir} ` +
161 `${out} ` +
162 `-- ` +
163 `--include_build_info ` +
164 `--force ` +
165 `--payload_type image ` +
166 `--key ${key} ` +
167 `--file_contexts ${file_contexts} ` +
168 `${opt_flags} `,
169 CommandDeps: []string{"${apexer_with_trim_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
170 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
171 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
172 "prebuilts/sdk/current/public/android.jar"},
173 Rspfile: "${out}.copy_commands",
174 RspfileContent: "${copy_commands}",
175 Description: "APEX ${image_dir} => ${out}",
176 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
177 "opt_flags", "manifest", "libs_to_trim")
178
Jiyong Park09d77522019-11-18 11:16:27 +0900179 zipApexRule = pctx.StaticRule("zipApexRule", blueprint.RuleParams{
180 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
181 `(. ${out}.copy_commands) && ` +
182 `APEXER_TOOL_PATH=${tool_path} ` +
Jooyung Han214bf372019-11-12 13:03:50 +0900183 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900184 `--payload_type zip ` +
185 `${image_dir} ${out} `,
186 CommandDeps: []string{"${apexer}", "${merge_zips}", "${soong_zip}", "${zipalign}", "${aapt2}"},
187 Rspfile: "${out}.copy_commands",
188 RspfileContent: "${copy_commands}",
189 Description: "ZipAPEX ${image_dir} => ${out}",
Alexei Nicoara0a389202022-07-12 14:35:39 +0100190 }, "tool_path", "image_dir", "copy_commands", "manifest")
Jiyong Park09d77522019-11-18 11:16:27 +0900191
192 apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule",
193 blueprint.RuleParams{
194 Command: `${aapt2} convert --output-format proto $in -o $out`,
195 CommandDeps: []string{"${aapt2}"},
196 })
197
198 apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{
Jiyong Parkbd159612020-02-28 15:22:21 +0900199 Command: `${zip2zip} -i $in -o $out.base ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900200 `apex_payload.img:apex/${abi}.img ` +
Dario Frenida1aefe2020-03-02 21:47:09 +0000201 `apex_build_info.pb:apex/${abi}.build_info.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900202 `apex_manifest.json:root/apex_manifest.json ` +
Jiyong Park53ae3342019-12-08 02:06:24 +0900203 `apex_manifest.pb:root/apex_manifest.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900204 `AndroidManifest.xml:manifest/AndroidManifest.xml ` +
Jiyong Parkbd159612020-02-28 15:22:21 +0900205 `assets/NOTICE.html.gz:assets/NOTICE.html.gz &&` +
206 `${soong_zip} -o $out.config -C $$(dirname ${config}) -f ${config} && ` +
207 `${merge_zips} $out $out.base $out.config`,
208 CommandDeps: []string{"${zip2zip}", "${soong_zip}", "${merge_zips}"},
Jiyong Park09d77522019-11-18 11:16:27 +0900209 Description: "app bundle",
Jiyong Parkbd159612020-02-28 15:22:21 +0900210 }, "abi", "config")
Jiyong Park09d77522019-11-18 11:16:27 +0900211
Jiyong Park09d77522019-11-18 11:16:27 +0900212 diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{
213 Command: `diff --unchanged-group-format='' \` +
214 `--changed-group-format='%<' \` +
Colin Cross440e0d02020-06-11 11:32:11 -0700215 `${image_content_file} ${allowed_files_file} || (` +
Jiyong Park09d77522019-11-18 11:16:27 +0900216 `echo -e "New unexpected files were added to ${apex_module_name}." ` +
217 ` "To fix the build run following command:" && ` +
Colin Cross440e0d02020-06-11 11:32:11 -0700218 `echo "system/apex/tools/update_allowed_list.sh ${allowed_files_file} ${image_content_file}" && ` +
Dan Willemsen81e43c52020-01-28 15:40:19 -0800219 `exit 1); touch ${out}`,
Colin Cross440e0d02020-06-11 11:32:11 -0700220 Description: "Diff ${image_content_file} and ${allowed_files_file}",
221 }, "image_content_file", "allowed_files_file", "apex_module_name")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900222
sophiezc80a2b32020-11-12 16:39:19 +0000223 generateAPIsUsedbyApexRule = pctx.StaticRule("generateAPIsUsedbyApexRule", blueprint.RuleParams{
224 Command: "$genNdkUsedbyApexPath ${image_dir} ${readelf} ${out}",
225 CommandDeps: []string{"${genNdkUsedbyApexPath}"},
226 Description: "Generate symbol list used by Apex",
227 }, "image_dir", "readelf")
228
Jiyong Parkb81b9902020-11-24 19:51:18 +0900229 // Don't add more rules here. Consider using android.NewRuleBuilder instead.
Jiyong Park09d77522019-11-18 11:16:27 +0900230)
231
Jiyong Parkb81b9902020-11-24 19:51:18 +0900232// buildManifest creates buile rules to modify the input apex_manifest.json to add information
233// gathered by the build system such as provided/required native libraries. Two output files having
234// different formats are generated. a.manifestJsonOut is JSON format for Q devices, and
235// a.manifest.PbOut is protobuf format for R+ devices.
236// TODO(jiyong): make this to return paths instead of directly storing the paths to apexBundle
Jiyong Park09d77522019-11-18 11:16:27 +0900237func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900238 src := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json"))
Jiyong Park09d77522019-11-18 11:16:27 +0900239
Jiyong Parkb81b9902020-11-24 19:51:18 +0900240 // Put dependency({provide|require}NativeLibs) in apex_manifest.json
Jiyong Park09d77522019-11-18 11:16:27 +0900241 provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs)
242 requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs))
243
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900244 // VNDK APEX name is determined at runtime, so update "name" in apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900245 optCommands := []string{}
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900246 if a.vndkApex {
247 apexName := vndkApexNamePrefix + a.vndkVersion(ctx.DeviceConfig())
248 optCommands = append(optCommands, "-v name "+apexName)
Jiyong Park09d77522019-11-18 11:16:27 +0900249 }
250
Jiyong Parkb81b9902020-11-24 19:51:18 +0900251 // Collect jniLibs. Notice that a.filesInfo is already sorted
Jooyung Han643adc42020-02-27 13:50:06 +0900252 var jniLibs []string
253 for _, fi := range a.filesInfo {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900254 if fi.isJniLib && !android.InList(fi.stem(), jniLibs) {
255 jniLibs = append(jniLibs, fi.stem())
Jooyung Han643adc42020-02-27 13:50:06 +0900256 }
257 }
258 if len(jniLibs) > 0 {
259 optCommands = append(optCommands, "-a jniLibs "+strings.Join(jniLibs, " "))
260 }
261
Jooyung Hand045ebc2022-12-06 15:23:57 +0900262 if android.InList(":vndk", requireNativeLibs) {
263 if _, vndkVersion := a.getImageVariationPair(ctx.DeviceConfig()); vndkVersion != "" {
264 optCommands = append(optCommands, "-v vndkVersion "+vndkVersion)
265 }
266 }
267
Jiyong Parkb81b9902020-11-24 19:51:18 +0900268 manifestJsonFullOut := android.PathForModuleOut(ctx, "apex_manifest_full.json")
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000269 defaultVersion := android.DefaultUpdatableModuleVersion
270 if override := ctx.Config().Getenv("OVERRIDE_APEX_MANIFEST_DEFAULT_VERSION"); override != "" {
271 defaultVersion = override
272 }
Jiyong Park09d77522019-11-18 11:16:27 +0900273 ctx.Build(pctx, android.BuildParams{
274 Rule: apexManifestRule,
Alexei Nicoara0a389202022-07-12 14:35:39 +0100275 Input: src,
Jooyung Han214bf372019-11-12 13:03:50 +0900276 Output: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900277 Args: map[string]string{
278 "provideNativeLibs": strings.Join(provideNativeLibs, " "),
279 "requireNativeLibs": strings.Join(requireNativeLibs, " "),
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000280 "default_version": defaultVersion,
Jiyong Park09d77522019-11-18 11:16:27 +0900281 "opt": strings.Join(optCommands, " "),
282 },
283 })
284
Jiyong Parkb81b9902020-11-24 19:51:18 +0900285 // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json prepare
286 // stripped-down version so that APEX modules built from R+ can be installed to Q
Dan Albertc8060532020-07-22 22:32:17 -0700287 minSdkVersion := a.minSdkVersion(ctx)
288 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Jooyung Han214bf372019-11-12 13:03:50 +0900289 a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json")
290 ctx.Build(pctx, android.BuildParams{
291 Rule: stripApexManifestRule,
292 Input: manifestJsonFullOut,
293 Output: a.manifestJsonOut,
294 })
295 }
Jiyong Park09d77522019-11-18 11:16:27 +0900296
Jiyong Parkb81b9902020-11-24 19:51:18 +0900297 // From R+, protobuf binary format (.pb) is the standard format for apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900298 a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb")
299 ctx.Build(pctx, android.BuildParams{
300 Rule: pbApexManifestRule,
Jooyung Han214bf372019-11-12 13:03:50 +0900301 Input: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900302 Output: a.manifestPbOut,
303 })
304}
305
Jiyong Parkb81b9902020-11-24 19:51:18 +0900306// buildFileContexts create build rules to append an entry for apex_manifest.pb to the file_contexts
307// file for this APEX which is either from /systme/sepolicy/apex/<apexname>-file_contexts or from
308// the file_contexts property of this APEX. This is to make sure that the manifest file is correctly
309// labeled as system_file.
310func (a *apexBundle) buildFileContexts(ctx android.ModuleContext) android.OutputPath {
Jooyung Han580eb4f2020-06-24 19:33:06 +0900311 var fileContexts android.Path
Liz Kammer37997c42021-09-14 17:53:38 -0400312 var fileContextsDir string
Jooyung Han580eb4f2020-06-24 19:33:06 +0900313 if a.properties.File_contexts == nil {
314 fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
315 } else {
Liz Kammer37997c42021-09-14 17:53:38 -0400316 if m, t := android.SrcIsModuleWithTag(*a.properties.File_contexts); m != "" {
317 otherModule := android.GetModuleFromPathDep(ctx, m, t)
318 fileContextsDir = ctx.OtherModuleDir(otherModule)
319 }
Jooyung Han580eb4f2020-06-24 19:33:06 +0900320 fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
321 }
Liz Kammer37997c42021-09-14 17:53:38 -0400322 if fileContextsDir == "" {
323 fileContextsDir = filepath.Dir(fileContexts.String())
324 }
325 fileContextsDir += string(filepath.Separator)
326
Jooyung Han580eb4f2020-06-24 19:33:06 +0900327 if a.Platform() {
Liz Kammer37997c42021-09-14 17:53:38 -0400328 if !strings.HasPrefix(fileContextsDir, "system/sepolicy/") {
329 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but found in %q", fileContextsDir)
Jooyung Han580eb4f2020-06-24 19:33:06 +0900330 }
331 }
332 if !android.ExistentPathForSource(ctx, fileContexts.String()).Valid() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900333 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", fileContexts.String())
Jooyung Han580eb4f2020-06-24 19:33:06 +0900334 }
335
336 output := android.PathForModuleOut(ctx, "file_contexts")
Colin Crossf1a035e2020-11-16 17:32:30 -0800337 rule := android.NewRuleBuilder(pctx, ctx)
Jooyung Han7f146c02020-09-23 19:15:55 +0900338
Jiyong Parkb81b9902020-11-24 19:51:18 +0900339 switch a.properties.ApexType {
340 case imageApex:
Jooyung Han7f146c02020-09-23 19:15:55 +0900341 // remove old file
342 rule.Command().Text("rm").FlagWithOutput("-f ", output)
343 // copy file_contexts
344 rule.Command().Text("cat").Input(fileContexts).Text(">>").Output(output)
345 // new line
346 rule.Command().Text("echo").Text(">>").Output(output)
347 // force-label /apex_manifest.pb and / as system_file so that apexd can read them
348 rule.Command().Text("echo").Flag("/apex_manifest\\\\.pb u:object_r:system_file:s0").Text(">>").Output(output)
349 rule.Command().Text("echo").Flag("/ u:object_r:system_file:s0").Text(">>").Output(output)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900350 case flattenedApex:
Jooyung Han7f146c02020-09-23 19:15:55 +0900351 // For flattened apexes, install path should be prepended.
352 // File_contexts file should be emiited to make via LOCAL_FILE_CONTEXTS
353 // so that it can be merged into file_contexts.bin
354 apexPath := android.InstallPathToOnDevicePath(ctx, a.installDir.Join(ctx, a.Name()))
355 apexPath = strings.ReplaceAll(apexPath, ".", `\\.`)
356 // remove old file
357 rule.Command().Text("rm").FlagWithOutput("-f ", output)
358 // copy file_contexts
359 rule.Command().Text("awk").Text(`'/object_r/{printf("` + apexPath + `%s\n", $0)}'`).Input(fileContexts).Text(">").Output(output)
360 // new line
361 rule.Command().Text("echo").Text(">>").Output(output)
362 // force-label /apex_manifest.pb and / as system_file so that apexd can read them
363 rule.Command().Text("echo").Flag(apexPath + `/apex_manifest\\.pb u:object_r:system_file:s0`).Text(">>").Output(output)
364 rule.Command().Text("echo").Flag(apexPath + "/ u:object_r:system_file:s0").Text(">>").Output(output)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900365 default:
366 panic(fmt.Errorf("unsupported type %v", a.properties.ApexType))
Jooyung Han7f146c02020-09-23 19:15:55 +0900367 }
368
Colin Crossf1a035e2020-11-16 17:32:30 -0800369 rule.Build("file_contexts."+a.Name(), "Generate file_contexts")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900370 return output.OutputPath
Jooyung Han580eb4f2020-06-24 19:33:06 +0900371}
372
Jiyong Parkb81b9902020-11-24 19:51:18 +0900373// buildInstalledFilesFile creates a build rule for the installed-files.txt file where the list of
374// files included in this APEX is shown. The text file is dist'ed so that people can see what's
375// included in the APEX without actually downloading and extracting it.
Jiyong Park3a1602e2020-01-14 14:39:19 +0900376func (a *apexBundle) buildInstalledFilesFile(ctx android.ModuleContext, builtApex android.Path, imageDir android.Path) android.OutputPath {
377 output := android.PathForModuleOut(ctx, "installed-files.txt")
Colin Crossf1a035e2020-11-16 17:32:30 -0800378 rule := android.NewRuleBuilder(pctx, ctx)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900379 rule.Command().
380 Implicit(builtApex).
381 Text("(cd " + imageDir.String() + " ; ").
Jiyong Parkbd63a102020-02-08 12:40:05 +0900382 Text("find . \\( -type f -o -type l \\) -printf \"%s %p\\n\") ").
Jiyong Park3a1602e2020-01-14 14:39:19 +0900383 Text(" | sort -nr > ").
384 Output(output)
Colin Crossf1a035e2020-11-16 17:32:30 -0800385 rule.Build("installed-files."+a.Name(), "Installed files")
Jiyong Park3a1602e2020-01-14 14:39:19 +0900386 return output.OutputPath
387}
388
Jiyong Parkb81b9902020-11-24 19:51:18 +0900389// buildBundleConfig creates a build rule for the bundle config file that will control the bundle
390// creation process.
Jiyong Parkbd159612020-02-28 15:22:21 +0900391func (a *apexBundle) buildBundleConfig(ctx android.ModuleContext) android.OutputPath {
392 output := android.PathForModuleOut(ctx, "bundle_config.json")
393
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900394 type ApkConfig struct {
395 Package_name string `json:"package_name"`
396 Apk_path string `json:"path"`
397 }
Jiyong Parkbd159612020-02-28 15:22:21 +0900398 config := struct {
399 Compression struct {
400 Uncompressed_glob []string `json:"uncompressed_glob"`
401 } `json:"compression"`
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900402 Apex_config struct {
403 Apex_embedded_apk_config []ApkConfig `json:"apex_embedded_apk_config,omitempty"`
404 } `json:"apex_config,omitempty"`
Jiyong Parkbd159612020-02-28 15:22:21 +0900405 }{}
406
407 config.Compression.Uncompressed_glob = []string{
408 "apex_payload.img",
409 "apex_manifest.*",
410 }
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900411
Jiyong Parkb81b9902020-11-24 19:51:18 +0900412 // Collect the manifest names and paths of android apps if their manifest names are
413 // overridden.
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900414 for _, fi := range a.filesInfo {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700415 if fi.class != app && fi.class != appSet {
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900416 continue
417 }
418 packageName := fi.overriddenPackageName
419 if packageName != "" {
420 config.Apex_config.Apex_embedded_apk_config = append(
421 config.Apex_config.Apex_embedded_apk_config,
422 ApkConfig{
423 Package_name: packageName,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900424 Apk_path: fi.path(),
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900425 })
426 }
427 }
428
Jiyong Parkbd159612020-02-28 15:22:21 +0900429 j, err := json.Marshal(config)
430 if err != nil {
431 panic(fmt.Errorf("error while marshalling to %q: %#v", output, err))
432 }
433
Colin Crosscf371cc2020-11-13 11:48:42 -0800434 android.WriteFileRule(ctx, output, string(j))
Jiyong Parkbd159612020-02-28 15:22:21 +0900435
436 return output.OutputPath
437}
438
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000439func markManifestTestOnly(ctx android.ModuleContext, androidManifestFile android.Path) android.Path {
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000440 return java.ManifestFixer(ctx, androidManifestFile, java.ManifestFixerParams{
441 TestOnly: true,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000442 })
443}
444
Jiyong Parkb81b9902020-11-24 19:51:18 +0900445// buildUnflattendApex creates build rules to build an APEX using apexer.
Jiyong Park09d77522019-11-18 11:16:27 +0900446func (a *apexBundle) buildUnflattenedApex(ctx android.ModuleContext) {
Jiyong Park09d77522019-11-18 11:16:27 +0900447 apexType := a.properties.ApexType
448 suffix := apexType.suffix()
Jooyung Han63dff462023-02-09 00:11:27 +0000449 apexName := a.BaseModuleName()
Jiyong Park09d77522019-11-18 11:16:27 +0900450
Jiyong Parkb81b9902020-11-24 19:51:18 +0900451 ////////////////////////////////////////////////////////////////////////////////////////////
452 // Step 1: copy built files to appropriate directories under the image directory
453
454 imageDir := android.PathForModuleOut(ctx, "image"+suffix)
455
Colin Cross02730b92022-04-18 17:42:27 -0700456 installSymbolFiles := (!ctx.Config().KatiEnabled() || a.ExportedToMake()) && a.installable()
Colin Cross6340ea52021-11-04 12:01:18 -0700457
Colin Cross4acaea92021-12-10 23:05:02 +0000458 // set of dependency module:location mappings
459 installMapSet := make(map[string]bool)
Colin Cross6340ea52021-11-04 12:01:18 -0700460
Jiyong Parkb81b9902020-11-24 19:51:18 +0900461 // TODO(jiyong): use the RuleBuilder
Jiyong Park7cd10e32020-01-14 09:22:18 +0900462 var copyCommands []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900463 var implicitInputs []android.Path
Jooyung Han63dff462023-02-09 00:11:27 +0000464 apexDir := android.PathForModuleInPartitionInstall(ctx, "apex", apexName)
Jiyong Park7cd10e32020-01-14 09:22:18 +0900465 for _, fi := range a.filesInfo {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900466 destPath := imageDir.Join(ctx, fi.path()).String()
Jiyong Parkb81b9902020-11-24 19:51:18 +0900467 // Prepare the destination path
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700468 destPathDir := filepath.Dir(destPath)
469 if fi.class == appSet {
470 copyCommands = append(copyCommands, "rm -rf "+destPathDir)
471 }
472 copyCommands = append(copyCommands, "mkdir -p "+destPathDir)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900473
Colin Cross4acaea92021-12-10 23:05:02 +0000474 installMapPath := fi.builtFile
475
Jiyong Parkb81b9902020-11-24 19:51:18 +0900476 // Copy the built file to the directory. But if the symlink optimization is turned
477 // on, place a symlink to the corresponding file in /system partition instead.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900478 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900479 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Jiyong Park7cd10e32020-01-14 09:22:18 +0900480 copyCommands = append(copyCommands, "ln -sfn "+pathOnDevice+" "+destPath)
481 } else {
Jiyong Park4169a252022-09-29 21:30:25 +0900482 // Copy the file into APEX
483 copyCommands = append(copyCommands, "cp -f "+fi.builtFile.String()+" "+destPath)
484
Colin Cross4acaea92021-12-10 23:05:02 +0000485 var installedPath android.InstallPath
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700486 if fi.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +0900487 // In case of AppSet, we need to copy additional APKs as well. They
488 // are zipped. So we need to unzip them.
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700489 copyCommands = append(copyCommands,
Colin Crossffbcd1d2021-11-12 12:19:42 -0800490 fmt.Sprintf("unzip -qDD -d %s %s", destPathDir,
491 fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs().String()))
Colin Cross6340ea52021-11-04 12:01:18 -0700492 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000493 installedPath = ctx.InstallFileWithExtraFilesZip(apexDir.Join(ctx, fi.installDir),
Colin Cross6340ea52021-11-04 12:01:18 -0700494 fi.stem(), fi.builtFile, fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs())
495 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700496 } else {
Colin Cross6340ea52021-11-04 12:01:18 -0700497 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000498 installedPath = ctx.InstallFile(apexDir.Join(ctx, fi.installDir), fi.stem(), fi.builtFile)
Colin Cross6340ea52021-11-04 12:01:18 -0700499 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700500 }
Jiyong Park7cd10e32020-01-14 09:22:18 +0900501 implicitInputs = append(implicitInputs, fi.builtFile)
Colin Cross6340ea52021-11-04 12:01:18 -0700502 if installSymbolFiles {
503 implicitInputs = append(implicitInputs, installedPath)
504 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900505
Colin Cross4acaea92021-12-10 23:05:02 +0000506 // Create additional symlinks pointing the file inside the APEX (if any). Note that
507 // this is independent from the symlink optimization.
508 for _, symlinkPath := range fi.symlinkPaths() {
509 symlinkDest := imageDir.Join(ctx, symlinkPath).String()
510 copyCommands = append(copyCommands, "ln -sfn "+filepath.Base(destPath)+" "+symlinkDest)
511 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000512 installedSymlink := ctx.InstallSymlink(apexDir.Join(ctx, filepath.Dir(symlinkPath)), filepath.Base(symlinkPath), installedPath)
Colin Cross4acaea92021-12-10 23:05:02 +0000513 implicitInputs = append(implicitInputs, installedSymlink)
514 }
Colin Cross6340ea52021-11-04 12:01:18 -0700515 }
Colin Cross4acaea92021-12-10 23:05:02 +0000516
517 installMapPath = installedPath
Jiyong Park7cd10e32020-01-14 09:22:18 +0900518 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900519
520 // Copy the test files (if any)
Liz Kammer1c14a212020-05-12 15:26:55 -0700521 for _, d := range fi.dataPaths {
522 // 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 -0400523 relPath := d.SrcPath.Rel()
524 dataPath := d.SrcPath.String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700525 if !strings.HasSuffix(dataPath, relPath) {
526 panic(fmt.Errorf("path %q does not end with %q", dataPath, relPath))
527 }
528
Jiyong Parkb81b9902020-11-24 19:51:18 +0900529 dataDest := imageDir.Join(ctx, fi.apexRelativePath(relPath), d.RelativeInstallPath).String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700530
Chris Parsons216e10a2020-07-09 17:12:52 -0400531 copyCommands = append(copyCommands, "cp -f "+d.SrcPath.String()+" "+dataDest)
532 implicitInputs = append(implicitInputs, d.SrcPath)
Liz Kammer1c14a212020-05-12 15:26:55 -0700533 }
Colin Cross4acaea92021-12-10 23:05:02 +0000534
535 installMapSet[installMapPath.String()+":"+fi.installDir+"/"+fi.builtFile.Base()] = true
Jiyong Park09d77522019-11-18 11:16:27 +0900536 }
Jooyung Han214bf372019-11-12 13:03:50 +0900537 implicitInputs = append(implicitInputs, a.manifestPbOut)
Colin Cross6340ea52021-11-04 12:01:18 -0700538 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000539 installedManifest := ctx.InstallFile(apexDir, "apex_manifest.pb", a.manifestPbOut)
540 installedKey := ctx.InstallFile(apexDir, "apex_pubkey", a.publicKeyFile)
Colin Cross6340ea52021-11-04 12:01:18 -0700541 implicitInputs = append(implicitInputs, installedManifest, installedKey)
542 }
Jiyong Park09d77522019-11-18 11:16:27 +0900543
Colin Cross4acaea92021-12-10 23:05:02 +0000544 if len(installMapSet) > 0 {
545 var installs []string
546 installs = append(installs, android.SortedStringKeys(installMapSet)...)
547 a.SetLicenseInstallMap(installs)
548 }
549
Jiyong Parkb81b9902020-11-24 19:51:18 +0900550 ////////////////////////////////////////////////////////////////////////////////////////////
551 // Step 1.a: Write the list of files in this APEX to a txt file and compare it against
552 // the allowed list given via the allowed_files property. Build fails when the two lists
553 // differ.
554 //
555 // TODO(jiyong): consider removing this. Nobody other than com.android.apex.cts.shim.* seems
556 // to be using this at this moment. Furthermore, this looks very similar to what
557 // buildInstalledFilesFile does. At least, move this to somewhere else so that this doesn't
558 // hurt readability.
Jooyung Han938b5932020-06-20 12:47:47 +0900559 if a.overridableProperties.Allowed_files != nil {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900560 // Build content.txt
Cole Fausta7347492022-12-16 10:56:24 -0800561 var contentLines []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900562 imageContentFile := android.PathForModuleOut(ctx, "content.txt")
Cole Fausta7347492022-12-16 10:56:24 -0800563 contentLines = append(contentLines, "./apex_manifest.pb")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900564 minSdkVersion := a.minSdkVersion(ctx)
565 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Cole Fausta7347492022-12-16 10:56:24 -0800566 contentLines = append(contentLines, "./apex_manifest.json")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900567 }
568 for _, fi := range a.filesInfo {
Cole Fausta7347492022-12-16 10:56:24 -0800569 contentLines = append(contentLines, "./"+fi.path())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900570 }
Cole Fausta7347492022-12-16 10:56:24 -0800571 sort.Strings(contentLines)
572 android.WriteFileRule(ctx, imageContentFile, strings.Join(contentLines, "\n"))
Jiyong Park09d77522019-11-18 11:16:27 +0900573 implicitInputs = append(implicitInputs, imageContentFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900574
Jiyong Parkb81b9902020-11-24 19:51:18 +0900575 // Compare content.txt against allowed_files.
576 allowedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.overridableProperties.Allowed_files))
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800577 phonyOutput := android.PathForModuleOut(ctx, a.Name()+"-diff-phony-output")
Jiyong Park09d77522019-11-18 11:16:27 +0900578 ctx.Build(pctx, android.BuildParams{
579 Rule: diffApexContentRule,
580 Implicits: implicitInputs,
581 Output: phonyOutput,
582 Description: "diff apex image content",
583 Args: map[string]string{
Colin Cross440e0d02020-06-11 11:32:11 -0700584 "allowed_files_file": allowedFilesFile.String(),
585 "image_content_file": imageContentFile.String(),
586 "apex_module_name": a.Name(),
Jiyong Park09d77522019-11-18 11:16:27 +0900587 },
588 })
Jiyong Park09d77522019-11-18 11:16:27 +0900589 implicitInputs = append(implicitInputs, phonyOutput)
590 }
591
Jiyong Parkb81b9902020-11-24 19:51:18 +0900592 unsignedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix+".unsigned")
Colin Cross790ef352021-10-25 19:15:55 -0700593 outHostBinDir := ctx.Config().HostToolPath(ctx, "").String()
Jiyong Park09d77522019-11-18 11:16:27 +0900594 prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin")
595
596 if apexType == imageApex {
Jiyong Park1b0893e2021-12-13 23:40:17 +0900597
Jiyong Parkb81b9902020-11-24 19:51:18 +0900598 ////////////////////////////////////////////////////////////////////////////////////
599 // Step 2: create canned_fs_config which encodes filemode,uid,gid of each files
600 // in this APEX. The file will be used by apexer in later steps.
Jiyong Park1b0893e2021-12-13 23:40:17 +0900601 cannedFsConfig := a.buildCannedFsConfig(ctx)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900602 implicitInputs = append(implicitInputs, cannedFsConfig)
Jiyong Park09d77522019-11-18 11:16:27 +0900603
Jiyong Parkb81b9902020-11-24 19:51:18 +0900604 ////////////////////////////////////////////////////////////////////////////////////
605 // Step 3: Prepare option flags for apexer and invoke it to create an unsigned APEX.
606 // TODO(jiyong): use the RuleBuilder
Jiyong Park09d77522019-11-18 11:16:27 +0900607 optFlags := []string{}
608
Jiyong Parkb81b9902020-11-24 19:51:18 +0900609 fileContexts := a.buildFileContexts(ctx)
610 implicitInputs = append(implicitInputs, fileContexts)
611
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800612 implicitInputs = append(implicitInputs, a.privateKeyFile, a.publicKeyFile)
613 optFlags = append(optFlags, "--pubkey "+a.publicKeyFile.String())
Jiyong Park09d77522019-11-18 11:16:27 +0900614
Jooyung Han27151d92019-12-16 17:45:32 +0900615 manifestPackageName := a.getOverrideManifestPackageName(ctx)
616 if manifestPackageName != "" {
Jiyong Park09d77522019-11-18 11:16:27 +0900617 optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName)
618 }
619
620 if a.properties.AndroidManifest != nil {
621 androidManifestFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.AndroidManifest))
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000622
623 if a.testApex {
624 androidManifestFile = markManifestTestOnly(ctx, androidManifestFile)
625 }
626
Jiyong Park09d77522019-11-18 11:16:27 +0900627 implicitInputs = append(implicitInputs, androidManifestFile)
628 optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String())
Gurpreet Singha76f8742022-02-03 21:01:51 +0000629 } else if a.testApex {
630 optFlags = append(optFlags, "--test_only")
Jiyong Park09d77522019-11-18 11:16:27 +0900631 }
632
Jiyong Parkb81b9902020-11-24 19:51:18 +0900633 // Determine target/min sdk version from the context
634 // TODO(jiyong): make this as a function
Dan Albertc8060532020-07-22 22:32:17 -0700635 moduleMinSdkVersion := a.minSdkVersion(ctx)
Nikita Ioffe5335bc42020-10-20 00:02:15 +0100636 minSdkVersion := moduleMinSdkVersion.String()
637
Jiyong Parkb81b9902020-11-24 19:51:18 +0900638 // bundletool doesn't understand what "current" is. We need to transform it to
639 // codename
Jooyung Haned124c32021-01-26 11:43:46 +0900640 if moduleMinSdkVersion.IsCurrent() || moduleMinSdkVersion.IsNone() {
Nikita Ioffe5335bc42020-10-20 00:02:15 +0100641 minSdkVersion = ctx.Config().DefaultAppTargetSdk(ctx).String()
Liz Kammer4854a7d2021-05-27 14:28:27 -0400642
643 if java.UseApiFingerprint(ctx) {
644 minSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
645 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
646 }
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000647 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900648 // apex module doesn't have a concept of target_sdk_version, hence for the time
649 // being targetSdkVersion == default targetSdkVersion of the branch.
Nikita Ioffe5335bc42020-10-20 00:02:15 +0100650 targetSdkVersion := strconv.Itoa(ctx.Config().DefaultAppTargetSdk(ctx).FinalOrFutureInt())
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000651
Nikita Ioffe1f4f3452020-03-02 16:58:11 +0000652 if java.UseApiFingerprint(ctx) {
653 targetSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
Baligh Uddinf6201372020-01-24 23:15:44 +0000654 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
655 }
Jiyong Park09d77522019-11-18 11:16:27 +0900656 optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion)
Baligh Uddinf6201372020-01-24 23:15:44 +0000657 optFlags = append(optFlags, "--min_sdk_version "+minSdkVersion)
Jiyong Park09d77522019-11-18 11:16:27 +0900658
Baligh Uddin004d7172020-02-19 21:29:28 -0800659 if a.overridableProperties.Logging_parent != "" {
660 optFlags = append(optFlags, "--logging_parent ", a.overridableProperties.Logging_parent)
661 }
662
Bob Badourde6a0872022-04-01 18:00:00 +0000663 // Create a NOTICE file, and embed it as an asset file in the APEX.
Jingwen Chen4a9630b2022-11-16 19:12:35 +0000664 htmlGzNotice := android.PathForModuleOut(ctx, "NOTICE.html.gz")
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700665 android.BuildNoticeHtmlOutputFromLicenseMetadata(
Jingwen Chen4a9630b2022-11-16 19:12:35 +0000666 ctx, htmlGzNotice, "", "",
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700667 []string{
668 android.PathForModuleInstall(ctx).String() + "/",
669 android.PathForModuleInPartitionInstall(ctx, "apex").String() + "/",
670 })
Bob Badour2c8888e2022-04-04 16:12:21 -0700671 noticeAssetPath := android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
672 builder := android.NewRuleBuilder(pctx, ctx)
673 builder.Command().Text("cp").
Jingwen Chen4a9630b2022-11-16 19:12:35 +0000674 Input(htmlGzNotice).
Bob Badour2c8888e2022-04-04 16:12:21 -0700675 Output(noticeAssetPath)
676 builder.Build("notice_dir", "Building notice dir")
677 implicitInputs = append(implicitInputs, noticeAssetPath)
678 optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeAssetPath.String()))
Jiyong Park09d77522019-11-18 11:16:27 +0900679
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700680 // Apexes which are supposed to be installed in builtin dirs(/system, etc)
681 // don't need hashtree for activation. Therefore, by removing hashtree from
682 // apex bundle (filesystem image in it, to be specific), we can save storage.
683 needHashTree := moduleMinSdkVersion.LessThanOrEqualTo(android.SdkVersion_Android10) ||
684 a.shouldGenerateHashtree()
685 if ctx.Config().ApexCompressionEnabled() && a.isCompressable() {
686 needHashTree = true
687 }
688 if !needHashTree {
Jiyong Park09d77522019-11-18 11:16:27 +0900689 optFlags = append(optFlags, "--no_hashtree")
690 }
691
Dario Frenica913392020-04-27 18:21:11 +0100692 if a.testOnlyShouldSkipPayloadSign() {
693 optFlags = append(optFlags, "--unsigned_payload")
694 }
695
Dan Albertc8060532020-07-22 22:32:17 -0700696 if moduleMinSdkVersion == android.SdkVersion_Android10 {
Jooyung Han214bf372019-11-12 13:03:50 +0900697 implicitInputs = append(implicitInputs, a.manifestJsonOut)
698 optFlags = append(optFlags, "--manifest_json "+a.manifestJsonOut.String())
699 }
700
Theotime Combes4ba38c12020-06-12 12:46:59 +0000701 optFlags = append(optFlags, "--payload_fs_type "+a.payloadFsType.string())
702
Dennis Shenaf41bc12022-08-03 16:46:43 +0000703 if a.dynamic_common_lib_apex() {
704 ctx.Build(pctx, android.BuildParams{
705 Rule: DCLAApexRule,
706 Implicits: implicitInputs,
707 Output: unsignedOutputFile,
708 Description: "apex (" + apexType.name() + ")",
709 Args: map[string]string{
710 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
711 "image_dir": imageDir.String(),
712 "copy_commands": strings.Join(copyCommands, " && "),
713 "manifest": a.manifestPbOut.String(),
714 "file_contexts": fileContexts.String(),
715 "canned_fs_config": cannedFsConfig.String(),
716 "key": a.privateKeyFile.String(),
717 "opt_flags": strings.Join(optFlags, " "),
718 },
719 })
Dennis Shene2ed70c2023-01-11 14:15:43 +0000720 } else if ctx.Config().ApexTrimEnabled() && len(a.libs_to_trim(ctx)) > 0 {
721 ctx.Build(pctx, android.BuildParams{
722 Rule: TrimmedApexRule,
723 Implicits: implicitInputs,
724 Output: unsignedOutputFile,
725 Description: "apex (" + apexType.name() + ")",
726 Args: map[string]string{
727 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
728 "image_dir": imageDir.String(),
729 "copy_commands": strings.Join(copyCommands, " && "),
730 "manifest": a.manifestPbOut.String(),
731 "file_contexts": fileContexts.String(),
732 "canned_fs_config": cannedFsConfig.String(),
733 "key": a.privateKeyFile.String(),
734 "opt_flags": strings.Join(optFlags, " "),
735 "libs_to_trim": strings.Join(a.libs_to_trim(ctx), ","),
736 },
737 })
Dennis Shenaf41bc12022-08-03 16:46:43 +0000738 } else {
739 ctx.Build(pctx, android.BuildParams{
740 Rule: apexRule,
741 Implicits: implicitInputs,
742 Output: unsignedOutputFile,
743 Description: "apex (" + apexType.name() + ")",
744 Args: map[string]string{
745 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
746 "image_dir": imageDir.String(),
747 "copy_commands": strings.Join(copyCommands, " && "),
748 "manifest": a.manifestPbOut.String(),
749 "file_contexts": fileContexts.String(),
750 "canned_fs_config": cannedFsConfig.String(),
751 "key": a.privateKeyFile.String(),
752 "opt_flags": strings.Join(optFlags, " "),
753 },
754 })
755 }
Jiyong Park09d77522019-11-18 11:16:27 +0900756
Jiyong Parkb81b9902020-11-24 19:51:18 +0900757 // TODO(jiyong): make the two rules below as separate functions
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800758 apexProtoFile := android.PathForModuleOut(ctx, a.Name()+".pb"+suffix)
759 bundleModuleFile := android.PathForModuleOut(ctx, a.Name()+suffix+"-base.zip")
Jiyong Park09d77522019-11-18 11:16:27 +0900760 a.bundleModuleFile = bundleModuleFile
761
762 ctx.Build(pctx, android.BuildParams{
763 Rule: apexProtoConvertRule,
764 Input: unsignedOutputFile,
765 Output: apexProtoFile,
766 Description: "apex proto convert",
767 })
768
sophiezc80a2b32020-11-12 16:39:19 +0000769 implicitInputs = append(implicitInputs, unsignedOutputFile)
770
771 // Run coverage analysis
sophiez6bde0b52021-01-09 01:03:42 +0000772 apisUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.txt")
sophiezc80a2b32020-11-12 16:39:19 +0000773 ctx.Build(pctx, android.BuildParams{
774 Rule: generateAPIsUsedbyApexRule,
775 Implicits: implicitInputs,
776 Description: "coverage",
777 Output: apisUsedbyOutputFile,
778 Args: map[string]string{
779 "image_dir": imageDir.String(),
780 "readelf": "${config.ClangBin}/llvm-readelf",
781 },
782 })
sophiez02347372021-11-02 17:58:02 -0700783 a.nativeApisUsedByModuleFile = apisUsedbyOutputFile
sophiez6bde0b52021-01-09 01:03:42 +0000784
sophiez02347372021-11-02 17:58:02 -0700785 var nativeLibNames []string
Colin Cross69f0a242021-02-08 16:49:57 -0800786 for _, f := range a.filesInfo {
787 if f.class == nativeSharedLib {
sophiez02347372021-11-02 17:58:02 -0700788 nativeLibNames = append(nativeLibNames, f.stem())
Colin Cross69f0a242021-02-08 16:49:57 -0800789 }
790 }
sophiez6bde0b52021-01-09 01:03:42 +0000791 apisBackedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_backing.txt")
sophiez6bde0b52021-01-09 01:03:42 +0000792 rule := android.NewRuleBuilder(pctx, ctx)
793 rule.Command().
794 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_ndk_backedby_apex.sh")).
sophiez6bde0b52021-01-09 01:03:42 +0000795 Output(apisBackedbyOutputFile).
sophiez02347372021-11-02 17:58:02 -0700796 Flags(nativeLibNames)
sophiez6bde0b52021-01-09 01:03:42 +0000797 rule.Build("ndk_backedby_list", "Generate API libraries backed by Apex")
sophiez02347372021-11-02 17:58:02 -0700798 a.nativeApisBackedByModuleFile = apisBackedbyOutputFile
799
800 var javaLibOrApkPath []android.Path
801 for _, f := range a.filesInfo {
802 if f.class == javaSharedLib || f.class == app {
803 javaLibOrApkPath = append(javaLibOrApkPath, f.builtFile)
804 }
805 }
806 javaApiUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.xml")
807 javaUsedByRule := android.NewRuleBuilder(pctx, ctx)
808 javaUsedByRule.Command().
809 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_java_usedby_apex.sh")).
810 BuiltTool("dexdeps").
811 Output(javaApiUsedbyOutputFile).
812 Inputs(javaLibOrApkPath)
813 javaUsedByRule.Build("java_usedby_list", "Generate Java APIs used by Apex")
814 a.javaApisUsedByModuleFile = javaApiUsedbyOutputFile
sophiezc80a2b32020-11-12 16:39:19 +0000815
Jiyong Parkbd159612020-02-28 15:22:21 +0900816 bundleConfig := a.buildBundleConfig(ctx)
817
Jiyong Parkb81b9902020-11-24 19:51:18 +0900818 var abis []string
819 for _, target := range ctx.MultiTargets() {
820 if len(target.Arch.Abi) > 0 {
821 abis = append(abis, target.Arch.Abi[0])
822 }
823 }
824
825 abis = android.FirstUniqueStrings(abis)
826
Jiyong Park09d77522019-11-18 11:16:27 +0900827 ctx.Build(pctx, android.BuildParams{
828 Rule: apexBundleRule,
829 Input: apexProtoFile,
Jiyong Parkbd159612020-02-28 15:22:21 +0900830 Implicit: bundleConfig,
Jiyong Park09d77522019-11-18 11:16:27 +0900831 Output: a.bundleModuleFile,
832 Description: "apex bundle module",
833 Args: map[string]string{
Jiyong Parkbd159612020-02-28 15:22:21 +0900834 "abi": strings.Join(abis, "."),
835 "config": bundleConfig.String(),
Jiyong Park09d77522019-11-18 11:16:27 +0900836 },
837 })
Jiyong Parkb81b9902020-11-24 19:51:18 +0900838 } else { // zipApex
Jiyong Park09d77522019-11-18 11:16:27 +0900839 ctx.Build(pctx, android.BuildParams{
840 Rule: zipApexRule,
841 Implicits: implicitInputs,
842 Output: unsignedOutputFile,
843 Description: "apex (" + apexType.name() + ")",
844 Args: map[string]string{
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000845 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
846 "image_dir": imageDir.String(),
847 "copy_commands": strings.Join(copyCommands, " && "),
848 "manifest": a.manifestPbOut.String(),
Jiyong Park09d77522019-11-18 11:16:27 +0900849 },
850 })
851 }
852
Jiyong Parkb81b9902020-11-24 19:51:18 +0900853 ////////////////////////////////////////////////////////////////////////////////////
854 // Step 4: Sign the APEX using signapk
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000855 signedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900856
857 pem, key := a.getCertificateAndPrivateKey(ctx)
Kousik Kumar309b1c02020-05-28 06:13:33 -0700858 rule := java.Signapk
859 args := map[string]string{
Jiyong Parkb81b9902020-11-24 19:51:18 +0900860 "certificates": pem.String() + " " + key.String(),
Jooyung Han5d00f502021-07-11 07:26:22 +0900861 "flags": "-a 4096 --align-file-size", //alignment
Kousik Kumar309b1c02020-05-28 06:13:33 -0700862 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900863 implicits := android.Paths{pem, key}
Ramy Medhat16f23a42020-09-03 01:29:49 -0400864 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
Kousik Kumar309b1c02020-05-28 06:13:33 -0700865 rule = java.SignapkRE
866 args["implicits"] = strings.Join(implicits.Strings(), ",")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000867 args["outCommaList"] = signedOutputFile.String()
Kousik Kumar309b1c02020-05-28 06:13:33 -0700868 }
Jiyong Park09d77522019-11-18 11:16:27 +0900869 ctx.Build(pctx, android.BuildParams{
Kousik Kumar309b1c02020-05-28 06:13:33 -0700870 Rule: rule,
Jiyong Park09d77522019-11-18 11:16:27 +0900871 Description: "signapk",
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000872 Output: signedOutputFile,
Jiyong Park09d77522019-11-18 11:16:27 +0900873 Input: unsignedOutputFile,
Kousik Kumar309b1c02020-05-28 06:13:33 -0700874 Implicits: implicits,
875 Args: args,
Jiyong Park09d77522019-11-18 11:16:27 +0900876 })
Jooyung Hana6d36672022-02-24 13:58:07 +0900877 if suffix == imageApexSuffix {
878 a.outputApexFile = signedOutputFile
879 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000880 a.outputFile = signedOutputFile
881
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +0000882 if ctx.ModuleDir() != "system/apex/apexd/apexd_testdata" && a.testOnlyShouldForceCompression() {
883 ctx.PropertyErrorf("test_only_force_compression", "not available")
884 return
885 }
Nikita Ioffebc035882021-04-14 21:35:24 +0100886
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700887 installSuffix := suffix
888 a.setCompression(ctx)
889 if a.isCompressed {
Samiul Islam7c02e262021-09-08 17:48:28 +0100890 unsignedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix+".unsigned")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000891
892 compressRule := android.NewRuleBuilder(pctx, ctx)
893 compressRule.Command().
894 Text("rm").
895 FlagWithOutput("-f ", unsignedCompressedOutputFile)
896 compressRule.Command().
897 BuiltTool("apex_compression_tool").
898 Flag("compress").
899 FlagWithArg("--apex_compression_tool ", outHostBinDir+":"+prebuiltSdkToolsBinDir).
900 FlagWithInput("--input ", signedOutputFile).
901 FlagWithOutput("--output ", unsignedCompressedOutputFile)
902 compressRule.Build("compressRule", "Generate unsigned compressed APEX file")
903
Samiul Islam7c02e262021-09-08 17:48:28 +0100904 signedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix)
Mohammad Samiul Islam9ac0e322021-01-19 11:32:29 +0000905 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
906 args["outCommaList"] = signedCompressedOutputFile.String()
907 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000908 ctx.Build(pctx, android.BuildParams{
909 Rule: rule,
910 Description: "sign compressedApex",
911 Output: signedCompressedOutputFile,
912 Input: unsignedCompressedOutputFile,
913 Implicits: implicits,
914 Args: args,
915 })
916 a.outputFile = signedCompressedOutputFile
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000917 installSuffix = imageCapexSuffix
918 }
919
Colin Crossd9ccb6a2022-03-07 18:38:34 -0800920 if !a.installable() {
921 a.SkipInstall()
922 }
923
Jiyong Park17ff2832021-09-27 12:50:30 +0900924 // Install to $OUT/soong/{target,host}/.../apex.
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000925 a.installedFile = ctx.InstallFile(a.installDir, a.Name()+installSuffix, a.outputFile,
Colin Cross6340ea52021-11-04 12:01:18 -0700926 a.compatSymlinks.Paths()...)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900927
928 // installed-files.txt is dist'ed
929 a.installedFilesFile = a.buildInstalledFilesFile(ctx, a.outputFile, imageDir)
Jiyong Park09d77522019-11-18 11:16:27 +0900930}
931
Jiyong Parkb81b9902020-11-24 19:51:18 +0900932// buildFlattenedApex creates rules for a flattened APEX. Flattened APEX actually doesn't have a
933// single output file. It is a phony target for all the files under /system/apex/<name> directory.
934// This function creates the installation rules for the files.
Jiyong Park09d77522019-11-18 11:16:27 +0900935func (a *apexBundle) buildFlattenedApex(ctx android.ModuleContext) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900936 bundleName := a.Name()
Colin Cross6340ea52021-11-04 12:01:18 -0700937 installedSymlinks := append(android.InstallPaths(nil), a.compatSymlinks...)
Jiyong Park09d77522019-11-18 11:16:27 +0900938 if a.installable() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900939 for _, fi := range a.filesInfo {
940 dir := filepath.Join("apex", bundleName, fi.installDir)
Colin Cross6340ea52021-11-04 12:01:18 -0700941 installDir := android.PathForModuleInstall(ctx, dir)
942 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900943 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Colin Cross6340ea52021-11-04 12:01:18 -0700944 installedSymlinks = append(installedSymlinks,
945 ctx.InstallAbsoluteSymlink(installDir, fi.stem(), pathOnDevice))
946 } else {
Jiyong Parkf648d532022-10-19 18:18:56 +0900947 if fi.class == appSet {
948 as := fi.module.(*java.AndroidAppSet)
949 ctx.InstallFileWithExtraFilesZip(installDir, as.BaseModuleName()+".apk",
950 as.OutputFile(), as.PackedAdditionalOutputs())
951 } else {
952 target := ctx.InstallFile(installDir, fi.stem(), fi.builtFile)
953 for _, sym := range fi.symlinks {
954 installedSymlinks = append(installedSymlinks,
955 ctx.InstallSymlink(installDir, sym, target))
956 }
Colin Cross6340ea52021-11-04 12:01:18 -0700957 }
Jiyong Park09d77522019-11-18 11:16:27 +0900958 }
959 }
Colin Cross6340ea52021-11-04 12:01:18 -0700960
961 // Create install rules for the files added in GenerateAndroidBuildActions after
962 // buildFlattenedApex is called. Add the links to system libs (if any) as dependencies
963 // of the apex_manifest.pb file since it is always present.
964 dir := filepath.Join("apex", bundleName)
965 installDir := android.PathForModuleInstall(ctx, dir)
966 ctx.InstallFile(installDir, "apex_manifest.pb", a.manifestPbOut, installedSymlinks.Paths()...)
967 ctx.InstallFile(installDir, "apex_pubkey", a.publicKeyFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900968 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900969
970 a.fileContexts = a.buildFileContexts(ctx)
971
Colin Cross6340ea52021-11-04 12:01:18 -0700972 a.outputFile = android.PathForModuleInstall(ctx, "apex", bundleName)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900973}
974
975// getCertificateAndPrivateKey retrieves the cert and the private key that will be used to sign
976// the zip container of this APEX. See the description of the 'certificate' property for how
977// the cert and the private key are found.
978func (a *apexBundle) getCertificateAndPrivateKey(ctx android.PathContext) (pem, key android.Path) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800979 if a.containerCertificateFile != nil {
980 return a.containerCertificateFile, a.containerPrivateKeyFile
Jiyong Parkb81b9902020-11-24 19:51:18 +0900981 }
982
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -0700983 cert := String(a.overridableProperties.Certificate)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900984 if cert == "" {
985 return ctx.Config().DefaultAppCertificate(ctx)
986 }
987
988 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
989 pem = defaultDir.Join(ctx, cert+".x509.pem")
990 key = defaultDir.Join(ctx, cert+".pk8")
991 return pem, key
Jiyong Park09d77522019-11-18 11:16:27 +0900992}
Jooyung Han27151d92019-12-16 17:45:32 +0900993
994func (a *apexBundle) getOverrideManifestPackageName(ctx android.ModuleContext) string {
995 // For VNDK APEXes, check "com.android.vndk" in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
996 // to see if it should be overridden because their <apex name> is dynamically generated
997 // according to its VNDK version.
998 if a.vndkApex {
999 overrideName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(vndkApexName)
1000 if overridden {
Jooyung Han2cd2f9a2023-02-06 18:29:08 +09001001 return overrideName + ".v" + a.vndkVersion(ctx.DeviceConfig())
Jooyung Han27151d92019-12-16 17:45:32 +09001002 }
1003 return ""
1004 }
Baligh Uddin5b57dba2020-03-15 13:01:05 -07001005 if a.overridableProperties.Package_name != "" {
1006 return a.overridableProperties.Package_name
1007 }
Jiyong Park20bacab2020-03-03 11:45:41 +09001008 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jooyung Han27151d92019-12-16 17:45:32 +09001009 if overridden {
1010 return manifestPackageName
1011 }
1012 return ""
1013}
Jiyong Park83dc74b2020-01-14 18:38:44 +09001014
1015func (a *apexBundle) buildApexDependencyInfo(ctx android.ModuleContext) {
1016 if !a.primaryApexType {
1017 return
1018 }
1019
1020 if a.properties.IsCoverageVariant {
1021 // Otherwise, we will have duplicated rules for coverage and
1022 // non-coverage variants of the same APEX
1023 return
1024 }
1025
1026 if ctx.Host() {
1027 // No need to generate dependency info for host variant
1028 return
1029 }
1030
Artur Satayev872a1442020-04-27 17:08:37 +01001031 depInfos := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +09001032 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev872a1442020-04-27 17:08:37 +01001033 if from.Name() == to.Name() {
1034 // This can happen for cc.reuseObjTag. We are not interested in tracking this.
1035 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1036 return !externalDep
Jiyong Park678c8812020-02-07 17:25:49 +09001037 }
Jiyong Park83dc74b2020-01-14 18:38:44 +09001038
Artur Satayev533b98c2021-03-11 18:03:42 +00001039 // Skip dependencies that are only available to APEXes; they are developed with updatability
1040 // in mind and don't need manual approval.
1041 if to.(android.ApexModule).NotAvailableForPlatform() {
1042 return !externalDep
1043 }
1044
Cindy Zhou18417cb2020-12-10 07:12:38 -08001045 depTag := ctx.OtherModuleDependencyTag(to)
Artur Satayev533b98c2021-03-11 18:03:42 +00001046 // Check to see if dependency been marked to skip the dependency check
Cindy Zhou18417cb2020-12-10 07:12:38 -08001047 if skipDepCheck, ok := depTag.(android.SkipApexAllowedDependenciesCheck); ok && skipDepCheck.SkipApexAllowedDependenciesCheck() {
Cindy Zhou18417cb2020-12-10 07:12:38 -08001048 return !externalDep
1049 }
1050
Artur Satayev872a1442020-04-27 17:08:37 +01001051 if info, exists := depInfos[to.Name()]; exists {
1052 if !android.InList(from.Name(), info.From) {
1053 info.From = append(info.From, from.Name())
1054 }
1055 info.IsExternal = info.IsExternal && externalDep
1056 depInfos[to.Name()] = info
1057 } else {
Artur Satayev480e25b2020-04-27 18:53:18 +01001058 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001059 if m, ok := to.(interface {
1060 MinSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec
1061 }); ok {
1062 if v := m.MinSdkVersion(ctx); !v.ApiLevel.IsNone() {
1063 toMinSdkVersion = v.ApiLevel.String()
1064 }
1065 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1066 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1067 // string
Artur Satayev480e25b2020-04-27 18:53:18 +01001068 if v := m.MinSdkVersion(); v != "" {
1069 toMinSdkVersion = v
1070 }
1071 }
Artur Satayev872a1442020-04-27 17:08:37 +01001072 depInfos[to.Name()] = android.ApexModuleDepInfo{
Artur Satayev480e25b2020-04-27 18:53:18 +01001073 To: to.Name(),
1074 From: []string{from.Name()},
1075 IsExternal: externalDep,
1076 MinSdkVersion: toMinSdkVersion,
Artur Satayev872a1442020-04-27 17:08:37 +01001077 }
1078 }
1079
1080 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1081 return !externalDep
Jiyong Park83dc74b2020-01-14 18:38:44 +09001082 })
1083
Albert Martineefabcf2022-03-21 20:11:16 +00001084 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).Raw, depInfos)
Artur Satayev872a1442020-04-27 17:08:37 +01001085
Jiyong Park83dc74b2020-01-14 18:38:44 +09001086 ctx.Build(pctx, android.BuildParams{
1087 Rule: android.Phony,
1088 Output: android.PathForPhony(ctx, a.Name()+"-deps-info"),
Artur Satayeva8bd1132020-04-27 18:07:06 +01001089 Inputs: []android.Path{
1090 a.ApexBundleDepsInfo.FullListPath(),
1091 a.ApexBundleDepsInfo.FlatListPath(),
1092 },
Jiyong Park83dc74b2020-01-14 18:38:44 +09001093 })
1094}
Colin Cross08dca382020-07-21 20:31:17 -07001095
1096func (a *apexBundle) buildLintReports(ctx android.ModuleContext) {
1097 depSetsBuilder := java.NewLintDepSetBuilder()
1098 for _, fi := range a.filesInfo {
1099 depSetsBuilder.Transitive(fi.lintDepSets)
1100 }
1101
1102 a.lintReports = java.BuildModuleLintReportZips(ctx, depSetsBuilder.Build())
1103}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001104
1105func (a *apexBundle) buildCannedFsConfig(ctx android.ModuleContext) android.OutputPath {
1106 var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"}
1107 var executablePaths []string // this also includes dirs
1108 var appSetDirs []string
1109 appSetFiles := make(map[string]android.Path)
1110 for _, f := range a.filesInfo {
1111 pathInApex := f.path()
1112 if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") {
1113 executablePaths = append(executablePaths, pathInApex)
1114 for _, d := range f.dataPaths {
1115 readOnlyPaths = append(readOnlyPaths, filepath.Join(f.installDir, d.RelativeInstallPath, d.SrcPath.Rel()))
1116 }
1117 for _, s := range f.symlinks {
1118 executablePaths = append(executablePaths, filepath.Join(f.installDir, s))
1119 }
1120 } else if f.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +09001121 // base APK
1122 readOnlyPaths = append(readOnlyPaths, pathInApex)
1123 // Additional APKs
Jiyong Park1b0893e2021-12-13 23:40:17 +09001124 appSetDirs = append(appSetDirs, f.installDir)
Jiyong Parke1b69142022-09-26 14:48:56 +09001125 appSetFiles[f.installDir] = f.module.(*java.AndroidAppSet).PackedAdditionalOutputs()
Jiyong Park1b0893e2021-12-13 23:40:17 +09001126 } else {
1127 readOnlyPaths = append(readOnlyPaths, pathInApex)
1128 }
1129 dir := f.installDir
1130 for !android.InList(dir, executablePaths) && dir != "" {
1131 executablePaths = append(executablePaths, dir)
1132 dir, _ = filepath.Split(dir) // move up to the parent
1133 if len(dir) > 0 {
1134 // remove trailing slash
1135 dir = dir[:len(dir)-1]
1136 }
1137 }
1138 }
1139 sort.Strings(readOnlyPaths)
1140 sort.Strings(executablePaths)
1141 sort.Strings(appSetDirs)
1142
1143 cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config")
1144 builder := android.NewRuleBuilder(pctx, ctx)
1145 cmd := builder.Command()
1146 cmd.Text("(")
1147 cmd.Text("echo '/ 1000 1000 0755';")
1148 for _, p := range readOnlyPaths {
1149 cmd.Textf("echo '/%s 1000 1000 0644';", p)
1150 }
1151 for _, p := range executablePaths {
1152 cmd.Textf("echo '/%s 0 2000 0755';", p)
1153 }
1154 for _, dir := range appSetDirs {
1155 cmd.Textf("echo '/%s 0 2000 0755';", dir)
1156 file := appSetFiles[dir]
1157 cmd.Text("zipinfo -1").Input(file).Textf(`| sed "s:\(.*\):/%s/\1 1000 1000 0644:";`, dir)
1158 }
Jiyong Park038e8522021-12-13 23:56:35 +09001159 // Custom fs_config is "appended" to the last so that entries from the file are preferred
1160 // over default ones set above.
1161 if a.properties.Canned_fs_config != nil {
1162 cmd.Text("cat").Input(android.PathForModuleSrc(ctx, *a.properties.Canned_fs_config))
1163 }
Sasha Smundakd6322932023-01-11 19:37:31 -08001164 cmd.Text(") | LC_ALL=C sort ").FlagWithOutput("> ", cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +09001165 builder.Build("generateFsConfig", fmt.Sprintf("Generating canned fs config for %s", a.BaseModuleName()))
1166
1167 return cannedFsConfig.OutputPath
1168}