blob: ec704d53cf8a68110873e996f267fd61b2f57621 [file] [log] [blame]
Jihoon Kang98047cf2024-10-02 17:13:54 +00001// Copyright (C) 2024 The Android Open Source Project
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 fsgen
16
17import (
Cole Faust92ccbe22024-10-03 14:38:37 -070018 "crypto/sha256"
Jihoon Kang98047cf2024-10-02 17:13:54 +000019 "fmt"
Spandan Das312cc412024-10-29 18:20:11 +000020 "path/filepath"
Cole Fauste1676122024-12-03 17:32:25 -080021 "slices"
Jihoon Kang98047cf2024-10-02 17:13:54 +000022 "strconv"
mrziwang8f86c882024-10-03 12:34:33 -070023 "strings"
mrziwang8f86c882024-10-03 12:34:33 -070024
25 "android/soong/android"
26 "android/soong/filesystem"
Spandan Das5e336422024-11-01 22:31:20 +000027 "android/soong/kernel"
Jihoon Kang98047cf2024-10-02 17:13:54 +000028
Cole Faust92ccbe22024-10-03 14:38:37 -070029 "github.com/google/blueprint"
mrziwang8f86c882024-10-03 12:34:33 -070030 "github.com/google/blueprint/parser"
Jihoon Kang98047cf2024-10-02 17:13:54 +000031 "github.com/google/blueprint/proptools"
32)
33
Cole Faust92ccbe22024-10-03 14:38:37 -070034var pctx = android.NewPackageContext("android/soong/fsgen")
35
Jihoon Kang98047cf2024-10-02 17:13:54 +000036func init() {
37 registerBuildComponents(android.InitRegistrationContext)
38}
39
40func registerBuildComponents(ctx android.RegistrationContext) {
41 ctx.RegisterModuleType("soong_filesystem_creator", filesystemCreatorFactory)
mrziwang8f86c882024-10-03 12:34:33 -070042 ctx.PreDepsMutators(RegisterCollectFileSystemDepsMutators)
43}
44
Cole Faust92ccbe22024-10-03 14:38:37 -070045type filesystemCreatorProps struct {
46 Generated_partition_types []string `blueprint:"mutated"`
47 Unsupported_partition_types []string `blueprint:"mutated"`
Cole Faust3552eb62024-11-06 18:07:26 -080048
49 Vbmeta_module_names []string `blueprint:"mutated"`
50 Vbmeta_partition_names []string `blueprint:"mutated"`
Cole Faustf2a6e8b2024-11-14 10:54:48 -080051
Cole Faust24938e22024-11-18 14:01:58 -080052 Boot_image string `blueprint:"mutated" android:"path_device_first"`
53 Vendor_boot_image string `blueprint:"mutated" android:"path_device_first"`
Jihoon Kang95eb1da2024-11-19 20:55:20 +000054 Init_boot_image string `blueprint:"mutated" android:"path_device_first"`
mrziwang79730d42024-12-02 22:13:59 -080055 Super_image string `blueprint:"mutated" android:"path_device_first"`
Cole Faust92ccbe22024-10-03 14:38:37 -070056}
57
Jihoon Kang98047cf2024-10-02 17:13:54 +000058type filesystemCreator struct {
59 android.ModuleBase
Cole Faust92ccbe22024-10-03 14:38:37 -070060
61 properties filesystemCreatorProps
Jihoon Kang98047cf2024-10-02 17:13:54 +000062}
63
64func filesystemCreatorFactory() android.Module {
65 module := &filesystemCreator{}
66
Cole Faust69788792024-10-10 11:00:36 -070067 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
Cole Faust92ccbe22024-10-03 14:38:37 -070068 module.AddProperties(&module.properties)
Jihoon Kang98047cf2024-10-02 17:13:54 +000069 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jihoon Kang675d4682024-10-24 23:45:11 +000070 generatedPrebuiltEtcModuleNames := createPrebuiltEtcModules(ctx)
Jihoon Kang04f12c92024-11-12 23:03:08 +000071 avbpubkeyGenerated := createAvbpubkeyModule(ctx)
72 createFsGenState(ctx, generatedPrebuiltEtcModuleNames, avbpubkeyGenerated)
Cole Faust953476f2024-11-14 14:11:29 -080073 module.createAvbKeyFilegroups(ctx)
Cole Faust3e730972024-12-03 13:12:08 -080074 module.createMiscFilegroups(ctx)
Jihoon Kang98047cf2024-10-02 17:13:54 +000075 module.createInternalModules(ctx)
76 })
77
78 return module
79}
80
Cole Faustf2a6e8b2024-11-14 10:54:48 -080081func generatedPartitions(ctx android.LoadHookContext) []string {
Cole Faust24938e22024-11-18 14:01:58 -080082 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Cole Faustf2a6e8b2024-11-14 10:54:48 -080083 generatedPartitions := []string{"system"}
84 if ctx.DeviceConfig().SystemExtPath() == "system_ext" {
85 generatedPartitions = append(generatedPartitions, "system_ext")
86 }
87 if ctx.DeviceConfig().BuildingVendorImage() && ctx.DeviceConfig().VendorPath() == "vendor" {
88 generatedPartitions = append(generatedPartitions, "vendor")
89 }
90 if ctx.DeviceConfig().BuildingProductImage() && ctx.DeviceConfig().ProductPath() == "product" {
91 generatedPartitions = append(generatedPartitions, "product")
92 }
93 if ctx.DeviceConfig().BuildingOdmImage() && ctx.DeviceConfig().OdmPath() == "odm" {
94 generatedPartitions = append(generatedPartitions, "odm")
95 }
96 if ctx.DeviceConfig().BuildingUserdataImage() && ctx.DeviceConfig().UserdataPath() == "data" {
97 generatedPartitions = append(generatedPartitions, "userdata")
98 }
Cole Faust24938e22024-11-18 14:01:58 -080099 if partitionVars.BuildingSystemDlkmImage {
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800100 generatedPartitions = append(generatedPartitions, "system_dlkm")
101 }
Cole Faust24938e22024-11-18 14:01:58 -0800102 if partitionVars.BuildingVendorDlkmImage {
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800103 generatedPartitions = append(generatedPartitions, "vendor_dlkm")
104 }
Cole Faust24938e22024-11-18 14:01:58 -0800105 if partitionVars.BuildingOdmDlkmImage {
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800106 generatedPartitions = append(generatedPartitions, "odm_dlkm")
107 }
Cole Faust24938e22024-11-18 14:01:58 -0800108 if partitionVars.BuildingRamdiskImage {
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800109 generatedPartitions = append(generatedPartitions, "ramdisk")
110 }
Cole Faust24938e22024-11-18 14:01:58 -0800111 if buildingVendorBootImage(partitionVars) {
112 generatedPartitions = append(generatedPartitions, "vendor_ramdisk")
113 }
Jihoon Kang3216c982024-12-02 19:42:20 +0000114 if ctx.DeviceConfig().BuildingRecoveryImage() && ctx.DeviceConfig().RecoveryPath() == "recovery" {
115 generatedPartitions = append(generatedPartitions, "recovery")
116 }
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800117 return generatedPartitions
118}
119
Jihoon Kang98047cf2024-10-02 17:13:54 +0000120func (f *filesystemCreator) createInternalModules(ctx android.LoadHookContext) {
Cole Faust3552eb62024-11-06 18:07:26 -0800121 soongGeneratedPartitions := generatedPartitions(ctx)
122 finalSoongGeneratedPartitions := make([]string, 0, len(soongGeneratedPartitions))
123 for _, partitionType := range soongGeneratedPartitions {
Cole Faust92ccbe22024-10-03 14:38:37 -0700124 if f.createPartition(ctx, partitionType) {
125 f.properties.Generated_partition_types = append(f.properties.Generated_partition_types, partitionType)
Cole Faust3552eb62024-11-06 18:07:26 -0800126 finalSoongGeneratedPartitions = append(finalSoongGeneratedPartitions, partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700127 } else {
128 f.properties.Unsupported_partition_types = append(f.properties.Unsupported_partition_types, partitionType)
129 }
130 }
Cole Faust3552eb62024-11-06 18:07:26 -0800131
Cole Faust24938e22024-11-18 14:01:58 -0800132 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Jihoon Kang70c1c682024-11-20 23:58:38 +0000133 dtbImg := createDtbImgFilegroup(ctx)
134
Cole Faust24938e22024-11-18 14:01:58 -0800135 if buildingBootImage(partitionVars) {
Jihoon Kang70c1c682024-11-20 23:58:38 +0000136 if createBootImage(ctx, dtbImg) {
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800137 f.properties.Boot_image = ":" + generatedModuleNameForPartition(ctx.Config(), "boot")
138 } else {
139 f.properties.Unsupported_partition_types = append(f.properties.Unsupported_partition_types, "boot")
140 }
141 }
Cole Faust24938e22024-11-18 14:01:58 -0800142 if buildingVendorBootImage(partitionVars) {
Jihoon Kang70c1c682024-11-20 23:58:38 +0000143 if createVendorBootImage(ctx, dtbImg) {
Cole Faust24938e22024-11-18 14:01:58 -0800144 f.properties.Vendor_boot_image = ":" + generatedModuleNameForPartition(ctx.Config(), "vendor_boot")
145 } else {
146 f.properties.Unsupported_partition_types = append(f.properties.Unsupported_partition_types, "vendor_boot")
147 }
148 }
Jihoon Kang95eb1da2024-11-19 20:55:20 +0000149 if buildingInitBootImage(partitionVars) {
150 if createInitBootImage(ctx) {
151 f.properties.Init_boot_image = ":" + generatedModuleNameForPartition(ctx.Config(), "init_boot")
152 } else {
153 f.properties.Unsupported_partition_types = append(f.properties.Unsupported_partition_types, "init_boot")
154 }
155 }
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800156
Cole Faust3552eb62024-11-06 18:07:26 -0800157 for _, x := range createVbmetaPartitions(ctx, finalSoongGeneratedPartitions) {
158 f.properties.Vbmeta_module_names = append(f.properties.Vbmeta_module_names, x.moduleName)
159 f.properties.Vbmeta_partition_names = append(f.properties.Vbmeta_partition_names, x.partitionName)
160 }
161
mrziwang79730d42024-12-02 22:13:59 -0800162 if buildingSuperImage(partitionVars) {
163 createSuperImage(ctx, finalSoongGeneratedPartitions, partitionVars)
164 f.properties.Super_image = ":" + generatedModuleName(ctx.Config(), "super")
165 }
166
Cole Faust3552eb62024-11-06 18:07:26 -0800167 ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions = finalSoongGeneratedPartitions
168 f.createDeviceModule(ctx, finalSoongGeneratedPartitions, f.properties.Vbmeta_module_names)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000169}
170
Jihoon Kang0d545b82024-10-11 00:21:57 +0000171func generatedModuleName(cfg android.Config, suffix string) string {
Cole Faust92ccbe22024-10-03 14:38:37 -0700172 prefix := "soong"
173 if cfg.HasDeviceProduct() {
174 prefix = cfg.DeviceProduct()
175 }
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000176 return fmt.Sprintf("%s_generated_%s", prefix, suffix)
177}
178
Jihoon Kang0d545b82024-10-11 00:21:57 +0000179func generatedModuleNameForPartition(cfg android.Config, partitionType string) string {
180 return generatedModuleName(cfg, fmt.Sprintf("%s_image", partitionType))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000181}
182
Cole Faust3552eb62024-11-06 18:07:26 -0800183func (f *filesystemCreator) createDeviceModule(
184 ctx android.LoadHookContext,
185 generatedPartitionTypes []string,
186 vbmetaPartitions []string,
187) {
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000188 baseProps := &struct {
189 Name *string
190 }{
Jihoon Kang0d545b82024-10-11 00:21:57 +0000191 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "device")),
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000192 }
193
Priyanka Advani (xWF)dafaa7f2024-10-21 22:55:13 +0000194 // Currently, only the system and system_ext partition module is created.
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000195 partitionProps := &filesystem.PartitionNameProperties{}
Cole Faust3552eb62024-11-06 18:07:26 -0800196 if android.InList("system", generatedPartitionTypes) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000197 partitionProps.System_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000198 }
Cole Faust3552eb62024-11-06 18:07:26 -0800199 if android.InList("system_ext", generatedPartitionTypes) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000200 partitionProps.System_ext_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
Spandan Das7a46f6c2024-10-14 18:41:18 +0000201 }
Cole Faust3552eb62024-11-06 18:07:26 -0800202 if android.InList("vendor", generatedPartitionTypes) {
Spandan Dase3b65312024-10-22 00:27:27 +0000203 partitionProps.Vendor_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "vendor"))
204 }
Cole Faust3552eb62024-11-06 18:07:26 -0800205 if android.InList("product", generatedPartitionTypes) {
Jihoon Kang6dd13b62024-10-22 23:21:02 +0000206 partitionProps.Product_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "product"))
207 }
Cole Faust3552eb62024-11-06 18:07:26 -0800208 if android.InList("odm", generatedPartitionTypes) {
Spandan Dasc5717162024-11-01 18:33:57 +0000209 partitionProps.Odm_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "odm"))
210 }
mrziwang23ba8762024-11-07 16:21:53 -0800211 if android.InList("userdata", f.properties.Generated_partition_types) {
212 partitionProps.Userdata_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "userdata"))
213 }
Cole Faust3552eb62024-11-06 18:07:26 -0800214 partitionProps.Vbmeta_partitions = vbmetaPartitions
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000215
216 ctx.CreateModule(filesystem.AndroidDeviceFactory, baseProps, partitionProps)
Cole Faust92ccbe22024-10-03 14:38:37 -0700217}
218
Spandan Das71be42d2024-11-20 18:34:16 +0000219func partitionSpecificFsProps(ctx android.EarlyModuleContext, fsProps *filesystem.FilesystemProperties, partitionVars android.PartitionVariables, partitionType string) {
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000220 switch partitionType {
221 case "system":
222 fsProps.Build_logtags = proptools.BoolPtr(true)
223 // https://source.corp.google.com/h/googleplex-android/platform/build//639d79f5012a6542ab1f733b0697db45761ab0f3:core/packaging/flags.mk;l=21;drc=5ba8a8b77507f93aa48cc61c5ba3f31a4d0cbf37;bpv=1;bpt=0
224 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Justin Yuned3dbce2024-11-15 11:57:24 +0900225 // Identical to that of the aosp_shared_system_image
Spandan Das2b4bf4c2024-12-02 19:41:04 +0000226 if partitionVars.ProductFsverityGenerateMetadata {
227 fsProps.Fsverity.Inputs = []string{
228 "etc/boot-image.prof",
229 "etc/dirty-image-objects",
230 "etc/preloaded-classes",
231 "etc/classpaths/*.pb",
232 "framework/*",
233 "framework/*/*", // framework/{arch}
234 "framework/oat/*/*", // framework/oat/{arch}
235 }
236 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000237 }
Cole Faust1d4e76c2024-11-26 14:15:29 -0800238 // Most of the symlinks and directories listed here originate from create_root_structure.mk,
239 // but the handwritten generic system image also recreates them:
240 // https://cs.android.com/android/platform/superproject/main/+/main:build/make/target/product/generic/Android.bp;l=33;drc=db08311f1b6ef6cb0a4fbcc6263b89849360ce04
mrziwang9afc2982024-11-05 14:29:48 -0800241 // TODO(b/377734331): only generate the symlinks if the relevant partitions exist
242 fsProps.Symlinks = []filesystem.SymlinkDefinition{
243 filesystem.SymlinkDefinition{
Cole Faust1d4e76c2024-11-26 14:15:29 -0800244 Target: proptools.StringPtr("/system/bin/init"),
245 Name: proptools.StringPtr("init"),
246 },
247 filesystem.SymlinkDefinition{
248 Target: proptools.StringPtr("/system/etc"),
249 Name: proptools.StringPtr("etc"),
250 },
251 filesystem.SymlinkDefinition{
252 Target: proptools.StringPtr("/system/bin"),
253 Name: proptools.StringPtr("bin"),
254 },
255 filesystem.SymlinkDefinition{
256 Target: proptools.StringPtr("/data/user_de/0/com.android.shell/files/bugreports"),
257 Name: proptools.StringPtr("bugreports"),
258 },
259 filesystem.SymlinkDefinition{
260 Target: proptools.StringPtr("/sys/kernel/debug"),
261 Name: proptools.StringPtr("d"),
262 },
263 filesystem.SymlinkDefinition{
264 Target: proptools.StringPtr("/storage/self/primary"),
265 Name: proptools.StringPtr("sdcard"),
266 },
267 filesystem.SymlinkDefinition{
268 Target: proptools.StringPtr("/product/etc/security/adb_keys"),
269 Name: proptools.StringPtr("adb_keys"),
270 },
271 filesystem.SymlinkDefinition{
272 Target: proptools.StringPtr("/vendor/odm/app"),
273 Name: proptools.StringPtr("odm/app"),
274 },
275 filesystem.SymlinkDefinition{
276 Target: proptools.StringPtr("/vendor/odm/bin"),
277 Name: proptools.StringPtr("odm/bin"),
278 },
279 filesystem.SymlinkDefinition{
280 Target: proptools.StringPtr("/vendor/odm/etc"),
281 Name: proptools.StringPtr("odm/etc"),
282 },
283 filesystem.SymlinkDefinition{
284 Target: proptools.StringPtr("/vendor/odm/firmware"),
285 Name: proptools.StringPtr("odm/firmware"),
286 },
287 filesystem.SymlinkDefinition{
288 Target: proptools.StringPtr("/vendor/odm/framework"),
289 Name: proptools.StringPtr("odm/framework"),
290 },
291 filesystem.SymlinkDefinition{
292 Target: proptools.StringPtr("/vendor/odm/lib"),
293 Name: proptools.StringPtr("odm/lib"),
294 },
295 filesystem.SymlinkDefinition{
296 Target: proptools.StringPtr("/vendor/odm/lib64"),
297 Name: proptools.StringPtr("odm/lib64"),
298 },
299 filesystem.SymlinkDefinition{
300 Target: proptools.StringPtr("/vendor/odm/overlay"),
301 Name: proptools.StringPtr("odm/overlay"),
302 },
303 filesystem.SymlinkDefinition{
304 Target: proptools.StringPtr("/vendor/odm/priv-app"),
305 Name: proptools.StringPtr("odm/priv-app"),
306 },
307 filesystem.SymlinkDefinition{
308 Target: proptools.StringPtr("/vendor/odm/usr"),
309 Name: proptools.StringPtr("odm/usr"),
310 },
311 filesystem.SymlinkDefinition{
mrziwang9afc2982024-11-05 14:29:48 -0800312 Target: proptools.StringPtr("/product"),
313 Name: proptools.StringPtr("system/product"),
314 },
315 filesystem.SymlinkDefinition{
316 Target: proptools.StringPtr("/system_ext"),
317 Name: proptools.StringPtr("system/system_ext"),
318 },
319 filesystem.SymlinkDefinition{
320 Target: proptools.StringPtr("/vendor"),
321 Name: proptools.StringPtr("system/vendor"),
322 },
323 filesystem.SymlinkDefinition{
324 Target: proptools.StringPtr("/system_dlkm/lib/modules"),
325 Name: proptools.StringPtr("system/lib/modules"),
326 },
Cole Faust1d4e76c2024-11-26 14:15:29 -0800327 filesystem.SymlinkDefinition{
328 Target: proptools.StringPtr("/data/cache"),
329 Name: proptools.StringPtr("cache"),
330 },
Cole Faust0d467052024-12-04 17:19:19 -0800331 // For Treble Generic System Image (GSI), system-as-root GSI needs to work on
332 // both devices with and without /odm_dlkm partition. Those symlinks are for
333 // devices without /odm_dlkm partition. For devices with /odm_dlkm
334 // partition, mount odm_dlkm.img under /odm_dlkm will hide those symlinks.
335 // Note that /odm_dlkm/lib is omitted because odm DLKMs should be accessed
336 // via /odm/lib/modules directly. All of this also applies to the vendor_dlkm symlink
337 filesystem.SymlinkDefinition{
338 Target: proptools.StringPtr("/odm/odm_dlkm/etc"),
339 Name: proptools.StringPtr("odm_dlkm/etc"),
340 },
341 filesystem.SymlinkDefinition{
342 Target: proptools.StringPtr("/vendor/vendor_dlkm/etc"),
343 Name: proptools.StringPtr("vendor_dlkm/etc"),
344 },
mrziwang9afc2982024-11-05 14:29:48 -0800345 }
Cole Faust1d4e76c2024-11-26 14:15:29 -0800346 fsProps.Dirs = proptools.NewSimpleConfigurable([]string{
347 // From generic_rootdirs in build/make/target/product/generic/Android.bp
348 "acct",
349 "apex",
350 "bootstrap-apex",
351 "config",
352 "data",
353 "data_mirror",
354 "debug_ramdisk",
355 "dev",
356 "linkerconfig",
357 "metadata",
358 "mnt",
359 "odm",
360 "odm_dlkm",
361 "oem",
362 "postinstall",
363 "proc",
364 "second_stage_resources",
365 "storage",
366 "sys",
367 "system",
368 "system_dlkm",
369 "tmp",
370 "vendor",
371 "vendor_dlkm",
372
373 // from android_rootdirs in build/make/target/product/generic/Android.bp
374 "system_ext",
375 "product",
376 })
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000377 case "system_ext":
Spandan Das2b4bf4c2024-12-02 19:41:04 +0000378 if partitionVars.ProductFsverityGenerateMetadata {
379 fsProps.Fsverity.Inputs = []string{
380 "framework/*",
381 "framework/*/*", // framework/{arch}
382 "framework/oat/*/*", // framework/oat/{arch}
383 }
384 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000385 }
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000386 case "product":
387 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das71be42d2024-11-20 18:34:16 +0000388 fsProps.Android_filesystem_deps.System = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
389 if ctx.DeviceConfig().SystemExtPath() == "system_ext" {
390 fsProps.Android_filesystem_deps.System_ext = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
391 }
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000392 case "vendor":
393 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das69464c32024-10-25 20:08:06 +0000394 fsProps.Symlinks = []filesystem.SymlinkDefinition{
395 filesystem.SymlinkDefinition{
396 Target: proptools.StringPtr("/odm"),
397 Name: proptools.StringPtr("vendor/odm"),
398 },
399 filesystem.SymlinkDefinition{
400 Target: proptools.StringPtr("/vendor_dlkm/lib/modules"),
401 Name: proptools.StringPtr("vendor/lib/modules"),
402 },
403 }
Spandan Das71be42d2024-11-20 18:34:16 +0000404 fsProps.Android_filesystem_deps.System = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
405 if ctx.DeviceConfig().SystemExtPath() == "system_ext" {
406 fsProps.Android_filesystem_deps.System_ext = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
407 }
Spandan Dasc5717162024-11-01 18:33:57 +0000408 case "odm":
409 fsProps.Symlinks = []filesystem.SymlinkDefinition{
410 filesystem.SymlinkDefinition{
411 Target: proptools.StringPtr("/odm_dlkm/lib/modules"),
412 Name: proptools.StringPtr("odm/lib/modules"),
413 },
414 }
mrziwang23ba8762024-11-07 16:21:53 -0800415 case "userdata":
416 fsProps.Base_dir = proptools.StringPtr("data")
Jihoon Kangd098d442024-11-19 00:03:22 +0000417 case "ramdisk":
418 // Following the logic in https://cs.android.com/android/platform/superproject/main/+/c3c5063df32748a8806ce5da5dd0db158eab9ad9:build/make/core/Makefile;l=1307
419 fsProps.Dirs = android.NewSimpleConfigurable([]string{
420 "debug_ramdisk",
421 "dev",
422 "metadata",
423 "mnt",
424 "proc",
425 "second_stage_resources",
426 "sys",
427 })
428 if partitionVars.BoardUsesGenericKernelImage {
429 fsProps.Dirs.AppendSimpleValue([]string{
430 "first_stage_ramdisk/debug_ramdisk",
431 "first_stage_ramdisk/dev",
432 "first_stage_ramdisk/metadata",
433 "first_stage_ramdisk/mnt",
434 "first_stage_ramdisk/proc",
435 "first_stage_ramdisk/second_stage_resources",
436 "first_stage_ramdisk/sys",
437 })
438 }
Jihoon Kang9007f382024-12-04 00:43:52 +0000439 case "recovery":
440 // Following https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/Makefile;l=2826;drc=ad7cfb56010cb22c3aa0e70cf71c804352553526
441 fsProps.Dirs = android.NewSimpleConfigurable([]string{
442 "sdcard",
443 "tmp",
444 })
445 fsProps.Symlinks = []filesystem.SymlinkDefinition{
446 {
447 Target: proptools.StringPtr("/system/bin/init"),
448 Name: proptools.StringPtr("init"),
449 },
450 {
451 Target: proptools.StringPtr("prop.default"),
452 Name: proptools.StringPtr("default.prop"),
453 },
454 }
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000455 }
456}
Spandan Dascbe641a2024-10-14 21:07:34 +0000457
Spandan Das5b493cd2024-11-07 20:55:56 +0000458var (
459 dlkmPartitions = []string{
460 "system_dlkm",
461 "vendor_dlkm",
462 "odm_dlkm",
463 }
464)
465
Cole Faust92ccbe22024-10-03 14:38:37 -0700466// Creates a soong module to build the given partition. Returns false if we can't support building
467// it.
468func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700469 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
470
471 fsProps, supported := generateFsProps(ctx, partitionType)
472 if !supported {
473 return false
mrziwanga077b942024-10-16 16:00:06 -0700474 }
mrziwanga077b942024-10-16 16:00:06 -0700475
Cole Faust7db05752024-11-21 13:30:41 -0800476 if partitionType == "vendor" || partitionType == "product" || partitionType == "system" {
Spandan Das2047a4c2024-11-11 21:24:58 +0000477 fsProps.Linker_config.Gen_linker_config = proptools.BoolPtr(true)
Cole Faust7db05752024-11-21 13:30:41 -0800478 if partitionType != "system" {
479 fsProps.Linker_config.Linker_config_srcs = f.createLinkerConfigSourceFilegroups(ctx, partitionType)
480 }
Spandan Das312cc412024-10-29 18:20:11 +0000481 }
482
Jihoon Kanga8fa0712024-11-26 23:11:07 +0000483 if android.InList(partitionType, append(dlkmPartitions, "vendor_ramdisk")) {
Spandan Das5b493cd2024-11-07 20:55:56 +0000484 f.createPrebuiltKernelModules(ctx, partitionType)
Spandan Das5e336422024-11-01 22:31:20 +0000485 }
486
mrziwang4b0ca972024-10-17 14:56:19 -0700487 var module android.Module
488 if partitionType == "system" {
489 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
490 } else {
491 // Explicitly set the partition.
492 fsProps.Partition_type = proptools.StringPtr(partitionType)
493 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
494 }
495 module.HideFromMake()
Spandan Das168098c2024-10-28 19:44:34 +0000496 if partitionType == "vendor" {
Spandan Das4cd93b52024-11-05 23:27:03 +0000497 f.createVendorBuildProp(ctx)
Spandan Das168098c2024-10-28 19:44:34 +0000498 }
mrziwang4b0ca972024-10-17 14:56:19 -0700499 return true
500}
501
Cole Faust953476f2024-11-14 14:11:29 -0800502// Creates filegroups for the files specified in BOARD_(partition_)AVB_KEY_PATH
503func (f *filesystemCreator) createAvbKeyFilegroups(ctx android.LoadHookContext) {
504 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
505 var files []string
506
507 if len(partitionVars.BoardAvbKeyPath) > 0 {
508 files = append(files, partitionVars.BoardAvbKeyPath)
509 }
510 for _, partition := range android.SortedKeys(partitionVars.PartitionQualifiedVariables) {
511 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partition]
512 if len(specificPartitionVars.BoardAvbKeyPath) > 0 {
513 files = append(files, specificPartitionVars.BoardAvbKeyPath)
514 }
515 }
516
517 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
518 for _, file := range files {
519 if _, ok := fsGenState.avbKeyFilegroups[file]; ok {
520 continue
521 }
522 if file == "external/avb/test/data/testkey_rsa4096.pem" {
523 // There already exists a checked-in filegroup for this commonly-used key, just use that
524 fsGenState.avbKeyFilegroups[file] = "avb_testkey_rsa4096"
525 continue
526 }
527 dir := filepath.Dir(file)
528 base := filepath.Base(file)
529 name := fmt.Sprintf("avb_key_%x", strings.ReplaceAll(file, "/", "_"))
530 ctx.CreateModuleInDirectory(
531 android.FileGroupFactory,
532 dir,
533 &struct {
534 Name *string
535 Srcs []string
536 Visibility []string
537 }{
538 Name: proptools.StringPtr(name),
539 Srcs: []string{base},
540 Visibility: []string{"//visibility:public"},
541 },
542 )
543 fsGenState.avbKeyFilegroups[file] = name
544 }
545}
546
Cole Faust3e730972024-12-03 13:12:08 -0800547// Creates filegroups for miscellaneous other files
548func (f *filesystemCreator) createMiscFilegroups(ctx android.LoadHookContext) {
549 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
550
551 if partitionVars.BoardErofsCompressorHints != "" {
552 dir := filepath.Dir(partitionVars.BoardErofsCompressorHints)
553 base := filepath.Base(partitionVars.BoardErofsCompressorHints)
554 ctx.CreateModuleInDirectory(
555 android.FileGroupFactory,
556 dir,
557 &struct {
558 Name *string
559 Srcs []string
560 Visibility []string
561 }{
562 Name: proptools.StringPtr("soong_generated_board_erofs_compress_hints_filegroup"),
563 Srcs: []string{base},
564 Visibility: []string{"//visibility:public"},
565 },
566 )
567 }
568}
569
Spandan Das5e336422024-11-01 22:31:20 +0000570// createPrebuiltKernelModules creates `prebuilt_kernel_modules`. These modules will be added to deps of the
Spandan Das7b25a512024-11-06 20:41:26 +0000571// autogenerated *_dlkm filsystem modules. Each _dlkm partition should have a single prebuilt_kernel_modules dependency.
572// This ensures that the depmod artifacts (modules.* installed in /lib/modules/) are generated with a complete view.
Spandan Das5b493cd2024-11-07 20:55:56 +0000573func (f *filesystemCreator) createPrebuiltKernelModules(ctx android.LoadHookContext, partitionType string) {
Spandan Das5e336422024-11-01 22:31:20 +0000574 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
Spandan Das7b25a512024-11-06 20:41:26 +0000575 name := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-kernel-modules", partitionType))
576 props := &struct {
Spandan Das912d26b2024-11-06 19:35:17 +0000577 Name *string
578 Srcs []string
Spandan Das5b493cd2024-11-07 20:55:56 +0000579 System_deps []string
Spandan Das912d26b2024-11-06 19:35:17 +0000580 System_dlkm_specific *bool
Spandan Das5b493cd2024-11-07 20:55:56 +0000581 Vendor_dlkm_specific *bool
582 Odm_dlkm_specific *bool
Jihoon Kanga8fa0712024-11-26 23:11:07 +0000583 Vendor_ramdisk *bool
Spandan Das5b493cd2024-11-07 20:55:56 +0000584 Load_by_default *bool
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000585 Blocklist_file *string
Jihoon Kang72dd6fc2024-11-27 01:16:39 +0000586 Options_file *string
Spandan Das7b25a512024-11-06 20:41:26 +0000587 }{
588 Name: proptools.StringPtr(name),
Spandan Das5e336422024-11-01 22:31:20 +0000589 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000590 switch partitionType {
591 case "system_dlkm":
Spandan Das59ee5d72024-11-18 19:36:32 +0000592 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules).Strings()
Spandan Das912d26b2024-11-06 19:35:17 +0000593 props.System_dlkm_specific = proptools.BoolPtr(true)
Spandan Das5b493cd2024-11-07 20:55:56 +0000594 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelLoadModules) == 0 {
595 // Create empty modules.load file for system
596 // https://source.corp.google.com/h/googleplex-android/platform/build/+/ef55daac9954896161b26db4f3ef1781b5a5694c:core/Makefile;l=695-700;drc=549fe2a5162548bd8b47867d35f907eb22332023;bpv=1;bpt=0
597 props.Load_by_default = proptools.BoolPtr(false)
598 }
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000599 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelBlocklistFile; blocklistFile != "" {
600 props.Blocklist_file = proptools.StringPtr(blocklistFile)
601 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000602 case "vendor_dlkm":
Spandan Das59ee5d72024-11-18 19:36:32 +0000603 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorKernelModules).Strings()
Spandan Das5b493cd2024-11-07 20:55:56 +0000604 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules) > 0 {
605 props.System_deps = []string{":" + generatedModuleName(ctx.Config(), "system_dlkm-kernel-modules") + "{.modules}"}
606 }
607 props.Vendor_dlkm_specific = proptools.BoolPtr(true)
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000608 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorKernelBlocklistFile; blocklistFile != "" {
609 props.Blocklist_file = proptools.StringPtr(blocklistFile)
610 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000611 case "odm_dlkm":
Spandan Das59ee5d72024-11-18 19:36:32 +0000612 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.OdmKernelModules).Strings()
Spandan Das5b493cd2024-11-07 20:55:56 +0000613 props.Odm_dlkm_specific = proptools.BoolPtr(true)
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000614 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.OdmKernelBlocklistFile; blocklistFile != "" {
615 props.Blocklist_file = proptools.StringPtr(blocklistFile)
616 }
Jihoon Kanga8fa0712024-11-26 23:11:07 +0000617 case "vendor_ramdisk":
618 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorRamdiskKernelModules).Strings()
619 props.Vendor_ramdisk = proptools.BoolPtr(true)
620 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorRamdiskKernelBlocklistFile; blocklistFile != "" {
621 props.Blocklist_file = proptools.StringPtr(blocklistFile)
622 }
Jihoon Kang72dd6fc2024-11-27 01:16:39 +0000623 if optionsFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorRamdiskKernelOptionsFile; optionsFile != "" {
624 props.Options_file = proptools.StringPtr(optionsFile)
625 }
626
Spandan Das5b493cd2024-11-07 20:55:56 +0000627 default:
628 ctx.ModuleErrorf("DLKM is not supported for %s\n", partitionType)
Spandan Das912d26b2024-11-06 19:35:17 +0000629 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000630
631 if len(props.Srcs) == 0 {
632 return // do not generate `prebuilt_kernel_modules` if there are no sources
633 }
634
Spandan Das7b25a512024-11-06 20:41:26 +0000635 kernelModule := ctx.CreateModuleInDirectory(
636 kernel.PrebuiltKernelModulesFactory,
637 ".", // create in root directory for now
638 props,
639 )
640 kernelModule.HideFromMake()
641 // Add to deps
642 (*fsGenState.fsDeps[partitionType])[name] = defaultDepCandidateProps(ctx.Config())
Spandan Das5e336422024-11-01 22:31:20 +0000643}
644
Spandan Das4cd93b52024-11-05 23:27:03 +0000645// Create a build_prop and android_info module. This will be used to create /vendor/build.prop
646func (f *filesystemCreator) createVendorBuildProp(ctx android.LoadHookContext) {
647 // Create a android_info for vendor
648 // The board info files might be in a directory outside the root soong namespace, so create
649 // the module in "."
650 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
651 androidInfoProps := &struct {
652 Name *string
653 Board_info_files []string
654 Bootloader_board_name *string
655 }{
656 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "android-info.prop")),
657 Board_info_files: partitionVars.BoardInfoFiles,
658 }
659 if len(androidInfoProps.Board_info_files) == 0 {
660 androidInfoProps.Bootloader_board_name = proptools.StringPtr(partitionVars.BootLoaderBoardName)
661 }
662 androidInfoProp := ctx.CreateModuleInDirectory(
663 android.AndroidInfoFactory,
664 ".",
665 androidInfoProps,
666 )
667 androidInfoProp.HideFromMake()
668 // Create a build prop for vendor
669 vendorBuildProps := &struct {
670 Name *string
671 Vendor *bool
672 Stem *string
673 Product_config *string
674 Android_info *string
675 }{
676 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "vendor-build.prop")),
677 Vendor: proptools.BoolPtr(true),
678 Stem: proptools.StringPtr("build.prop"),
679 Product_config: proptools.StringPtr(":product_config"),
680 Android_info: proptools.StringPtr(":" + androidInfoProp.Name()),
681 }
682 vendorBuildProp := ctx.CreateModule(
683 android.BuildPropFactory,
684 vendorBuildProps,
685 )
686 vendorBuildProp.HideFromMake()
687}
688
Spandan Das8fe68dc2024-10-29 18:20:11 +0000689// createLinkerConfigSourceFilegroups creates filegroup modules to generate linker.config.pb for the following partitions
690// 1. vendor: Using PRODUCT_VENDOR_LINKER_CONFIG_FRAGMENTS (space separated file list)
691// 1. product: Using PRODUCT_PRODUCT_LINKER_CONFIG_FRAGMENTS (space separated file list)
692// It creates a filegroup for each file in the fragment list
Spandan Das312cc412024-10-29 18:20:11 +0000693// The filegroup modules are then added to `linker_config_srcs` of the autogenerated vendor `android_filesystem`.
Spandan Das8fe68dc2024-10-29 18:20:11 +0000694func (f *filesystemCreator) createLinkerConfigSourceFilegroups(ctx android.LoadHookContext, partitionType string) []string {
Spandan Das312cc412024-10-29 18:20:11 +0000695 ret := []string{}
696 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Spandan Das8fe68dc2024-10-29 18:20:11 +0000697 var linkerConfigSrcs []string
698 if partitionType == "vendor" {
699 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.VendorLinkerConfigSrcs)
700 } else if partitionType == "product" {
701 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.ProductLinkerConfigSrcs)
702 } else {
703 ctx.ModuleErrorf("linker.config.pb is only supported for vendor and product partitions. For system partition, use `android_system_image`")
704 }
705
706 if len(linkerConfigSrcs) > 0 {
Spandan Das312cc412024-10-29 18:20:11 +0000707 // Create a filegroup, and add `:<filegroup_name>` to ret.
708 for index, linkerConfigSrc := range linkerConfigSrcs {
709 dir := filepath.Dir(linkerConfigSrc)
710 base := filepath.Base(linkerConfigSrc)
Spandan Das8fe68dc2024-10-29 18:20:11 +0000711 fgName := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-linker-config-src%s", partitionType, strconv.Itoa(index)))
Spandan Das312cc412024-10-29 18:20:11 +0000712 srcs := []string{base}
713 fgProps := &struct {
714 Name *string
715 Srcs proptools.Configurable[[]string]
716 }{
717 Name: proptools.StringPtr(fgName),
718 Srcs: proptools.NewSimpleConfigurable(srcs),
719 }
720 ctx.CreateModuleInDirectory(
721 android.FileGroupFactory,
722 dir,
723 fgProps,
724 )
725 ret = append(ret, ":"+fgName)
726 }
727 }
728 return ret
729}
730
mrziwang4b0ca972024-10-17 14:56:19 -0700731type filesystemBaseProperty struct {
732 Name *string
733 Compile_multilib *string
Cole Faust3552eb62024-11-06 18:07:26 -0800734 Visibility []string
mrziwang4b0ca972024-10-17 14:56:19 -0700735}
736
737func generateBaseProps(namePtr *string) *filesystemBaseProperty {
738 return &filesystemBaseProperty{
739 Name: namePtr,
740 Compile_multilib: proptools.StringPtr("both"),
Cole Faust3552eb62024-11-06 18:07:26 -0800741 // The vbmeta modules are currently in the root directory and depend on the partitions
742 Visibility: []string{"//.", "//build/soong:__subpackages__"},
mrziwang4b0ca972024-10-17 14:56:19 -0700743 }
744}
745
746func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700747 fsProps := &filesystem.FilesystemProperties{}
748
mrziwang4b0ca972024-10-17 14:56:19 -0700749 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Cole Faust0c4b4152024-11-20 16:42:53 -0800750 var avbInfo avbInfo
Cole Faust76a6e952024-11-07 16:56:45 -0800751 var fsType string
752 if strings.Contains(partitionType, "ramdisk") {
753 fsType = "compressed_cpio"
754 } else {
Cole Faust953476f2024-11-14 14:11:29 -0800755 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
Cole Faust76a6e952024-11-07 16:56:45 -0800756 fsType = specificPartitionVars.BoardFileSystemType
Cole Faust0c4b4152024-11-20 16:42:53 -0800757 avbInfo = getAvbInfo(ctx.Config(), partitionType)
Cole Faust953476f2024-11-14 14:11:29 -0800758 if fsType == "" {
759 fsType = "ext4" //default
760 }
Cole Faust76a6e952024-11-07 16:56:45 -0800761 }
Cole Faust76a6e952024-11-07 16:56:45 -0800762
mrziwang4b0ca972024-10-17 14:56:19 -0700763 fsProps.Type = proptools.StringPtr(fsType)
764 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
765 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
766 return nil, false
767 }
768
Cole Faust3e730972024-12-03 13:12:08 -0800769 if *fsProps.Type == "erofs" {
770 if partitionVars.BoardErofsCompressor != "" {
771 fsProps.Erofs.Compressor = proptools.StringPtr(partitionVars.BoardErofsCompressor)
772 }
773 if partitionVars.BoardErofsCompressorHints != "" {
774 fsProps.Erofs.Compress_hints = proptools.StringPtr(":soong_generated_board_erofs_compress_hints_filegroup")
775 }
776 }
777
Cole Faust92ccbe22024-10-03 14:38:37 -0700778 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
779 // and sometimes don't build.
780 fsProps.Unchecked_module = proptools.BoolPtr(true)
781
Jihoon Kang98047cf2024-10-02 17:13:54 +0000782 // BOARD_AVB_ENABLE
Cole Faust0c4b4152024-11-20 16:42:53 -0800783 fsProps.Use_avb = avbInfo.avbEnable
Jihoon Kang98047cf2024-10-02 17:13:54 +0000784 // BOARD_AVB_KEY_PATH
Cole Faust0c4b4152024-11-20 16:42:53 -0800785 fsProps.Avb_private_key = avbInfo.avbkeyFilegroup
Jihoon Kang98047cf2024-10-02 17:13:54 +0000786 // BOARD_AVB_ALGORITHM
Cole Faust0c4b4152024-11-20 16:42:53 -0800787 fsProps.Avb_algorithm = avbInfo.avbAlgorithm
Jihoon Kang98047cf2024-10-02 17:13:54 +0000788 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust0c4b4152024-11-20 16:42:53 -0800789 fsProps.Rollback_index = avbInfo.avbRollbackIndex
Cole Fauste1676122024-12-03 17:32:25 -0800790 fsProps.Avb_hash_algorithm = avbInfo.avbHashAlgorithm
Jihoon Kang98047cf2024-10-02 17:13:54 +0000791
Cole Faust92ccbe22024-10-03 14:38:37 -0700792 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000793
Cole Faust0d467052024-12-04 17:19:19 -0800794 switch partitionType {
795 // The partitions that support file_contexts came from here:
796 // https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/Makefile;l=2270;drc=ad7cfb56010cb22c3aa0e70cf71c804352553526
797 case "system", "userdata", "cache", "vendor", "product", "system_ext", "odm", "vendor_dlkm", "odm_dlkm", "system_dlkm", "oem":
798 fsProps.Precompiled_file_contexts = proptools.StringPtr(":file_contexts_bin_gen")
799 }
800
Cole Faust68382192024-11-19 10:36:03 -0800801 if !strings.Contains(partitionType, "ramdisk") {
802 fsProps.Base_dir = proptools.StringPtr(partitionType)
803 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000804
Jihoon Kang0d545b82024-10-11 00:21:57 +0000805 fsProps.Is_auto_generated = proptools.BoolPtr(true)
806
Spandan Das71be42d2024-11-20 18:34:16 +0000807 partitionSpecificFsProps(ctx, fsProps, partitionVars, partitionType)
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000808
mrziwang4b0ca972024-10-17 14:56:19 -0700809 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700810}
811
Cole Faust0c4b4152024-11-20 16:42:53 -0800812type avbInfo struct {
813 avbEnable *bool
814 avbKeyPath *string
815 avbkeyFilegroup *string
816 avbAlgorithm *string
817 avbRollbackIndex *int64
818 avbMode *string
Cole Fauste1676122024-12-03 17:32:25 -0800819 avbHashAlgorithm *string
Cole Faust0c4b4152024-11-20 16:42:53 -0800820}
821
822func getAvbInfo(config android.Config, partitionType string) avbInfo {
823 partitionVars := config.ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
824 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
825 var result avbInfo
826 boardAvbEnable := partitionVars.BoardAvbEnable
827 if boardAvbEnable {
828 result.avbEnable = proptools.BoolPtr(true)
Cole Fauste1676122024-12-03 17:32:25 -0800829 // There are "global" and "specific" copies of a lot of these variables. Sometimes they
830 // choose the specific and then fall back to the global one if it's not set, other times
831 // the global one actually only applies to the vbmeta partition.
832 if partitionType == "vbmeta" {
833 if partitionVars.BoardAvbKeyPath != "" {
834 result.avbKeyPath = proptools.StringPtr(partitionVars.BoardAvbKeyPath)
835 }
836 if partitionVars.BoardAvbRollbackIndex != "" {
837 parsed, err := strconv.ParseInt(partitionVars.BoardAvbRollbackIndex, 10, 64)
838 if err != nil {
839 panic(fmt.Sprintf("Rollback index must be an int, got %s", partitionVars.BoardAvbRollbackIndex))
840 }
841 result.avbRollbackIndex = &parsed
842 }
843 }
Cole Faust0c4b4152024-11-20 16:42:53 -0800844 if specificPartitionVars.BoardAvbKeyPath != "" {
845 result.avbKeyPath = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Cole Faust0c4b4152024-11-20 16:42:53 -0800846 }
847 if specificPartitionVars.BoardAvbAlgorithm != "" {
848 result.avbAlgorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
849 } else if partitionVars.BoardAvbAlgorithm != "" {
850 result.avbAlgorithm = proptools.StringPtr(partitionVars.BoardAvbAlgorithm)
851 }
852 if specificPartitionVars.BoardAvbRollbackIndex != "" {
853 parsed, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64)
854 if err != nil {
855 panic(fmt.Sprintf("Rollback index must be an int, got %s", specificPartitionVars.BoardAvbRollbackIndex))
856 }
857 result.avbRollbackIndex = &parsed
Cole Fauste1676122024-12-03 17:32:25 -0800858 }
859 if specificPartitionVars.BoardAvbRollbackIndex != "" {
860 parsed, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64)
Cole Faust0c4b4152024-11-20 16:42:53 -0800861 if err != nil {
Cole Fauste1676122024-12-03 17:32:25 -0800862 panic(fmt.Sprintf("Rollback index must be an int, got %s", specificPartitionVars.BoardAvbRollbackIndex))
Cole Faust0c4b4152024-11-20 16:42:53 -0800863 }
864 result.avbRollbackIndex = &parsed
865 }
Cole Fauste1676122024-12-03 17:32:25 -0800866
867 // Make allows you to pass arbitrary arguments to avbtool via this variable, but in practice
868 // it's only used for --hash_algorithm. The soong module has a dedicated property for the
869 // hashtree algorithm, and doesn't allow custom arguments, so just extract the hashtree
870 // algorithm out of the arbitrary arguments.
871 addHashtreeFooterArgs := strings.Split(specificPartitionVars.BoardAvbAddHashtreeFooterArgs, " ")
872 if i := slices.Index(addHashtreeFooterArgs, "--hash_algorithm"); i >= 0 {
873 result.avbHashAlgorithm = &addHashtreeFooterArgs[i+1]
874 }
875
Cole Faust0c4b4152024-11-20 16:42:53 -0800876 result.avbMode = proptools.StringPtr("make_legacy")
877 }
878 if result.avbKeyPath != nil {
879 fsGenState := config.Get(fsGenStateOnceKey).(*FsGenState)
880 filegroup := fsGenState.avbKeyFilegroups[*result.avbKeyPath]
881 result.avbkeyFilegroup = proptools.StringPtr(":" + filegroup)
882 }
883 return result
884}
885
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800886func (f *filesystemCreator) createFileListDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000887 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700888 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
889 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
890 if !ok {
891 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
892 }
893 makeFileList := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/obj/PACKAGING/%s_intermediates/file_list.txt", ctx.Config().DeviceName(), partitionType))
Jihoon Kang9e866c82024-10-07 22:39:18 +0000894 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700895
896 builder := android.NewRuleBuilder(pctx, ctx)
897 builder.Command().BuiltTool("file_list_diff").
898 Input(makeFileList).
899 Input(filesystemInfo.FileListFile).
Cole Faust56301572024-11-07 15:22:42 -0800900 Text(partitionModuleName)
Cole Faust92ccbe22024-10-03 14:38:37 -0700901 builder.Command().Text("touch").Output(diffTestResultFile)
902 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
903 return diffTestResultFile
904}
905
906func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
907 hasher := sha256.New()
908 hasher.Write([]byte(message))
909 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
910 file := android.PathForModuleOut(ctx, filename)
911 builder := android.NewRuleBuilder(pctx, ctx)
912 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
913 builder.Command().Text("exit 1 #").Output(file)
914 builder.Build("failing command "+filename, "failing command "+filename)
915 return file
916}
917
Cole Faust3552eb62024-11-06 18:07:26 -0800918func createVbmetaDiff(ctx android.ModuleContext, vbmetaModuleName string, vbmetaPartitionName string) android.Path {
919 vbmetaModule := ctx.GetDirectDepWithTag(vbmetaModuleName, generatedVbmetaPartitionDepTag)
920 outputFilesProvider, ok := android.OtherModuleProvider(ctx, vbmetaModule, android.OutputFilesProvider)
921 if !ok {
922 ctx.ModuleErrorf("Expected module %s to provide OutputFiles", vbmetaModule)
923 }
924 if len(outputFilesProvider.DefaultOutputFiles) != 1 {
925 ctx.ModuleErrorf("Expected 1 output file from module %s", vbmetaModule)
926 }
927 soongVbMetaFile := outputFilesProvider.DefaultOutputFiles[0]
928 makeVbmetaFile := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/%s.img", ctx.Config().DeviceName(), vbmetaPartitionName))
929
930 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", vbmetaModuleName))
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800931 createDiffTest(ctx, diffTestResultFile, soongVbMetaFile, makeVbmetaFile)
932 return diffTestResultFile
933}
934
935func createDiffTest(ctx android.ModuleContext, diffTestResultFile android.WritablePath, file1 android.Path, file2 android.Path) {
Cole Faust3552eb62024-11-06 18:07:26 -0800936 builder := android.NewRuleBuilder(pctx, ctx)
937 builder.Command().Text("diff").
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800938 Input(file1).
939 Input(file2)
Cole Faust3552eb62024-11-06 18:07:26 -0800940 builder.Command().Text("touch").Output(diffTestResultFile)
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800941 builder.Build("diff test "+diffTestResultFile.String(), "diff test")
Cole Faust3552eb62024-11-06 18:07:26 -0800942}
943
Cole Faust92ccbe22024-10-03 14:38:37 -0700944type systemImageDepTagType struct {
945 blueprint.BaseDependencyTag
946}
947
948var generatedFilesystemDepTag systemImageDepTagType
Cole Faust3552eb62024-11-06 18:07:26 -0800949var generatedVbmetaPartitionDepTag systemImageDepTagType
Cole Faust92ccbe22024-10-03 14:38:37 -0700950
951func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
952 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000953 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700954 }
Cole Faust3552eb62024-11-06 18:07:26 -0800955 for _, vbmetaModule := range f.properties.Vbmeta_module_names {
956 ctx.AddDependency(ctx.Module(), generatedVbmetaPartitionDepTag, vbmetaModule)
957 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000958}
959
960func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700961 if ctx.ModuleDir() != "build/soong/fsgen" {
962 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
963 }
964 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000965
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000966 var content strings.Builder
967 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
968 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
969 content.WriteString(generateBpContent(ctx, partition))
970 content.WriteString("\n")
971 }
972 android.WriteFileRule(ctx, generatedBp, content.String())
973
mrziwang8f86c882024-10-03 12:34:33 -0700974 ctx.Phony("product_config_to_bp", generatedBp)
975
Cole Faust92ccbe22024-10-03 14:38:37 -0700976 var diffTestFiles []android.Path
977 for _, partitionType := range f.properties.Generated_partition_types {
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800978 diffTestFile := f.createFileListDiffTest(ctx, partitionType)
Jihoon Kang72f812f2024-10-17 18:46:24 +0000979 diffTestFiles = append(diffTestFiles, diffTestFile)
980 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700981 }
982 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000983 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
984 diffTestFiles = append(diffTestFiles, diffTestFile)
985 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700986 }
Cole Faust3552eb62024-11-06 18:07:26 -0800987 for i, vbmetaModule := range f.properties.Vbmeta_module_names {
988 diffTestFile := createVbmetaDiff(ctx, vbmetaModule, f.properties.Vbmeta_partition_names[i])
989 diffTestFiles = append(diffTestFiles, diffTestFile)
990 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", f.properties.Vbmeta_partition_names[i]), diffTestFile)
991 }
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800992 if f.properties.Boot_image != "" {
993 diffTestFile := android.PathForModuleOut(ctx, "boot_diff_test.txt")
994 soongBootImg := android.PathForModuleSrc(ctx, f.properties.Boot_image)
995 makeBootImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/boot.img", ctx.Config().DeviceName()))
996 createDiffTest(ctx, diffTestFile, soongBootImg, makeBootImage)
997 diffTestFiles = append(diffTestFiles, diffTestFile)
998 ctx.Phony("soong_generated_boot_filesystem_test", diffTestFile)
999 }
Cole Faust24938e22024-11-18 14:01:58 -08001000 if f.properties.Vendor_boot_image != "" {
1001 diffTestFile := android.PathForModuleOut(ctx, "vendor_boot_diff_test.txt")
Jihoon Kang95eb1da2024-11-19 20:55:20 +00001002 soongBootImg := android.PathForModuleSrc(ctx, f.properties.Vendor_boot_image)
Cole Faust24938e22024-11-18 14:01:58 -08001003 makeBootImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/vendor_boot.img", ctx.Config().DeviceName()))
1004 createDiffTest(ctx, diffTestFile, soongBootImg, makeBootImage)
1005 diffTestFiles = append(diffTestFiles, diffTestFile)
1006 ctx.Phony("soong_generated_vendor_boot_filesystem_test", diffTestFile)
1007 }
Jihoon Kang95eb1da2024-11-19 20:55:20 +00001008 if f.properties.Init_boot_image != "" {
1009 diffTestFile := android.PathForModuleOut(ctx, "init_boot_diff_test.txt")
1010 soongBootImg := android.PathForModuleSrc(ctx, f.properties.Init_boot_image)
1011 makeBootImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/init_boot.img", ctx.Config().DeviceName()))
1012 createDiffTest(ctx, diffTestFile, soongBootImg, makeBootImage)
1013 diffTestFiles = append(diffTestFiles, diffTestFile)
1014 ctx.Phony("soong_generated_init_boot_filesystem_test", diffTestFile)
1015 }
mrziwang79730d42024-12-02 22:13:59 -08001016 if f.properties.Super_image != "" {
1017 diffTestFile := android.PathForModuleOut(ctx, "super_diff_test.txt")
1018 soongSuperImg := android.PathForModuleSrc(ctx, f.properties.Super_image)
1019 makeSuperImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/super.img", ctx.Config().DeviceName()))
1020 createDiffTest(ctx, diffTestFile, soongSuperImg, makeSuperImage)
1021 diffTestFiles = append(diffTestFiles, diffTestFile)
1022 ctx.Phony("soong_generated_super_filesystem_test", diffTestFile)
1023 }
Cole Faust92ccbe22024-10-03 14:38:37 -07001024 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +00001025}
mrziwang8f86c882024-10-03 12:34:33 -07001026
mrziwang8f86c882024-10-03 12:34:33 -07001027func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -07001028 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
1029 if !fsTypeSupported {
1030 return ""
mrziwang8f86c882024-10-03 12:34:33 -07001031 }
1032
mrziwang4b0ca972024-10-17 14:56:19 -07001033 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
Jihoon Kang0d7b0112024-11-13 20:44:05 +00001034 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
1035 deps := fsGenState.fsDeps[partitionType]
1036 highPriorityDeps := fsGenState.generatedPrebuiltEtcModuleNames
1037 depProps := generateDepStruct(*deps, highPriorityDeps)
mrziwang8f86c882024-10-03 12:34:33 -07001038
mrziwang4b0ca972024-10-17 14:56:19 -07001039 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -07001040 if err != nil {
Cole Faustae3e1d32024-11-05 13:22:50 -08001041 ctx.ModuleErrorf("%s", err.Error())
1042 return ""
mrziwang8f86c882024-10-03 12:34:33 -07001043 }
1044
Jihoon Kang4e5d8de2024-10-19 01:59:58 +00001045 moduleType := "android_filesystem"
1046 if partitionType == "system" {
1047 moduleType = "android_system_image"
1048 }
1049
mrziwang8f86c882024-10-03 12:34:33 -07001050 file := &parser.File{
1051 Defs: []parser.Definition{
1052 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +00001053 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -07001054 Map: *result,
1055 },
1056 },
1057 }
1058 bytes, err := parser.Print(file)
1059 if err != nil {
1060 ctx.ModuleErrorf(err.Error())
1061 }
1062 return strings.TrimSpace(string(bytes))
1063}