blob: 655a47644cf7d54eaaa6ea763140b8c00f1a812c [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 }
Martin Stjernholm6d415272020-01-31 17:10:36 +0000208 if dexpreopt.GetCachedGlobalSoongConfig(ctx) == nil {
209 // No module has enabled dexpreopting, so we assume there will be no boot image to make.
210 return
211 }
Colin Cross800fe132019-02-11 14:21:24 -0800212
Colin Cross2d00f0d2019-05-09 21:50:00 -0700213 d.dexpreoptConfigForMake = android.PathForOutput(ctx, ctx.Config().DeviceName(), "dexpreopt.config")
214 writeGlobalConfigForMake(ctx, d.dexpreoptConfigForMake)
215
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000216 global := dexpreopt.GetGlobalConfig(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)))
Colin Crossc9a4c362019-02-26 21:13:48 -0800232
233 dumpOatRules(ctx, d.defaultBootImage)
Colin Cross44df5812019-02-15 23:06:46 -0800234}
235
236// buildBootImage takes a bootImageConfig, creates rules to build it, and returns a *bootImage.
237func buildBootImage(ctx android.SingletonContext, config bootImageConfig) *bootImage {
Colin Cross44df5812019-02-15 23:06:46 -0800238 image := newBootImage(ctx, config)
239
240 bootDexJars := make(android.Paths, len(image.modules))
Colin Cross800fe132019-02-11 14:21:24 -0800241 ctx.VisitAllModules(func(module android.Module) {
242 // Collect dex jar paths for the modules listed above.
Colin Cross42be7612019-02-21 18:12:14 -0800243 if j, ok := module.(interface{ DexJar() android.Path }); ok {
Colin Cross800fe132019-02-11 14:21:24 -0800244 name := ctx.ModuleName(module)
Colin Cross44df5812019-02-15 23:06:46 -0800245 if i := android.IndexList(name, image.modules); i != -1 {
Colin Cross800fe132019-02-11 14:21:24 -0800246 bootDexJars[i] = j.DexJar()
247 }
248 }
249 })
250
251 var missingDeps []string
252 // Ensure all modules were converted to paths
253 for i := range bootDexJars {
254 if bootDexJars[i] == nil {
255 if ctx.Config().AllowMissingDependencies() {
Colin Cross44df5812019-02-15 23:06:46 -0800256 missingDeps = append(missingDeps, image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800257 bootDexJars[i] = android.PathForOutput(ctx, "missing")
258 } else {
259 ctx.Errorf("failed to find dex jar path for module %q",
Colin Cross44df5812019-02-15 23:06:46 -0800260 image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800261 }
262 }
263 }
264
265 // The path to bootclasspath dex files needs to be known at module GenerateAndroidBuildAction time, before
266 // the bootclasspath modules have been compiled. Copy the dex jars there so the module rules that have
267 // already been set up can find them.
268 for i := range bootDexJars {
269 ctx.Build(pctx, android.BuildParams{
270 Rule: android.Cp,
271 Input: bootDexJars[i],
Colin Cross44df5812019-02-15 23:06:46 -0800272 Output: image.dexPaths[i],
Colin Cross800fe132019-02-11 14:21:24 -0800273 })
274 }
275
Colin Cross44df5812019-02-15 23:06:46 -0800276 profile := bootImageProfileRule(ctx, image, missingDeps)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100277 bootFrameworkProfileRule(ctx, image, missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800278
Colin Crossdf8eebe2019-04-09 15:29:41 -0700279 var allFiles android.Paths
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000280 for _, target := range image.targets {
281 files := buildBootImageRuleForArch(ctx, image, target.Arch.ArchType, profile, missingDeps)
282 allFiles = append(allFiles, files.Paths()...)
Colin Cross800fe132019-02-11 14:21:24 -0800283 }
Colin Cross44df5812019-02-15 23:06:46 -0800284
Colin Crossdf8eebe2019-04-09 15:29:41 -0700285 if image.zip != nil {
286 rule := android.NewRuleBuilder()
287 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -0700288 BuiltTool(ctx, "soong_zip").
Colin Crossdf8eebe2019-04-09 15:29:41 -0700289 FlagWithOutput("-o ", image.zip).
290 FlagWithArg("-C ", image.dir.String()).
291 FlagWithInputList("-f ", allFiles, " -f ")
292
293 rule.Build(pctx, ctx, "zip_"+image.name, "zip "+image.name+" image")
294 }
295
Colin Cross44df5812019-02-15 23:06:46 -0800296 return image
Colin Cross800fe132019-02-11 14:21:24 -0800297}
298
Colin Cross44df5812019-02-15 23:06:46 -0800299func buildBootImageRuleForArch(ctx android.SingletonContext, image *bootImage,
Colin Crossdf8eebe2019-04-09 15:29:41 -0700300 arch android.ArchType, profile android.Path, missingDeps []string) android.WritablePaths {
Colin Cross800fe132019-02-11 14:21:24 -0800301
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000302 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000303 global := dexpreopt.GetGlobalConfig(ctx)
Colin Cross44df5812019-02-15 23:06:46 -0800304
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000305 symbolsDir := image.symbolsDir.Join(ctx, image.installSubdir, arch.String())
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000306 symbolsFile := symbolsDir.Join(ctx, image.stem+".oat")
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000307 outputDir := image.dir.Join(ctx, image.installSubdir, arch.String())
308 outputPath := outputDir.Join(ctx, image.stem+".oat")
309 oatLocation := dexpreopt.PathToLocation(outputPath, arch)
310 imagePath := outputPath.ReplaceExtension(ctx, "art")
Colin Cross800fe132019-02-11 14:21:24 -0800311
312 rule := android.NewRuleBuilder()
313 rule.MissingDeps(missingDeps)
314
315 rule.Command().Text("mkdir").Flag("-p").Flag(symbolsDir.String())
316 rule.Command().Text("rm").Flag("-f").
317 Flag(symbolsDir.Join(ctx, "*.art").String()).
318 Flag(symbolsDir.Join(ctx, "*.oat").String()).
319 Flag(symbolsDir.Join(ctx, "*.invocation").String())
320 rule.Command().Text("rm").Flag("-f").
321 Flag(outputDir.Join(ctx, "*.art").String()).
322 Flag(outputDir.Join(ctx, "*.oat").String()).
323 Flag(outputDir.Join(ctx, "*.invocation").String())
324
325 cmd := rule.Command()
326
327 extraFlags := ctx.Config().Getenv("ART_BOOT_IMAGE_EXTRA_ARGS")
328 if extraFlags == "" {
329 // Use ANDROID_LOG_TAGS to suppress most logging by default...
330 cmd.Text(`ANDROID_LOG_TAGS="*:e"`)
331 } else {
332 // ...unless the boot image is generated specifically for testing, then allow all logging.
333 cmd.Text(`ANDROID_LOG_TAGS="*:v"`)
334 }
335
336 invocationPath := outputPath.ReplaceExtension(ctx, "invocation")
337
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000338 cmd.Tool(globalSoong.Dex2oat).
Colin Cross800fe132019-02-11 14:21:24 -0800339 Flag("--avoid-storing-invocation").
Colin Cross69f59a32019-02-15 10:39:37 -0800340 FlagWithOutput("--write-invocation-to=", invocationPath).ImplicitOutput(invocationPath).
Colin Cross44df5812019-02-15 23:06:46 -0800341 Flag("--runtime-arg").FlagWithArg("-Xms", global.Dex2oatImageXms).
342 Flag("--runtime-arg").FlagWithArg("-Xmx", global.Dex2oatImageXmx)
Colin Cross800fe132019-02-11 14:21:24 -0800343
Colin Cross69f59a32019-02-15 10:39:37 -0800344 if profile != nil {
Colin Cross800fe132019-02-11 14:21:24 -0800345 cmd.FlagWithArg("--compiler-filter=", "speed-profile")
Colin Cross69f59a32019-02-15 10:39:37 -0800346 cmd.FlagWithInput("--profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800347 }
348
Colin Cross44df5812019-02-15 23:06:46 -0800349 if global.DirtyImageObjects.Valid() {
350 cmd.FlagWithInput("--dirty-image-objects=", global.DirtyImageObjects.Path())
Colin Cross800fe132019-02-11 14:21:24 -0800351 }
352
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000353 if image.extension {
Ulya Trafimovichb0a2d372020-01-28 14:42:41 +0000354 artImage := image.primaryImages[arch]
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000355 cmd.
356 Flag("--runtime-arg").FlagWithInputList("-Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
357 Flag("--runtime-arg").FlagWithList("-Xbootclasspath-locations:", image.dexLocationsDeps, ":").
358 FlagWithArg("--boot-image=", dexpreopt.PathToLocation(artImage, arch)).Implicit(artImage)
359 } else {
360 cmd.FlagWithArg("--base=", ctx.Config().LibartImgDeviceBaseAddress())
361 }
362
Colin Cross800fe132019-02-11 14:21:24 -0800363 cmd.
Colin Cross44df5812019-02-15 23:06:46 -0800364 FlagForEachInput("--dex-file=", image.dexPaths.Paths()).
365 FlagForEachArg("--dex-location=", image.dexLocations).
Colin Cross800fe132019-02-11 14:21:24 -0800366 Flag("--generate-debug-info").
367 Flag("--generate-build-id").
Mathieu Chartier54fd8072019-07-26 13:50:04 -0700368 Flag("--image-format=lz4hc").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000369 FlagWithArg("--oat-symbols=", symbolsFile.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800370 Flag("--strip").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000371 FlagWithArg("--oat-file=", outputPath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800372 FlagWithArg("--oat-location=", oatLocation).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000373 FlagWithArg("--image=", imagePath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800374 FlagWithArg("--instruction-set=", arch.String()).
Colin Cross44df5812019-02-15 23:06:46 -0800375 FlagWithArg("--instruction-set-variant=", global.CpuVariant[arch]).
376 FlagWithArg("--instruction-set-features=", global.InstructionSetFeatures[arch]).
377 FlagWithArg("--android-root=", global.EmptyDirectory).
Colin Cross800fe132019-02-11 14:21:24 -0800378 FlagWithArg("--no-inline-from=", "core-oj.jar").
379 Flag("--abort-on-hard-verifier-error")
380
Colin Cross44df5812019-02-15 23:06:46 -0800381 if global.BootFlags != "" {
382 cmd.Flag(global.BootFlags)
Colin Cross800fe132019-02-11 14:21:24 -0800383 }
384
385 if extraFlags != "" {
386 cmd.Flag(extraFlags)
387 }
388
Colin Cross0b9f31f2019-02-28 11:00:01 -0800389 cmd.Textf(`|| ( echo %s ; false )`, proptools.ShellEscape(failureMessage))
Colin Cross800fe132019-02-11 14:21:24 -0800390
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000391 installDir := filepath.Join("/", image.installSubdir, arch.String())
392 vdexInstallDir := filepath.Join("/", image.installSubdir)
Colin Cross800fe132019-02-11 14:21:24 -0800393
Colin Cross800fe132019-02-11 14:21:24 -0800394 var vdexInstalls android.RuleBuilderInstalls
395 var unstrippedInstalls android.RuleBuilderInstalls
396
Colin Crossdf8eebe2019-04-09 15:29:41 -0700397 var zipFiles android.WritablePaths
398
Dan Willemsen0f416782019-06-13 21:44:53 +0000399 for _, artOrOat := range image.moduleFiles(ctx, outputDir, ".art", ".oat") {
400 cmd.ImplicitOutput(artOrOat)
401 zipFiles = append(zipFiles, artOrOat)
Colin Cross800fe132019-02-11 14:21:24 -0800402
Dan Willemsen0f416782019-06-13 21:44:53 +0000403 // Install the .oat and .art files
404 rule.Install(artOrOat, filepath.Join(installDir, artOrOat.Base()))
405 }
Colin Cross800fe132019-02-11 14:21:24 -0800406
Dan Willemsen0f416782019-06-13 21:44:53 +0000407 for _, vdex := range image.moduleFiles(ctx, outputDir, ".vdex") {
408 cmd.ImplicitOutput(vdex)
409 zipFiles = append(zipFiles, vdex)
Colin Cross800fe132019-02-11 14:21:24 -0800410
411 // The vdex files are identical between architectures, install them to a shared location. The Make rules will
412 // only use the install rules for one architecture, and will create symlinks into the architecture-specific
413 // directories.
414 vdexInstalls = append(vdexInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800415 android.RuleBuilderInstall{vdex, filepath.Join(vdexInstallDir, vdex.Base())})
Dan Willemsen0f416782019-06-13 21:44:53 +0000416 }
417
418 for _, unstrippedOat := range image.moduleFiles(ctx, symbolsDir, ".oat") {
419 cmd.ImplicitOutput(unstrippedOat)
Colin Cross800fe132019-02-11 14:21:24 -0800420
421 // Install the unstripped oat files. The Make rules will put these in $(TARGET_OUT_UNSTRIPPED)
422 unstrippedInstalls = append(unstrippedInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800423 android.RuleBuilderInstall{unstrippedOat, filepath.Join(installDir, unstrippedOat.Base())})
Colin Cross800fe132019-02-11 14:21:24 -0800424 }
425
Colin Cross44df5812019-02-15 23:06:46 -0800426 rule.Build(pctx, ctx, image.name+"JarsDexpreopt_"+arch.String(), "dexpreopt "+image.name+" jars "+arch.String())
Colin Cross800fe132019-02-11 14:21:24 -0800427
428 // save output and installed files for makevars
Colin Cross44df5812019-02-15 23:06:46 -0800429 image.installs[arch] = rule.Installs()
430 image.vdexInstalls[arch] = vdexInstalls
431 image.unstrippedInstalls[arch] = unstrippedInstalls
Colin Crossdf8eebe2019-04-09 15:29:41 -0700432
433 return zipFiles
Colin Cross800fe132019-02-11 14:21:24 -0800434}
435
436const failureMessage = `ERROR: Dex2oat failed to compile a boot image.
437It is likely that the boot classpath is inconsistent.
438Rebuild with ART_BOOT_IMAGE_EXTRA_ARGS="--runtime-arg -verbose:verifier" to see verification errors.`
439
Colin Cross44df5812019-02-15 23:06:46 -0800440func bootImageProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000441 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000442 global := dexpreopt.GetGlobalConfig(ctx)
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000443
Mathieu Chartier6adeee12019-06-26 10:01:36 -0700444 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000445 return nil
446 }
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000447 profile := ctx.Config().Once(bootImageProfileRuleKey, func() interface{} {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000448 defaultProfile := "frameworks/base/config/boot-image-profile.txt"
Colin Cross800fe132019-02-11 14:21:24 -0800449
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000450 rule := android.NewRuleBuilder()
451 rule.MissingDeps(missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800452
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000453 var bootImageProfile android.Path
454 if len(global.BootImageProfiles) > 1 {
455 combinedBootImageProfile := image.dir.Join(ctx, "boot-image-profile.txt")
456 rule.Command().Text("cat").Inputs(global.BootImageProfiles).Text(">").Output(combinedBootImageProfile)
457 bootImageProfile = combinedBootImageProfile
458 } else if len(global.BootImageProfiles) == 1 {
459 bootImageProfile = global.BootImageProfiles[0]
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000460 } else if path := android.ExistentPathForSource(ctx, defaultProfile); path.Valid() {
461 bootImageProfile = path.Path()
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000462 } else {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000463 // No profile (not even a default one, which is the case on some branches
464 // like master-art-host that don't have frameworks/base).
465 // Return nil and continue without profile.
466 return nil
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000467 }
Colin Cross800fe132019-02-11 14:21:24 -0800468
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000469 profile := image.dir.Join(ctx, "boot.prof")
Colin Cross800fe132019-02-11 14:21:24 -0800470
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000471 rule.Command().
472 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000473 Tool(globalSoong.Profman).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000474 FlagWithInput("--create-profile-from=", bootImageProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000475 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
476 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000477 FlagWithOutput("--reference-profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800478
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000479 rule.Install(profile, "/system/etc/boot-image.prof")
480
481 rule.Build(pctx, ctx, "bootJarsProfile", "profile boot jars")
482
483 image.profileInstalls = rule.Installs()
484
485 return profile
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000486 })
487 if profile == nil {
488 return nil // wrap nil into a typed pointer with value nil
489 }
490 return profile.(android.WritablePath)
Colin Cross800fe132019-02-11 14:21:24 -0800491}
492
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000493var bootImageProfileRuleKey = android.NewOnceKey("bootImageProfileRule")
494
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100495func bootFrameworkProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000496 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000497 global := dexpreopt.GetGlobalConfig(ctx)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100498
499 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
500 return nil
501 }
502 return ctx.Config().Once(bootFrameworkProfileRuleKey, func() interface{} {
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100503 rule := android.NewRuleBuilder()
504 rule.MissingDeps(missingDeps)
505
506 // Some branches like master-art-host don't have frameworks/base, so manually
507 // handle the case that the default is missing. Those branches won't attempt to build the profile rule,
508 // and if they do they'll get a missing deps error.
509 defaultProfile := "frameworks/base/config/boot-profile.txt"
510 path := android.ExistentPathForSource(ctx, defaultProfile)
511 var bootFrameworkProfile android.Path
512 if path.Valid() {
513 bootFrameworkProfile = path.Path()
514 } else {
515 missingDeps = append(missingDeps, defaultProfile)
516 bootFrameworkProfile = android.PathForOutput(ctx, "missing")
517 }
518
519 profile := image.dir.Join(ctx, "boot.bprof")
520
521 rule.Command().
522 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000523 Tool(globalSoong.Profman).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100524 Flag("--generate-boot-profile").
525 FlagWithInput("--create-profile-from=", bootFrameworkProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000526 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
527 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100528 FlagWithOutput("--reference-profile-file=", profile)
529
530 rule.Install(profile, "/system/etc/boot-image.bprof")
531 rule.Build(pctx, ctx, "bootFrameworkProfile", "profile boot framework jars")
532 image.profileInstalls = append(image.profileInstalls, rule.Installs()...)
533
534 return profile
535 }).(android.WritablePath)
536}
537
538var bootFrameworkProfileRuleKey = android.NewOnceKey("bootFrameworkProfileRule")
539
Colin Crossc9a4c362019-02-26 21:13:48 -0800540func dumpOatRules(ctx android.SingletonContext, image *bootImage) {
541 var archs []android.ArchType
542 for arch := range image.images {
543 archs = append(archs, arch)
544 }
545 sort.Slice(archs, func(i, j int) bool { return archs[i].String() < archs[j].String() })
546
547 var allPhonies android.Paths
548 for _, arch := range archs {
549 // Create a rule to call oatdump.
550 output := android.PathForOutput(ctx, "boot."+arch.String()+".oatdump.txt")
551 rule := android.NewRuleBuilder()
552 rule.Command().
553 // TODO: for now, use the debug version for better error reporting
Colin Crossee94d6a2019-07-08 17:08:34 -0700554 BuiltTool(ctx, "oatdumpd").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000555 FlagWithInputList("--runtime-arg -Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
556 FlagWithList("--runtime-arg -Xbootclasspath-locations:", image.dexLocationsDeps, ":").
Ulya Trafimovich163664a2019-12-06 13:42:21 +0000557 FlagWithArg("--image=", strings.Join(image.imageLocations, ":")).Implicits(image.imagesDeps[arch].Paths()).
Colin Crossc9a4c362019-02-26 21:13:48 -0800558 FlagWithOutput("--output=", output).
559 FlagWithArg("--instruction-set=", arch.String())
560 rule.Build(pctx, ctx, "dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
561
562 // Create a phony rule that depends on the output file and prints the path.
563 phony := android.PathForPhony(ctx, "dump-oat-boot-"+arch.String())
564 rule = android.NewRuleBuilder()
565 rule.Command().
566 Implicit(output).
567 ImplicitOutput(phony).
568 Text("echo").FlagWithArg("Output in ", output.String())
569 rule.Build(pctx, ctx, "phony-dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
570
571 allPhonies = append(allPhonies, phony)
572 }
573
574 phony := android.PathForPhony(ctx, "dump-oat-boot")
575 ctx.Build(pctx, android.BuildParams{
576 Rule: android.Phony,
577 Output: phony,
578 Inputs: allPhonies,
579 Description: "dump-oat-boot",
580 })
581
582}
583
Colin Cross2d00f0d2019-05-09 21:50:00 -0700584func writeGlobalConfigForMake(ctx android.SingletonContext, path android.WritablePath) {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000585 data := dexpreopt.GetGlobalConfigRawData(ctx)
Colin Cross2d00f0d2019-05-09 21:50:00 -0700586
587 ctx.Build(pctx, android.BuildParams{
588 Rule: android.WriteFile,
589 Output: path,
590 Args: map[string]string{
591 "content": string(data),
592 },
593 })
594}
595
Colin Cross44df5812019-02-15 23:06:46 -0800596// Export paths for default boot image to Make
597func (d *dexpreoptBootJars) MakeVars(ctx android.MakeVarsContext) {
Colin Cross2d00f0d2019-05-09 21:50:00 -0700598 if d.dexpreoptConfigForMake != nil {
599 ctx.Strict("DEX_PREOPT_CONFIG_FOR_MAKE", d.dexpreoptConfigForMake.String())
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000600 ctx.Strict("DEX_PREOPT_SOONG_CONFIG_FOR_MAKE", android.PathForOutput(ctx, "dexpreopt_soong.config").String())
Colin Cross2d00f0d2019-05-09 21:50:00 -0700601 }
602
Colin Cross44df5812019-02-15 23:06:46 -0800603 image := d.defaultBootImage
604 if image != nil {
Colin Cross44df5812019-02-15 23:06:46 -0800605 ctx.Strict("DEXPREOPT_IMAGE_PROFILE_BUILT_INSTALLED", image.profileInstalls.String())
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000606 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_FILES", strings.Join(image.dexPathsDeps.Strings(), " "))
607 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_LOCATIONS", strings.Join(image.dexLocationsDeps, " "))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000608
609 var imageNames []string
610 for _, current := range append(d.otherImages, image) {
611 imageNames = append(imageNames, current.name)
Colin Cross91268c62019-04-11 14:07:04 -0700612 var arches []android.ArchType
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000613 for arch, _ := range current.images {
Colin Cross91268c62019-04-11 14:07:04 -0700614 arches = append(arches, arch)
615 }
616
617 sort.Slice(arches, func(i, j int) bool { return arches[i].String() < arches[j].String() })
618
619 for _, arch := range arches {
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000620 sfx := current.name + "_" + arch.String()
621 ctx.Strict("DEXPREOPT_IMAGE_VDEX_BUILT_INSTALLED_"+sfx, current.vdexInstalls[arch].String())
622 ctx.Strict("DEXPREOPT_IMAGE_"+sfx, current.images[arch].String())
623 ctx.Strict("DEXPREOPT_IMAGE_DEPS_"+sfx, strings.Join(current.imagesDeps[arch].Strings(), " "))
624 ctx.Strict("DEXPREOPT_IMAGE_BUILT_INSTALLED_"+sfx, current.installs[arch].String())
625 ctx.Strict("DEXPREOPT_IMAGE_UNSTRIPPED_BUILT_INSTALLED_"+sfx, current.unstrippedInstalls[arch].String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000626 }
Colin Cross31bf00d2019-12-04 13:16:01 -0800627
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000628 ctx.Strict("DEXPREOPT_IMAGE_LOCATIONS_"+current.name, strings.Join(current.imageLocations, ":"))
Colin Cross31bf00d2019-12-04 13:16:01 -0800629 ctx.Strict("DEXPREOPT_IMAGE_ZIP_"+current.name, current.zip.String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000630 }
631 ctx.Strict("DEXPREOPT_IMAGE_NAMES", strings.Join(imageNames, " "))
Colin Cross800fe132019-02-11 14:21:24 -0800632 }
Colin Cross800fe132019-02-11 14:21:24 -0800633}