blob: a497b08fcdfbe46429e715291d56139906a92927 [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
Colin Cross44df5812019-02-15 23:06:46 -0800181type dexpreoptBootJars struct {
182 defaultBootImage *bootImage
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000183 otherImages []*bootImage
Colin Cross2d00f0d2019-05-09 21:50:00 -0700184
185 dexpreoptConfigForMake android.WritablePath
Colin Cross44df5812019-02-15 23:06:46 -0800186}
Colin Cross800fe132019-02-11 14:21:24 -0800187
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000188// Accessor function for the apex package. Returns nil if dexpreopt is disabled.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000189func DexpreoptedArtApexJars(ctx android.BuilderContext) map[android.ArchType]android.OutputPaths {
Ulya Trafimovich44561882020-01-03 13:25:54 +0000190 if skipDexpreoptBootJars(ctx) {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000191 return nil
192 }
Ulya Trafimovich7eebb4f2020-01-22 13:41:06 +0000193
194 // Include dexpreopt files for the primary boot image.
195 files := artBootImageConfig(ctx).imagesDeps
196
197 // For JIT-zygote config, also include dexpreopt files for the primary JIT-zygote image.
198 if dexpreoptGlobalConfig(ctx).UseApexImage {
199 for arch, paths := range artJZBootImageConfig(ctx).imagesDeps {
200 files[arch] = append(files[arch], paths...)
201 }
202 }
203
204 return files
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000205}
206
Colin Cross800fe132019-02-11 14:21:24 -0800207// dexpreoptBoot singleton rules
Colin Cross44df5812019-02-15 23:06:46 -0800208func (d *dexpreoptBootJars) GenerateBuildActions(ctx android.SingletonContext) {
Colin Cross800fe132019-02-11 14:21:24 -0800209 if skipDexpreoptBootJars(ctx) {
210 return
211 }
212
Colin Cross2d00f0d2019-05-09 21:50:00 -0700213 d.dexpreoptConfigForMake = android.PathForOutput(ctx, ctx.Config().DeviceName(), "dexpreopt.config")
214 writeGlobalConfigForMake(ctx, d.dexpreoptConfigForMake)
215
Colin Cross44df5812019-02-15 23:06:46 -0800216 global := dexpreoptGlobalConfig(ctx)
Colin Cross800fe132019-02-11 14:21:24 -0800217
218 // Skip recompiling the boot image for the second sanitization phase. We'll get separate paths
219 // and invalidate first-stage artifacts which are crucial to SANITIZE_LITE builds.
220 // Note: this is technically incorrect. Compiled code contains stack checks which may depend
221 // on ASAN settings.
222 if len(ctx.Config().SanitizeDevice()) == 1 &&
223 ctx.Config().SanitizeDevice()[0] == "address" &&
Colin Cross44df5812019-02-15 23:06:46 -0800224 global.SanitizeLite {
Colin Cross800fe132019-02-11 14:21:24 -0800225 return
226 }
227
Lingfeng Yang54191fa2019-12-19 16:40:09 +0000228 // Always create the default boot image first, to get a unique profile rule for all images.
229 d.defaultBootImage = buildBootImage(ctx, defaultBootImageConfig(ctx))
Ulya Trafimovich44561882020-01-03 13:25:54 +0000230 // Create boot image for the ART apex (build artifacts are accessed via the global boot image config).
231 d.otherImages = append(d.otherImages, buildBootImage(ctx, artBootImageConfig(ctx)))
Lingfeng Yang54191fa2019-12-19 16:40:09 +0000232 if global.GenerateApexImage {
233 // Create boot images for the JIT-zygote experiment.
Ulya Trafimovich57547452019-12-09 15:40:17 +0000234 d.otherImages = append(d.otherImages, buildBootImage(ctx, artJZBootImageConfig(ctx)))
235 d.otherImages = append(d.otherImages, buildBootImage(ctx, frameworkJZBootImageConfig(ctx)))
Lingfeng Yang54191fa2019-12-19 16:40:09 +0000236 }
Colin Crossc9a4c362019-02-26 21:13:48 -0800237
238 dumpOatRules(ctx, d.defaultBootImage)
Colin Cross44df5812019-02-15 23:06:46 -0800239}
240
241// buildBootImage takes a bootImageConfig, creates rules to build it, and returns a *bootImage.
242func buildBootImage(ctx android.SingletonContext, config bootImageConfig) *bootImage {
Colin Cross44df5812019-02-15 23:06:46 -0800243 image := newBootImage(ctx, config)
244
245 bootDexJars := make(android.Paths, len(image.modules))
Colin Cross800fe132019-02-11 14:21:24 -0800246 ctx.VisitAllModules(func(module android.Module) {
247 // Collect dex jar paths for the modules listed above.
Colin Cross42be7612019-02-21 18:12:14 -0800248 if j, ok := module.(interface{ DexJar() android.Path }); ok {
Colin Cross800fe132019-02-11 14:21:24 -0800249 name := ctx.ModuleName(module)
Colin Cross44df5812019-02-15 23:06:46 -0800250 if i := android.IndexList(name, image.modules); i != -1 {
Colin Cross800fe132019-02-11 14:21:24 -0800251 bootDexJars[i] = j.DexJar()
252 }
253 }
254 })
255
256 var missingDeps []string
257 // Ensure all modules were converted to paths
258 for i := range bootDexJars {
259 if bootDexJars[i] == nil {
260 if ctx.Config().AllowMissingDependencies() {
Colin Cross44df5812019-02-15 23:06:46 -0800261 missingDeps = append(missingDeps, image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800262 bootDexJars[i] = android.PathForOutput(ctx, "missing")
263 } else {
264 ctx.Errorf("failed to find dex jar path for module %q",
Colin Cross44df5812019-02-15 23:06:46 -0800265 image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800266 }
267 }
268 }
269
270 // The path to bootclasspath dex files needs to be known at module GenerateAndroidBuildAction time, before
271 // the bootclasspath modules have been compiled. Copy the dex jars there so the module rules that have
272 // already been set up can find them.
273 for i := range bootDexJars {
274 ctx.Build(pctx, android.BuildParams{
275 Rule: android.Cp,
276 Input: bootDexJars[i],
Colin Cross44df5812019-02-15 23:06:46 -0800277 Output: image.dexPaths[i],
Colin Cross800fe132019-02-11 14:21:24 -0800278 })
279 }
280
Colin Cross44df5812019-02-15 23:06:46 -0800281 profile := bootImageProfileRule(ctx, image, missingDeps)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100282 bootFrameworkProfileRule(ctx, image, missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800283
Colin Crossdf8eebe2019-04-09 15:29:41 -0700284 var allFiles android.Paths
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000285 for _, target := range image.targets {
286 files := buildBootImageRuleForArch(ctx, image, target.Arch.ArchType, profile, missingDeps)
287 allFiles = append(allFiles, files.Paths()...)
Colin Cross800fe132019-02-11 14:21:24 -0800288 }
Colin Cross44df5812019-02-15 23:06:46 -0800289
Colin Crossdf8eebe2019-04-09 15:29:41 -0700290 if image.zip != nil {
291 rule := android.NewRuleBuilder()
292 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -0700293 BuiltTool(ctx, "soong_zip").
Colin Crossdf8eebe2019-04-09 15:29:41 -0700294 FlagWithOutput("-o ", image.zip).
295 FlagWithArg("-C ", image.dir.String()).
296 FlagWithInputList("-f ", allFiles, " -f ")
297
298 rule.Build(pctx, ctx, "zip_"+image.name, "zip "+image.name+" image")
299 }
300
Colin Cross44df5812019-02-15 23:06:46 -0800301 return image
Colin Cross800fe132019-02-11 14:21:24 -0800302}
303
Colin Cross44df5812019-02-15 23:06:46 -0800304func buildBootImageRuleForArch(ctx android.SingletonContext, image *bootImage,
Colin Crossdf8eebe2019-04-09 15:29:41 -0700305 arch android.ArchType, profile android.Path, missingDeps []string) android.WritablePaths {
Colin Cross800fe132019-02-11 14:21:24 -0800306
Martin Stjernholmbe9d0d22020-01-10 20:32:59 +0000307 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Colin Cross44df5812019-02-15 23:06:46 -0800308 global := dexpreoptGlobalConfig(ctx)
309
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000310 symbolsDir := image.symbolsDir.Join(ctx, image.installSubdir, arch.String())
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000311 symbolsFile := symbolsDir.Join(ctx, image.stem+".oat")
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000312 outputDir := image.dir.Join(ctx, image.installSubdir, arch.String())
313 outputPath := outputDir.Join(ctx, image.stem+".oat")
314 oatLocation := dexpreopt.PathToLocation(outputPath, arch)
315 imagePath := outputPath.ReplaceExtension(ctx, "art")
Colin Cross800fe132019-02-11 14:21:24 -0800316
317 rule := android.NewRuleBuilder()
318 rule.MissingDeps(missingDeps)
319
320 rule.Command().Text("mkdir").Flag("-p").Flag(symbolsDir.String())
321 rule.Command().Text("rm").Flag("-f").
322 Flag(symbolsDir.Join(ctx, "*.art").String()).
323 Flag(symbolsDir.Join(ctx, "*.oat").String()).
324 Flag(symbolsDir.Join(ctx, "*.invocation").String())
325 rule.Command().Text("rm").Flag("-f").
326 Flag(outputDir.Join(ctx, "*.art").String()).
327 Flag(outputDir.Join(ctx, "*.oat").String()).
328 Flag(outputDir.Join(ctx, "*.invocation").String())
329
330 cmd := rule.Command()
331
332 extraFlags := ctx.Config().Getenv("ART_BOOT_IMAGE_EXTRA_ARGS")
333 if extraFlags == "" {
334 // Use ANDROID_LOG_TAGS to suppress most logging by default...
335 cmd.Text(`ANDROID_LOG_TAGS="*:e"`)
336 } else {
337 // ...unless the boot image is generated specifically for testing, then allow all logging.
338 cmd.Text(`ANDROID_LOG_TAGS="*:v"`)
339 }
340
341 invocationPath := outputPath.ReplaceExtension(ctx, "invocation")
342
Martin Stjernholmbe9d0d22020-01-10 20:32:59 +0000343 cmd.Tool(globalSoong.Dex2oat).
Colin Cross800fe132019-02-11 14:21:24 -0800344 Flag("--avoid-storing-invocation").
Colin Cross69f59a32019-02-15 10:39:37 -0800345 FlagWithOutput("--write-invocation-to=", invocationPath).ImplicitOutput(invocationPath).
Colin Cross44df5812019-02-15 23:06:46 -0800346 Flag("--runtime-arg").FlagWithArg("-Xms", global.Dex2oatImageXms).
347 Flag("--runtime-arg").FlagWithArg("-Xmx", global.Dex2oatImageXmx)
Colin Cross800fe132019-02-11 14:21:24 -0800348
Colin Cross69f59a32019-02-15 10:39:37 -0800349 if profile != nil {
Colin Cross800fe132019-02-11 14:21:24 -0800350 cmd.FlagWithArg("--compiler-filter=", "speed-profile")
Colin Cross69f59a32019-02-15 10:39:37 -0800351 cmd.FlagWithInput("--profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800352 }
353
Colin Cross44df5812019-02-15 23:06:46 -0800354 if global.DirtyImageObjects.Valid() {
355 cmd.FlagWithInput("--dirty-image-objects=", global.DirtyImageObjects.Path())
Colin Cross800fe132019-02-11 14:21:24 -0800356 }
357
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000358 if image.extension {
359 artImage := artBootImageConfig(ctx).images[arch]
360 cmd.
361 Flag("--runtime-arg").FlagWithInputList("-Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
362 Flag("--runtime-arg").FlagWithList("-Xbootclasspath-locations:", image.dexLocationsDeps, ":").
363 FlagWithArg("--boot-image=", dexpreopt.PathToLocation(artImage, arch)).Implicit(artImage)
364 } else {
365 cmd.FlagWithArg("--base=", ctx.Config().LibartImgDeviceBaseAddress())
366 }
367
Colin Cross800fe132019-02-11 14:21:24 -0800368 cmd.
Colin Cross44df5812019-02-15 23:06:46 -0800369 FlagForEachInput("--dex-file=", image.dexPaths.Paths()).
370 FlagForEachArg("--dex-location=", image.dexLocations).
Colin Cross800fe132019-02-11 14:21:24 -0800371 Flag("--generate-debug-info").
372 Flag("--generate-build-id").
Mathieu Chartier54fd8072019-07-26 13:50:04 -0700373 Flag("--image-format=lz4hc").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000374 FlagWithArg("--oat-symbols=", symbolsFile.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800375 Flag("--strip").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000376 FlagWithArg("--oat-file=", outputPath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800377 FlagWithArg("--oat-location=", oatLocation).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000378 FlagWithArg("--image=", imagePath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800379 FlagWithArg("--instruction-set=", arch.String()).
Colin Cross44df5812019-02-15 23:06:46 -0800380 FlagWithArg("--instruction-set-variant=", global.CpuVariant[arch]).
381 FlagWithArg("--instruction-set-features=", global.InstructionSetFeatures[arch]).
382 FlagWithArg("--android-root=", global.EmptyDirectory).
Colin Cross800fe132019-02-11 14:21:24 -0800383 FlagWithArg("--no-inline-from=", "core-oj.jar").
384 Flag("--abort-on-hard-verifier-error")
385
Colin Cross44df5812019-02-15 23:06:46 -0800386 if global.BootFlags != "" {
387 cmd.Flag(global.BootFlags)
Colin Cross800fe132019-02-11 14:21:24 -0800388 }
389
390 if extraFlags != "" {
391 cmd.Flag(extraFlags)
392 }
393
Colin Cross0b9f31f2019-02-28 11:00:01 -0800394 cmd.Textf(`|| ( echo %s ; false )`, proptools.ShellEscape(failureMessage))
Colin Cross800fe132019-02-11 14:21:24 -0800395
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000396 installDir := filepath.Join("/", image.installSubdir, arch.String())
397 vdexInstallDir := filepath.Join("/", image.installSubdir)
Colin Cross800fe132019-02-11 14:21:24 -0800398
Colin Cross800fe132019-02-11 14:21:24 -0800399 var vdexInstalls android.RuleBuilderInstalls
400 var unstrippedInstalls android.RuleBuilderInstalls
401
Colin Crossdf8eebe2019-04-09 15:29:41 -0700402 var zipFiles android.WritablePaths
403
Dan Willemsen0f416782019-06-13 21:44:53 +0000404 for _, artOrOat := range image.moduleFiles(ctx, outputDir, ".art", ".oat") {
405 cmd.ImplicitOutput(artOrOat)
406 zipFiles = append(zipFiles, artOrOat)
Colin Cross800fe132019-02-11 14:21:24 -0800407
Dan Willemsen0f416782019-06-13 21:44:53 +0000408 // Install the .oat and .art files
409 rule.Install(artOrOat, filepath.Join(installDir, artOrOat.Base()))
410 }
Colin Cross800fe132019-02-11 14:21:24 -0800411
Dan Willemsen0f416782019-06-13 21:44:53 +0000412 for _, vdex := range image.moduleFiles(ctx, outputDir, ".vdex") {
413 cmd.ImplicitOutput(vdex)
414 zipFiles = append(zipFiles, vdex)
Colin Cross800fe132019-02-11 14:21:24 -0800415
416 // The vdex files are identical between architectures, install them to a shared location. The Make rules will
417 // only use the install rules for one architecture, and will create symlinks into the architecture-specific
418 // directories.
419 vdexInstalls = append(vdexInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800420 android.RuleBuilderInstall{vdex, filepath.Join(vdexInstallDir, vdex.Base())})
Dan Willemsen0f416782019-06-13 21:44:53 +0000421 }
422
423 for _, unstrippedOat := range image.moduleFiles(ctx, symbolsDir, ".oat") {
424 cmd.ImplicitOutput(unstrippedOat)
Colin Cross800fe132019-02-11 14:21:24 -0800425
426 // Install the unstripped oat files. The Make rules will put these in $(TARGET_OUT_UNSTRIPPED)
427 unstrippedInstalls = append(unstrippedInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800428 android.RuleBuilderInstall{unstrippedOat, filepath.Join(installDir, unstrippedOat.Base())})
Colin Cross800fe132019-02-11 14:21:24 -0800429 }
430
Colin Cross44df5812019-02-15 23:06:46 -0800431 rule.Build(pctx, ctx, image.name+"JarsDexpreopt_"+arch.String(), "dexpreopt "+image.name+" jars "+arch.String())
Colin Cross800fe132019-02-11 14:21:24 -0800432
433 // save output and installed files for makevars
Colin Cross44df5812019-02-15 23:06:46 -0800434 image.installs[arch] = rule.Installs()
435 image.vdexInstalls[arch] = vdexInstalls
436 image.unstrippedInstalls[arch] = unstrippedInstalls
Colin Crossdf8eebe2019-04-09 15:29:41 -0700437
438 return zipFiles
Colin Cross800fe132019-02-11 14:21:24 -0800439}
440
441const failureMessage = `ERROR: Dex2oat failed to compile a boot image.
442It is likely that the boot classpath is inconsistent.
443Rebuild with ART_BOOT_IMAGE_EXTRA_ARGS="--runtime-arg -verbose:verifier" to see verification errors.`
444
Colin Cross44df5812019-02-15 23:06:46 -0800445func bootImageProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
Martin Stjernholmbe9d0d22020-01-10 20:32:59 +0000446 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000447 global := dexpreoptGlobalConfig(ctx)
448
Mathieu Chartier6adeee12019-06-26 10:01:36 -0700449 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000450 return nil
451 }
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000452 profile := ctx.Config().Once(bootImageProfileRuleKey, func() interface{} {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000453 defaultProfile := "frameworks/base/config/boot-image-profile.txt"
Colin Cross800fe132019-02-11 14:21:24 -0800454
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000455 rule := android.NewRuleBuilder()
456 rule.MissingDeps(missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800457
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000458 var bootImageProfile android.Path
459 if len(global.BootImageProfiles) > 1 {
460 combinedBootImageProfile := image.dir.Join(ctx, "boot-image-profile.txt")
461 rule.Command().Text("cat").Inputs(global.BootImageProfiles).Text(">").Output(combinedBootImageProfile)
462 bootImageProfile = combinedBootImageProfile
463 } else if len(global.BootImageProfiles) == 1 {
464 bootImageProfile = global.BootImageProfiles[0]
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000465 } else if path := android.ExistentPathForSource(ctx, defaultProfile); path.Valid() {
466 bootImageProfile = path.Path()
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000467 } else {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000468 // No profile (not even a default one, which is the case on some branches
469 // like master-art-host that don't have frameworks/base).
470 // Return nil and continue without profile.
471 return nil
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000472 }
Colin Cross800fe132019-02-11 14:21:24 -0800473
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000474 profile := image.dir.Join(ctx, "boot.prof")
Colin Cross800fe132019-02-11 14:21:24 -0800475
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000476 rule.Command().
477 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholmbe9d0d22020-01-10 20:32:59 +0000478 Tool(globalSoong.Profman).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000479 FlagWithInput("--create-profile-from=", bootImageProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000480 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
481 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000482 FlagWithOutput("--reference-profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800483
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000484 rule.Install(profile, "/system/etc/boot-image.prof")
485
486 rule.Build(pctx, ctx, "bootJarsProfile", "profile boot jars")
487
488 image.profileInstalls = rule.Installs()
489
490 return profile
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000491 })
492 if profile == nil {
493 return nil // wrap nil into a typed pointer with value nil
494 }
495 return profile.(android.WritablePath)
Colin Cross800fe132019-02-11 14:21:24 -0800496}
497
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000498var bootImageProfileRuleKey = android.NewOnceKey("bootImageProfileRule")
499
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100500func bootFrameworkProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
Martin Stjernholmbe9d0d22020-01-10 20:32:59 +0000501 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100502 global := dexpreoptGlobalConfig(ctx)
503
504 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
505 return nil
506 }
507 return ctx.Config().Once(bootFrameworkProfileRuleKey, func() interface{} {
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100508 rule := android.NewRuleBuilder()
509 rule.MissingDeps(missingDeps)
510
511 // Some branches like master-art-host don't have frameworks/base, so manually
512 // handle the case that the default is missing. Those branches won't attempt to build the profile rule,
513 // and if they do they'll get a missing deps error.
514 defaultProfile := "frameworks/base/config/boot-profile.txt"
515 path := android.ExistentPathForSource(ctx, defaultProfile)
516 var bootFrameworkProfile android.Path
517 if path.Valid() {
518 bootFrameworkProfile = path.Path()
519 } else {
520 missingDeps = append(missingDeps, defaultProfile)
521 bootFrameworkProfile = android.PathForOutput(ctx, "missing")
522 }
523
524 profile := image.dir.Join(ctx, "boot.bprof")
525
526 rule.Command().
527 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholmbe9d0d22020-01-10 20:32:59 +0000528 Tool(globalSoong.Profman).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100529 Flag("--generate-boot-profile").
530 FlagWithInput("--create-profile-from=", bootFrameworkProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000531 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
532 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100533 FlagWithOutput("--reference-profile-file=", profile)
534
535 rule.Install(profile, "/system/etc/boot-image.bprof")
536 rule.Build(pctx, ctx, "bootFrameworkProfile", "profile boot framework jars")
537 image.profileInstalls = append(image.profileInstalls, rule.Installs()...)
538
539 return profile
540 }).(android.WritablePath)
541}
542
543var bootFrameworkProfileRuleKey = android.NewOnceKey("bootFrameworkProfileRule")
544
Colin Crossc9a4c362019-02-26 21:13:48 -0800545func dumpOatRules(ctx android.SingletonContext, image *bootImage) {
546 var archs []android.ArchType
547 for arch := range image.images {
548 archs = append(archs, arch)
549 }
550 sort.Slice(archs, func(i, j int) bool { return archs[i].String() < archs[j].String() })
551
552 var allPhonies android.Paths
553 for _, arch := range archs {
554 // Create a rule to call oatdump.
555 output := android.PathForOutput(ctx, "boot."+arch.String()+".oatdump.txt")
556 rule := android.NewRuleBuilder()
557 rule.Command().
558 // TODO: for now, use the debug version for better error reporting
Colin Crossee94d6a2019-07-08 17:08:34 -0700559 BuiltTool(ctx, "oatdumpd").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000560 FlagWithInputList("--runtime-arg -Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
561 FlagWithList("--runtime-arg -Xbootclasspath-locations:", image.dexLocationsDeps, ":").
Ulya Trafimovich163664a2019-12-06 13:42:21 +0000562 FlagWithArg("--image=", strings.Join(image.imageLocations, ":")).Implicits(image.imagesDeps[arch].Paths()).
Colin Crossc9a4c362019-02-26 21:13:48 -0800563 FlagWithOutput("--output=", output).
564 FlagWithArg("--instruction-set=", arch.String())
565 rule.Build(pctx, ctx, "dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
566
567 // Create a phony rule that depends on the output file and prints the path.
568 phony := android.PathForPhony(ctx, "dump-oat-boot-"+arch.String())
569 rule = android.NewRuleBuilder()
570 rule.Command().
571 Implicit(output).
572 ImplicitOutput(phony).
573 Text("echo").FlagWithArg("Output in ", output.String())
574 rule.Build(pctx, ctx, "phony-dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
575
576 allPhonies = append(allPhonies, phony)
577 }
578
579 phony := android.PathForPhony(ctx, "dump-oat-boot")
580 ctx.Build(pctx, android.BuildParams{
581 Rule: android.Phony,
582 Output: phony,
583 Inputs: allPhonies,
584 Description: "dump-oat-boot",
585 })
586
587}
588
Colin Cross2d00f0d2019-05-09 21:50:00 -0700589func writeGlobalConfigForMake(ctx android.SingletonContext, path android.WritablePath) {
590 data := dexpreoptGlobalConfigRaw(ctx).data
591
592 ctx.Build(pctx, android.BuildParams{
593 Rule: android.WriteFile,
594 Output: path,
595 Args: map[string]string{
596 "content": string(data),
597 },
598 })
599}
600
Colin Cross44df5812019-02-15 23:06:46 -0800601// Export paths for default boot image to Make
602func (d *dexpreoptBootJars) MakeVars(ctx android.MakeVarsContext) {
Colin Cross2d00f0d2019-05-09 21:50:00 -0700603 if d.dexpreoptConfigForMake != nil {
604 ctx.Strict("DEX_PREOPT_CONFIG_FOR_MAKE", d.dexpreoptConfigForMake.String())
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000605 ctx.Strict("DEX_PREOPT_SOONG_CONFIG_FOR_MAKE", android.PathForOutput(ctx, "dexpreopt_soong.config").String())
Colin Cross2d00f0d2019-05-09 21:50:00 -0700606 }
607
Colin Cross44df5812019-02-15 23:06:46 -0800608 image := d.defaultBootImage
609 if image != nil {
Colin Cross44df5812019-02-15 23:06:46 -0800610 ctx.Strict("DEXPREOPT_IMAGE_PROFILE_BUILT_INSTALLED", image.profileInstalls.String())
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000611 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_FILES", strings.Join(image.dexPathsDeps.Strings(), " "))
612 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_LOCATIONS", strings.Join(image.dexLocationsDeps, " "))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000613
614 var imageNames []string
615 for _, current := range append(d.otherImages, image) {
616 imageNames = append(imageNames, current.name)
Colin Cross91268c62019-04-11 14:07:04 -0700617 var arches []android.ArchType
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000618 for arch, _ := range current.images {
Colin Cross91268c62019-04-11 14:07:04 -0700619 arches = append(arches, arch)
620 }
621
622 sort.Slice(arches, func(i, j int) bool { return arches[i].String() < arches[j].String() })
623
624 for _, arch := range arches {
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000625 sfx := current.name + "_" + arch.String()
626 ctx.Strict("DEXPREOPT_IMAGE_VDEX_BUILT_INSTALLED_"+sfx, current.vdexInstalls[arch].String())
627 ctx.Strict("DEXPREOPT_IMAGE_"+sfx, current.images[arch].String())
628 ctx.Strict("DEXPREOPT_IMAGE_DEPS_"+sfx, strings.Join(current.imagesDeps[arch].Strings(), " "))
629 ctx.Strict("DEXPREOPT_IMAGE_BUILT_INSTALLED_"+sfx, current.installs[arch].String())
630 ctx.Strict("DEXPREOPT_IMAGE_UNSTRIPPED_BUILT_INSTALLED_"+sfx, current.unstrippedInstalls[arch].String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000631 }
Colin Cross31bf00d2019-12-04 13:16:01 -0800632
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000633 ctx.Strict("DEXPREOPT_IMAGE_LOCATIONS_"+current.name, strings.Join(current.imageLocations, ":"))
Colin Cross31bf00d2019-12-04 13:16:01 -0800634 ctx.Strict("DEXPREOPT_IMAGE_ZIP_"+current.name, current.zip.String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000635 }
636 ctx.Strict("DEXPREOPT_IMAGE_NAMES", strings.Join(imageNames, " "))
Colin Cross800fe132019-02-11 14:21:24 -0800637 }
Colin Cross800fe132019-02-11 14:21:24 -0800638}