blob: 2bd696c3defc8750418cb02ff8f2ede5b2cc3ac2 [file] [log] [blame]
Colin Cross44df5812019-02-15 23:06:46 -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 (
Colin Cross44df5812019-02-15 23:06:46 -080018 "path/filepath"
19 "strings"
Colin Cross2d00f0d2019-05-09 21:50:00 -070020
21 "android/soong/android"
22 "android/soong/dexpreopt"
Colin Cross44df5812019-02-15 23:06:46 -080023)
24
Colin Crossc11e0c52019-05-08 15:18:22 -070025// dexpreoptTargets returns the list of targets that are relevant to dexpreopting, which excludes architectures
26// supported through native bridge.
27func dexpreoptTargets(ctx android.PathContext) []android.Target {
28 var targets []android.Target
Colin Cross3b19f5d2019-09-17 14:45:31 -070029 for _, target := range ctx.Config().Targets[android.Android] {
Colin Crossc11e0c52019-05-08 15:18:22 -070030 if target.NativeBridge == android.NativeBridgeDisabled {
31 targets = append(targets, target)
32 }
33 }
David Srbecky7f8dac12020-02-13 16:00:45 +000034 // We may also need the images on host in order to run host-based tests.
Colin Cross0c66bc62021-07-20 09:47:41 -070035 for _, target := range ctx.Config().Targets[ctx.Config().BuildOS] {
David Srbecky7f8dac12020-02-13 16:00:45 +000036 targets = append(targets, target)
37 }
Colin Crossc11e0c52019-05-08 15:18:22 -070038
39 return targets
40}
41
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000042var (
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +010043 bootImageConfigKey = android.NewOnceKey("bootImageConfig")
44 bootImageConfigRawKey = android.NewOnceKey("bootImageConfigRaw")
45 frameworkBootImageName = "boot"
46 mainlineBootImageName = "mainline"
47 bootImageStem = "boot"
48 profileInstallPathInApex = "etc/boot-image.prof"
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000049)
Ulyana Trafimovichde534412019-11-08 10:51:01 +000050
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +010051// getImageNames returns an ordered list of image names. The order doesn't matter but needs to be
52// deterministic. The names listed here must match the map keys returned by genBootImageConfigs.
53func getImageNames() []string {
54 return []string{"art", "boot", "mainline"}
55}
56
Jiakai Zhang6decef92022-01-12 17:56:19 +000057func genBootImageConfigRaw(ctx android.PathContext) map[string]*bootImageConfig {
58 return ctx.Config().Once(bootImageConfigRawKey, func() interface{} {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +000059 global := dexpreopt.GetGlobalConfig(ctx)
Nicolas Geoffray72892f12019-02-22 15:34:40 +000060
Jiakai Zhang556bdf82023-07-12 16:51:57 +010061 artBootImageName := "art" // Keep this local to avoid accidental references.
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +010062 frameworkModules := global.BootJars // This includes `global.ArtApexJars`.
Jiakai Zhangb8796202023-03-06 19:16:48 +000063 mainlineBcpModules := global.ApexBootJars
64 frameworkSubdir := "system/framework"
Nicolas Geoffray72892f12019-02-22 15:34:40 +000065
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +010066 profileImports := []string{"com.android.art"}
67
68 // ART boot image for testing only. Do not rely on it to make any build-time decision.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000069 artCfg := bootImageConfig{
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +010070 name: artBootImageName,
71 enabledIfExists: "art-bootclasspath-fragment",
72 stem: bootImageStem,
73 installDir: "apex/art_boot_images/javalib",
Jiakai Zhang556bdf82023-07-12 16:51:57 +010074 modules: global.TestOnlyArtBootImageJars,
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +010075 preloadedClassesFile: "art/build/boot/preloaded-classes",
76 compilerFilter: "speed-profile",
77 singleImage: false,
78 profileImports: profileImports,
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000079 }
Ulyana Trafimovichde534412019-11-08 10:51:01 +000080
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000081 // Framework config for the boot image extension.
Ulyana Trafimovich5a4ccd12019-12-18 17:32:33 +000082 // It includes framework libraries and depends on the ART config.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000083 frameworkCfg := bootImageConfig{
Nicolas Geoffrayb9a46fb2022-03-14 15:31:47 +000084 name: frameworkBootImageName,
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +010085 enabledIfExists: "platform-bootclasspath",
Jiakai Zhangb8796202023-03-06 19:16:48 +000086 stem: bootImageStem,
Jiakai Zhang09d88df2023-05-10 17:04:53 +010087 installDir: frameworkSubdir,
Nicolas Geoffrayb9a46fb2022-03-14 15:31:47 +000088 modules: frameworkModules,
89 preloadedClassesFile: "frameworks/base/config/preloaded-classes",
Jiakai Zhang8e9ea8b2023-02-23 17:50:46 +000090 compilerFilter: "speed-profile",
Jiakai Zhangb8796202023-03-06 19:16:48 +000091 singleImage: false,
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +010092 profileImports: profileImports,
Jiakai Zhangb8796202023-03-06 19:16:48 +000093 }
94
95 mainlineCfg := bootImageConfig{
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +010096 extends: &frameworkCfg,
97 name: mainlineBootImageName,
98 enabledIfExists: "platform-bootclasspath",
99 stem: bootImageStem,
100 installDir: frameworkSubdir,
101 modules: mainlineBcpModules,
102 compilerFilter: "verify",
103 singleImage: true,
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000104 }
105
Jiakai Zhang6decef92022-01-12 17:56:19 +0000106 return map[string]*bootImageConfig{
Ulya Trafimovich4cdada22020-02-10 15:29:28 +0000107 artBootImageName: &artCfg,
108 frameworkBootImageName: &frameworkCfg,
Jiakai Zhangb8796202023-03-06 19:16:48 +0000109 mainlineBootImageName: &mainlineCfg,
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000110 }
Jiakai Zhang6decef92022-01-12 17:56:19 +0000111 }).(map[string]*bootImageConfig)
112}
113
114// Construct the global boot image configs.
115func genBootImageConfigs(ctx android.PathContext) map[string]*bootImageConfig {
116 return ctx.Config().Once(bootImageConfigKey, func() interface{} {
117 targets := dexpreoptTargets(ctx)
Jiakai Zhangb1639db2023-07-11 15:03:13 +0100118 deviceDir := android.PathForOutput(ctx, getDexpreoptDirName(ctx))
Jiakai Zhang6decef92022-01-12 17:56:19 +0000119
120 configs := genBootImageConfigRaw(ctx)
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000121
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000122 for _, c := range configs {
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000123 c.dir = deviceDir.Join(ctx, "dex_"+c.name+"jars")
124 c.symbolsDir = deviceDir.Join(ctx, "dex_"+c.name+"jars_unstripped")
125
126 // expands to <stem>.art for primary image and <stem>-<1st module>.art for extension
Ulya Trafimovich8640ab92020-05-11 18:06:15 +0100127 imageName := c.firstModuleNameOrStem(ctx) + ".art"
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000128
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000129 // The path to bootclasspath dex files needs to be known at module
130 // GenerateAndroidBuildAction time, before the bootclasspath modules have been compiled.
131 // Set up known paths for them, the singleton rules will copy them there.
132 // TODO(b/143682396): use module dependencies instead
133 inputDir := deviceDir.Join(ctx, "dex_"+c.name+"jars_input")
Ulya Trafimovich249386a2020-07-01 14:31:13 +0100134 c.dexPaths = c.modules.BuildPaths(ctx, inputDir)
Paul Duffin5f148ca2021-06-02 17:24:22 +0100135 c.dexPathsByModule = c.modules.BuildPathsByModule(ctx, inputDir)
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000136 c.dexPathsDeps = c.dexPaths
137
David Srbeckyc177ebe2020-02-18 20:43:06 +0000138 // Create target-specific variants.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000139 for _, target := range targets {
140 arch := target.Arch.ArchType
Jiakai Zhang09d88df2023-05-10 17:04:53 +0100141 imageDir := c.dir.Join(ctx, target.Os.String(), c.installDir, arch.String())
David Srbeckyc177ebe2020-02-18 20:43:06 +0000142 variant := &bootImageVariant{
Jeongik Cha4dda75e2021-04-27 23:56:44 +0900143 bootImageConfig: c,
144 target: target,
145 imagePathOnHost: imageDir.Join(ctx, imageName),
Jiakai Zhang09d88df2023-05-10 17:04:53 +0100146 imagePathOnDevice: filepath.Join("/", c.installDir, arch.String(), imageName),
Jeongik Cha4dda75e2021-04-27 23:56:44 +0900147 imagesDeps: c.moduleFiles(ctx, imageDir, ".art", ".oat", ".vdex"),
148 dexLocations: c.modules.DevicePaths(ctx.Config(), target.Os),
David Srbeckyab994982020-03-30 17:24:13 +0100149 }
150 variant.dexLocationsDeps = variant.dexLocations
David Srbeckyc177ebe2020-02-18 20:43:06 +0000151 c.variants = append(c.variants, variant)
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000152 }
Colin Cross31bf00d2019-12-04 13:16:01 -0800153
154 c.zip = c.dir.Join(ctx, c.name+".zip")
Nicolas Geoffrayfeef2ef2019-04-30 09:43:22 +0100155 }
156
Jiakai Zhang8fe3a412023-02-23 17:37:16 +0000157 visited := make(map[string]bool)
158 for _, c := range configs {
159 calculateDepsRecursive(c, targets, visited)
David Srbeckyc177ebe2020-02-18 20:43:06 +0000160 }
Ulyana Trafimovich5a4ccd12019-12-18 17:32:33 +0000161
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000162 return configs
163 }).(map[string]*bootImageConfig)
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000164}
165
Jiakai Zhang8fe3a412023-02-23 17:37:16 +0000166// calculateDepsRecursive calculates the dependencies of the given boot image config and all its
167// ancestors, if they are not visited.
168// The boot images are supposed to form a tree, where the root is the primary boot image. We do not
169// expect loops (e.g., A extends B, B extends C, C extends A), and we let them crash soong with a
170// stack overflow.
171// Note that a boot image config only has a pointer to the parent, not to children. Therefore, we
172// first go up through the parent chain, and then go back down to visit every code along the path.
173// `visited` is a map where a key is a boot image name and the value indicates whether the boot
174// image config is visited. The boot image names are guaranteed to be unique because they come from
175// `genBootImageConfigRaw` above, which also returns a map and would fail in the first place if the
176// names were not unique.
177func calculateDepsRecursive(c *bootImageConfig, targets []android.Target, visited map[string]bool) {
178 if c.extends == nil || visited[c.name] {
179 return
180 }
181 if c.extends.extends != nil {
182 calculateDepsRecursive(c.extends, targets, visited)
183 }
184 visited[c.name] = true
185 c.dexPathsDeps = android.Concat(c.extends.dexPathsDeps, c.dexPathsDeps)
186 for i := range targets {
187 c.variants[i].baseImages = android.Concat(c.extends.variants[i].baseImages, android.OutputPaths{c.extends.variants[i].imagePathOnHost})
188 c.variants[i].baseImagesDeps = android.Concat(c.extends.variants[i].baseImagesDeps, c.extends.variants[i].imagesDeps.Paths())
189 c.variants[i].dexLocationsDeps = android.Concat(c.extends.variants[i].dexLocationsDeps, c.variants[i].dexLocationsDeps)
190 }
191}
192
David Srbeckyc177ebe2020-02-18 20:43:06 +0000193func defaultBootImageConfig(ctx android.PathContext) *bootImageConfig {
194 return genBootImageConfigs(ctx)[frameworkBootImageName]
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000195}
196
Jiakai Zhangb8796202023-03-06 19:16:48 +0000197func mainlineBootImageConfig(ctx android.PathContext) *bootImageConfig {
198 return genBootImageConfigs(ctx)[mainlineBootImageName]
199}
200
Jiakai Zhangcb13b5d2023-07-13 11:03:38 +0100201// isProfileProviderApex returns true if this apex provides a boot image profile.
202func isProfileProviderApex(ctx android.PathContext, apexName string) bool {
203 for _, config := range genBootImageConfigs(ctx) {
204 for _, profileImport := range config.profileImports {
205 if profileImport == apexName {
206 return true
207 }
208 }
209 }
210 return false
211}
212
Ulya Trafimovich9023b022021-03-22 16:02:28 +0000213// Returns a list of paths and a list of locations for the boot jars used in dexpreopt (to be
214// passed in -Xbootclasspath and -Xbootclasspath-locations arguments for dex2oat).
215func bcpForDexpreopt(ctx android.PathContext, withUpdatable bool) (android.WritablePaths, []string) {
Ulya Trafimovich9023b022021-03-22 16:02:28 +0000216 bootImage := defaultBootImageConfig(ctx)
Jiakai Zhangc6879f32023-11-06 16:31:19 +0000217 if withUpdatable {
218 bootImage = mainlineBootImageConfig(ctx)
219 }
220
Ulya Trafimovich9023b022021-03-22 16:02:28 +0000221 dexPaths := bootImage.dexPathsDeps
222 // The dex locations for all Android variants are identical.
223 dexLocations := bootImage.getAnyAndroidVariant().dexLocationsDeps
224
Ulya Trafimovich9023b022021-03-22 16:02:28 +0000225 return dexPaths, dexLocations
226}
227
Colin Cross44df5812019-02-15 23:06:46 -0800228var defaultBootclasspathKey = android.NewOnceKey("defaultBootclasspath")
229
Colin Cross44df5812019-02-15 23:06:46 -0800230func init() {
231 android.RegisterMakeVarsProvider(pctx, dexpreoptConfigMakevars)
232}
233
234func dexpreoptConfigMakevars(ctx android.MakeVarsContext) {
Ulya Trafimovich249386a2020-07-01 14:31:13 +0100235 ctx.Strict("DEXPREOPT_BOOT_JARS_MODULES", strings.Join(defaultBootImageConfig(ctx).modules.CopyOfApexJarPairs(), ":"))
Colin Cross44df5812019-02-15 23:06:46 -0800236}
Jeongik Cha4753b392023-04-19 23:25:41 +0900237
Jiakai Zhangb1639db2023-07-11 15:03:13 +0100238func getDexpreoptDirName(ctx android.PathContext) string {
239 prefix := "dexpreopt_"
240 targets := ctx.Config().Targets[android.Android]
241 if len(targets) > 0 {
Cole Faust06ea5312023-10-18 17:38:40 -0700242 return prefix + targets[0].Arch.ArchType.String()
Jiakai Zhangb1639db2023-07-11 15:03:13 +0100243 }
Cole Faust06ea5312023-10-18 17:38:40 -0700244 return prefix + "unknown_target"
Jeongik Cha4753b392023-04-19 23:25:41 +0900245}