blob: e49fa984e7eb6a1706e012b83879055844665ce0 [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"
Ulya Trafimovich696c59d2020-06-01 16:10:56 +010040 "sort"
Colin Cross43f08db2018-11-12 10:13:39 -080041 "strings"
42
Colin Crossfeec25b2019-01-30 17:32:39 -080043 "android/soong/android"
44
Colin Cross43f08db2018-11-12 10:13:39 -080045 "github.com/google/blueprint/pathtools"
46)
47
48const SystemPartition = "/system/"
49const SystemOtherPartition = "/system_other/"
50
Ulya Trafimovich6cf2c0c2020-04-24 12:15:20 +010051var DexpreoptRunningInSoong = false
52
Colin Cross43f08db2018-11-12 10:13:39 -080053// GenerateDexpreoptRule generates a set of commands that will preopt a module based on a GlobalConfig and a
54// ModuleConfig. The produced files and their install locations will be available through rule.Installs().
Martin Stjernholm8d80cee2020-01-31 17:44:54 +000055func GenerateDexpreoptRule(ctx android.PathContext, globalSoong *GlobalSoongConfig,
56 global *GlobalConfig, module *ModuleConfig) (rule *android.RuleBuilder, err error) {
Colin Cross69f59a32019-02-15 10:39:37 -080057
Colin Cross43f08db2018-11-12 10:13:39 -080058 defer func() {
59 if r := recover(); r != nil {
Colin Cross69f59a32019-02-15 10:39:37 -080060 if _, ok := r.(runtime.Error); ok {
61 panic(r)
62 } else if e, ok := r.(error); ok {
Colin Cross43f08db2018-11-12 10:13:39 -080063 err = e
64 rule = nil
65 } else {
66 panic(r)
67 }
68 }
69 }()
70
Colin Cross758290d2019-02-01 16:42:32 -080071 rule = android.NewRuleBuilder()
Colin Cross43f08db2018-11-12 10:13:39 -080072
Colin Cross69f59a32019-02-15 10:39:37 -080073 generateProfile := module.ProfileClassListing.Valid() && !global.DisableGenerateProfile
Nicolas Geoffraye7102422019-07-24 13:19:29 +010074 generateBootProfile := module.ProfileBootListing.Valid() && !global.DisableGenerateProfile
Colin Cross43f08db2018-11-12 10:13:39 -080075
Colin Cross69f59a32019-02-15 10:39:37 -080076 var profile android.WritablePath
Colin Crosscbed6572019-01-08 17:38:37 -080077 if generateProfile {
Martin Stjernholm75a48d82020-01-10 20:32:59 +000078 profile = profileCommand(ctx, globalSoong, global, module, rule)
Colin Crosscbed6572019-01-08 17:38:37 -080079 }
Nicolas Geoffraye7102422019-07-24 13:19:29 +010080 if generateBootProfile {
Martin Stjernholm75a48d82020-01-10 20:32:59 +000081 bootProfileCommand(ctx, globalSoong, global, module, rule)
Nicolas Geoffraye7102422019-07-24 13:19:29 +010082 }
Colin Crosscbed6572019-01-08 17:38:37 -080083
Ulya Trafimovichf3ff0102019-12-03 15:39:23 +000084 if !dexpreoptDisabled(ctx, global, module) {
Colin Crosscbed6572019-01-08 17:38:37 -080085 // Don't preopt individual boot jars, they will be preopted together.
Ulya Trafimovich8640ab92020-05-11 18:06:15 +010086 if !contains(android.GetJarsFromApexJarPairs(ctx, global.BootJars), module.Name) {
Colin Crosscbed6572019-01-08 17:38:37 -080087 appImage := (generateProfile || module.ForceCreateAppImage || global.DefaultAppImages) &&
88 !module.NoCreateAppImage
89
90 generateDM := shouldGenerateDM(module, global)
91
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000092 for archIdx, _ := range module.Archs {
Martin Stjernholm75a48d82020-01-10 20:32:59 +000093 dexpreoptCommand(ctx, globalSoong, global, module, rule, archIdx, profile, appImage, generateDM)
Colin Crosscbed6572019-01-08 17:38:37 -080094 }
95 }
96 }
97
98 return rule, nil
99}
100
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000101func dexpreoptDisabled(ctx android.PathContext, global *GlobalConfig, module *ModuleConfig) bool {
Colin Crosscbed6572019-01-08 17:38:37 -0800102 if contains(global.DisablePreoptModules, module.Name) {
103 return true
Colin Cross43f08db2018-11-12 10:13:39 -0800104 }
105
Ulyana Trafimovichf2cb7e92019-11-27 12:26:49 +0000106 // Don't preopt system server jars that are updatable.
107 for _, p := range global.UpdatableSystemServerJars {
Ulya Trafimovich8640ab92020-05-11 18:06:15 +0100108 if _, jar := android.SplitApexJarPair(ctx, p); jar == module.Name {
Ulyana Trafimovichf2cb7e92019-11-27 12:26:49 +0000109 return true
110 }
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 Trafimovich8640ab92020-05-11 18:06:15 +0100117 if global.OnlyPreoptBootImageAndSystemServer && !contains(android.GetJarsFromApexJarPairs(ctx, global.BootJars), module.Name) &&
Colin Cross43f08db2018-11-12 10:13:39 -0800118 !contains(global.SystemServerJars, 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 {
132 rule.Command().FlagWithOutput("touch ", profilePath)
133 }
134
135 cmd := rule.Command().
136 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000137 Tool(globalSoong.Profman)
Colin Cross43f08db2018-11-12 10:13:39 -0800138
139 if module.ProfileIsTextListing {
140 // The profile is a test listing of classes (used for framework jars).
141 // We need to generate the actual binary profile before being able to compile.
Colin Cross69f59a32019-02-15 10:39:37 -0800142 cmd.FlagWithInput("--create-profile-from=", module.ProfileClassListing.Path())
Colin Cross43f08db2018-11-12 10:13:39 -0800143 } else {
144 // The profile is binary profile (used for apps). Run it through profman to
145 // ensure the profile keys match the apk.
146 cmd.
147 Flag("--copy-and-update-profile-key").
Colin Cross69f59a32019-02-15 10:39:37 -0800148 FlagWithInput("--profile-file=", module.ProfileClassListing.Path())
Colin Cross43f08db2018-11-12 10:13:39 -0800149 }
150
151 cmd.
152 FlagWithInput("--apk=", module.DexPath).
153 Flag("--dex-location="+module.DexLocation).
154 FlagWithOutput("--reference-profile-file=", profilePath)
155
156 if !module.ProfileIsTextListing {
157 cmd.Text(fmt.Sprintf(`|| echo "Profile out of date for %s"`, module.DexPath))
158 }
159 rule.Install(profilePath, profileInstalledPath)
160
161 return profilePath
162}
163
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000164func bootProfileCommand(ctx android.PathContext, globalSoong *GlobalSoongConfig, global *GlobalConfig,
165 module *ModuleConfig, rule *android.RuleBuilder) android.WritablePath {
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100166
167 profilePath := module.BuildPath.InSameDir(ctx, "profile.bprof")
168 profileInstalledPath := module.DexLocation + ".bprof"
169
170 if !module.ProfileIsTextListing {
171 rule.Command().FlagWithOutput("touch ", profilePath)
172 }
173
174 cmd := rule.Command().
175 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000176 Tool(globalSoong.Profman)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100177
178 // The profile is a test listing of methods.
179 // We need to generate the actual binary profile.
180 cmd.FlagWithInput("--create-profile-from=", module.ProfileBootListing.Path())
181
182 cmd.
183 Flag("--generate-boot-profile").
184 FlagWithInput("--apk=", module.DexPath).
185 Flag("--dex-location="+module.DexLocation).
186 FlagWithOutput("--reference-profile-file=", profilePath)
187
188 if !module.ProfileIsTextListing {
189 cmd.Text(fmt.Sprintf(`|| echo "Profile out of date for %s"`, module.DexPath))
190 }
191 rule.Install(profilePath, profileInstalledPath)
192
193 return profilePath
194}
195
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100196type classLoaderContext struct {
197 // The class loader context using paths in the build.
198 Host android.Paths
199
200 // The class loader context using paths as they will be on the device.
201 Target []string
202}
203
204// A map of class loader contexts for each SDK version.
205// A map entry for "any" version contains libraries that are unconditionally added to class loader
206// context. Map entries for existing versions contains libraries that were in the default classpath
207// until that API version, and should be added to class loader context if and only if the
208// targetSdkVersion in the manifest or APK is less than that API version.
209type classLoaderContextMap map[int]*classLoaderContext
210
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100211const anySdkVersion int = 9999 // should go last in class loader context
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100212
213func (m classLoaderContextMap) getSortedKeys() []int {
214 keys := make([]int, 0, len(m))
215 for k := range m {
216 keys = append(keys, k)
217 }
218 sort.Ints(keys)
219 return keys
220}
221
222func (m classLoaderContextMap) getValue(sdkVer int) *classLoaderContext {
223 if _, ok := m[sdkVer]; !ok {
224 m[sdkVer] = &classLoaderContext{}
225 }
226 return m[sdkVer]
227}
228
229func (m classLoaderContextMap) addLibs(sdkVer int, module *ModuleConfig, libs ...string) {
230 clc := m.getValue(sdkVer)
231 for _, lib := range libs {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +0100232 p := pathForLibrary(module, lib)
233 clc.Host = append(clc.Host, p.Host)
234 clc.Target = append(clc.Target, p.Device)
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100235 }
236}
237
238func (m classLoaderContextMap) addSystemServerLibs(sdkVer int, ctx android.PathContext, module *ModuleConfig, libs ...string) {
239 clc := m.getValue(sdkVer)
240 for _, lib := range libs {
241 clc.Host = append(clc.Host, SystemServerDexJarHostPath(ctx, lib))
242 clc.Target = append(clc.Target, filepath.Join("/system/framework", lib+".jar"))
243 }
244}
245
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000246func dexpreoptCommand(ctx android.PathContext, globalSoong *GlobalSoongConfig, global *GlobalConfig,
247 module *ModuleConfig, rule *android.RuleBuilder, archIdx int, profile android.WritablePath,
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000248 appImage bool, generateDM bool) {
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000249
250 arch := module.Archs[archIdx]
Colin Cross43f08db2018-11-12 10:13:39 -0800251
252 // HACK: make soname in Soong-generated .odex files match Make.
253 base := filepath.Base(module.DexLocation)
254 if filepath.Ext(base) == ".jar" {
255 base = "javalib.jar"
256 } else if filepath.Ext(base) == ".apk" {
257 base = "package.apk"
258 }
259
260 toOdexPath := func(path string) string {
261 return filepath.Join(
262 filepath.Dir(path),
263 "oat",
Colin Cross74ba9622019-02-11 15:11:14 -0800264 arch.String(),
Colin Cross43f08db2018-11-12 10:13:39 -0800265 pathtools.ReplaceExtension(filepath.Base(path), "odex"))
266 }
267
Colin Cross69f59a32019-02-15 10:39:37 -0800268 odexPath := module.BuildPath.InSameDir(ctx, "oat", arch.String(), pathtools.ReplaceExtension(base, "odex"))
Colin Cross43f08db2018-11-12 10:13:39 -0800269 odexInstallPath := toOdexPath(module.DexLocation)
270 if odexOnSystemOther(module, global) {
Anton Hansson43ab0bc2019-10-03 14:18:45 +0100271 odexInstallPath = filepath.Join(SystemOtherPartition, odexInstallPath)
Colin Cross43f08db2018-11-12 10:13:39 -0800272 }
273
Colin Cross69f59a32019-02-15 10:39:37 -0800274 vdexPath := odexPath.ReplaceExtension(ctx, "vdex")
Colin Cross43f08db2018-11-12 10:13:39 -0800275 vdexInstallPath := pathtools.ReplaceExtension(odexInstallPath, "vdex")
276
Colin Cross69f59a32019-02-15 10:39:37 -0800277 invocationPath := odexPath.ReplaceExtension(ctx, "invocation")
Alex Light5de41962018-12-18 15:16:26 -0800278
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100279 classLoaderContexts := make(classLoaderContextMap)
Ulya Trafimovichdacc6c52020-03-11 11:59:34 +0000280 systemServerJars := NonUpdatableSystemServerJars(ctx, global)
281
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100282 rule.Command().FlagWithArg("mkdir -p ", filepath.Dir(odexPath.String()))
283 rule.Command().FlagWithOutput("rm -f ", odexPath)
Ulya Trafimovichc9af5382020-05-29 15:35:06 +0100284
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100285 if jarIndex := android.IndexList(module.Name, systemServerJars); jarIndex >= 0 {
286 // System server jars should be dexpreopted together: class loader context of each jar
287 // should include all preceding jars on the system server classpath.
288 classLoaderContexts.addSystemServerLibs(anySdkVersion, ctx, module, systemServerJars[:jarIndex]...)
Colin Cross69f59a32019-02-15 10:39:37 -0800289
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100290 // Copy the system server jar to a predefined location where dex2oat will find it.
291 dexPathHost := SystemServerDexJarHostPath(ctx, module.Name)
292 rule.Command().Text("mkdir -p").Flag(filepath.Dir(dexPathHost.String()))
293 rule.Command().Text("cp -f").Input(module.DexPath).Output(dexPathHost)
294
295 checkSystemServerOrder(ctx, jarIndex)
296
297 clc := classLoaderContexts[anySdkVersion]
298 rule.Command().
299 Text("class_loader_context_arg=--class-loader-context=PCL[" + strings.Join(clc.Host.Strings(), ":") + "]").
300 Implicits(clc.Host).
301 Text("stored_class_loader_context_arg=--stored-class-loader-context=PCL[" + strings.Join(clc.Target, ":") + "]")
302 } else if module.EnforceUsesLibraries {
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100303 // Unconditional class loader context.
Ulya Trafimovich6e827482020-06-12 14:32:24 +0100304 usesLibs := append(copyOf(module.UsesLibraries), module.OptionalUsesLibraries...)
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100305 classLoaderContexts.addLibs(anySdkVersion, module, usesLibs...)
Colin Cross43f08db2018-11-12 10:13:39 -0800306
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100307 // Conditional class loader context for API version < 28.
Colin Cross43f08db2018-11-12 10:13:39 -0800308 const httpLegacy = "org.apache.http.legacy"
Ulya Trafimovichdf00dde2020-05-29 14:55:02 +0100309 if !contains(usesLibs, httpLegacy) {
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100310 classLoaderContexts.addLibs(28, module, httpLegacy)
Colin Cross43f08db2018-11-12 10:13:39 -0800311 }
Nicolas Geoffray05aa7d22018-12-18 14:15:12 +0000312
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100313 // Conditional class loader context for API version < 29.
314 usesLibs29 := []string{
315 "android.hidl.base-V1.0-java",
316 "android.hidl.manager-V1.0-java",
317 }
318 classLoaderContexts.addLibs(29, module, usesLibs29...)
Ulya Trafimovichc9af5382020-05-29 15:35:06 +0100319
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100320 // Conditional class loader context for API version < 30.
Ulya Trafimovichc9af5382020-05-29 15:35:06 +0100321 const testBase = "android.test.base"
322 if !contains(usesLibs, testBase) {
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100323 classLoaderContexts.addLibs(30, module, testBase)
Ulya Trafimovichc9af5382020-05-29 15:35:06 +0100324 }
Ulya Trafimovichf3ff0102019-12-03 15:39:23 +0000325
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100326 // Generate command that saves target SDK version in a shell variable.
Colin Cross38b96852019-05-22 10:21:09 -0700327 if module.ManifestPath != nil {
328 rule.Command().Text(`target_sdk_version="$(`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000329 Tool(globalSoong.ManifestCheck).
Colin Cross38b96852019-05-22 10:21:09 -0700330 Flag("--extract-target-sdk-version").
331 Input(module.ManifestPath).
332 Text(`)"`)
333 } else {
334 // No manifest to extract targetSdkVersion from, hope that DexJar is an APK
335 rule.Command().Text(`target_sdk_version="$(`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000336 Tool(globalSoong.Aapt).
Colin Cross38b96852019-05-22 10:21:09 -0700337 Flag("dump badging").
338 Input(module.DexPath).
339 Text(`| grep "targetSdkVersion" | sed -n "s/targetSdkVersion:'\(.*\)'/\1/p"`).
340 Text(`)"`)
341 }
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100342
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100343 // Generate command that saves host and target class loader context in shell variables.
344 cmd := rule.Command().
345 Text(`eval "$(`).Tool(globalSoong.ConstructContext).
346 Text(` --target-sdk-version ${target_sdk_version}`)
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100347 for _, ver := range classLoaderContexts.getSortedKeys() {
348 clc := classLoaderContexts.getValue(ver)
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100349 verString := fmt.Sprintf("%d", ver)
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100350 if ver == anySdkVersion {
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100351 verString = "any" // a special keyword that means any SDK version
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100352 }
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100353 cmd.Textf(`--host-classpath-for-sdk %s %s`, verString, strings.Join(clc.Host.Strings(), ":")).
354 Implicits(clc.Host).
355 Textf(`--target-classpath-for-sdk %s %s`, verString, strings.Join(clc.Target, ":"))
Ulya Trafimovich696c59d2020-06-01 16:10:56 +0100356 }
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100357 cmd.Text(`)"`)
Ulya Trafimovichc4dac262020-06-30 11:25:49 +0100358 } else {
359 // Pass special class loader context to skip the classpath and collision check.
360 // This will get removed once LOCAL_USES_LIBRARIES is enforced.
361 // Right now LOCAL_USES_LIBRARIES is opt in, for the case where it's not specified we still default
362 // to the &.
363 rule.Command().
364 Text(`class_loader_context_arg=--class-loader-context=\&`).
365 Text(`stored_class_loader_context_arg=""`)
Colin Cross43f08db2018-11-12 10:13:39 -0800366 }
367
Nicolas Geoffray2464ef42019-03-05 14:07:07 +0000368 // Devices that do not have a product partition use a symlink from /product to /system/product.
369 // Because on-device dexopt will see dex locations starting with /product, we change the paths
370 // to mimic this behavior.
371 dexLocationArg := module.DexLocation
372 if strings.HasPrefix(dexLocationArg, "/system/product/") {
373 dexLocationArg = strings.TrimPrefix(dexLocationArg, "/system")
374 }
375
Colin Cross43f08db2018-11-12 10:13:39 -0800376 cmd := rule.Command().
377 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000378 Tool(globalSoong.Dex2oat).
Colin Cross43f08db2018-11-12 10:13:39 -0800379 Flag("--avoid-storing-invocation").
Alex Light5de41962018-12-18 15:16:26 -0800380 FlagWithOutput("--write-invocation-to=", invocationPath).ImplicitOutput(invocationPath).
Colin Cross43f08db2018-11-12 10:13:39 -0800381 Flag("--runtime-arg").FlagWithArg("-Xms", global.Dex2oatXms).
382 Flag("--runtime-arg").FlagWithArg("-Xmx", global.Dex2oatXmx).
Colin Cross800fe132019-02-11 14:21:24 -0800383 Flag("--runtime-arg").FlagWithInputList("-Xbootclasspath:", module.PreoptBootClassPathDexFiles, ":").
384 Flag("--runtime-arg").FlagWithList("-Xbootclasspath-locations:", module.PreoptBootClassPathDexLocations, ":").
Colin Cross43f08db2018-11-12 10:13:39 -0800385 Flag("${class_loader_context_arg}").
Ulya Trafimovichdacc6c52020-03-11 11:59:34 +0000386 Flag("${stored_class_loader_context_arg}").
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000387 FlagWithArg("--boot-image=", strings.Join(module.DexPreoptImageLocations, ":")).Implicits(module.DexPreoptImagesDeps[archIdx].Paths()).
Colin Cross43f08db2018-11-12 10:13:39 -0800388 FlagWithInput("--dex-file=", module.DexPath).
Nicolas Geoffray2464ef42019-03-05 14:07:07 +0000389 FlagWithArg("--dex-location=", dexLocationArg).
Colin Cross43f08db2018-11-12 10:13:39 -0800390 FlagWithOutput("--oat-file=", odexPath).ImplicitOutput(vdexPath).
391 // Pass an empty directory, dex2oat shouldn't be reading arbitrary files
392 FlagWithArg("--android-root=", global.EmptyDirectory).
Colin Cross74ba9622019-02-11 15:11:14 -0800393 FlagWithArg("--instruction-set=", arch.String()).
Colin Cross43f08db2018-11-12 10:13:39 -0800394 FlagWithArg("--instruction-set-variant=", global.CpuVariant[arch]).
395 FlagWithArg("--instruction-set-features=", global.InstructionSetFeatures[arch]).
396 Flag("--no-generate-debug-info").
397 Flag("--generate-build-id").
398 Flag("--abort-on-hard-verifier-error").
399 Flag("--force-determinism").
400 FlagWithArg("--no-inline-from=", "core-oj.jar")
401
402 var preoptFlags []string
403 if len(module.PreoptFlags) > 0 {
404 preoptFlags = module.PreoptFlags
405 } else if len(global.PreoptFlags) > 0 {
406 preoptFlags = global.PreoptFlags
407 }
408
409 if len(preoptFlags) > 0 {
410 cmd.Text(strings.Join(preoptFlags, " "))
411 }
412
413 if module.UncompressedDex {
414 cmd.FlagWithArg("--copy-dex-files=", "false")
415 }
416
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800417 if !android.PrefixInList(preoptFlags, "--compiler-filter=") {
Colin Cross43f08db2018-11-12 10:13:39 -0800418 var compilerFilter string
419 if contains(global.SystemServerJars, module.Name) {
420 // Jars of system server, use the product option if it is set, speed otherwise.
421 if global.SystemServerCompilerFilter != "" {
422 compilerFilter = global.SystemServerCompilerFilter
423 } else {
424 compilerFilter = "speed"
425 }
426 } else if contains(global.SpeedApps, module.Name) || contains(global.SystemServerApps, module.Name) {
427 // Apps loaded into system server, and apps the product default to being compiled with the
428 // 'speed' compiler filter.
429 compilerFilter = "speed"
Colin Cross69f59a32019-02-15 10:39:37 -0800430 } else if profile != nil {
Colin Cross43f08db2018-11-12 10:13:39 -0800431 // For non system server jars, use speed-profile when we have a profile.
432 compilerFilter = "speed-profile"
433 } else if global.DefaultCompilerFilter != "" {
434 compilerFilter = global.DefaultCompilerFilter
435 } else {
436 compilerFilter = "quicken"
437 }
438 cmd.FlagWithArg("--compiler-filter=", compilerFilter)
439 }
440
441 if generateDM {
442 cmd.FlagWithArg("--copy-dex-files=", "false")
Colin Cross69f59a32019-02-15 10:39:37 -0800443 dmPath := module.BuildPath.InSameDir(ctx, "generated.dm")
Colin Cross43f08db2018-11-12 10:13:39 -0800444 dmInstalledPath := pathtools.ReplaceExtension(module.DexLocation, "dm")
Colin Cross69f59a32019-02-15 10:39:37 -0800445 tmpPath := module.BuildPath.InSameDir(ctx, "primary.vdex")
Colin Cross43f08db2018-11-12 10:13:39 -0800446 rule.Command().Text("cp -f").Input(vdexPath).Output(tmpPath)
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000447 rule.Command().Tool(globalSoong.SoongZip).
Colin Cross43f08db2018-11-12 10:13:39 -0800448 FlagWithArg("-L", "9").
449 FlagWithOutput("-o", dmPath).
450 Flag("-j").
451 Input(tmpPath)
452 rule.Install(dmPath, dmInstalledPath)
453 }
454
455 // By default, emit debug info.
456 debugInfo := true
457 if global.NoDebugInfo {
458 // If the global setting suppresses mini-debug-info, disable it.
459 debugInfo = false
460 }
461
462 // PRODUCT_SYSTEM_SERVER_DEBUG_INFO overrides WITH_DEXPREOPT_DEBUG_INFO.
463 // PRODUCT_OTHER_JAVA_DEBUG_INFO overrides WITH_DEXPREOPT_DEBUG_INFO.
464 if contains(global.SystemServerJars, module.Name) {
465 if global.AlwaysSystemServerDebugInfo {
466 debugInfo = true
467 } else if global.NeverSystemServerDebugInfo {
468 debugInfo = false
469 }
470 } else {
471 if global.AlwaysOtherDebugInfo {
472 debugInfo = true
473 } else if global.NeverOtherDebugInfo {
474 debugInfo = false
475 }
476 }
477
478 // Never enable on eng.
479 if global.IsEng {
480 debugInfo = false
481 }
482
483 if debugInfo {
484 cmd.Flag("--generate-mini-debug-info")
485 } else {
486 cmd.Flag("--no-generate-mini-debug-info")
487 }
488
489 // Set the compiler reason to 'prebuilt' to identify the oat files produced
490 // during the build, as opposed to compiled on the device.
491 cmd.FlagWithArg("--compilation-reason=", "prebuilt")
492
493 if appImage {
Colin Cross69f59a32019-02-15 10:39:37 -0800494 appImagePath := odexPath.ReplaceExtension(ctx, "art")
Colin Cross43f08db2018-11-12 10:13:39 -0800495 appImageInstallPath := pathtools.ReplaceExtension(odexInstallPath, "art")
496 cmd.FlagWithOutput("--app-image-file=", appImagePath).
497 FlagWithArg("--image-format=", "lz4")
Mathieu Chartier3f7ddbb2019-04-29 09:33:50 -0700498 if !global.DontResolveStartupStrings {
499 cmd.FlagWithArg("--resolve-startup-const-strings=", "true")
500 }
Colin Cross43f08db2018-11-12 10:13:39 -0800501 rule.Install(appImagePath, appImageInstallPath)
502 }
503
Colin Cross69f59a32019-02-15 10:39:37 -0800504 if profile != nil {
505 cmd.FlagWithInput("--profile-file=", profile)
Colin Cross43f08db2018-11-12 10:13:39 -0800506 }
507
508 rule.Install(odexPath, odexInstallPath)
509 rule.Install(vdexPath, vdexInstallPath)
510}
511
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000512func shouldGenerateDM(module *ModuleConfig, global *GlobalConfig) bool {
Colin Cross43f08db2018-11-12 10:13:39 -0800513 // Generating DM files only makes sense for verify, avoid doing for non verify compiler filter APKs.
514 // No reason to use a dm file if the dex is already uncompressed.
515 return global.GenerateDMFiles && !module.UncompressedDex &&
516 contains(module.PreoptFlags, "--compiler-filter=verify")
517}
518
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000519func OdexOnSystemOtherByName(name string, dexLocation string, global *GlobalConfig) bool {
Colin Cross43f08db2018-11-12 10:13:39 -0800520 if !global.HasSystemOther {
521 return false
522 }
523
524 if global.SanitizeLite {
525 return false
526 }
527
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000528 if contains(global.SpeedApps, name) || contains(global.SystemServerApps, name) {
Colin Cross43f08db2018-11-12 10:13:39 -0800529 return false
530 }
531
532 for _, f := range global.PatternsOnSystemOther {
Anton Hanssond57bd3c2019-10-14 16:53:02 +0100533 if makefileMatch(filepath.Join(SystemPartition, f), dexLocation) {
Colin Cross43f08db2018-11-12 10:13:39 -0800534 return true
535 }
536 }
537
538 return false
539}
540
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000541func odexOnSystemOther(module *ModuleConfig, global *GlobalConfig) bool {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000542 return OdexOnSystemOtherByName(module.Name, module.DexLocation, global)
543}
544
Colin Crossc7e40aa2019-02-08 21:37:00 -0800545// PathToLocation converts .../system/framework/arm64/boot.art to .../system/framework/boot.art
Colin Cross69f59a32019-02-15 10:39:37 -0800546func PathToLocation(path android.Path, arch android.ArchType) string {
547 pathArch := filepath.Base(filepath.Dir(path.String()))
Colin Cross74ba9622019-02-11 15:11:14 -0800548 if pathArch != arch.String() {
549 panic(fmt.Errorf("last directory in %q must be %q", path, arch.String()))
Colin Crossc7e40aa2019-02-08 21:37:00 -0800550 }
Colin Cross69f59a32019-02-15 10:39:37 -0800551 return filepath.Join(filepath.Dir(filepath.Dir(path.String())), filepath.Base(path.String()))
Colin Crossc7e40aa2019-02-08 21:37:00 -0800552}
553
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +0100554func pathForLibrary(module *ModuleConfig, lib string) *LibraryPath {
Colin Cross69f59a32019-02-15 10:39:37 -0800555 path, ok := module.LibraryPaths[lib]
556 if !ok {
Colin Cross43f08db2018-11-12 10:13:39 -0800557 panic(fmt.Errorf("unknown library path for %q", lib))
558 }
559 return path
560}
561
562func makefileMatch(pattern, s string) bool {
563 percent := strings.IndexByte(pattern, '%')
564 switch percent {
565 case -1:
566 return pattern == s
567 case len(pattern) - 1:
568 return strings.HasPrefix(s, pattern[:len(pattern)-1])
569 default:
570 panic(fmt.Errorf("unsupported makefile pattern %q", pattern))
571 }
572}
573
Ulyana Trafimovichf2cb7e92019-11-27 12:26:49 +0000574// Expected format for apexJarValue = <apex name>:<jar name>
Ulya Trafimovich8640ab92020-05-11 18:06:15 +0100575func GetJarLocationFromApexJarPair(ctx android.PathContext, apexJarValue string) string {
576 apex, jar := android.SplitApexJarPair(ctx, apexJarValue)
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000577 return filepath.Join("/apex", apex, "javalib", jar+".jar")
Roshan Piusccc26ef2019-11-27 09:37:46 -0800578}
579
Ulya Trafimovichf3ff0102019-12-03 15:39:23 +0000580var nonUpdatableSystemServerJarsKey = android.NewOnceKey("nonUpdatableSystemServerJars")
581
582// TODO: eliminate the superficial global config parameter by moving global config definition
583// from java subpackage to dexpreopt.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000584func NonUpdatableSystemServerJars(ctx android.PathContext, global *GlobalConfig) []string {
Ulya Trafimovichf3ff0102019-12-03 15:39:23 +0000585 return ctx.Config().Once(nonUpdatableSystemServerJarsKey, func() interface{} {
586 return android.RemoveListFromList(global.SystemServerJars,
Ulya Trafimovich8640ab92020-05-11 18:06:15 +0100587 android.GetJarsFromApexJarPairs(ctx, global.UpdatableSystemServerJars))
Ulya Trafimovichf3ff0102019-12-03 15:39:23 +0000588 }).([]string)
589}
590
Ulya Trafimovichdacc6c52020-03-11 11:59:34 +0000591// A predefined location for the system server dex jars. This is needed in order to generate
592// class loader context for dex2oat, as the path to the jar in the Soong module may be unknown
593// at that time (Soong processes the jars in dependency order, which may be different from the
594// the system server classpath order).
595func SystemServerDexJarHostPath(ctx android.PathContext, jar string) android.OutputPath {
Ulya Trafimovich6cf2c0c2020-04-24 12:15:20 +0100596 if DexpreoptRunningInSoong {
597 // Soong module, just use the default output directory $OUT/soong.
598 return android.PathForOutput(ctx, "system_server_dexjars", jar+".jar")
599 } else {
600 // Make module, default output directory is $OUT (passed via the "null config" created
601 // by dexpreopt_gen). Append Soong subdirectory to match Soong module paths.
602 return android.PathForOutput(ctx, "soong", "system_server_dexjars", jar+".jar")
603 }
Ulya Trafimovichdacc6c52020-03-11 11:59:34 +0000604}
605
Ulya Trafimovichcd3203f2020-03-27 11:30:00 +0000606// Check the order of jars on the system server classpath and give a warning/error if a jar precedes
607// one of its dependencies. This is not an error, but a missed optimization, as dexpreopt won't
608// have the dependency jar in the class loader context, and it won't be able to resolve any
609// references to its classes and methods.
610func checkSystemServerOrder(ctx android.PathContext, jarIndex int) {
611 mctx, isModule := ctx.(android.ModuleContext)
612 if isModule {
613 config := GetGlobalConfig(ctx)
614 jars := NonUpdatableSystemServerJars(ctx, config)
615 mctx.WalkDeps(func(dep android.Module, parent android.Module) bool {
616 depIndex := android.IndexList(dep.Name(), jars)
617 if jarIndex < depIndex && !config.BrokenSuboptimalOrderOfSystemServerJars {
618 jar := jars[jarIndex]
619 dep := jars[depIndex]
620 mctx.ModuleErrorf("non-optimal order of jars on the system server classpath:"+
621 " '%s' precedes its dependency '%s', so dexpreopt is unable to resolve any"+
622 " references from '%s' to '%s'.\n", jar, dep, jar, dep)
623 }
624 return true
625 })
626 }
627}
628
Colin Cross43f08db2018-11-12 10:13:39 -0800629func contains(l []string, s string) bool {
630 for _, e := range l {
631 if e == s {
632 return true
633 }
634 }
635 return false
636}
637
Colin Cross454c0872019-02-15 23:03:34 -0800638var copyOf = android.CopyOf