blob: 3b6f357d71ad1c54e95c258104f267b8567c7510 [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"
19 "strings"
20
21 "android/soong/android"
22 "android/soong/dexpreopt"
23
Colin Cross800fe132019-02-11 14:21:24 -080024 "github.com/google/blueprint/proptools"
25)
26
27func init() {
28 android.RegisterSingletonType("dex_bootjars", dexpreoptBootJarsFactory)
29}
30
31// The image "location" is a symbolic path that with multiarchitecture
32// support doesn't really exist on the device. Typically it is
33// /system/framework/boot.art and should be the same for all supported
34// architectures on the device. The concrete architecture specific
35// content actually ends up in a "filename" that contains an
36// architecture specific directory name such as arm, arm64, mips,
37// mips64, x86, x86_64.
38//
39// Here are some example values for an x86_64 / x86 configuration:
40//
41// bootImages["x86_64"] = "out/soong/generic_x86_64/dex_bootjars/system/framework/x86_64/boot.art"
42// dexpreopt.PathToLocation(bootImages["x86_64"], "x86_64") = "out/soong/generic_x86_64/dex_bootjars/system/framework/boot.art"
43//
44// bootImages["x86"] = "out/soong/generic_x86_64/dex_bootjars/system/framework/x86/boot.art"
45// dexpreopt.PathToLocation(bootImages["x86"])= "out/soong/generic_x86_64/dex_bootjars/system/framework/boot.art"
46//
47// The location is passed as an argument to the ART tools like dex2oat instead of the real path. The ART tools
48// will then reconstruct the real path, so the rules must have a dependency on the real path.
49
David Srbeckyc177ebe2020-02-18 20:43:06 +000050// Target-independent description of pre-compiled boot image.
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
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000070 // The names of jars that constitute this image.
71 modules []string
72
73 // The "locations" of jars.
74 dexLocations []string // for this image
75 dexLocationsDeps []string // for the dependency images and in this image
76
77 // File paths to jars.
78 dexPaths android.WritablePaths // for this image
79 dexPathsDeps android.WritablePaths // for the dependency images and in this image
80
81 // The "locations" of the dependency images and in this image.
82 imageLocations []string
83
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000084 // File path to a zip archive with all image files (or nil, if not needed).
85 zip android.WritablePath
David Srbeckyc177ebe2020-02-18 20:43:06 +000086
87 // Rules which should be used in make to install the outputs.
88 profileInstalls android.RuleBuilderInstalls
89
90 // Target-dependent fields.
91 variants []*bootImageVariant
92}
93
94// Target-dependent description of pre-compiled boot image.
95type bootImageVariant struct {
96 *bootImageConfig
97
98 // Target for which the image is generated.
99 target android.Target
100
101 // Paths to image files.
102 images android.OutputPath // first image file
103 imagesDeps android.OutputPaths // all files
104
105 // Only for extensions, paths to the primary boot images.
106 primaryImages android.OutputPath
107
108 // Rules which should be used in make to install the outputs.
109 installs android.RuleBuilderInstalls
110 vdexInstalls android.RuleBuilderInstalls
111 unstrippedInstalls android.RuleBuilderInstalls
112}
113
114func (image bootImageConfig) getVariant(target android.Target) *bootImageVariant {
115 for _, variant := range image.variants {
116 if variant.target.Os == target.Os && variant.target.Arch.ArchType == target.Arch.ArchType {
117 return variant
118 }
119 }
120 return nil
Colin Cross800fe132019-02-11 14:21:24 -0800121}
122
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000123func (image bootImageConfig) moduleName(idx int) string {
124 // Dexpreopt on the boot class path produces multiple files. The first dex file
125 // is converted into 'name'.art (to match the legacy assumption that 'name'.art
Dan Willemsen0f416782019-06-13 21:44:53 +0000126 // exists), and the rest are converted to 'name'-<jar>.art.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000127 m := image.modules[idx]
128 name := image.stem
129 if idx != 0 || image.extension {
130 name += "-" + stemOf(m)
131 }
132 return name
133}
Dan Willemsen0f416782019-06-13 21:44:53 +0000134
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000135func (image bootImageConfig) firstModuleNameOrStem() string {
136 if len(image.modules) > 0 {
137 return image.moduleName(0)
138 } else {
139 return image.stem
140 }
141}
142
143func (image bootImageConfig) moduleFiles(ctx android.PathContext, dir android.OutputPath, exts ...string) android.OutputPaths {
144 ret := make(android.OutputPaths, 0, len(image.modules)*len(exts))
145 for i := range image.modules {
146 name := image.moduleName(i)
Dan Willemsen0f416782019-06-13 21:44:53 +0000147 for _, ext := range exts {
148 ret = append(ret, dir.Join(ctx, name+ext))
149 }
150 }
Dan Willemsen0f416782019-06-13 21:44:53 +0000151 return ret
152}
153
Colin Cross800fe132019-02-11 14:21:24 -0800154func concat(lists ...[]string) []string {
155 var size int
156 for _, l := range lists {
157 size += len(l)
158 }
159 ret := make([]string, 0, size)
160 for _, l := range lists {
161 ret = append(ret, l...)
162 }
163 return ret
164}
165
Colin Cross800fe132019-02-11 14:21:24 -0800166func dexpreoptBootJarsFactory() android.Singleton {
Colin Cross44df5812019-02-15 23:06:46 -0800167 return &dexpreoptBootJars{}
Colin Cross800fe132019-02-11 14:21:24 -0800168}
169
170func skipDexpreoptBootJars(ctx android.PathContext) bool {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000171 if dexpreopt.GetGlobalConfig(ctx).DisablePreopt {
Ulya Trafimovichacb33e02019-11-01 17:57:29 +0000172 return true
173 }
174
Colin Cross800fe132019-02-11 14:21:24 -0800175 if ctx.Config().UnbundledBuild() {
176 return true
177 }
178
Colin Cross800fe132019-02-11 14:21:24 -0800179 return false
180}
181
Colin Cross44df5812019-02-15 23:06:46 -0800182type dexpreoptBootJars struct {
David Srbeckyc177ebe2020-02-18 20:43:06 +0000183 defaultBootImage *bootImageConfig
184 otherImages []*bootImageConfig
Colin Cross2d00f0d2019-05-09 21:50:00 -0700185
186 dexpreoptConfigForMake android.WritablePath
Colin Cross44df5812019-02-15 23:06:46 -0800187}
Colin Cross800fe132019-02-11 14:21:24 -0800188
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000189// Accessor function for the apex package. Returns nil if dexpreopt is disabled.
Ulya Trafimovich5b88fe32020-03-11 11:19:26 +0000190func DexpreoptedArtApexJars(ctx android.BuilderContext) (map[android.ArchType]android.OutputPaths, android.OutputPaths) {
Ulya Trafimovich44561882020-01-03 13:25:54 +0000191 if skipDexpreoptBootJars(ctx) {
Ulya Trafimovich5b88fe32020-03-11 11:19:26 +0000192 return nil, nil
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000193 }
Ulya Trafimovich5b88fe32020-03-11 11:19:26 +0000194
195 image := artBootImageConfig(ctx)
196
197 // Target-independent boot image files (*.vdex).
198 anyTarget := image.variants[0].target
199 vdexDir := image.dir.Join(ctx, anyTarget.Os.String(), image.installSubdir, anyTarget.Arch.ArchType.String())
200 vdexFiles := image.moduleFiles(ctx, vdexDir, ".vdex")
201
202 // Target-specific boot image files (*.oat, *.art).
203 artAndOatFiles := map[android.ArchType]android.OutputPaths{}
204 for _, variant := range image.variants {
David Srbecky7f8dac12020-02-13 16:00:45 +0000205 // We also generate boot images for host (for testing), but we don't need those in the apex.
Ulya Trafimovich5b88fe32020-03-11 11:19:26 +0000206 os := variant.target.Os
207 if os == android.Android {
208 arch := variant.target.Arch.ArchType
209 archDir := image.dir.Join(ctx, os.String(), image.installSubdir, arch.String())
210 artAndOatFiles[arch] = image.moduleFiles(ctx, archDir, ".art", ".oat")
David Srbecky7f8dac12020-02-13 16:00:45 +0000211 }
David Srbeckyc177ebe2020-02-18 20:43:06 +0000212 }
Ulya Trafimovich5b88fe32020-03-11 11:19:26 +0000213
214 return artAndOatFiles, vdexFiles
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000215}
216
Colin Cross800fe132019-02-11 14:21:24 -0800217// dexpreoptBoot singleton rules
Colin Cross44df5812019-02-15 23:06:46 -0800218func (d *dexpreoptBootJars) GenerateBuildActions(ctx android.SingletonContext) {
Colin Cross800fe132019-02-11 14:21:24 -0800219 if skipDexpreoptBootJars(ctx) {
220 return
221 }
Martin Stjernholm6d415272020-01-31 17:10:36 +0000222 if dexpreopt.GetCachedGlobalSoongConfig(ctx) == nil {
223 // No module has enabled dexpreopting, so we assume there will be no boot image to make.
224 return
225 }
Colin Cross800fe132019-02-11 14:21:24 -0800226
Colin Cross2d00f0d2019-05-09 21:50:00 -0700227 d.dexpreoptConfigForMake = android.PathForOutput(ctx, ctx.Config().DeviceName(), "dexpreopt.config")
228 writeGlobalConfigForMake(ctx, d.dexpreoptConfigForMake)
229
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000230 global := dexpreopt.GetGlobalConfig(ctx)
Colin Cross800fe132019-02-11 14:21:24 -0800231
232 // Skip recompiling the boot image for the second sanitization phase. We'll get separate paths
233 // and invalidate first-stage artifacts which are crucial to SANITIZE_LITE builds.
234 // Note: this is technically incorrect. Compiled code contains stack checks which may depend
235 // on ASAN settings.
236 if len(ctx.Config().SanitizeDevice()) == 1 &&
237 ctx.Config().SanitizeDevice()[0] == "address" &&
Colin Cross44df5812019-02-15 23:06:46 -0800238 global.SanitizeLite {
Colin Cross800fe132019-02-11 14:21:24 -0800239 return
240 }
241
Lingfeng Yang54191fa2019-12-19 16:40:09 +0000242 // Always create the default boot image first, to get a unique profile rule for all images.
243 d.defaultBootImage = buildBootImage(ctx, defaultBootImageConfig(ctx))
Ulya Trafimovich44561882020-01-03 13:25:54 +0000244 // Create boot image for the ART apex (build artifacts are accessed via the global boot image config).
245 d.otherImages = append(d.otherImages, buildBootImage(ctx, artBootImageConfig(ctx)))
Colin Crossc9a4c362019-02-26 21:13:48 -0800246
247 dumpOatRules(ctx, d.defaultBootImage)
Colin Cross44df5812019-02-15 23:06:46 -0800248}
249
David Srbeckyc177ebe2020-02-18 20:43:06 +0000250// buildBootImage takes a bootImageConfig, creates rules to build it, and returns the image.
251func buildBootImage(ctx android.SingletonContext, image *bootImageConfig) *bootImageConfig {
Colin Cross44df5812019-02-15 23:06:46 -0800252 bootDexJars := make(android.Paths, len(image.modules))
Colin Cross800fe132019-02-11 14:21:24 -0800253 ctx.VisitAllModules(func(module android.Module) {
254 // Collect dex jar paths for the modules listed above.
Colin Cross42be7612019-02-21 18:12:14 -0800255 if j, ok := module.(interface{ DexJar() android.Path }); ok {
Colin Cross800fe132019-02-11 14:21:24 -0800256 name := ctx.ModuleName(module)
Colin Cross44df5812019-02-15 23:06:46 -0800257 if i := android.IndexList(name, image.modules); i != -1 {
Colin Cross800fe132019-02-11 14:21:24 -0800258 bootDexJars[i] = j.DexJar()
259 }
260 }
261 })
262
263 var missingDeps []string
264 // Ensure all modules were converted to paths
265 for i := range bootDexJars {
266 if bootDexJars[i] == nil {
267 if ctx.Config().AllowMissingDependencies() {
Colin Cross44df5812019-02-15 23:06:46 -0800268 missingDeps = append(missingDeps, image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800269 bootDexJars[i] = android.PathForOutput(ctx, "missing")
270 } else {
271 ctx.Errorf("failed to find dex jar path for module %q",
Colin Cross44df5812019-02-15 23:06:46 -0800272 image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800273 }
274 }
275 }
276
277 // The path to bootclasspath dex files needs to be known at module GenerateAndroidBuildAction time, before
278 // the bootclasspath modules have been compiled. Copy the dex jars there so the module rules that have
279 // already been set up can find them.
280 for i := range bootDexJars {
281 ctx.Build(pctx, android.BuildParams{
282 Rule: android.Cp,
283 Input: bootDexJars[i],
Colin Cross44df5812019-02-15 23:06:46 -0800284 Output: image.dexPaths[i],
Colin Cross800fe132019-02-11 14:21:24 -0800285 })
286 }
287
Colin Cross44df5812019-02-15 23:06:46 -0800288 profile := bootImageProfileRule(ctx, image, missingDeps)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100289 bootFrameworkProfileRule(ctx, image, missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800290
Colin Crossdf8eebe2019-04-09 15:29:41 -0700291 var allFiles android.Paths
David Srbeckyc177ebe2020-02-18 20:43:06 +0000292 for _, variant := range image.variants {
293 files := buildBootImageVariant(ctx, variant, profile, missingDeps)
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000294 allFiles = append(allFiles, files.Paths()...)
Colin Cross800fe132019-02-11 14:21:24 -0800295 }
Colin Cross44df5812019-02-15 23:06:46 -0800296
Colin Crossdf8eebe2019-04-09 15:29:41 -0700297 if image.zip != nil {
298 rule := android.NewRuleBuilder()
299 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -0700300 BuiltTool(ctx, "soong_zip").
Colin Crossdf8eebe2019-04-09 15:29:41 -0700301 FlagWithOutput("-o ", image.zip).
302 FlagWithArg("-C ", image.dir.String()).
303 FlagWithInputList("-f ", allFiles, " -f ")
304
305 rule.Build(pctx, ctx, "zip_"+image.name, "zip "+image.name+" image")
306 }
307
Colin Cross44df5812019-02-15 23:06:46 -0800308 return image
Colin Cross800fe132019-02-11 14:21:24 -0800309}
310
David Srbeckyc177ebe2020-02-18 20:43:06 +0000311func buildBootImageVariant(ctx android.SingletonContext, image *bootImageVariant,
312 profile android.Path, missingDeps []string) android.WritablePaths {
Colin Cross800fe132019-02-11 14:21:24 -0800313
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000314 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000315 global := dexpreopt.GetGlobalConfig(ctx)
Colin Cross44df5812019-02-15 23:06:46 -0800316
David Srbeckyc177ebe2020-02-18 20:43:06 +0000317 arch := image.target.Arch.ArchType
David Srbecky7f8dac12020-02-13 16:00:45 +0000318 os := image.target.Os.String() // We need to distinguish host-x86 and device-x86.
319 symbolsDir := image.symbolsDir.Join(ctx, os, image.installSubdir, arch.String())
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000320 symbolsFile := symbolsDir.Join(ctx, image.stem+".oat")
David Srbecky7f8dac12020-02-13 16:00:45 +0000321 outputDir := image.dir.Join(ctx, os, image.installSubdir, arch.String())
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000322 outputPath := outputDir.Join(ctx, image.stem+".oat")
323 oatLocation := dexpreopt.PathToLocation(outputPath, arch)
324 imagePath := outputPath.ReplaceExtension(ctx, "art")
Colin Cross800fe132019-02-11 14:21:24 -0800325
326 rule := android.NewRuleBuilder()
327 rule.MissingDeps(missingDeps)
328
329 rule.Command().Text("mkdir").Flag("-p").Flag(symbolsDir.String())
330 rule.Command().Text("rm").Flag("-f").
331 Flag(symbolsDir.Join(ctx, "*.art").String()).
332 Flag(symbolsDir.Join(ctx, "*.oat").String()).
333 Flag(symbolsDir.Join(ctx, "*.invocation").String())
334 rule.Command().Text("rm").Flag("-f").
335 Flag(outputDir.Join(ctx, "*.art").String()).
336 Flag(outputDir.Join(ctx, "*.oat").String()).
337 Flag(outputDir.Join(ctx, "*.invocation").String())
338
339 cmd := rule.Command()
340
341 extraFlags := ctx.Config().Getenv("ART_BOOT_IMAGE_EXTRA_ARGS")
342 if extraFlags == "" {
343 // Use ANDROID_LOG_TAGS to suppress most logging by default...
344 cmd.Text(`ANDROID_LOG_TAGS="*:e"`)
345 } else {
346 // ...unless the boot image is generated specifically for testing, then allow all logging.
347 cmd.Text(`ANDROID_LOG_TAGS="*:v"`)
348 }
349
350 invocationPath := outputPath.ReplaceExtension(ctx, "invocation")
351
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000352 cmd.Tool(globalSoong.Dex2oat).
Colin Cross800fe132019-02-11 14:21:24 -0800353 Flag("--avoid-storing-invocation").
Colin Cross69f59a32019-02-15 10:39:37 -0800354 FlagWithOutput("--write-invocation-to=", invocationPath).ImplicitOutput(invocationPath).
Colin Cross44df5812019-02-15 23:06:46 -0800355 Flag("--runtime-arg").FlagWithArg("-Xms", global.Dex2oatImageXms).
356 Flag("--runtime-arg").FlagWithArg("-Xmx", global.Dex2oatImageXmx)
Colin Cross800fe132019-02-11 14:21:24 -0800357
Colin Cross69f59a32019-02-15 10:39:37 -0800358 if profile != nil {
Colin Cross800fe132019-02-11 14:21:24 -0800359 cmd.FlagWithArg("--compiler-filter=", "speed-profile")
Colin Cross69f59a32019-02-15 10:39:37 -0800360 cmd.FlagWithInput("--profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800361 }
362
Colin Cross44df5812019-02-15 23:06:46 -0800363 if global.DirtyImageObjects.Valid() {
364 cmd.FlagWithInput("--dirty-image-objects=", global.DirtyImageObjects.Path())
Colin Cross800fe132019-02-11 14:21:24 -0800365 }
366
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000367 if image.extension {
David Srbeckyc177ebe2020-02-18 20:43:06 +0000368 artImage := image.primaryImages
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000369 cmd.
370 Flag("--runtime-arg").FlagWithInputList("-Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
371 Flag("--runtime-arg").FlagWithList("-Xbootclasspath-locations:", image.dexLocationsDeps, ":").
372 FlagWithArg("--boot-image=", dexpreopt.PathToLocation(artImage, arch)).Implicit(artImage)
373 } else {
374 cmd.FlagWithArg("--base=", ctx.Config().LibartImgDeviceBaseAddress())
375 }
376
Colin Cross800fe132019-02-11 14:21:24 -0800377 cmd.
Colin Cross44df5812019-02-15 23:06:46 -0800378 FlagForEachInput("--dex-file=", image.dexPaths.Paths()).
379 FlagForEachArg("--dex-location=", image.dexLocations).
Colin Cross800fe132019-02-11 14:21:24 -0800380 Flag("--generate-debug-info").
381 Flag("--generate-build-id").
Mathieu Chartier54fd8072019-07-26 13:50:04 -0700382 Flag("--image-format=lz4hc").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000383 FlagWithArg("--oat-symbols=", symbolsFile.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800384 Flag("--strip").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000385 FlagWithArg("--oat-file=", outputPath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800386 FlagWithArg("--oat-location=", oatLocation).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000387 FlagWithArg("--image=", imagePath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800388 FlagWithArg("--instruction-set=", arch.String()).
Colin Cross44df5812019-02-15 23:06:46 -0800389 FlagWithArg("--android-root=", global.EmptyDirectory).
Colin Cross800fe132019-02-11 14:21:24 -0800390 FlagWithArg("--no-inline-from=", "core-oj.jar").
Ulya Trafimovichc0c98d52020-03-09 12:46:06 +0000391 Flag("--force-determinism").
Colin Cross800fe132019-02-11 14:21:24 -0800392 Flag("--abort-on-hard-verifier-error")
393
David Srbecky7f8dac12020-02-13 16:00:45 +0000394 // Use the default variant/features for host builds.
395 // The map below contains only device CPU info (which might be x86 on some devices).
396 if image.target.Os == android.Android {
397 cmd.FlagWithArg("--instruction-set-variant=", global.CpuVariant[arch])
398 cmd.FlagWithArg("--instruction-set-features=", global.InstructionSetFeatures[arch])
399 }
400
Colin Cross44df5812019-02-15 23:06:46 -0800401 if global.BootFlags != "" {
402 cmd.Flag(global.BootFlags)
Colin Cross800fe132019-02-11 14:21:24 -0800403 }
404
405 if extraFlags != "" {
406 cmd.Flag(extraFlags)
407 }
408
Colin Cross0b9f31f2019-02-28 11:00:01 -0800409 cmd.Textf(`|| ( echo %s ; false )`, proptools.ShellEscape(failureMessage))
Colin Cross800fe132019-02-11 14:21:24 -0800410
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000411 installDir := filepath.Join("/", image.installSubdir, arch.String())
Colin Cross800fe132019-02-11 14:21:24 -0800412
Colin Cross800fe132019-02-11 14:21:24 -0800413 var vdexInstalls android.RuleBuilderInstalls
414 var unstrippedInstalls android.RuleBuilderInstalls
415
Colin Crossdf8eebe2019-04-09 15:29:41 -0700416 var zipFiles android.WritablePaths
417
Dan Willemsen0f416782019-06-13 21:44:53 +0000418 for _, artOrOat := range image.moduleFiles(ctx, outputDir, ".art", ".oat") {
419 cmd.ImplicitOutput(artOrOat)
420 zipFiles = append(zipFiles, artOrOat)
Colin Cross800fe132019-02-11 14:21:24 -0800421
Dan Willemsen0f416782019-06-13 21:44:53 +0000422 // Install the .oat and .art files
423 rule.Install(artOrOat, filepath.Join(installDir, artOrOat.Base()))
424 }
Colin Cross800fe132019-02-11 14:21:24 -0800425
Dan Willemsen0f416782019-06-13 21:44:53 +0000426 for _, vdex := range image.moduleFiles(ctx, outputDir, ".vdex") {
427 cmd.ImplicitOutput(vdex)
428 zipFiles = append(zipFiles, vdex)
Colin Cross800fe132019-02-11 14:21:24 -0800429
David Srbecky7f8dac12020-02-13 16:00:45 +0000430 // Note that the vdex files are identical between architectures.
431 // Make rules will create symlinks to share them between architectures.
Colin Cross800fe132019-02-11 14:21:24 -0800432 vdexInstalls = append(vdexInstalls,
David Srbecky7f8dac12020-02-13 16:00:45 +0000433 android.RuleBuilderInstall{vdex, filepath.Join(installDir, vdex.Base())})
Dan Willemsen0f416782019-06-13 21:44:53 +0000434 }
435
436 for _, unstrippedOat := range image.moduleFiles(ctx, symbolsDir, ".oat") {
437 cmd.ImplicitOutput(unstrippedOat)
Colin Cross800fe132019-02-11 14:21:24 -0800438
439 // Install the unstripped oat files. The Make rules will put these in $(TARGET_OUT_UNSTRIPPED)
440 unstrippedInstalls = append(unstrippedInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800441 android.RuleBuilderInstall{unstrippedOat, filepath.Join(installDir, unstrippedOat.Base())})
Colin Cross800fe132019-02-11 14:21:24 -0800442 }
443
David Srbecky7f8dac12020-02-13 16:00:45 +0000444 rule.Build(pctx, ctx, image.name+"JarsDexpreopt_"+image.target.String(), "dexpreopt "+image.name+" jars "+arch.String())
Colin Cross800fe132019-02-11 14:21:24 -0800445
446 // save output and installed files for makevars
David Srbeckyc177ebe2020-02-18 20:43:06 +0000447 image.installs = rule.Installs()
448 image.vdexInstalls = vdexInstalls
449 image.unstrippedInstalls = unstrippedInstalls
Colin Crossdf8eebe2019-04-09 15:29:41 -0700450
451 return zipFiles
Colin Cross800fe132019-02-11 14:21:24 -0800452}
453
454const failureMessage = `ERROR: Dex2oat failed to compile a boot image.
455It is likely that the boot classpath is inconsistent.
456Rebuild with ART_BOOT_IMAGE_EXTRA_ARGS="--runtime-arg -verbose:verifier" to see verification errors.`
457
David Srbeckyc177ebe2020-02-18 20:43:06 +0000458func bootImageProfileRule(ctx android.SingletonContext, image *bootImageConfig, missingDeps []string) android.WritablePath {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000459 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000460 global := dexpreopt.GetGlobalConfig(ctx)
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000461
Mathieu Chartier6adeee12019-06-26 10:01:36 -0700462 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000463 return nil
464 }
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000465 profile := ctx.Config().Once(bootImageProfileRuleKey, func() interface{} {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000466 defaultProfile := "frameworks/base/config/boot-image-profile.txt"
Colin Cross800fe132019-02-11 14:21:24 -0800467
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000468 rule := android.NewRuleBuilder()
469 rule.MissingDeps(missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800470
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000471 var bootImageProfile android.Path
472 if len(global.BootImageProfiles) > 1 {
473 combinedBootImageProfile := image.dir.Join(ctx, "boot-image-profile.txt")
474 rule.Command().Text("cat").Inputs(global.BootImageProfiles).Text(">").Output(combinedBootImageProfile)
475 bootImageProfile = combinedBootImageProfile
476 } else if len(global.BootImageProfiles) == 1 {
477 bootImageProfile = global.BootImageProfiles[0]
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000478 } else if path := android.ExistentPathForSource(ctx, defaultProfile); path.Valid() {
479 bootImageProfile = path.Path()
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000480 } else {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000481 // No profile (not even a default one, which is the case on some branches
482 // like master-art-host that don't have frameworks/base).
483 // Return nil and continue without profile.
484 return nil
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000485 }
Colin Cross800fe132019-02-11 14:21:24 -0800486
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000487 profile := image.dir.Join(ctx, "boot.prof")
Colin Cross800fe132019-02-11 14:21:24 -0800488
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000489 rule.Command().
490 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000491 Tool(globalSoong.Profman).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000492 FlagWithInput("--create-profile-from=", bootImageProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000493 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
494 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000495 FlagWithOutput("--reference-profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800496
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000497 rule.Install(profile, "/system/etc/boot-image.prof")
498
499 rule.Build(pctx, ctx, "bootJarsProfile", "profile boot jars")
500
501 image.profileInstalls = rule.Installs()
502
503 return profile
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000504 })
505 if profile == nil {
506 return nil // wrap nil into a typed pointer with value nil
507 }
508 return profile.(android.WritablePath)
Colin Cross800fe132019-02-11 14:21:24 -0800509}
510
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000511var bootImageProfileRuleKey = android.NewOnceKey("bootImageProfileRule")
512
David Srbeckyc177ebe2020-02-18 20:43:06 +0000513func bootFrameworkProfileRule(ctx android.SingletonContext, image *bootImageConfig, missingDeps []string) android.WritablePath {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000514 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000515 global := dexpreopt.GetGlobalConfig(ctx)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100516
517 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
518 return nil
519 }
520 return ctx.Config().Once(bootFrameworkProfileRuleKey, func() interface{} {
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100521 rule := android.NewRuleBuilder()
522 rule.MissingDeps(missingDeps)
523
524 // Some branches like master-art-host don't have frameworks/base, so manually
525 // handle the case that the default is missing. Those branches won't attempt to build the profile rule,
526 // and if they do they'll get a missing deps error.
527 defaultProfile := "frameworks/base/config/boot-profile.txt"
528 path := android.ExistentPathForSource(ctx, defaultProfile)
529 var bootFrameworkProfile android.Path
530 if path.Valid() {
531 bootFrameworkProfile = path.Path()
532 } else {
533 missingDeps = append(missingDeps, defaultProfile)
534 bootFrameworkProfile = android.PathForOutput(ctx, "missing")
535 }
536
537 profile := image.dir.Join(ctx, "boot.bprof")
538
539 rule.Command().
540 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000541 Tool(globalSoong.Profman).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100542 Flag("--generate-boot-profile").
543 FlagWithInput("--create-profile-from=", bootFrameworkProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000544 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
545 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100546 FlagWithOutput("--reference-profile-file=", profile)
547
548 rule.Install(profile, "/system/etc/boot-image.bprof")
549 rule.Build(pctx, ctx, "bootFrameworkProfile", "profile boot framework jars")
550 image.profileInstalls = append(image.profileInstalls, rule.Installs()...)
551
552 return profile
553 }).(android.WritablePath)
554}
555
556var bootFrameworkProfileRuleKey = android.NewOnceKey("bootFrameworkProfileRule")
557
David Srbeckyc177ebe2020-02-18 20:43:06 +0000558func dumpOatRules(ctx android.SingletonContext, image *bootImageConfig) {
Colin Crossc9a4c362019-02-26 21:13:48 -0800559 var allPhonies android.Paths
David Srbeckyc177ebe2020-02-18 20:43:06 +0000560 for _, image := range image.variants {
561 arch := image.target.Arch.ArchType
David Srbecky7f8dac12020-02-13 16:00:45 +0000562 suffix := image.target.String()
Colin Crossc9a4c362019-02-26 21:13:48 -0800563 // Create a rule to call oatdump.
David Srbecky7f8dac12020-02-13 16:00:45 +0000564 output := android.PathForOutput(ctx, "boot."+suffix+".oatdump.txt")
Colin Crossc9a4c362019-02-26 21:13:48 -0800565 rule := android.NewRuleBuilder()
566 rule.Command().
567 // TODO: for now, use the debug version for better error reporting
Colin Crossee94d6a2019-07-08 17:08:34 -0700568 BuiltTool(ctx, "oatdumpd").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000569 FlagWithInputList("--runtime-arg -Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
570 FlagWithList("--runtime-arg -Xbootclasspath-locations:", image.dexLocationsDeps, ":").
David Srbeckyc177ebe2020-02-18 20:43:06 +0000571 FlagWithArg("--image=", strings.Join(image.imageLocations, ":")).Implicits(image.imagesDeps.Paths()).
Colin Crossc9a4c362019-02-26 21:13:48 -0800572 FlagWithOutput("--output=", output).
573 FlagWithArg("--instruction-set=", arch.String())
David Srbecky7f8dac12020-02-13 16:00:45 +0000574 rule.Build(pctx, ctx, "dump-oat-boot-"+suffix, "dump oat boot "+arch.String())
Colin Crossc9a4c362019-02-26 21:13:48 -0800575
576 // Create a phony rule that depends on the output file and prints the path.
David Srbecky7f8dac12020-02-13 16:00:45 +0000577 phony := android.PathForPhony(ctx, "dump-oat-boot-"+suffix)
Colin Crossc9a4c362019-02-26 21:13:48 -0800578 rule = android.NewRuleBuilder()
579 rule.Command().
580 Implicit(output).
581 ImplicitOutput(phony).
582 Text("echo").FlagWithArg("Output in ", output.String())
David Srbecky7f8dac12020-02-13 16:00:45 +0000583 rule.Build(pctx, ctx, "phony-dump-oat-boot-"+suffix, "dump oat boot "+arch.String())
Colin Crossc9a4c362019-02-26 21:13:48 -0800584
585 allPhonies = append(allPhonies, phony)
586 }
587
588 phony := android.PathForPhony(ctx, "dump-oat-boot")
589 ctx.Build(pctx, android.BuildParams{
590 Rule: android.Phony,
591 Output: phony,
592 Inputs: allPhonies,
593 Description: "dump-oat-boot",
594 })
595
596}
597
Colin Cross2d00f0d2019-05-09 21:50:00 -0700598func writeGlobalConfigForMake(ctx android.SingletonContext, path android.WritablePath) {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000599 data := dexpreopt.GetGlobalConfigRawData(ctx)
Colin Cross2d00f0d2019-05-09 21:50:00 -0700600
601 ctx.Build(pctx, android.BuildParams{
602 Rule: android.WriteFile,
603 Output: path,
604 Args: map[string]string{
605 "content": string(data),
606 },
607 })
608}
609
Colin Cross44df5812019-02-15 23:06:46 -0800610// Export paths for default boot image to Make
611func (d *dexpreoptBootJars) MakeVars(ctx android.MakeVarsContext) {
Colin Cross2d00f0d2019-05-09 21:50:00 -0700612 if d.dexpreoptConfigForMake != nil {
613 ctx.Strict("DEX_PREOPT_CONFIG_FOR_MAKE", d.dexpreoptConfigForMake.String())
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000614 ctx.Strict("DEX_PREOPT_SOONG_CONFIG_FOR_MAKE", android.PathForOutput(ctx, "dexpreopt_soong.config").String())
Colin Cross2d00f0d2019-05-09 21:50:00 -0700615 }
616
Colin Cross44df5812019-02-15 23:06:46 -0800617 image := d.defaultBootImage
618 if image != nil {
Colin Cross44df5812019-02-15 23:06:46 -0800619 ctx.Strict("DEXPREOPT_IMAGE_PROFILE_BUILT_INSTALLED", image.profileInstalls.String())
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000620 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_FILES", strings.Join(image.dexPathsDeps.Strings(), " "))
621 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_LOCATIONS", strings.Join(image.dexLocationsDeps, " "))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000622
623 var imageNames []string
624 for _, current := range append(d.otherImages, image) {
625 imageNames = append(imageNames, current.name)
David Srbeckyc177ebe2020-02-18 20:43:06 +0000626 for _, current := range current.variants {
David Srbecky7f8dac12020-02-13 16:00:45 +0000627 suffix := ""
628 if current.target.Os.Class == android.Host {
629 suffix = "_host"
630 }
631 sfx := current.name + suffix + "_" + current.target.Arch.ArchType.String()
David Srbeckyc177ebe2020-02-18 20:43:06 +0000632 ctx.Strict("DEXPREOPT_IMAGE_VDEX_BUILT_INSTALLED_"+sfx, current.vdexInstalls.String())
633 ctx.Strict("DEXPREOPT_IMAGE_"+sfx, current.images.String())
634 ctx.Strict("DEXPREOPT_IMAGE_DEPS_"+sfx, strings.Join(current.imagesDeps.Strings(), " "))
635 ctx.Strict("DEXPREOPT_IMAGE_BUILT_INSTALLED_"+sfx, current.installs.String())
636 ctx.Strict("DEXPREOPT_IMAGE_UNSTRIPPED_BUILT_INSTALLED_"+sfx, current.unstrippedInstalls.String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000637 }
Colin Cross31bf00d2019-12-04 13:16:01 -0800638
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000639 ctx.Strict("DEXPREOPT_IMAGE_LOCATIONS_"+current.name, strings.Join(current.imageLocations, ":"))
Colin Cross31bf00d2019-12-04 13:16:01 -0800640 ctx.Strict("DEXPREOPT_IMAGE_ZIP_"+current.name, current.zip.String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000641 }
642 ctx.Strict("DEXPREOPT_IMAGE_NAMES", strings.Join(imageNames, " "))
Colin Cross800fe132019-02-11 14:21:24 -0800643 }
Colin Cross800fe132019-02-11 14:21:24 -0800644}