blob: 11aa2711226b77299a0969ab465756218e9d2c16 [file] [log] [blame]
Colin Cross800fe132019-02-11 14:21:24 -08001// Copyright 2019 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
15package java
16
17import (
18 "path/filepath"
Colin Crossc9a4c362019-02-26 21:13:48 -080019 "sort"
Colin Cross800fe132019-02-11 14:21:24 -080020 "strings"
21
22 "android/soong/android"
23 "android/soong/dexpreopt"
24
Colin Cross800fe132019-02-11 14:21:24 -080025 "github.com/google/blueprint/proptools"
26)
27
28func init() {
29 android.RegisterSingletonType("dex_bootjars", dexpreoptBootJarsFactory)
30}
31
32// The image "location" is a symbolic path that with multiarchitecture
33// support doesn't really exist on the device. Typically it is
34// /system/framework/boot.art and should be the same for all supported
35// architectures on the device. The concrete architecture specific
36// content actually ends up in a "filename" that contains an
37// architecture specific directory name such as arm, arm64, mips,
38// mips64, x86, x86_64.
39//
40// Here are some example values for an x86_64 / x86 configuration:
41//
42// bootImages["x86_64"] = "out/soong/generic_x86_64/dex_bootjars/system/framework/x86_64/boot.art"
43// dexpreopt.PathToLocation(bootImages["x86_64"], "x86_64") = "out/soong/generic_x86_64/dex_bootjars/system/framework/boot.art"
44//
45// bootImages["x86"] = "out/soong/generic_x86_64/dex_bootjars/system/framework/x86/boot.art"
46// dexpreopt.PathToLocation(bootImages["x86"])= "out/soong/generic_x86_64/dex_bootjars/system/framework/boot.art"
47//
48// The location is passed as an argument to the ART tools like dex2oat instead of the real path. The ART tools
49// will then reconstruct the real path, so the rules must have a dependency on the real path.
50
Colin Cross44df5812019-02-15 23:06:46 -080051type bootImageConfig struct {
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000052 // Whether this image is an extension.
53 extension bool
54
55 // Image name (used in directory names and ninja rule names).
56 name string
57
58 // Basename of the image: the resulting filenames are <stem>[-<jar>].{art,oat,vdex}.
59 stem string
60
61 // Output directory for the image files.
62 dir android.OutputPath
63
64 // Output directory for the image files with debug symbols.
65 symbolsDir android.OutputPath
66
67 // Subdirectory where the image files are installed.
68 installSubdir string
69
70 // Targets for which the image is generated.
71 targets []android.Target
72
73 // The names of jars that constitute this image.
74 modules []string
75
76 // The "locations" of jars.
77 dexLocations []string // for this image
78 dexLocationsDeps []string // for the dependency images and in this image
79
80 // File paths to jars.
81 dexPaths android.WritablePaths // for this image
82 dexPathsDeps android.WritablePaths // for the dependency images and in this image
83
84 // The "locations" of the dependency images and in this image.
85 imageLocations []string
86
87 // Paths to image files (grouped by target).
88 images map[android.ArchType]android.OutputPath // first image file
89 imagesDeps map[android.ArchType]android.OutputPaths // all files
90
91 // File path to a zip archive with all image files (or nil, if not needed).
92 zip android.WritablePath
Colin Cross800fe132019-02-11 14:21:24 -080093}
94
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000095func (image bootImageConfig) moduleName(idx int) string {
96 // Dexpreopt on the boot class path produces multiple files. The first dex file
97 // is converted into 'name'.art (to match the legacy assumption that 'name'.art
Dan Willemsen0f416782019-06-13 21:44:53 +000098 // exists), and the rest are converted to 'name'-<jar>.art.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000099 m := image.modules[idx]
100 name := image.stem
101 if idx != 0 || image.extension {
102 name += "-" + stemOf(m)
103 }
104 return name
105}
Dan Willemsen0f416782019-06-13 21:44:53 +0000106
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000107func (image bootImageConfig) firstModuleNameOrStem() string {
108 if len(image.modules) > 0 {
109 return image.moduleName(0)
110 } else {
111 return image.stem
112 }
113}
114
115func (image bootImageConfig) moduleFiles(ctx android.PathContext, dir android.OutputPath, exts ...string) android.OutputPaths {
116 ret := make(android.OutputPaths, 0, len(image.modules)*len(exts))
117 for i := range image.modules {
118 name := image.moduleName(i)
Dan Willemsen0f416782019-06-13 21:44:53 +0000119 for _, ext := range exts {
120 ret = append(ret, dir.Join(ctx, name+ext))
121 }
122 }
Dan Willemsen0f416782019-06-13 21:44:53 +0000123 return ret
124}
125
Colin Cross44df5812019-02-15 23:06:46 -0800126type bootImage struct {
127 bootImageConfig
Colin Cross800fe132019-02-11 14:21:24 -0800128
Colin Cross44df5812019-02-15 23:06:46 -0800129 installs map[android.ArchType]android.RuleBuilderInstalls
130 vdexInstalls map[android.ArchType]android.RuleBuilderInstalls
131 unstrippedInstalls map[android.ArchType]android.RuleBuilderInstalls
Colin Cross800fe132019-02-11 14:21:24 -0800132
Colin Cross44df5812019-02-15 23:06:46 -0800133 profileInstalls android.RuleBuilderInstalls
134}
Colin Cross800fe132019-02-11 14:21:24 -0800135
Colin Cross44df5812019-02-15 23:06:46 -0800136func newBootImage(ctx android.PathContext, config bootImageConfig) *bootImage {
137 image := &bootImage{
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000138 bootImageConfig: config,
Colin Cross800fe132019-02-11 14:21:24 -0800139
Colin Cross44df5812019-02-15 23:06:46 -0800140 installs: make(map[android.ArchType]android.RuleBuilderInstalls),
141 vdexInstalls: make(map[android.ArchType]android.RuleBuilderInstalls),
142 unstrippedInstalls: make(map[android.ArchType]android.RuleBuilderInstalls),
143 }
Colin Cross800fe132019-02-11 14:21:24 -0800144
Colin Cross44df5812019-02-15 23:06:46 -0800145 return image
Colin Cross800fe132019-02-11 14:21:24 -0800146}
147
148func concat(lists ...[]string) []string {
149 var size int
150 for _, l := range lists {
151 size += len(l)
152 }
153 ret := make([]string, 0, size)
154 for _, l := range lists {
155 ret = append(ret, l...)
156 }
157 return ret
158}
159
Colin Cross800fe132019-02-11 14:21:24 -0800160func dexpreoptBootJarsFactory() android.Singleton {
Colin Cross44df5812019-02-15 23:06:46 -0800161 return &dexpreoptBootJars{}
Colin Cross800fe132019-02-11 14:21:24 -0800162}
163
164func skipDexpreoptBootJars(ctx android.PathContext) bool {
Ulya Trafimovichacb33e02019-11-01 17:57:29 +0000165 if dexpreoptGlobalConfig(ctx).DisablePreopt {
166 return true
167 }
168
Colin Cross800fe132019-02-11 14:21:24 -0800169 if ctx.Config().UnbundledBuild() {
170 return true
171 }
172
173 if len(ctx.Config().Targets[android.Android]) == 0 {
174 // Host-only build
175 return true
176 }
177
178 return false
179}
180
Ulyana Trafimovich3fae7662019-12-11 10:31:32 +0000181func skipDexpreoptArtBootJars(ctx android.BuilderContext) bool {
182 // with EMMA_INSTRUMENT_FRAMEWORK=true ART boot class path libraries have dependencies on framework,
183 // therefore dexpreopt ART libraries cannot be dexpreopted in isolation => no ART boot image
184 return ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
185}
186
Colin Cross44df5812019-02-15 23:06:46 -0800187type dexpreoptBootJars struct {
188 defaultBootImage *bootImage
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000189 otherImages []*bootImage
Colin Cross2d00f0d2019-05-09 21:50:00 -0700190
191 dexpreoptConfigForMake android.WritablePath
Colin Cross44df5812019-02-15 23:06:46 -0800192}
Colin Cross800fe132019-02-11 14:21:24 -0800193
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000194// Accessor function for the apex package. Returns nil if dexpreopt is disabled.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000195func DexpreoptedArtApexJars(ctx android.BuilderContext) map[android.ArchType]android.OutputPaths {
Ulyana Trafimovich3fae7662019-12-11 10:31:32 +0000196 if skipDexpreoptBootJars(ctx) || skipDexpreoptArtBootJars(ctx) {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000197 return nil
198 }
199 return artBootImageConfig(ctx).imagesDeps
200}
201
Colin Cross800fe132019-02-11 14:21:24 -0800202// dexpreoptBoot singleton rules
Colin Cross44df5812019-02-15 23:06:46 -0800203func (d *dexpreoptBootJars) GenerateBuildActions(ctx android.SingletonContext) {
Colin Cross800fe132019-02-11 14:21:24 -0800204 if skipDexpreoptBootJars(ctx) {
205 return
206 }
207
Colin Cross2d00f0d2019-05-09 21:50:00 -0700208 d.dexpreoptConfigForMake = android.PathForOutput(ctx, ctx.Config().DeviceName(), "dexpreopt.config")
209 writeGlobalConfigForMake(ctx, d.dexpreoptConfigForMake)
210
Colin Cross44df5812019-02-15 23:06:46 -0800211 global := dexpreoptGlobalConfig(ctx)
Colin Cross800fe132019-02-11 14:21:24 -0800212
213 // Skip recompiling the boot image for the second sanitization phase. We'll get separate paths
214 // and invalidate first-stage artifacts which are crucial to SANITIZE_LITE builds.
215 // Note: this is technically incorrect. Compiled code contains stack checks which may depend
216 // on ASAN settings.
217 if len(ctx.Config().SanitizeDevice()) == 1 &&
218 ctx.Config().SanitizeDevice()[0] == "address" &&
Colin Cross44df5812019-02-15 23:06:46 -0800219 global.SanitizeLite {
Colin Cross800fe132019-02-11 14:21:24 -0800220 return
221 }
222
Lingfeng Yang54191fa2019-12-19 16:40:09 +0000223 // Always create the default boot image first, to get a unique profile rule for all images.
224 d.defaultBootImage = buildBootImage(ctx, defaultBootImageConfig(ctx))
Ulya Trafimovich48b3b3c2019-12-13 13:34:06 +0000225 if !skipDexpreoptArtBootJars(ctx) {
Lingfeng Yang54191fa2019-12-19 16:40:09 +0000226 // Create boot image for the ART apex (build artifacts are accessed via the global boot image config).
Ulya Trafimovich48b3b3c2019-12-13 13:34:06 +0000227 d.otherImages = append(d.otherImages, buildBootImage(ctx, artBootImageConfig(ctx)))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000228 }
Lingfeng Yang54191fa2019-12-19 16:40:09 +0000229 if global.GenerateApexImage {
230 // Create boot images for the JIT-zygote experiment.
231 d.otherImages = append(d.otherImages, buildBootImage(ctx, apexBootImageConfig(ctx)))
232 }
Colin Crossc9a4c362019-02-26 21:13:48 -0800233
234 dumpOatRules(ctx, d.defaultBootImage)
Colin Cross44df5812019-02-15 23:06:46 -0800235}
236
237// buildBootImage takes a bootImageConfig, creates rules to build it, and returns a *bootImage.
238func buildBootImage(ctx android.SingletonContext, config bootImageConfig) *bootImage {
Colin Cross44df5812019-02-15 23:06:46 -0800239 image := newBootImage(ctx, config)
240
241 bootDexJars := make(android.Paths, len(image.modules))
Colin Cross800fe132019-02-11 14:21:24 -0800242 ctx.VisitAllModules(func(module android.Module) {
243 // Collect dex jar paths for the modules listed above.
Colin Cross42be7612019-02-21 18:12:14 -0800244 if j, ok := module.(interface{ DexJar() android.Path }); ok {
Colin Cross800fe132019-02-11 14:21:24 -0800245 name := ctx.ModuleName(module)
Colin Cross44df5812019-02-15 23:06:46 -0800246 if i := android.IndexList(name, image.modules); i != -1 {
Colin Cross800fe132019-02-11 14:21:24 -0800247 bootDexJars[i] = j.DexJar()
248 }
249 }
250 })
251
252 var missingDeps []string
253 // Ensure all modules were converted to paths
254 for i := range bootDexJars {
255 if bootDexJars[i] == nil {
256 if ctx.Config().AllowMissingDependencies() {
Colin Cross44df5812019-02-15 23:06:46 -0800257 missingDeps = append(missingDeps, image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800258 bootDexJars[i] = android.PathForOutput(ctx, "missing")
259 } else {
260 ctx.Errorf("failed to find dex jar path for module %q",
Colin Cross44df5812019-02-15 23:06:46 -0800261 image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800262 }
263 }
264 }
265
266 // The path to bootclasspath dex files needs to be known at module GenerateAndroidBuildAction time, before
267 // the bootclasspath modules have been compiled. Copy the dex jars there so the module rules that have
268 // already been set up can find them.
269 for i := range bootDexJars {
270 ctx.Build(pctx, android.BuildParams{
271 Rule: android.Cp,
272 Input: bootDexJars[i],
Colin Cross44df5812019-02-15 23:06:46 -0800273 Output: image.dexPaths[i],
Colin Cross800fe132019-02-11 14:21:24 -0800274 })
275 }
276
Colin Cross44df5812019-02-15 23:06:46 -0800277 profile := bootImageProfileRule(ctx, image, missingDeps)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100278 bootFrameworkProfileRule(ctx, image, missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800279
Colin Crossdf8eebe2019-04-09 15:29:41 -0700280 var allFiles android.Paths
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000281 for _, target := range image.targets {
282 files := buildBootImageRuleForArch(ctx, image, target.Arch.ArchType, profile, missingDeps)
283 allFiles = append(allFiles, files.Paths()...)
Colin Cross800fe132019-02-11 14:21:24 -0800284 }
Colin Cross44df5812019-02-15 23:06:46 -0800285
Colin Crossdf8eebe2019-04-09 15:29:41 -0700286 if image.zip != nil {
287 rule := android.NewRuleBuilder()
288 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -0700289 BuiltTool(ctx, "soong_zip").
Colin Crossdf8eebe2019-04-09 15:29:41 -0700290 FlagWithOutput("-o ", image.zip).
291 FlagWithArg("-C ", image.dir.String()).
292 FlagWithInputList("-f ", allFiles, " -f ")
293
294 rule.Build(pctx, ctx, "zip_"+image.name, "zip "+image.name+" image")
295 }
296
Colin Cross44df5812019-02-15 23:06:46 -0800297 return image
Colin Cross800fe132019-02-11 14:21:24 -0800298}
299
Colin Cross44df5812019-02-15 23:06:46 -0800300func buildBootImageRuleForArch(ctx android.SingletonContext, image *bootImage,
Colin Crossdf8eebe2019-04-09 15:29:41 -0700301 arch android.ArchType, profile android.Path, missingDeps []string) android.WritablePaths {
Colin Cross800fe132019-02-11 14:21:24 -0800302
Colin Cross44df5812019-02-15 23:06:46 -0800303 global := dexpreoptGlobalConfig(ctx)
304
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000305 symbolsDir := image.symbolsDir.Join(ctx, image.installSubdir, arch.String())
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000306 symbolsFile := symbolsDir.Join(ctx, image.stem+".oat")
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000307 outputDir := image.dir.Join(ctx, image.installSubdir, arch.String())
308 outputPath := outputDir.Join(ctx, image.stem+".oat")
309 oatLocation := dexpreopt.PathToLocation(outputPath, arch)
310 imagePath := outputPath.ReplaceExtension(ctx, "art")
Colin Cross800fe132019-02-11 14:21:24 -0800311
312 rule := android.NewRuleBuilder()
313 rule.MissingDeps(missingDeps)
314
315 rule.Command().Text("mkdir").Flag("-p").Flag(symbolsDir.String())
316 rule.Command().Text("rm").Flag("-f").
317 Flag(symbolsDir.Join(ctx, "*.art").String()).
318 Flag(symbolsDir.Join(ctx, "*.oat").String()).
319 Flag(symbolsDir.Join(ctx, "*.invocation").String())
320 rule.Command().Text("rm").Flag("-f").
321 Flag(outputDir.Join(ctx, "*.art").String()).
322 Flag(outputDir.Join(ctx, "*.oat").String()).
323 Flag(outputDir.Join(ctx, "*.invocation").String())
324
325 cmd := rule.Command()
326
327 extraFlags := ctx.Config().Getenv("ART_BOOT_IMAGE_EXTRA_ARGS")
328 if extraFlags == "" {
329 // Use ANDROID_LOG_TAGS to suppress most logging by default...
330 cmd.Text(`ANDROID_LOG_TAGS="*:e"`)
331 } else {
332 // ...unless the boot image is generated specifically for testing, then allow all logging.
333 cmd.Text(`ANDROID_LOG_TAGS="*:v"`)
334 }
335
336 invocationPath := outputPath.ReplaceExtension(ctx, "invocation")
337
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000338 cmd.Tool(global.SoongConfig.Dex2oat).
Colin Cross800fe132019-02-11 14:21:24 -0800339 Flag("--avoid-storing-invocation").
Colin Cross69f59a32019-02-15 10:39:37 -0800340 FlagWithOutput("--write-invocation-to=", invocationPath).ImplicitOutput(invocationPath).
Colin Cross44df5812019-02-15 23:06:46 -0800341 Flag("--runtime-arg").FlagWithArg("-Xms", global.Dex2oatImageXms).
342 Flag("--runtime-arg").FlagWithArg("-Xmx", global.Dex2oatImageXmx)
Colin Cross800fe132019-02-11 14:21:24 -0800343
Colin Cross69f59a32019-02-15 10:39:37 -0800344 if profile != nil {
Colin Cross800fe132019-02-11 14:21:24 -0800345 cmd.FlagWithArg("--compiler-filter=", "speed-profile")
Colin Cross69f59a32019-02-15 10:39:37 -0800346 cmd.FlagWithInput("--profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800347 }
348
Colin Cross44df5812019-02-15 23:06:46 -0800349 if global.DirtyImageObjects.Valid() {
350 cmd.FlagWithInput("--dirty-image-objects=", global.DirtyImageObjects.Path())
Colin Cross800fe132019-02-11 14:21:24 -0800351 }
352
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000353 if image.extension {
354 artImage := artBootImageConfig(ctx).images[arch]
355 cmd.
356 Flag("--runtime-arg").FlagWithInputList("-Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
357 Flag("--runtime-arg").FlagWithList("-Xbootclasspath-locations:", image.dexLocationsDeps, ":").
358 FlagWithArg("--boot-image=", dexpreopt.PathToLocation(artImage, arch)).Implicit(artImage)
359 } else {
360 cmd.FlagWithArg("--base=", ctx.Config().LibartImgDeviceBaseAddress())
361 }
362
Colin Cross800fe132019-02-11 14:21:24 -0800363 cmd.
Colin Cross44df5812019-02-15 23:06:46 -0800364 FlagForEachInput("--dex-file=", image.dexPaths.Paths()).
365 FlagForEachArg("--dex-location=", image.dexLocations).
Colin Cross800fe132019-02-11 14:21:24 -0800366 Flag("--generate-debug-info").
367 Flag("--generate-build-id").
Mathieu Chartier54fd8072019-07-26 13:50:04 -0700368 Flag("--image-format=lz4hc").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000369 FlagWithArg("--oat-symbols=", symbolsFile.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800370 Flag("--strip").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000371 FlagWithArg("--oat-file=", outputPath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800372 FlagWithArg("--oat-location=", oatLocation).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000373 FlagWithArg("--image=", imagePath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800374 FlagWithArg("--instruction-set=", arch.String()).
Colin Cross44df5812019-02-15 23:06:46 -0800375 FlagWithArg("--instruction-set-variant=", global.CpuVariant[arch]).
376 FlagWithArg("--instruction-set-features=", global.InstructionSetFeatures[arch]).
377 FlagWithArg("--android-root=", global.EmptyDirectory).
Colin Cross800fe132019-02-11 14:21:24 -0800378 FlagWithArg("--no-inline-from=", "core-oj.jar").
379 Flag("--abort-on-hard-verifier-error")
380
Colin Cross44df5812019-02-15 23:06:46 -0800381 if global.BootFlags != "" {
382 cmd.Flag(global.BootFlags)
Colin Cross800fe132019-02-11 14:21:24 -0800383 }
384
385 if extraFlags != "" {
386 cmd.Flag(extraFlags)
387 }
388
Colin Cross0b9f31f2019-02-28 11:00:01 -0800389 cmd.Textf(`|| ( echo %s ; false )`, proptools.ShellEscape(failureMessage))
Colin Cross800fe132019-02-11 14:21:24 -0800390
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000391 installDir := filepath.Join("/", image.installSubdir, arch.String())
392 vdexInstallDir := filepath.Join("/", image.installSubdir)
Colin Cross800fe132019-02-11 14:21:24 -0800393
Colin Cross800fe132019-02-11 14:21:24 -0800394 var vdexInstalls android.RuleBuilderInstalls
395 var unstrippedInstalls android.RuleBuilderInstalls
396
Colin Crossdf8eebe2019-04-09 15:29:41 -0700397 var zipFiles android.WritablePaths
398
Dan Willemsen0f416782019-06-13 21:44:53 +0000399 for _, artOrOat := range image.moduleFiles(ctx, outputDir, ".art", ".oat") {
400 cmd.ImplicitOutput(artOrOat)
401 zipFiles = append(zipFiles, artOrOat)
Colin Cross800fe132019-02-11 14:21:24 -0800402
Dan Willemsen0f416782019-06-13 21:44:53 +0000403 // Install the .oat and .art files
404 rule.Install(artOrOat, filepath.Join(installDir, artOrOat.Base()))
405 }
Colin Cross800fe132019-02-11 14:21:24 -0800406
Dan Willemsen0f416782019-06-13 21:44:53 +0000407 for _, vdex := range image.moduleFiles(ctx, outputDir, ".vdex") {
408 cmd.ImplicitOutput(vdex)
409 zipFiles = append(zipFiles, vdex)
Colin Cross800fe132019-02-11 14:21:24 -0800410
411 // The vdex files are identical between architectures, install them to a shared location. The Make rules will
412 // only use the install rules for one architecture, and will create symlinks into the architecture-specific
413 // directories.
414 vdexInstalls = append(vdexInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800415 android.RuleBuilderInstall{vdex, filepath.Join(vdexInstallDir, vdex.Base())})
Dan Willemsen0f416782019-06-13 21:44:53 +0000416 }
417
418 for _, unstrippedOat := range image.moduleFiles(ctx, symbolsDir, ".oat") {
419 cmd.ImplicitOutput(unstrippedOat)
Colin Cross800fe132019-02-11 14:21:24 -0800420
421 // Install the unstripped oat files. The Make rules will put these in $(TARGET_OUT_UNSTRIPPED)
422 unstrippedInstalls = append(unstrippedInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800423 android.RuleBuilderInstall{unstrippedOat, filepath.Join(installDir, unstrippedOat.Base())})
Colin Cross800fe132019-02-11 14:21:24 -0800424 }
425
Colin Cross44df5812019-02-15 23:06:46 -0800426 rule.Build(pctx, ctx, image.name+"JarsDexpreopt_"+arch.String(), "dexpreopt "+image.name+" jars "+arch.String())
Colin Cross800fe132019-02-11 14:21:24 -0800427
428 // save output and installed files for makevars
Colin Cross44df5812019-02-15 23:06:46 -0800429 image.installs[arch] = rule.Installs()
430 image.vdexInstalls[arch] = vdexInstalls
431 image.unstrippedInstalls[arch] = unstrippedInstalls
Colin Crossdf8eebe2019-04-09 15:29:41 -0700432
433 return zipFiles
Colin Cross800fe132019-02-11 14:21:24 -0800434}
435
436const failureMessage = `ERROR: Dex2oat failed to compile a boot image.
437It is likely that the boot classpath is inconsistent.
438Rebuild with ART_BOOT_IMAGE_EXTRA_ARGS="--runtime-arg -verbose:verifier" to see verification errors.`
439
Colin Cross44df5812019-02-15 23:06:46 -0800440func bootImageProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000441 global := dexpreoptGlobalConfig(ctx)
442
Mathieu Chartier6adeee12019-06-26 10:01:36 -0700443 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000444 return nil
445 }
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000446 profile := ctx.Config().Once(bootImageProfileRuleKey, func() interface{} {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000447 defaultProfile := "frameworks/base/config/boot-image-profile.txt"
Colin Cross800fe132019-02-11 14:21:24 -0800448
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000449 rule := android.NewRuleBuilder()
450 rule.MissingDeps(missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800451
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000452 var bootImageProfile android.Path
453 if len(global.BootImageProfiles) > 1 {
454 combinedBootImageProfile := image.dir.Join(ctx, "boot-image-profile.txt")
455 rule.Command().Text("cat").Inputs(global.BootImageProfiles).Text(">").Output(combinedBootImageProfile)
456 bootImageProfile = combinedBootImageProfile
457 } else if len(global.BootImageProfiles) == 1 {
458 bootImageProfile = global.BootImageProfiles[0]
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000459 } else if path := android.ExistentPathForSource(ctx, defaultProfile); path.Valid() {
460 bootImageProfile = path.Path()
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000461 } else {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000462 // No profile (not even a default one, which is the case on some branches
463 // like master-art-host that don't have frameworks/base).
464 // Return nil and continue without profile.
465 return nil
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000466 }
Colin Cross800fe132019-02-11 14:21:24 -0800467
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000468 profile := image.dir.Join(ctx, "boot.prof")
Colin Cross800fe132019-02-11 14:21:24 -0800469
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000470 rule.Command().
471 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000472 Tool(global.SoongConfig.Profman).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000473 FlagWithInput("--create-profile-from=", bootImageProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000474 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
475 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000476 FlagWithOutput("--reference-profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800477
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000478 rule.Install(profile, "/system/etc/boot-image.prof")
479
480 rule.Build(pctx, ctx, "bootJarsProfile", "profile boot jars")
481
482 image.profileInstalls = rule.Installs()
483
484 return profile
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000485 })
486 if profile == nil {
487 return nil // wrap nil into a typed pointer with value nil
488 }
489 return profile.(android.WritablePath)
Colin Cross800fe132019-02-11 14:21:24 -0800490}
491
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000492var bootImageProfileRuleKey = android.NewOnceKey("bootImageProfileRule")
493
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100494func bootFrameworkProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
495 global := dexpreoptGlobalConfig(ctx)
496
497 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
498 return nil
499 }
500 return ctx.Config().Once(bootFrameworkProfileRuleKey, func() interface{} {
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100501 rule := android.NewRuleBuilder()
502 rule.MissingDeps(missingDeps)
503
504 // Some branches like master-art-host don't have frameworks/base, so manually
505 // handle the case that the default is missing. Those branches won't attempt to build the profile rule,
506 // and if they do they'll get a missing deps error.
507 defaultProfile := "frameworks/base/config/boot-profile.txt"
508 path := android.ExistentPathForSource(ctx, defaultProfile)
509 var bootFrameworkProfile android.Path
510 if path.Valid() {
511 bootFrameworkProfile = path.Path()
512 } else {
513 missingDeps = append(missingDeps, defaultProfile)
514 bootFrameworkProfile = android.PathForOutput(ctx, "missing")
515 }
516
517 profile := image.dir.Join(ctx, "boot.bprof")
518
519 rule.Command().
520 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000521 Tool(global.SoongConfig.Profman).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100522 Flag("--generate-boot-profile").
523 FlagWithInput("--create-profile-from=", bootFrameworkProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000524 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
525 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100526 FlagWithOutput("--reference-profile-file=", profile)
527
528 rule.Install(profile, "/system/etc/boot-image.bprof")
529 rule.Build(pctx, ctx, "bootFrameworkProfile", "profile boot framework jars")
530 image.profileInstalls = append(image.profileInstalls, rule.Installs()...)
531
532 return profile
533 }).(android.WritablePath)
534}
535
536var bootFrameworkProfileRuleKey = android.NewOnceKey("bootFrameworkProfileRule")
537
Colin Crossc9a4c362019-02-26 21:13:48 -0800538func dumpOatRules(ctx android.SingletonContext, image *bootImage) {
539 var archs []android.ArchType
540 for arch := range image.images {
541 archs = append(archs, arch)
542 }
543 sort.Slice(archs, func(i, j int) bool { return archs[i].String() < archs[j].String() })
544
545 var allPhonies android.Paths
546 for _, arch := range archs {
547 // Create a rule to call oatdump.
548 output := android.PathForOutput(ctx, "boot."+arch.String()+".oatdump.txt")
549 rule := android.NewRuleBuilder()
550 rule.Command().
551 // TODO: for now, use the debug version for better error reporting
Colin Crossee94d6a2019-07-08 17:08:34 -0700552 BuiltTool(ctx, "oatdumpd").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000553 FlagWithInputList("--runtime-arg -Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
554 FlagWithList("--runtime-arg -Xbootclasspath-locations:", image.dexLocationsDeps, ":").
Ulya Trafimovich163664a2019-12-06 13:42:21 +0000555 FlagWithArg("--image=", strings.Join(image.imageLocations, ":")).Implicits(image.imagesDeps[arch].Paths()).
Colin Crossc9a4c362019-02-26 21:13:48 -0800556 FlagWithOutput("--output=", output).
557 FlagWithArg("--instruction-set=", arch.String())
558 rule.Build(pctx, ctx, "dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
559
560 // Create a phony rule that depends on the output file and prints the path.
561 phony := android.PathForPhony(ctx, "dump-oat-boot-"+arch.String())
562 rule = android.NewRuleBuilder()
563 rule.Command().
564 Implicit(output).
565 ImplicitOutput(phony).
566 Text("echo").FlagWithArg("Output in ", output.String())
567 rule.Build(pctx, ctx, "phony-dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
568
569 allPhonies = append(allPhonies, phony)
570 }
571
572 phony := android.PathForPhony(ctx, "dump-oat-boot")
573 ctx.Build(pctx, android.BuildParams{
574 Rule: android.Phony,
575 Output: phony,
576 Inputs: allPhonies,
577 Description: "dump-oat-boot",
578 })
579
580}
581
Colin Cross2d00f0d2019-05-09 21:50:00 -0700582func writeGlobalConfigForMake(ctx android.SingletonContext, path android.WritablePath) {
583 data := dexpreoptGlobalConfigRaw(ctx).data
584
585 ctx.Build(pctx, android.BuildParams{
586 Rule: android.WriteFile,
587 Output: path,
588 Args: map[string]string{
589 "content": string(data),
590 },
591 })
592}
593
Colin Cross44df5812019-02-15 23:06:46 -0800594// Export paths for default boot image to Make
595func (d *dexpreoptBootJars) MakeVars(ctx android.MakeVarsContext) {
Colin Cross2d00f0d2019-05-09 21:50:00 -0700596 if d.dexpreoptConfigForMake != nil {
597 ctx.Strict("DEX_PREOPT_CONFIG_FOR_MAKE", d.dexpreoptConfigForMake.String())
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000598 ctx.Strict("DEX_PREOPT_SOONG_CONFIG_FOR_MAKE", android.PathForOutput(ctx, "dexpreopt_soong.config").String())
Colin Cross2d00f0d2019-05-09 21:50:00 -0700599 }
600
Colin Cross44df5812019-02-15 23:06:46 -0800601 image := d.defaultBootImage
602 if image != nil {
Colin Cross44df5812019-02-15 23:06:46 -0800603 ctx.Strict("DEXPREOPT_IMAGE_PROFILE_BUILT_INSTALLED", image.profileInstalls.String())
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000604 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_FILES", strings.Join(image.dexPathsDeps.Strings(), " "))
605 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_LOCATIONS", strings.Join(image.dexLocationsDeps, " "))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000606
607 var imageNames []string
608 for _, current := range append(d.otherImages, image) {
609 imageNames = append(imageNames, current.name)
Colin Cross91268c62019-04-11 14:07:04 -0700610 var arches []android.ArchType
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000611 for arch, _ := range current.images {
Colin Cross91268c62019-04-11 14:07:04 -0700612 arches = append(arches, arch)
613 }
614
615 sort.Slice(arches, func(i, j int) bool { return arches[i].String() < arches[j].String() })
616
617 for _, arch := range arches {
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000618 sfx := current.name + "_" + arch.String()
619 ctx.Strict("DEXPREOPT_IMAGE_VDEX_BUILT_INSTALLED_"+sfx, current.vdexInstalls[arch].String())
620 ctx.Strict("DEXPREOPT_IMAGE_"+sfx, current.images[arch].String())
621 ctx.Strict("DEXPREOPT_IMAGE_DEPS_"+sfx, strings.Join(current.imagesDeps[arch].Strings(), " "))
622 ctx.Strict("DEXPREOPT_IMAGE_BUILT_INSTALLED_"+sfx, current.installs[arch].String())
623 ctx.Strict("DEXPREOPT_IMAGE_UNSTRIPPED_BUILT_INSTALLED_"+sfx, current.unstrippedInstalls[arch].String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000624 }
Colin Cross31bf00d2019-12-04 13:16:01 -0800625
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000626 ctx.Strict("DEXPREOPT_IMAGE_LOCATIONS_"+current.name, strings.Join(current.imageLocations, ":"))
Colin Cross31bf00d2019-12-04 13:16:01 -0800627 ctx.Strict("DEXPREOPT_IMAGE_ZIP_"+current.name, current.zip.String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000628 }
629 ctx.Strict("DEXPREOPT_IMAGE_NAMES", strings.Join(imageNames, " "))
Colin Cross800fe132019-02-11 14:21:24 -0800630 }
Colin Cross800fe132019-02-11 14:21:24 -0800631}