blob: 2a2e6dae5553b92914699340c615e13111fef73b [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
Ulya Trafimovichb0a2d372020-01-28 14:42:41 +000091 // Only for extensions, paths to the primary boot images (grouped by target).
92 primaryImages map[android.ArchType]android.OutputPath
93
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000094 // File path to a zip archive with all image files (or nil, if not needed).
95 zip android.WritablePath
Colin Cross800fe132019-02-11 14:21:24 -080096}
97
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000098func (image bootImageConfig) moduleName(idx int) string {
99 // Dexpreopt on the boot class path produces multiple files. The first dex file
100 // is converted into 'name'.art (to match the legacy assumption that 'name'.art
Dan Willemsen0f416782019-06-13 21:44:53 +0000101 // exists), and the rest are converted to 'name'-<jar>.art.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000102 m := image.modules[idx]
103 name := image.stem
104 if idx != 0 || image.extension {
105 name += "-" + stemOf(m)
106 }
107 return name
108}
Dan Willemsen0f416782019-06-13 21:44:53 +0000109
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000110func (image bootImageConfig) firstModuleNameOrStem() string {
111 if len(image.modules) > 0 {
112 return image.moduleName(0)
113 } else {
114 return image.stem
115 }
116}
117
118func (image bootImageConfig) moduleFiles(ctx android.PathContext, dir android.OutputPath, exts ...string) android.OutputPaths {
119 ret := make(android.OutputPaths, 0, len(image.modules)*len(exts))
120 for i := range image.modules {
121 name := image.moduleName(i)
Dan Willemsen0f416782019-06-13 21:44:53 +0000122 for _, ext := range exts {
123 ret = append(ret, dir.Join(ctx, name+ext))
124 }
125 }
Dan Willemsen0f416782019-06-13 21:44:53 +0000126 return ret
127}
128
Colin Cross44df5812019-02-15 23:06:46 -0800129type bootImage struct {
130 bootImageConfig
Colin Cross800fe132019-02-11 14:21:24 -0800131
Colin Cross44df5812019-02-15 23:06:46 -0800132 installs map[android.ArchType]android.RuleBuilderInstalls
133 vdexInstalls map[android.ArchType]android.RuleBuilderInstalls
134 unstrippedInstalls map[android.ArchType]android.RuleBuilderInstalls
Colin Cross800fe132019-02-11 14:21:24 -0800135
Colin Cross44df5812019-02-15 23:06:46 -0800136 profileInstalls android.RuleBuilderInstalls
137}
Colin Cross800fe132019-02-11 14:21:24 -0800138
Colin Cross44df5812019-02-15 23:06:46 -0800139func newBootImage(ctx android.PathContext, config bootImageConfig) *bootImage {
140 image := &bootImage{
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000141 bootImageConfig: config,
Colin Cross800fe132019-02-11 14:21:24 -0800142
Colin Cross44df5812019-02-15 23:06:46 -0800143 installs: make(map[android.ArchType]android.RuleBuilderInstalls),
144 vdexInstalls: make(map[android.ArchType]android.RuleBuilderInstalls),
145 unstrippedInstalls: make(map[android.ArchType]android.RuleBuilderInstalls),
146 }
Colin Cross800fe132019-02-11 14:21:24 -0800147
Colin Cross44df5812019-02-15 23:06:46 -0800148 return image
Colin Cross800fe132019-02-11 14:21:24 -0800149}
150
151func concat(lists ...[]string) []string {
152 var size int
153 for _, l := range lists {
154 size += len(l)
155 }
156 ret := make([]string, 0, size)
157 for _, l := range lists {
158 ret = append(ret, l...)
159 }
160 return ret
161}
162
Colin Cross800fe132019-02-11 14:21:24 -0800163func dexpreoptBootJarsFactory() android.Singleton {
Colin Cross44df5812019-02-15 23:06:46 -0800164 return &dexpreoptBootJars{}
Colin Cross800fe132019-02-11 14:21:24 -0800165}
166
167func skipDexpreoptBootJars(ctx android.PathContext) bool {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000168 if dexpreopt.GetGlobalConfig(ctx).DisablePreopt {
Ulya Trafimovichacb33e02019-11-01 17:57:29 +0000169 return true
170 }
171
Colin Cross800fe132019-02-11 14:21:24 -0800172 if ctx.Config().UnbundledBuild() {
173 return true
174 }
175
176 if len(ctx.Config().Targets[android.Android]) == 0 {
177 // Host-only build
178 return true
179 }
180
181 return false
182}
183
Colin Cross44df5812019-02-15 23:06:46 -0800184type dexpreoptBootJars struct {
185 defaultBootImage *bootImage
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000186 otherImages []*bootImage
Colin Cross2d00f0d2019-05-09 21:50:00 -0700187
188 dexpreoptConfigForMake android.WritablePath
Colin Cross44df5812019-02-15 23:06:46 -0800189}
Colin Cross800fe132019-02-11 14:21:24 -0800190
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000191// Accessor function for the apex package. Returns nil if dexpreopt is disabled.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000192func DexpreoptedArtApexJars(ctx android.BuilderContext) map[android.ArchType]android.OutputPaths {
Ulya Trafimovich44561882020-01-03 13:25:54 +0000193 if skipDexpreoptBootJars(ctx) {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000194 return nil
195 }
Ulya Trafimovich7eebb4f2020-01-22 13:41:06 +0000196
197 // Include dexpreopt files for the primary boot image.
198 files := artBootImageConfig(ctx).imagesDeps
199
Ulya Trafimovich7eebb4f2020-01-22 13:41:06 +0000200 return files
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000201}
202
Colin Cross800fe132019-02-11 14:21:24 -0800203// dexpreoptBoot singleton rules
Colin Cross44df5812019-02-15 23:06:46 -0800204func (d *dexpreoptBootJars) GenerateBuildActions(ctx android.SingletonContext) {
Colin Cross800fe132019-02-11 14:21:24 -0800205 if skipDexpreoptBootJars(ctx) {
206 return
207 }
208
Colin Cross2d00f0d2019-05-09 21:50:00 -0700209 d.dexpreoptConfigForMake = android.PathForOutput(ctx, ctx.Config().DeviceName(), "dexpreopt.config")
210 writeGlobalConfigForMake(ctx, d.dexpreoptConfigForMake)
211
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000212 global := dexpreopt.GetGlobalConfig(ctx)
Colin Cross800fe132019-02-11 14:21:24 -0800213
214 // Skip recompiling the boot image for the second sanitization phase. We'll get separate paths
215 // and invalidate first-stage artifacts which are crucial to SANITIZE_LITE builds.
216 // Note: this is technically incorrect. Compiled code contains stack checks which may depend
217 // on ASAN settings.
218 if len(ctx.Config().SanitizeDevice()) == 1 &&
219 ctx.Config().SanitizeDevice()[0] == "address" &&
Colin Cross44df5812019-02-15 23:06:46 -0800220 global.SanitizeLite {
Colin Cross800fe132019-02-11 14:21:24 -0800221 return
222 }
223
Lingfeng Yang54191fa2019-12-19 16:40:09 +0000224 // Always create the default boot image first, to get a unique profile rule for all images.
225 d.defaultBootImage = buildBootImage(ctx, defaultBootImageConfig(ctx))
Ulya Trafimovich44561882020-01-03 13:25:54 +0000226 // Create boot image for the ART apex (build artifacts are accessed via the global boot image config).
227 d.otherImages = append(d.otherImages, buildBootImage(ctx, artBootImageConfig(ctx)))
Colin Crossc9a4c362019-02-26 21:13:48 -0800228
229 dumpOatRules(ctx, d.defaultBootImage)
Colin Cross44df5812019-02-15 23:06:46 -0800230}
231
232// buildBootImage takes a bootImageConfig, creates rules to build it, and returns a *bootImage.
233func buildBootImage(ctx android.SingletonContext, config bootImageConfig) *bootImage {
Colin Cross44df5812019-02-15 23:06:46 -0800234 image := newBootImage(ctx, config)
235
236 bootDexJars := make(android.Paths, len(image.modules))
Colin Cross800fe132019-02-11 14:21:24 -0800237 ctx.VisitAllModules(func(module android.Module) {
238 // Collect dex jar paths for the modules listed above.
Colin Cross42be7612019-02-21 18:12:14 -0800239 if j, ok := module.(interface{ DexJar() android.Path }); ok {
Colin Cross800fe132019-02-11 14:21:24 -0800240 name := ctx.ModuleName(module)
Colin Cross44df5812019-02-15 23:06:46 -0800241 if i := android.IndexList(name, image.modules); i != -1 {
Colin Cross800fe132019-02-11 14:21:24 -0800242 bootDexJars[i] = j.DexJar()
243 }
244 }
245 })
246
247 var missingDeps []string
248 // Ensure all modules were converted to paths
249 for i := range bootDexJars {
250 if bootDexJars[i] == nil {
251 if ctx.Config().AllowMissingDependencies() {
Colin Cross44df5812019-02-15 23:06:46 -0800252 missingDeps = append(missingDeps, image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800253 bootDexJars[i] = android.PathForOutput(ctx, "missing")
254 } else {
255 ctx.Errorf("failed to find dex jar path for module %q",
Colin Cross44df5812019-02-15 23:06:46 -0800256 image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800257 }
258 }
259 }
260
261 // The path to bootclasspath dex files needs to be known at module GenerateAndroidBuildAction time, before
262 // the bootclasspath modules have been compiled. Copy the dex jars there so the module rules that have
263 // already been set up can find them.
264 for i := range bootDexJars {
265 ctx.Build(pctx, android.BuildParams{
266 Rule: android.Cp,
267 Input: bootDexJars[i],
Colin Cross44df5812019-02-15 23:06:46 -0800268 Output: image.dexPaths[i],
Colin Cross800fe132019-02-11 14:21:24 -0800269 })
270 }
271
Colin Cross44df5812019-02-15 23:06:46 -0800272 profile := bootImageProfileRule(ctx, image, missingDeps)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100273 bootFrameworkProfileRule(ctx, image, missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800274
Colin Crossdf8eebe2019-04-09 15:29:41 -0700275 var allFiles android.Paths
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000276 for _, target := range image.targets {
277 files := buildBootImageRuleForArch(ctx, image, target.Arch.ArchType, profile, missingDeps)
278 allFiles = append(allFiles, files.Paths()...)
Colin Cross800fe132019-02-11 14:21:24 -0800279 }
Colin Cross44df5812019-02-15 23:06:46 -0800280
Colin Crossdf8eebe2019-04-09 15:29:41 -0700281 if image.zip != nil {
282 rule := android.NewRuleBuilder()
283 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -0700284 BuiltTool(ctx, "soong_zip").
Colin Crossdf8eebe2019-04-09 15:29:41 -0700285 FlagWithOutput("-o ", image.zip).
286 FlagWithArg("-C ", image.dir.String()).
287 FlagWithInputList("-f ", allFiles, " -f ")
288
289 rule.Build(pctx, ctx, "zip_"+image.name, "zip "+image.name+" image")
290 }
291
Colin Cross44df5812019-02-15 23:06:46 -0800292 return image
Colin Cross800fe132019-02-11 14:21:24 -0800293}
294
Colin Cross44df5812019-02-15 23:06:46 -0800295func buildBootImageRuleForArch(ctx android.SingletonContext, image *bootImage,
Colin Crossdf8eebe2019-04-09 15:29:41 -0700296 arch android.ArchType, profile android.Path, missingDeps []string) android.WritablePaths {
Colin Cross800fe132019-02-11 14:21:24 -0800297
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000298 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000299 global := dexpreopt.GetGlobalConfig(ctx)
Colin Cross44df5812019-02-15 23:06:46 -0800300
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000301 symbolsDir := image.symbolsDir.Join(ctx, image.installSubdir, arch.String())
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000302 symbolsFile := symbolsDir.Join(ctx, image.stem+".oat")
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000303 outputDir := image.dir.Join(ctx, image.installSubdir, arch.String())
304 outputPath := outputDir.Join(ctx, image.stem+".oat")
305 oatLocation := dexpreopt.PathToLocation(outputPath, arch)
306 imagePath := outputPath.ReplaceExtension(ctx, "art")
Colin Cross800fe132019-02-11 14:21:24 -0800307
308 rule := android.NewRuleBuilder()
309 rule.MissingDeps(missingDeps)
310
311 rule.Command().Text("mkdir").Flag("-p").Flag(symbolsDir.String())
312 rule.Command().Text("rm").Flag("-f").
313 Flag(symbolsDir.Join(ctx, "*.art").String()).
314 Flag(symbolsDir.Join(ctx, "*.oat").String()).
315 Flag(symbolsDir.Join(ctx, "*.invocation").String())
316 rule.Command().Text("rm").Flag("-f").
317 Flag(outputDir.Join(ctx, "*.art").String()).
318 Flag(outputDir.Join(ctx, "*.oat").String()).
319 Flag(outputDir.Join(ctx, "*.invocation").String())
320
321 cmd := rule.Command()
322
323 extraFlags := ctx.Config().Getenv("ART_BOOT_IMAGE_EXTRA_ARGS")
324 if extraFlags == "" {
325 // Use ANDROID_LOG_TAGS to suppress most logging by default...
326 cmd.Text(`ANDROID_LOG_TAGS="*:e"`)
327 } else {
328 // ...unless the boot image is generated specifically for testing, then allow all logging.
329 cmd.Text(`ANDROID_LOG_TAGS="*:v"`)
330 }
331
332 invocationPath := outputPath.ReplaceExtension(ctx, "invocation")
333
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000334 cmd.Tool(globalSoong.Dex2oat).
Colin Cross800fe132019-02-11 14:21:24 -0800335 Flag("--avoid-storing-invocation").
Colin Cross69f59a32019-02-15 10:39:37 -0800336 FlagWithOutput("--write-invocation-to=", invocationPath).ImplicitOutput(invocationPath).
Colin Cross44df5812019-02-15 23:06:46 -0800337 Flag("--runtime-arg").FlagWithArg("-Xms", global.Dex2oatImageXms).
338 Flag("--runtime-arg").FlagWithArg("-Xmx", global.Dex2oatImageXmx)
Colin Cross800fe132019-02-11 14:21:24 -0800339
Colin Cross69f59a32019-02-15 10:39:37 -0800340 if profile != nil {
Colin Cross800fe132019-02-11 14:21:24 -0800341 cmd.FlagWithArg("--compiler-filter=", "speed-profile")
Colin Cross69f59a32019-02-15 10:39:37 -0800342 cmd.FlagWithInput("--profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800343 }
344
Colin Cross44df5812019-02-15 23:06:46 -0800345 if global.DirtyImageObjects.Valid() {
346 cmd.FlagWithInput("--dirty-image-objects=", global.DirtyImageObjects.Path())
Colin Cross800fe132019-02-11 14:21:24 -0800347 }
348
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000349 if image.extension {
Ulya Trafimovichb0a2d372020-01-28 14:42:41 +0000350 artImage := image.primaryImages[arch]
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000351 cmd.
352 Flag("--runtime-arg").FlagWithInputList("-Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
353 Flag("--runtime-arg").FlagWithList("-Xbootclasspath-locations:", image.dexLocationsDeps, ":").
354 FlagWithArg("--boot-image=", dexpreopt.PathToLocation(artImage, arch)).Implicit(artImage)
355 } else {
356 cmd.FlagWithArg("--base=", ctx.Config().LibartImgDeviceBaseAddress())
357 }
358
Colin Cross800fe132019-02-11 14:21:24 -0800359 cmd.
Colin Cross44df5812019-02-15 23:06:46 -0800360 FlagForEachInput("--dex-file=", image.dexPaths.Paths()).
361 FlagForEachArg("--dex-location=", image.dexLocations).
Colin Cross800fe132019-02-11 14:21:24 -0800362 Flag("--generate-debug-info").
363 Flag("--generate-build-id").
Mathieu Chartier54fd8072019-07-26 13:50:04 -0700364 Flag("--image-format=lz4hc").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000365 FlagWithArg("--oat-symbols=", symbolsFile.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800366 Flag("--strip").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000367 FlagWithArg("--oat-file=", outputPath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800368 FlagWithArg("--oat-location=", oatLocation).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000369 FlagWithArg("--image=", imagePath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800370 FlagWithArg("--instruction-set=", arch.String()).
Colin Cross44df5812019-02-15 23:06:46 -0800371 FlagWithArg("--instruction-set-variant=", global.CpuVariant[arch]).
372 FlagWithArg("--instruction-set-features=", global.InstructionSetFeatures[arch]).
373 FlagWithArg("--android-root=", global.EmptyDirectory).
Colin Cross800fe132019-02-11 14:21:24 -0800374 FlagWithArg("--no-inline-from=", "core-oj.jar").
375 Flag("--abort-on-hard-verifier-error")
376
Colin Cross44df5812019-02-15 23:06:46 -0800377 if global.BootFlags != "" {
378 cmd.Flag(global.BootFlags)
Colin Cross800fe132019-02-11 14:21:24 -0800379 }
380
381 if extraFlags != "" {
382 cmd.Flag(extraFlags)
383 }
384
Colin Cross0b9f31f2019-02-28 11:00:01 -0800385 cmd.Textf(`|| ( echo %s ; false )`, proptools.ShellEscape(failureMessage))
Colin Cross800fe132019-02-11 14:21:24 -0800386
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000387 installDir := filepath.Join("/", image.installSubdir, arch.String())
388 vdexInstallDir := filepath.Join("/", image.installSubdir)
Colin Cross800fe132019-02-11 14:21:24 -0800389
Colin Cross800fe132019-02-11 14:21:24 -0800390 var vdexInstalls android.RuleBuilderInstalls
391 var unstrippedInstalls android.RuleBuilderInstalls
392
Colin Crossdf8eebe2019-04-09 15:29:41 -0700393 var zipFiles android.WritablePaths
394
Dan Willemsen0f416782019-06-13 21:44:53 +0000395 for _, artOrOat := range image.moduleFiles(ctx, outputDir, ".art", ".oat") {
396 cmd.ImplicitOutput(artOrOat)
397 zipFiles = append(zipFiles, artOrOat)
Colin Cross800fe132019-02-11 14:21:24 -0800398
Dan Willemsen0f416782019-06-13 21:44:53 +0000399 // Install the .oat and .art files
400 rule.Install(artOrOat, filepath.Join(installDir, artOrOat.Base()))
401 }
Colin Cross800fe132019-02-11 14:21:24 -0800402
Dan Willemsen0f416782019-06-13 21:44:53 +0000403 for _, vdex := range image.moduleFiles(ctx, outputDir, ".vdex") {
404 cmd.ImplicitOutput(vdex)
405 zipFiles = append(zipFiles, vdex)
Colin Cross800fe132019-02-11 14:21:24 -0800406
407 // The vdex files are identical between architectures, install them to a shared location. The Make rules will
408 // only use the install rules for one architecture, and will create symlinks into the architecture-specific
409 // directories.
410 vdexInstalls = append(vdexInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800411 android.RuleBuilderInstall{vdex, filepath.Join(vdexInstallDir, vdex.Base())})
Dan Willemsen0f416782019-06-13 21:44:53 +0000412 }
413
414 for _, unstrippedOat := range image.moduleFiles(ctx, symbolsDir, ".oat") {
415 cmd.ImplicitOutput(unstrippedOat)
Colin Cross800fe132019-02-11 14:21:24 -0800416
417 // Install the unstripped oat files. The Make rules will put these in $(TARGET_OUT_UNSTRIPPED)
418 unstrippedInstalls = append(unstrippedInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800419 android.RuleBuilderInstall{unstrippedOat, filepath.Join(installDir, unstrippedOat.Base())})
Colin Cross800fe132019-02-11 14:21:24 -0800420 }
421
Colin Cross44df5812019-02-15 23:06:46 -0800422 rule.Build(pctx, ctx, image.name+"JarsDexpreopt_"+arch.String(), "dexpreopt "+image.name+" jars "+arch.String())
Colin Cross800fe132019-02-11 14:21:24 -0800423
424 // save output and installed files for makevars
Colin Cross44df5812019-02-15 23:06:46 -0800425 image.installs[arch] = rule.Installs()
426 image.vdexInstalls[arch] = vdexInstalls
427 image.unstrippedInstalls[arch] = unstrippedInstalls
Colin Crossdf8eebe2019-04-09 15:29:41 -0700428
429 return zipFiles
Colin Cross800fe132019-02-11 14:21:24 -0800430}
431
432const failureMessage = `ERROR: Dex2oat failed to compile a boot image.
433It is likely that the boot classpath is inconsistent.
434Rebuild with ART_BOOT_IMAGE_EXTRA_ARGS="--runtime-arg -verbose:verifier" to see verification errors.`
435
Colin Cross44df5812019-02-15 23:06:46 -0800436func bootImageProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000437 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000438 global := dexpreopt.GetGlobalConfig(ctx)
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000439
Mathieu Chartier6adeee12019-06-26 10:01:36 -0700440 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000441 return nil
442 }
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000443 profile := ctx.Config().Once(bootImageProfileRuleKey, func() interface{} {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000444 defaultProfile := "frameworks/base/config/boot-image-profile.txt"
Colin Cross800fe132019-02-11 14:21:24 -0800445
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000446 rule := android.NewRuleBuilder()
447 rule.MissingDeps(missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800448
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000449 var bootImageProfile android.Path
450 if len(global.BootImageProfiles) > 1 {
451 combinedBootImageProfile := image.dir.Join(ctx, "boot-image-profile.txt")
452 rule.Command().Text("cat").Inputs(global.BootImageProfiles).Text(">").Output(combinedBootImageProfile)
453 bootImageProfile = combinedBootImageProfile
454 } else if len(global.BootImageProfiles) == 1 {
455 bootImageProfile = global.BootImageProfiles[0]
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000456 } else if path := android.ExistentPathForSource(ctx, defaultProfile); path.Valid() {
457 bootImageProfile = path.Path()
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000458 } else {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000459 // No profile (not even a default one, which is the case on some branches
460 // like master-art-host that don't have frameworks/base).
461 // Return nil and continue without profile.
462 return nil
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000463 }
Colin Cross800fe132019-02-11 14:21:24 -0800464
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000465 profile := image.dir.Join(ctx, "boot.prof")
Colin Cross800fe132019-02-11 14:21:24 -0800466
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000467 rule.Command().
468 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000469 Tool(globalSoong.Profman).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000470 FlagWithInput("--create-profile-from=", bootImageProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000471 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
472 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000473 FlagWithOutput("--reference-profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800474
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000475 rule.Install(profile, "/system/etc/boot-image.prof")
476
477 rule.Build(pctx, ctx, "bootJarsProfile", "profile boot jars")
478
479 image.profileInstalls = rule.Installs()
480
481 return profile
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000482 })
483 if profile == nil {
484 return nil // wrap nil into a typed pointer with value nil
485 }
486 return profile.(android.WritablePath)
Colin Cross800fe132019-02-11 14:21:24 -0800487}
488
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000489var bootImageProfileRuleKey = android.NewOnceKey("bootImageProfileRule")
490
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100491func bootFrameworkProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000492 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000493 global := dexpreopt.GetGlobalConfig(ctx)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100494
495 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
496 return nil
497 }
498 return ctx.Config().Once(bootFrameworkProfileRuleKey, func() interface{} {
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100499 rule := android.NewRuleBuilder()
500 rule.MissingDeps(missingDeps)
501
502 // Some branches like master-art-host don't have frameworks/base, so manually
503 // handle the case that the default is missing. Those branches won't attempt to build the profile rule,
504 // and if they do they'll get a missing deps error.
505 defaultProfile := "frameworks/base/config/boot-profile.txt"
506 path := android.ExistentPathForSource(ctx, defaultProfile)
507 var bootFrameworkProfile android.Path
508 if path.Valid() {
509 bootFrameworkProfile = path.Path()
510 } else {
511 missingDeps = append(missingDeps, defaultProfile)
512 bootFrameworkProfile = android.PathForOutput(ctx, "missing")
513 }
514
515 profile := image.dir.Join(ctx, "boot.bprof")
516
517 rule.Command().
518 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000519 Tool(globalSoong.Profman).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100520 Flag("--generate-boot-profile").
521 FlagWithInput("--create-profile-from=", bootFrameworkProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000522 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
523 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100524 FlagWithOutput("--reference-profile-file=", profile)
525
526 rule.Install(profile, "/system/etc/boot-image.bprof")
527 rule.Build(pctx, ctx, "bootFrameworkProfile", "profile boot framework jars")
528 image.profileInstalls = append(image.profileInstalls, rule.Installs()...)
529
530 return profile
531 }).(android.WritablePath)
532}
533
534var bootFrameworkProfileRuleKey = android.NewOnceKey("bootFrameworkProfileRule")
535
Colin Crossc9a4c362019-02-26 21:13:48 -0800536func dumpOatRules(ctx android.SingletonContext, image *bootImage) {
537 var archs []android.ArchType
538 for arch := range image.images {
539 archs = append(archs, arch)
540 }
541 sort.Slice(archs, func(i, j int) bool { return archs[i].String() < archs[j].String() })
542
543 var allPhonies android.Paths
544 for _, arch := range archs {
545 // Create a rule to call oatdump.
546 output := android.PathForOutput(ctx, "boot."+arch.String()+".oatdump.txt")
547 rule := android.NewRuleBuilder()
548 rule.Command().
549 // TODO: for now, use the debug version for better error reporting
Colin Crossee94d6a2019-07-08 17:08:34 -0700550 BuiltTool(ctx, "oatdumpd").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000551 FlagWithInputList("--runtime-arg -Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
552 FlagWithList("--runtime-arg -Xbootclasspath-locations:", image.dexLocationsDeps, ":").
Ulya Trafimovich163664a2019-12-06 13:42:21 +0000553 FlagWithArg("--image=", strings.Join(image.imageLocations, ":")).Implicits(image.imagesDeps[arch].Paths()).
Colin Crossc9a4c362019-02-26 21:13:48 -0800554 FlagWithOutput("--output=", output).
555 FlagWithArg("--instruction-set=", arch.String())
556 rule.Build(pctx, ctx, "dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
557
558 // Create a phony rule that depends on the output file and prints the path.
559 phony := android.PathForPhony(ctx, "dump-oat-boot-"+arch.String())
560 rule = android.NewRuleBuilder()
561 rule.Command().
562 Implicit(output).
563 ImplicitOutput(phony).
564 Text("echo").FlagWithArg("Output in ", output.String())
565 rule.Build(pctx, ctx, "phony-dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
566
567 allPhonies = append(allPhonies, phony)
568 }
569
570 phony := android.PathForPhony(ctx, "dump-oat-boot")
571 ctx.Build(pctx, android.BuildParams{
572 Rule: android.Phony,
573 Output: phony,
574 Inputs: allPhonies,
575 Description: "dump-oat-boot",
576 })
577
578}
579
Colin Cross2d00f0d2019-05-09 21:50:00 -0700580func writeGlobalConfigForMake(ctx android.SingletonContext, path android.WritablePath) {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000581 data := dexpreopt.GetGlobalConfigRawData(ctx)
Colin Cross2d00f0d2019-05-09 21:50:00 -0700582
583 ctx.Build(pctx, android.BuildParams{
584 Rule: android.WriteFile,
585 Output: path,
586 Args: map[string]string{
587 "content": string(data),
588 },
589 })
590}
591
Colin Cross44df5812019-02-15 23:06:46 -0800592// Export paths for default boot image to Make
593func (d *dexpreoptBootJars) MakeVars(ctx android.MakeVarsContext) {
Colin Cross2d00f0d2019-05-09 21:50:00 -0700594 if d.dexpreoptConfigForMake != nil {
595 ctx.Strict("DEX_PREOPT_CONFIG_FOR_MAKE", d.dexpreoptConfigForMake.String())
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000596 ctx.Strict("DEX_PREOPT_SOONG_CONFIG_FOR_MAKE", android.PathForOutput(ctx, "dexpreopt_soong.config").String())
Colin Cross2d00f0d2019-05-09 21:50:00 -0700597 }
598
Colin Cross44df5812019-02-15 23:06:46 -0800599 image := d.defaultBootImage
600 if image != nil {
Colin Cross44df5812019-02-15 23:06:46 -0800601 ctx.Strict("DEXPREOPT_IMAGE_PROFILE_BUILT_INSTALLED", image.profileInstalls.String())
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000602 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_FILES", strings.Join(image.dexPathsDeps.Strings(), " "))
603 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_LOCATIONS", strings.Join(image.dexLocationsDeps, " "))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000604
605 var imageNames []string
606 for _, current := range append(d.otherImages, image) {
607 imageNames = append(imageNames, current.name)
Colin Cross91268c62019-04-11 14:07:04 -0700608 var arches []android.ArchType
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000609 for arch, _ := range current.images {
Colin Cross91268c62019-04-11 14:07:04 -0700610 arches = append(arches, arch)
611 }
612
613 sort.Slice(arches, func(i, j int) bool { return arches[i].String() < arches[j].String() })
614
615 for _, arch := range arches {
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000616 sfx := current.name + "_" + arch.String()
617 ctx.Strict("DEXPREOPT_IMAGE_VDEX_BUILT_INSTALLED_"+sfx, current.vdexInstalls[arch].String())
618 ctx.Strict("DEXPREOPT_IMAGE_"+sfx, current.images[arch].String())
619 ctx.Strict("DEXPREOPT_IMAGE_DEPS_"+sfx, strings.Join(current.imagesDeps[arch].Strings(), " "))
620 ctx.Strict("DEXPREOPT_IMAGE_BUILT_INSTALLED_"+sfx, current.installs[arch].String())
621 ctx.Strict("DEXPREOPT_IMAGE_UNSTRIPPED_BUILT_INSTALLED_"+sfx, current.unstrippedInstalls[arch].String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000622 }
Colin Cross31bf00d2019-12-04 13:16:01 -0800623
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000624 ctx.Strict("DEXPREOPT_IMAGE_LOCATIONS_"+current.name, strings.Join(current.imageLocations, ":"))
Colin Cross31bf00d2019-12-04 13:16:01 -0800625 ctx.Strict("DEXPREOPT_IMAGE_ZIP_"+current.name, current.zip.String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000626 }
627 ctx.Strict("DEXPREOPT_IMAGE_NAMES", strings.Join(imageNames, " "))
Colin Cross800fe132019-02-11 14:21:24 -0800628 }
Colin Cross800fe132019-02-11 14:21:24 -0800629}