blob: e3404a541ebd854731cb2f52f5d9dd43a75f1e97 [file] [log] [blame]
Colin Cross43f08db2018-11-12 10:13:39 -08001// Copyright 2018 Google Inc. All rights reserved.
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
15// The dexpreopt package converts a global dexpreopt config and a module dexpreopt config into rules to perform
Nicolas Geoffrayc1bf7242019-10-18 14:51:38 +010016// dexpreopting.
Colin Cross43f08db2018-11-12 10:13:39 -080017//
18// It is used in two places; in the dexpeopt_gen binary for modules defined in Make, and directly linked into Soong.
19//
20// For Make modules it is built into the dexpreopt_gen binary, which is executed as a Make rule using global config and
21// module config specified in JSON files. The binary writes out two shell scripts, only updating them if they have
22// changed. One script takes an APK or JAR as an input and produces a zip file containing any outputs of preopting,
23// in the location they should be on the device. The Make build rules will unzip the zip file into $(PRODUCT_OUT) when
24// installing the APK, which will install the preopt outputs into $(PRODUCT_OUT)/system or $(PRODUCT_OUT)/system_other
Nicolas Geoffrayc1bf7242019-10-18 14:51:38 +010025// as necessary. The zip file may be empty if preopting was disabled for any reason.
Colin Cross43f08db2018-11-12 10:13:39 -080026//
27// The intermediate shell scripts allow changes to this package or to the global config to regenerate the shell scripts
28// but only require re-executing preopting if the script has changed.
29//
30// For Soong modules this package is linked directly into Soong and run from the java package. It generates the same
31// commands as for make, using athe same global config JSON file used by make, but using a module config structure
32// provided by Soong. The generated commands are then converted into Soong rule and written directly to the ninja file,
33// with no extra shell scripts involved.
34package dexpreopt
35
36import (
37 "fmt"
38 "path/filepath"
Colin Cross69f59a32019-02-15 10:39:37 -080039 "runtime"
Colin Cross43f08db2018-11-12 10:13:39 -080040 "strings"
41
Colin Crossfeec25b2019-01-30 17:32:39 -080042 "android/soong/android"
43
Colin Cross43f08db2018-11-12 10:13:39 -080044 "github.com/google/blueprint/pathtools"
45)
46
47const SystemPartition = "/system/"
48const SystemOtherPartition = "/system_other/"
49
Ulya Trafimovich6cf2c0c2020-04-24 12:15:20 +010050var DexpreoptRunningInSoong = false
51
Colin Cross43f08db2018-11-12 10:13:39 -080052// GenerateDexpreoptRule generates a set of commands that will preopt a module based on a GlobalConfig and a
53// ModuleConfig. The produced files and their install locations will be available through rule.Installs().
Colin Crossf1a035e2020-11-16 17:32:30 -080054func GenerateDexpreoptRule(ctx android.BuilderContext, globalSoong *GlobalSoongConfig,
Martin Stjernholm8d80cee2020-01-31 17:44:54 +000055 global *GlobalConfig, module *ModuleConfig) (rule *android.RuleBuilder, err error) {
Colin Cross69f59a32019-02-15 10:39:37 -080056
Colin Cross43f08db2018-11-12 10:13:39 -080057 defer func() {
58 if r := recover(); r != nil {
Colin Cross69f59a32019-02-15 10:39:37 -080059 if _, ok := r.(runtime.Error); ok {
60 panic(r)
61 } else if e, ok := r.(error); ok {
Colin Cross43f08db2018-11-12 10:13:39 -080062 err = e
63 rule = nil
64 } else {
65 panic(r)
66 }
67 }
68 }()
69
Colin Crossf1a035e2020-11-16 17:32:30 -080070 rule = android.NewRuleBuilder(pctx, ctx)
Colin Cross43f08db2018-11-12 10:13:39 -080071
Colin Cross69f59a32019-02-15 10:39:37 -080072 generateProfile := module.ProfileClassListing.Valid() && !global.DisableGenerateProfile
Nicolas Geoffraye7102422019-07-24 13:19:29 +010073 generateBootProfile := module.ProfileBootListing.Valid() && !global.DisableGenerateProfile
Colin Cross43f08db2018-11-12 10:13:39 -080074
Colin Cross69f59a32019-02-15 10:39:37 -080075 var profile android.WritablePath
Colin Crosscbed6572019-01-08 17:38:37 -080076 if generateProfile {
Martin Stjernholm75a48d82020-01-10 20:32:59 +000077 profile = profileCommand(ctx, globalSoong, global, module, rule)
Colin Crosscbed6572019-01-08 17:38:37 -080078 }
Nicolas Geoffraye7102422019-07-24 13:19:29 +010079 if generateBootProfile {
Martin Stjernholm75a48d82020-01-10 20:32:59 +000080 bootProfileCommand(ctx, globalSoong, global, module, rule)
Nicolas Geoffraye7102422019-07-24 13:19:29 +010081 }
Colin Crosscbed6572019-01-08 17:38:37 -080082
Ulya Trafimovichf3ff0102019-12-03 15:39:23 +000083 if !dexpreoptDisabled(ctx, global, module) {
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +000084 if valid, err := validateClassLoaderContext(module.ClassLoaderContexts); err != nil {
Ulya Trafimovich69612672020-10-20 17:41:54 +010085 android.ReportPathErrorf(ctx, err.Error())
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +000086 } else if valid {
87 fixClassLoaderContext(module.ClassLoaderContexts)
88
Colin Crosscbed6572019-01-08 17:38:37 -080089 appImage := (generateProfile || module.ForceCreateAppImage || global.DefaultAppImages) &&
90 !module.NoCreateAppImage
91
92 generateDM := shouldGenerateDM(module, global)
93
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000094 for archIdx, _ := range module.Archs {
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +000095 dexpreoptCommand(ctx, globalSoong, global, module, rule, archIdx, profile, appImage, generateDM)
Colin Crosscbed6572019-01-08 17:38:37 -080096 }
97 }
98 }
99
100 return rule, nil
101}
102
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000103func dexpreoptDisabled(ctx android.PathContext, global *GlobalConfig, module *ModuleConfig) bool {
Colin Crosscbed6572019-01-08 17:38:37 -0800104 if contains(global.DisablePreoptModules, module.Name) {
105 return true
Colin Cross43f08db2018-11-12 10:13:39 -0800106 }
107
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100108 // Don't preopt individual boot jars, they will be preopted together.
109 if global.BootJars.ContainsJar(module.Name) {
110 return true
111 }
112
Colin Cross43f08db2018-11-12 10:13:39 -0800113 // If OnlyPreoptBootImageAndSystemServer=true and module is not in boot class path skip
114 // Also preopt system server jars since selinux prevents system server from loading anything from
115 // /data. If we don't do this they will need to be extracted which is not favorable for RAM usage
116 // or performance. If PreoptExtractedApk is true, we ignore the only preopt boot image options.
Ulya Trafimovich249386a2020-07-01 14:31:13 +0100117 if global.OnlyPreoptBootImageAndSystemServer && !global.BootJars.ContainsJar(module.Name) &&
Jiakai Zhang389a6472021-12-14 18:54:06 +0000118 !global.AllSystemServerJars(ctx).ContainsJar(module.Name) && !module.PreoptExtractedApk {
Colin Crosscbed6572019-01-08 17:38:37 -0800119 return true
Colin Cross43f08db2018-11-12 10:13:39 -0800120 }
121
Colin Crosscbed6572019-01-08 17:38:37 -0800122 return false
Colin Cross43f08db2018-11-12 10:13:39 -0800123}
124
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000125func profileCommand(ctx android.PathContext, globalSoong *GlobalSoongConfig, global *GlobalConfig,
126 module *ModuleConfig, rule *android.RuleBuilder) android.WritablePath {
Colin Cross69f59a32019-02-15 10:39:37 -0800127
128 profilePath := module.BuildPath.InSameDir(ctx, "profile.prof")
Colin Cross43f08db2018-11-12 10:13:39 -0800129 profileInstalledPath := module.DexLocation + ".prof"
130
131 if !module.ProfileIsTextListing {
Vladimir Marko982e3842021-04-29 09:05:18 +0100132 rule.Command().Text("rm -f").Output(profilePath)
133 rule.Command().Text("touch").Output(profilePath)
Colin Cross43f08db2018-11-12 10:13:39 -0800134 }
135
136 cmd := rule.Command().
137 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000138 Tool(globalSoong.Profman)
Colin Cross43f08db2018-11-12 10:13:39 -0800139
140 if module.ProfileIsTextListing {
141 // The profile is a test listing of classes (used for framework jars).
142 // We need to generate the actual binary profile before being able to compile.
Colin Cross69f59a32019-02-15 10:39:37 -0800143 cmd.FlagWithInput("--create-profile-from=", module.ProfileClassListing.Path())
Colin Cross43f08db2018-11-12 10:13:39 -0800144 } else {
145 // The profile is binary profile (used for apps). Run it through profman to
146 // ensure the profile keys match the apk.
147 cmd.
148 Flag("--copy-and-update-profile-key").
Colin Cross69f59a32019-02-15 10:39:37 -0800149 FlagWithInput("--profile-file=", module.ProfileClassListing.Path())
Colin Cross43f08db2018-11-12 10:13:39 -0800150 }
151
152 cmd.
Vladimir Marko230bd422021-04-23 15:18:33 +0100153 Flag("--output-profile-type=app").
Colin Cross43f08db2018-11-12 10:13:39 -0800154 FlagWithInput("--apk=", module.DexPath).
155 Flag("--dex-location="+module.DexLocation).
156 FlagWithOutput("--reference-profile-file=", profilePath)
157
158 if !module.ProfileIsTextListing {
159 cmd.Text(fmt.Sprintf(`|| echo "Profile out of date for %s"`, module.DexPath))
160 }
161 rule.Install(profilePath, profileInstalledPath)
162
163 return profilePath
164}
165
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000166func bootProfileCommand(ctx android.PathContext, globalSoong *GlobalSoongConfig, global *GlobalConfig,
167 module *ModuleConfig, rule *android.RuleBuilder) android.WritablePath {
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100168
169 profilePath := module.BuildPath.InSameDir(ctx, "profile.bprof")
170 profileInstalledPath := module.DexLocation + ".bprof"
171
172 if !module.ProfileIsTextListing {
Vladimir Marko982e3842021-04-29 09:05:18 +0100173 rule.Command().Text("rm -f").Output(profilePath)
174 rule.Command().Text("touch").Output(profilePath)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100175 }
176
177 cmd := rule.Command().
178 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000179 Tool(globalSoong.Profman)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100180
181 // The profile is a test listing of methods.
182 // We need to generate the actual binary profile.
183 cmd.FlagWithInput("--create-profile-from=", module.ProfileBootListing.Path())
184
185 cmd.
Vladimir Marko230bd422021-04-23 15:18:33 +0100186 Flag("--output-profile-type=bprof").
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100187 FlagWithInput("--apk=", module.DexPath).
188 Flag("--dex-location="+module.DexLocation).
189 FlagWithOutput("--reference-profile-file=", profilePath)
190
191 if !module.ProfileIsTextListing {
192 cmd.Text(fmt.Sprintf(`|| echo "Profile out of date for %s"`, module.DexPath))
193 }
194 rule.Install(profilePath, profileInstalledPath)
195
196 return profilePath
197}
198
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000199// Returns the dex location of a system server java library.
Jiakai Zhang389a6472021-12-14 18:54:06 +0000200func GetSystemServerDexLocation(ctx android.PathContext, global *GlobalConfig, lib string) string {
201 if apex := global.AllApexSystemServerJars(ctx).ApexOfJar(lib); apex != "" {
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000202 return fmt.Sprintf("/apex/%s/javalib/%s.jar", apex, lib)
203 }
liulvping76d56ee2022-05-07 14:40:13 +0800204
205 if apex := global.AllPlatformSystemServerJars(ctx).ApexOfJar(lib); apex == "system_ext" {
206 return fmt.Sprintf("/system_ext/framework/%s.jar", lib)
207 }
208
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000209 return fmt.Sprintf("/system/framework/%s.jar", lib)
210}
211
Jiakai Zhang0a0a2fb2021-09-30 09:38:19 +0000212// Returns the location to the odex file for the dex file at `path`.
213func ToOdexPath(path string, arch android.ArchType) string {
214 if strings.HasPrefix(path, "/apex/") {
215 return filepath.Join("/system/framework/oat", arch.String(),
216 strings.ReplaceAll(path[1:], "/", "@")+"@classes.odex")
217 }
218
219 return filepath.Join(filepath.Dir(path), "oat", arch.String(),
220 pathtools.ReplaceExtension(filepath.Base(path), "odex"))
221}
222
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000223func dexpreoptCommand(ctx android.PathContext, globalSoong *GlobalSoongConfig, global *GlobalConfig,
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000224 module *ModuleConfig, rule *android.RuleBuilder, archIdx int, profile android.WritablePath,
225 appImage bool, generateDM bool) {
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000226
227 arch := module.Archs[archIdx]
Colin Cross43f08db2018-11-12 10:13:39 -0800228
229 // HACK: make soname in Soong-generated .odex files match Make.
230 base := filepath.Base(module.DexLocation)
231 if filepath.Ext(base) == ".jar" {
232 base = "javalib.jar"
233 } else if filepath.Ext(base) == ".apk" {
234 base = "package.apk"
235 }
236
Colin Cross69f59a32019-02-15 10:39:37 -0800237 odexPath := module.BuildPath.InSameDir(ctx, "oat", arch.String(), pathtools.ReplaceExtension(base, "odex"))
Jiakai Zhang0a0a2fb2021-09-30 09:38:19 +0000238 odexInstallPath := ToOdexPath(module.DexLocation, arch)
Colin Cross43f08db2018-11-12 10:13:39 -0800239 if odexOnSystemOther(module, global) {
Anton Hansson43ab0bc2019-10-03 14:18:45 +0100240 odexInstallPath = filepath.Join(SystemOtherPartition, odexInstallPath)
Colin Cross43f08db2018-11-12 10:13:39 -0800241 }
242
Colin Cross69f59a32019-02-15 10:39:37 -0800243 vdexPath := odexPath.ReplaceExtension(ctx, "vdex")
Colin Cross43f08db2018-11-12 10:13:39 -0800244 vdexInstallPath := pathtools.ReplaceExtension(odexInstallPath, "vdex")
245
Colin Cross69f59a32019-02-15 10:39:37 -0800246 invocationPath := odexPath.ReplaceExtension(ctx, "invocation")
Alex Light5de41962018-12-18 15:16:26 -0800247
Jiakai Zhang389a6472021-12-14 18:54:06 +0000248 systemServerJars := global.AllSystemServerJars(ctx)
249 systemServerClasspathJars := global.AllSystemServerClasspathJars(ctx)
Ulya Trafimovichdacc6c52020-03-11 11:59:34 +0000250
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100251 rule.Command().FlagWithArg("mkdir -p ", filepath.Dir(odexPath.String()))
252 rule.Command().FlagWithOutput("rm -f ", odexPath)
Ulya Trafimovichc9af5382020-05-29 15:35:06 +0100253
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000254 if jarIndex := systemServerJars.IndexOfJar(module.Name); jarIndex >= 0 {
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000255 // System server jars should be dexpreopted together: class loader context of each jar
256 // should include all preceding jars on the system server classpath.
257
258 var clcHost android.Paths
259 var clcTarget []string
Jiakai Zhang389a6472021-12-14 18:54:06 +0000260 endIndex := systemServerClasspathJars.IndexOfJar(module.Name)
261 if endIndex < 0 {
262 // The jar is a standalone one. Use the full classpath as the class loader context.
263 endIndex = systemServerClasspathJars.Len()
264 }
265 for i := 0; i < endIndex; i++ {
266 lib := systemServerClasspathJars.Jar(i)
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000267 clcHost = append(clcHost, SystemServerDexJarHostPath(ctx, lib))
Jiakai Zhang389a6472021-12-14 18:54:06 +0000268 clcTarget = append(clcTarget, GetSystemServerDexLocation(ctx, global, lib))
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000269 }
270
Ulya Trafimovich29e95d92021-09-21 12:59:39 +0100271 if DexpreoptRunningInSoong {
272 // Copy the system server jar to a predefined location where dex2oat will find it.
273 dexPathHost := SystemServerDexJarHostPath(ctx, module.Name)
274 rule.Command().Text("mkdir -p").Flag(filepath.Dir(dexPathHost.String()))
275 rule.Command().Text("cp -f").Input(module.DexPath).Output(dexPathHost)
276 } else {
277 // For Make modules the copy rule is generated in the makefiles, not in dexpreopt.sh.
278 // This is necessary to expose the rule to Ninja, otherwise it has rules that depend on
279 // the jar (namely, dexpreopt commands for all subsequent system server jars that have
280 // this one in their class loader context), but no rule that creates it (because Ninja
281 // cannot see the rule in the generated dexpreopt.sh script).
282 }
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100283
Jiakai Zhang389a6472021-12-14 18:54:06 +0000284 clcHostString := "PCL[" + strings.Join(clcHost.Strings(), ":") + "]"
285 clcTargetString := "PCL[" + strings.Join(clcTarget, ":") + "]"
286
287 if systemServerClasspathJars.ContainsJar(module.Name) {
288 checkSystemServerOrder(ctx, jarIndex)
289 } else {
290 // Standalone jars are loaded by separate class loaders with SYSTEMSERVERCLASSPATH as the
291 // parent.
292 clcHostString = "PCL[];" + clcHostString
293 clcTargetString = "PCL[];" + clcTargetString
294 }
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100295
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100296 rule.Command().
Jiakai Zhang389a6472021-12-14 18:54:06 +0000297 Text(`class_loader_context_arg=--class-loader-context="` + clcHostString + `"`).
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000298 Implicits(clcHost).
Jiakai Zhang389a6472021-12-14 18:54:06 +0000299 Text(`stored_class_loader_context_arg=--stored-class-loader-context="` + clcTargetString + `"`)
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000300
Ulya Trafimovichbd6b0762021-03-12 12:12:12 +0000301 } else {
302 // There are three categories of Java modules handled here:
303 //
304 // - Modules that have passed verify_uses_libraries check. They are AOT-compiled and
305 // expected to be loaded on device without CLC mismatch errors.
306 //
307 // - Modules that have failed the check in relaxed mode, so it didn't cause a build error.
308 // They are dexpreopted with "verify" filter and not AOT-compiled.
309 // TODO(b/132357300): ensure that CLC mismatch errors are ignored with "verify" filter.
310 //
311 // - Modules that didn't run the check. They are AOT-compiled, but it's unknown if they
312 // will have CLC mismatch errors on device (the check is disabled by default).
313 //
314 // TODO(b/132357300): enable the check by default and eliminate the last category, so that
315 // no time/space is wasted on AOT-compiling modules that will fail CLC check on device.
316
317 var manifestOrApk android.Path
Jeongik Cha33a3a812021-04-15 09:12:49 +0900318 if module.ManifestPath.Valid() {
Ulya Trafimovichbd6b0762021-03-12 12:12:12 +0000319 // Ok, there is an XML manifest.
Jeongik Cha33a3a812021-04-15 09:12:49 +0900320 manifestOrApk = module.ManifestPath.Path()
Ulya Trafimovichbd6b0762021-03-12 12:12:12 +0000321 } else if filepath.Ext(base) == ".apk" {
322 // Ok, there is is an APK with the manifest inside.
Ulya Trafimovich0aba2522021-03-03 16:38:37 +0000323 manifestOrApk = module.DexPath
Colin Cross38b96852019-05-22 10:21:09 -0700324 }
Ulya Trafimovichbd6b0762021-03-12 12:12:12 +0000325
326 // Generate command that saves target SDK version in a shell variable.
327 if manifestOrApk == nil {
328 // There is neither an XML manifest nor APK => nowhere to extract targetSdkVersion from.
329 // Set the latest ("any") version: then construct_context will not add any compatibility
330 // libraries (if this is incorrect, there will be a CLC mismatch and dexopt on device).
331 rule.Command().Textf(`target_sdk_version=%d`, AnySdkVersion)
332 } else {
333 rule.Command().Text(`target_sdk_version="$(`).
334 Tool(globalSoong.ManifestCheck).
335 Flag("--extract-target-sdk-version").
336 Input(manifestOrApk).
Ulya Trafimovichdd622952021-03-25 12:52:49 +0000337 FlagWithInput("--aapt ", globalSoong.Aapt).
Ulya Trafimovichbd6b0762021-03-12 12:12:12 +0000338 Text(`)"`)
339 }
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100340
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100341 // Generate command that saves host and target class loader context in shell variables.
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000342 clc, paths := ComputeClassLoaderContext(module.ClassLoaderContexts)
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000343 rule.Command().
Ulya Trafimovichbd6b0762021-03-12 12:12:12 +0000344 Text(`eval "$(`).Tool(globalSoong.ConstructContext).
Ulya Trafimovich8130c482020-10-07 15:17:13 +0100345 Text(` --target-sdk-version ${target_sdk_version}`).
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000346 Text(clc).Implicits(paths).
Ulya Trafimovichbd6b0762021-03-12 12:12:12 +0000347 Text(`)"`)
Colin Cross43f08db2018-11-12 10:13:39 -0800348 }
349
Nicolas Geoffray2464ef42019-03-05 14:07:07 +0000350 // Devices that do not have a product partition use a symlink from /product to /system/product.
351 // Because on-device dexopt will see dex locations starting with /product, we change the paths
352 // to mimic this behavior.
353 dexLocationArg := module.DexLocation
354 if strings.HasPrefix(dexLocationArg, "/system/product/") {
355 dexLocationArg = strings.TrimPrefix(dexLocationArg, "/system")
356 }
357
Colin Cross43f08db2018-11-12 10:13:39 -0800358 cmd := rule.Command().
359 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000360 Tool(globalSoong.Dex2oat).
Colin Cross43f08db2018-11-12 10:13:39 -0800361 Flag("--avoid-storing-invocation").
Alex Light5de41962018-12-18 15:16:26 -0800362 FlagWithOutput("--write-invocation-to=", invocationPath).ImplicitOutput(invocationPath).
Colin Cross43f08db2018-11-12 10:13:39 -0800363 Flag("--runtime-arg").FlagWithArg("-Xms", global.Dex2oatXms).
364 Flag("--runtime-arg").FlagWithArg("-Xmx", global.Dex2oatXmx).
Colin Cross800fe132019-02-11 14:21:24 -0800365 Flag("--runtime-arg").FlagWithInputList("-Xbootclasspath:", module.PreoptBootClassPathDexFiles, ":").
366 Flag("--runtime-arg").FlagWithList("-Xbootclasspath-locations:", module.PreoptBootClassPathDexLocations, ":").
Colin Cross43f08db2018-11-12 10:13:39 -0800367 Flag("${class_loader_context_arg}").
Ulya Trafimovichdacc6c52020-03-11 11:59:34 +0000368 Flag("${stored_class_loader_context_arg}").
Jeongik Chaa5969092021-05-07 18:53:21 +0900369 FlagWithArg("--boot-image=", strings.Join(module.DexPreoptImageLocationsOnHost, ":")).Implicits(module.DexPreoptImagesDeps[archIdx].Paths()).
Colin Cross43f08db2018-11-12 10:13:39 -0800370 FlagWithInput("--dex-file=", module.DexPath).
Nicolas Geoffray2464ef42019-03-05 14:07:07 +0000371 FlagWithArg("--dex-location=", dexLocationArg).
Colin Cross43f08db2018-11-12 10:13:39 -0800372 FlagWithOutput("--oat-file=", odexPath).ImplicitOutput(vdexPath).
373 // Pass an empty directory, dex2oat shouldn't be reading arbitrary files
374 FlagWithArg("--android-root=", global.EmptyDirectory).
Colin Cross74ba9622019-02-11 15:11:14 -0800375 FlagWithArg("--instruction-set=", arch.String()).
Colin Cross43f08db2018-11-12 10:13:39 -0800376 FlagWithArg("--instruction-set-variant=", global.CpuVariant[arch]).
377 FlagWithArg("--instruction-set-features=", global.InstructionSetFeatures[arch]).
378 Flag("--no-generate-debug-info").
379 Flag("--generate-build-id").
380 Flag("--abort-on-hard-verifier-error").
381 Flag("--force-determinism").
382 FlagWithArg("--no-inline-from=", "core-oj.jar")
383
384 var preoptFlags []string
385 if len(module.PreoptFlags) > 0 {
386 preoptFlags = module.PreoptFlags
387 } else if len(global.PreoptFlags) > 0 {
388 preoptFlags = global.PreoptFlags
389 }
390
391 if len(preoptFlags) > 0 {
392 cmd.Text(strings.Join(preoptFlags, " "))
393 }
394
395 if module.UncompressedDex {
396 cmd.FlagWithArg("--copy-dex-files=", "false")
397 }
398
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800399 if !android.PrefixInList(preoptFlags, "--compiler-filter=") {
Colin Cross43f08db2018-11-12 10:13:39 -0800400 var compilerFilter string
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000401 if systemServerJars.ContainsJar(module.Name) {
Colin Cross43f08db2018-11-12 10:13:39 -0800402 if global.SystemServerCompilerFilter != "" {
Ulya Trafimovich6fad1d02022-06-30 13:21:35 +0100403 // Use the product option if it is set.
Colin Cross43f08db2018-11-12 10:13:39 -0800404 compilerFilter = global.SystemServerCompilerFilter
Ulya Trafimovich6fad1d02022-06-30 13:21:35 +0100405 } else if profile != nil {
406 // Use "speed-profile" for system server jars that have a profile.
407 compilerFilter = "speed-profile"
Colin Cross43f08db2018-11-12 10:13:39 -0800408 } else {
Ulya Trafimovich6fad1d02022-06-30 13:21:35 +0100409 // Use "speed" for system server jars that do not have a profile.
Colin Cross43f08db2018-11-12 10:13:39 -0800410 compilerFilter = "speed"
411 }
412 } else if contains(global.SpeedApps, module.Name) || contains(global.SystemServerApps, module.Name) {
413 // Apps loaded into system server, and apps the product default to being compiled with the
414 // 'speed' compiler filter.
415 compilerFilter = "speed"
Colin Cross69f59a32019-02-15 10:39:37 -0800416 } else if profile != nil {
Colin Cross43f08db2018-11-12 10:13:39 -0800417 // For non system server jars, use speed-profile when we have a profile.
418 compilerFilter = "speed-profile"
419 } else if global.DefaultCompilerFilter != "" {
420 compilerFilter = global.DefaultCompilerFilter
421 } else {
422 compilerFilter = "quicken"
423 }
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000424 if module.EnforceUsesLibraries {
425 // If the verify_uses_libraries check failed (in this case status file contains a
Ulya Trafimovich4a13acb2021-03-02 12:25:02 +0000426 // non-empty error message), then use "verify" compiler filter to avoid compiling any
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000427 // code (it would be rejected on device because of a class loader context mismatch).
428 cmd.Text("--compiler-filter=$(if test -s ").
429 Input(module.EnforceUsesLibrariesStatusFile).
Ulya Trafimovich4a13acb2021-03-02 12:25:02 +0000430 Text(" ; then echo verify ; else echo " + compilerFilter + " ; fi)")
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000431 } else {
432 cmd.FlagWithArg("--compiler-filter=", compilerFilter)
433 }
Colin Cross43f08db2018-11-12 10:13:39 -0800434 }
435
436 if generateDM {
437 cmd.FlagWithArg("--copy-dex-files=", "false")
Colin Cross69f59a32019-02-15 10:39:37 -0800438 dmPath := module.BuildPath.InSameDir(ctx, "generated.dm")
Colin Cross43f08db2018-11-12 10:13:39 -0800439 dmInstalledPath := pathtools.ReplaceExtension(module.DexLocation, "dm")
Colin Cross69f59a32019-02-15 10:39:37 -0800440 tmpPath := module.BuildPath.InSameDir(ctx, "primary.vdex")
Colin Cross43f08db2018-11-12 10:13:39 -0800441 rule.Command().Text("cp -f").Input(vdexPath).Output(tmpPath)
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000442 rule.Command().Tool(globalSoong.SoongZip).
Colin Cross43f08db2018-11-12 10:13:39 -0800443 FlagWithArg("-L", "9").
444 FlagWithOutput("-o", dmPath).
445 Flag("-j").
446 Input(tmpPath)
447 rule.Install(dmPath, dmInstalledPath)
448 }
449
450 // By default, emit debug info.
451 debugInfo := true
452 if global.NoDebugInfo {
453 // If the global setting suppresses mini-debug-info, disable it.
454 debugInfo = false
455 }
456
457 // PRODUCT_SYSTEM_SERVER_DEBUG_INFO overrides WITH_DEXPREOPT_DEBUG_INFO.
458 // PRODUCT_OTHER_JAVA_DEBUG_INFO overrides WITH_DEXPREOPT_DEBUG_INFO.
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000459 if systemServerJars.ContainsJar(module.Name) {
Colin Cross43f08db2018-11-12 10:13:39 -0800460 if global.AlwaysSystemServerDebugInfo {
461 debugInfo = true
462 } else if global.NeverSystemServerDebugInfo {
463 debugInfo = false
464 }
465 } else {
466 if global.AlwaysOtherDebugInfo {
467 debugInfo = true
468 } else if global.NeverOtherDebugInfo {
469 debugInfo = false
470 }
471 }
472
Colin Cross43f08db2018-11-12 10:13:39 -0800473 if debugInfo {
474 cmd.Flag("--generate-mini-debug-info")
475 } else {
476 cmd.Flag("--no-generate-mini-debug-info")
477 }
478
479 // Set the compiler reason to 'prebuilt' to identify the oat files produced
480 // during the build, as opposed to compiled on the device.
481 cmd.FlagWithArg("--compilation-reason=", "prebuilt")
482
483 if appImage {
Colin Cross69f59a32019-02-15 10:39:37 -0800484 appImagePath := odexPath.ReplaceExtension(ctx, "art")
Colin Cross43f08db2018-11-12 10:13:39 -0800485 appImageInstallPath := pathtools.ReplaceExtension(odexInstallPath, "art")
486 cmd.FlagWithOutput("--app-image-file=", appImagePath).
487 FlagWithArg("--image-format=", "lz4")
Mathieu Chartier3f7ddbb2019-04-29 09:33:50 -0700488 if !global.DontResolveStartupStrings {
489 cmd.FlagWithArg("--resolve-startup-const-strings=", "true")
490 }
Colin Cross43f08db2018-11-12 10:13:39 -0800491 rule.Install(appImagePath, appImageInstallPath)
492 }
493
Colin Cross69f59a32019-02-15 10:39:37 -0800494 if profile != nil {
495 cmd.FlagWithInput("--profile-file=", profile)
Colin Cross43f08db2018-11-12 10:13:39 -0800496 }
497
Jiakai Zhang616be062022-11-16 11:50:59 +0000498 if global.EnableUffdGc {
499 cmd.Flag("--runtime-arg").Flag("-Xgc:CMC")
500 }
501
Colin Cross43f08db2018-11-12 10:13:39 -0800502 rule.Install(odexPath, odexInstallPath)
503 rule.Install(vdexPath, vdexInstallPath)
504}
505
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000506func shouldGenerateDM(module *ModuleConfig, global *GlobalConfig) bool {
Colin Cross43f08db2018-11-12 10:13:39 -0800507 // Generating DM files only makes sense for verify, avoid doing for non verify compiler filter APKs.
508 // No reason to use a dm file if the dex is already uncompressed.
509 return global.GenerateDMFiles && !module.UncompressedDex &&
510 contains(module.PreoptFlags, "--compiler-filter=verify")
511}
512
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000513func OdexOnSystemOtherByName(name string, dexLocation string, global *GlobalConfig) bool {
Colin Cross43f08db2018-11-12 10:13:39 -0800514 if !global.HasSystemOther {
515 return false
516 }
517
518 if global.SanitizeLite {
519 return false
520 }
521
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000522 if contains(global.SpeedApps, name) || contains(global.SystemServerApps, name) {
Colin Cross43f08db2018-11-12 10:13:39 -0800523 return false
524 }
525
526 for _, f := range global.PatternsOnSystemOther {
Anton Hanssonda4d9d92020-09-15 09:28:55 +0000527 if makefileMatch(filepath.Join(SystemPartition, f), dexLocation) {
Colin Cross43f08db2018-11-12 10:13:39 -0800528 return true
529 }
530 }
531
532 return false
533}
534
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000535func odexOnSystemOther(module *ModuleConfig, global *GlobalConfig) bool {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000536 return OdexOnSystemOtherByName(module.Name, module.DexLocation, global)
537}
538
Colin Crossc7e40aa2019-02-08 21:37:00 -0800539// PathToLocation converts .../system/framework/arm64/boot.art to .../system/framework/boot.art
Colin Cross69f59a32019-02-15 10:39:37 -0800540func PathToLocation(path android.Path, arch android.ArchType) string {
Jeongik Cha4dda75e2021-04-27 23:56:44 +0900541 return PathStringToLocation(path.String(), arch)
542}
543
544// PathStringToLocation converts .../system/framework/arm64/boot.art to .../system/framework/boot.art
545func PathStringToLocation(path string, arch android.ArchType) string {
546 pathArch := filepath.Base(filepath.Dir(path))
Colin Cross74ba9622019-02-11 15:11:14 -0800547 if pathArch != arch.String() {
548 panic(fmt.Errorf("last directory in %q must be %q", path, arch.String()))
Colin Crossc7e40aa2019-02-08 21:37:00 -0800549 }
Jeongik Cha4dda75e2021-04-27 23:56:44 +0900550 return filepath.Join(filepath.Dir(filepath.Dir(path)), filepath.Base(path))
Colin Crossc7e40aa2019-02-08 21:37:00 -0800551}
552
Colin Cross43f08db2018-11-12 10:13:39 -0800553func makefileMatch(pattern, s string) bool {
554 percent := strings.IndexByte(pattern, '%')
555 switch percent {
556 case -1:
557 return pattern == s
558 case len(pattern) - 1:
559 return strings.HasPrefix(s, pattern[:len(pattern)-1])
560 default:
561 panic(fmt.Errorf("unsupported makefile pattern %q", pattern))
562 }
563}
564
Ulya Trafimovichdacc6c52020-03-11 11:59:34 +0000565// A predefined location for the system server dex jars. This is needed in order to generate
566// class loader context for dex2oat, as the path to the jar in the Soong module may be unknown
567// at that time (Soong processes the jars in dependency order, which may be different from the
568// the system server classpath order).
569func SystemServerDexJarHostPath(ctx android.PathContext, jar string) android.OutputPath {
Ulya Trafimovich6cf2c0c2020-04-24 12:15:20 +0100570 if DexpreoptRunningInSoong {
571 // Soong module, just use the default output directory $OUT/soong.
572 return android.PathForOutput(ctx, "system_server_dexjars", jar+".jar")
573 } else {
574 // Make module, default output directory is $OUT (passed via the "null config" created
575 // by dexpreopt_gen). Append Soong subdirectory to match Soong module paths.
576 return android.PathForOutput(ctx, "soong", "system_server_dexjars", jar+".jar")
577 }
Ulya Trafimovichdacc6c52020-03-11 11:59:34 +0000578}
579
Ulya Trafimovichcd3203f2020-03-27 11:30:00 +0000580// Check the order of jars on the system server classpath and give a warning/error if a jar precedes
581// one of its dependencies. This is not an error, but a missed optimization, as dexpreopt won't
582// have the dependency jar in the class loader context, and it won't be able to resolve any
583// references to its classes and methods.
584func checkSystemServerOrder(ctx android.PathContext, jarIndex int) {
585 mctx, isModule := ctx.(android.ModuleContext)
586 if isModule {
587 config := GetGlobalConfig(ctx)
Jiakai Zhang389a6472021-12-14 18:54:06 +0000588 jars := config.AllSystemServerClasspathJars(ctx)
Ulya Trafimovichcd3203f2020-03-27 11:30:00 +0000589 mctx.WalkDeps(func(dep android.Module, parent android.Module) bool {
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000590 depIndex := jars.IndexOfJar(dep.Name())
Ulya Trafimovichcd3203f2020-03-27 11:30:00 +0000591 if jarIndex < depIndex && !config.BrokenSuboptimalOrderOfSystemServerJars {
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000592 jar := jars.Jar(jarIndex)
593 dep := jars.Jar(depIndex)
Ulya Trafimovichcd3203f2020-03-27 11:30:00 +0000594 mctx.ModuleErrorf("non-optimal order of jars on the system server classpath:"+
595 " '%s' precedes its dependency '%s', so dexpreopt is unable to resolve any"+
596 " references from '%s' to '%s'.\n", jar, dep, jar, dep)
597 }
598 return true
599 })
600 }
601}
602
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000603// Returns path to a file containing the reult of verify_uses_libraries check (empty if the check
604// has succeeded, or an error message if it failed).
605func UsesLibrariesStatusFile(ctx android.ModuleContext) android.WritablePath {
606 return android.PathForModuleOut(ctx, "enforce_uses_libraries.status")
607}
608
Colin Cross43f08db2018-11-12 10:13:39 -0800609func contains(l []string, s string) bool {
610 for _, e := range l {
611 if e == s {
612 return true
613 }
614 }
615 return false
616}
617
Colin Cross454c0872019-02-15 23:03:34 -0800618var copyOf = android.CopyOf