blob: 700bd04af41781aa8494642f6339d393a8b28eaa [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 }
Spandan Das978f4532024-12-05 21:05:43 +0000346 fsProps.Base_dir = proptools.StringPtr("system")
Cole Faust1d4e76c2024-11-26 14:15:29 -0800347 fsProps.Dirs = proptools.NewSimpleConfigurable([]string{
348 // From generic_rootdirs in build/make/target/product/generic/Android.bp
349 "acct",
350 "apex",
351 "bootstrap-apex",
352 "config",
353 "data",
354 "data_mirror",
355 "debug_ramdisk",
356 "dev",
357 "linkerconfig",
358 "metadata",
359 "mnt",
360 "odm",
361 "odm_dlkm",
362 "oem",
363 "postinstall",
364 "proc",
365 "second_stage_resources",
366 "storage",
367 "sys",
368 "system",
369 "system_dlkm",
370 "tmp",
371 "vendor",
372 "vendor_dlkm",
373
374 // from android_rootdirs in build/make/target/product/generic/Android.bp
375 "system_ext",
376 "product",
377 })
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000378 case "system_ext":
Spandan Das2b4bf4c2024-12-02 19:41:04 +0000379 if partitionVars.ProductFsverityGenerateMetadata {
380 fsProps.Fsverity.Inputs = []string{
381 "framework/*",
382 "framework/*/*", // framework/{arch}
383 "framework/oat/*/*", // framework/oat/{arch}
384 }
385 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000386 }
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000387 case "product":
388 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das71be42d2024-11-20 18:34:16 +0000389 fsProps.Android_filesystem_deps.System = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
390 if ctx.DeviceConfig().SystemExtPath() == "system_ext" {
391 fsProps.Android_filesystem_deps.System_ext = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
392 }
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000393 case "vendor":
394 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das69464c32024-10-25 20:08:06 +0000395 fsProps.Symlinks = []filesystem.SymlinkDefinition{
396 filesystem.SymlinkDefinition{
397 Target: proptools.StringPtr("/odm"),
Spandan Das978f4532024-12-05 21:05:43 +0000398 Name: proptools.StringPtr("odm"),
Spandan Das69464c32024-10-25 20:08:06 +0000399 },
400 filesystem.SymlinkDefinition{
401 Target: proptools.StringPtr("/vendor_dlkm/lib/modules"),
Spandan Das978f4532024-12-05 21:05:43 +0000402 Name: proptools.StringPtr("lib/modules"),
Spandan Das69464c32024-10-25 20:08:06 +0000403 },
404 }
Spandan Das71be42d2024-11-20 18:34:16 +0000405 fsProps.Android_filesystem_deps.System = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
406 if ctx.DeviceConfig().SystemExtPath() == "system_ext" {
407 fsProps.Android_filesystem_deps.System_ext = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
408 }
Spandan Dasc5717162024-11-01 18:33:57 +0000409 case "odm":
410 fsProps.Symlinks = []filesystem.SymlinkDefinition{
411 filesystem.SymlinkDefinition{
412 Target: proptools.StringPtr("/odm_dlkm/lib/modules"),
Spandan Das978f4532024-12-05 21:05:43 +0000413 Name: proptools.StringPtr("lib/modules"),
Spandan Dasc5717162024-11-01 18:33:57 +0000414 },
415 }
mrziwang23ba8762024-11-07 16:21:53 -0800416 case "userdata":
417 fsProps.Base_dir = proptools.StringPtr("data")
Jihoon Kangd098d442024-11-19 00:03:22 +0000418 case "ramdisk":
419 // Following the logic in https://cs.android.com/android/platform/superproject/main/+/c3c5063df32748a8806ce5da5dd0db158eab9ad9:build/make/core/Makefile;l=1307
420 fsProps.Dirs = android.NewSimpleConfigurable([]string{
421 "debug_ramdisk",
422 "dev",
423 "metadata",
424 "mnt",
425 "proc",
426 "second_stage_resources",
427 "sys",
428 })
429 if partitionVars.BoardUsesGenericKernelImage {
430 fsProps.Dirs.AppendSimpleValue([]string{
431 "first_stage_ramdisk/debug_ramdisk",
432 "first_stage_ramdisk/dev",
433 "first_stage_ramdisk/metadata",
434 "first_stage_ramdisk/mnt",
435 "first_stage_ramdisk/proc",
436 "first_stage_ramdisk/second_stage_resources",
437 "first_stage_ramdisk/sys",
438 })
439 }
Jihoon Kang9007f382024-12-04 00:43:52 +0000440 case "recovery":
441 // Following https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/Makefile;l=2826;drc=ad7cfb56010cb22c3aa0e70cf71c804352553526
442 fsProps.Dirs = android.NewSimpleConfigurable([]string{
443 "sdcard",
444 "tmp",
445 })
446 fsProps.Symlinks = []filesystem.SymlinkDefinition{
447 {
448 Target: proptools.StringPtr("/system/bin/init"),
449 Name: proptools.StringPtr("init"),
450 },
451 {
452 Target: proptools.StringPtr("prop.default"),
453 Name: proptools.StringPtr("default.prop"),
454 },
455 }
Spandan Das978f4532024-12-05 21:05:43 +0000456 fsProps.Base_dir = proptools.StringPtr("recovery")
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000457 }
458}
Spandan Dascbe641a2024-10-14 21:07:34 +0000459
Spandan Das5b493cd2024-11-07 20:55:56 +0000460var (
461 dlkmPartitions = []string{
462 "system_dlkm",
463 "vendor_dlkm",
464 "odm_dlkm",
465 }
466)
467
Cole Faust92ccbe22024-10-03 14:38:37 -0700468// Creates a soong module to build the given partition. Returns false if we can't support building
469// it.
470func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700471 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
472
473 fsProps, supported := generateFsProps(ctx, partitionType)
474 if !supported {
475 return false
mrziwanga077b942024-10-16 16:00:06 -0700476 }
mrziwanga077b942024-10-16 16:00:06 -0700477
Cole Faust7db05752024-11-21 13:30:41 -0800478 if partitionType == "vendor" || partitionType == "product" || partitionType == "system" {
Spandan Das2047a4c2024-11-11 21:24:58 +0000479 fsProps.Linker_config.Gen_linker_config = proptools.BoolPtr(true)
Cole Faust7db05752024-11-21 13:30:41 -0800480 if partitionType != "system" {
481 fsProps.Linker_config.Linker_config_srcs = f.createLinkerConfigSourceFilegroups(ctx, partitionType)
482 }
Spandan Das312cc412024-10-29 18:20:11 +0000483 }
484
Jihoon Kanga8fa0712024-11-26 23:11:07 +0000485 if android.InList(partitionType, append(dlkmPartitions, "vendor_ramdisk")) {
Spandan Das5b493cd2024-11-07 20:55:56 +0000486 f.createPrebuiltKernelModules(ctx, partitionType)
Spandan Das5e336422024-11-01 22:31:20 +0000487 }
488
mrziwang4b0ca972024-10-17 14:56:19 -0700489 var module android.Module
490 if partitionType == "system" {
491 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
492 } else {
493 // Explicitly set the partition.
494 fsProps.Partition_type = proptools.StringPtr(partitionType)
495 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
496 }
497 module.HideFromMake()
Spandan Das168098c2024-10-28 19:44:34 +0000498 if partitionType == "vendor" {
Spandan Das4cd93b52024-11-05 23:27:03 +0000499 f.createVendorBuildProp(ctx)
Spandan Das168098c2024-10-28 19:44:34 +0000500 }
mrziwang4b0ca972024-10-17 14:56:19 -0700501 return true
502}
503
Cole Faust953476f2024-11-14 14:11:29 -0800504// Creates filegroups for the files specified in BOARD_(partition_)AVB_KEY_PATH
505func (f *filesystemCreator) createAvbKeyFilegroups(ctx android.LoadHookContext) {
506 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
507 var files []string
508
509 if len(partitionVars.BoardAvbKeyPath) > 0 {
510 files = append(files, partitionVars.BoardAvbKeyPath)
511 }
512 for _, partition := range android.SortedKeys(partitionVars.PartitionQualifiedVariables) {
513 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partition]
514 if len(specificPartitionVars.BoardAvbKeyPath) > 0 {
515 files = append(files, specificPartitionVars.BoardAvbKeyPath)
516 }
517 }
518
519 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
520 for _, file := range files {
521 if _, ok := fsGenState.avbKeyFilegroups[file]; ok {
522 continue
523 }
524 if file == "external/avb/test/data/testkey_rsa4096.pem" {
525 // There already exists a checked-in filegroup for this commonly-used key, just use that
526 fsGenState.avbKeyFilegroups[file] = "avb_testkey_rsa4096"
527 continue
528 }
529 dir := filepath.Dir(file)
530 base := filepath.Base(file)
531 name := fmt.Sprintf("avb_key_%x", strings.ReplaceAll(file, "/", "_"))
532 ctx.CreateModuleInDirectory(
533 android.FileGroupFactory,
534 dir,
535 &struct {
536 Name *string
537 Srcs []string
538 Visibility []string
539 }{
540 Name: proptools.StringPtr(name),
541 Srcs: []string{base},
542 Visibility: []string{"//visibility:public"},
543 },
544 )
545 fsGenState.avbKeyFilegroups[file] = name
546 }
547}
548
Cole Faust3e730972024-12-03 13:12:08 -0800549// Creates filegroups for miscellaneous other files
550func (f *filesystemCreator) createMiscFilegroups(ctx android.LoadHookContext) {
551 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
552
553 if partitionVars.BoardErofsCompressorHints != "" {
554 dir := filepath.Dir(partitionVars.BoardErofsCompressorHints)
555 base := filepath.Base(partitionVars.BoardErofsCompressorHints)
556 ctx.CreateModuleInDirectory(
557 android.FileGroupFactory,
558 dir,
559 &struct {
560 Name *string
561 Srcs []string
562 Visibility []string
563 }{
564 Name: proptools.StringPtr("soong_generated_board_erofs_compress_hints_filegroup"),
565 Srcs: []string{base},
566 Visibility: []string{"//visibility:public"},
567 },
568 )
569 }
570}
571
Spandan Das5e336422024-11-01 22:31:20 +0000572// createPrebuiltKernelModules creates `prebuilt_kernel_modules`. These modules will be added to deps of the
Spandan Das7b25a512024-11-06 20:41:26 +0000573// autogenerated *_dlkm filsystem modules. Each _dlkm partition should have a single prebuilt_kernel_modules dependency.
574// This ensures that the depmod artifacts (modules.* installed in /lib/modules/) are generated with a complete view.
Spandan Das5b493cd2024-11-07 20:55:56 +0000575func (f *filesystemCreator) createPrebuiltKernelModules(ctx android.LoadHookContext, partitionType string) {
Spandan Das5e336422024-11-01 22:31:20 +0000576 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
Spandan Das7b25a512024-11-06 20:41:26 +0000577 name := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-kernel-modules", partitionType))
578 props := &struct {
Spandan Das912d26b2024-11-06 19:35:17 +0000579 Name *string
580 Srcs []string
Spandan Das5b493cd2024-11-07 20:55:56 +0000581 System_deps []string
Spandan Das912d26b2024-11-06 19:35:17 +0000582 System_dlkm_specific *bool
Spandan Das5b493cd2024-11-07 20:55:56 +0000583 Vendor_dlkm_specific *bool
584 Odm_dlkm_specific *bool
Jihoon Kanga8fa0712024-11-26 23:11:07 +0000585 Vendor_ramdisk *bool
Spandan Das5b493cd2024-11-07 20:55:56 +0000586 Load_by_default *bool
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000587 Blocklist_file *string
Jihoon Kang72dd6fc2024-11-27 01:16:39 +0000588 Options_file *string
Spandan Das0eda1162024-12-10 20:44:49 +0000589 Strip_debug_symbols *bool
Spandan Das7b25a512024-11-06 20:41:26 +0000590 }{
591 Name: proptools.StringPtr(name),
Spandan Das5e336422024-11-01 22:31:20 +0000592 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000593 switch partitionType {
594 case "system_dlkm":
Spandan Das59ee5d72024-11-18 19:36:32 +0000595 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules).Strings()
Spandan Das912d26b2024-11-06 19:35:17 +0000596 props.System_dlkm_specific = proptools.BoolPtr(true)
Spandan Das5b493cd2024-11-07 20:55:56 +0000597 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelLoadModules) == 0 {
598 // Create empty modules.load file for system
599 // https://source.corp.google.com/h/googleplex-android/platform/build/+/ef55daac9954896161b26db4f3ef1781b5a5694c:core/Makefile;l=695-700;drc=549fe2a5162548bd8b47867d35f907eb22332023;bpv=1;bpt=0
600 props.Load_by_default = proptools.BoolPtr(false)
601 }
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000602 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelBlocklistFile; blocklistFile != "" {
603 props.Blocklist_file = proptools.StringPtr(blocklistFile)
604 }
Spandan Das0eda1162024-12-10 20:44:49 +0000605 props.Strip_debug_symbols = proptools.BoolPtr(false)
Spandan Das5b493cd2024-11-07 20:55:56 +0000606 case "vendor_dlkm":
Spandan Das59ee5d72024-11-18 19:36:32 +0000607 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorKernelModules).Strings()
Spandan Das5b493cd2024-11-07 20:55:56 +0000608 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules) > 0 {
609 props.System_deps = []string{":" + generatedModuleName(ctx.Config(), "system_dlkm-kernel-modules") + "{.modules}"}
610 }
611 props.Vendor_dlkm_specific = proptools.BoolPtr(true)
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000612 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorKernelBlocklistFile; blocklistFile != "" {
613 props.Blocklist_file = proptools.StringPtr(blocklistFile)
614 }
Spandan Das0eda1162024-12-10 20:44:49 +0000615 props.Strip_debug_symbols = proptools.BoolPtr(false)
Spandan Das5b493cd2024-11-07 20:55:56 +0000616 case "odm_dlkm":
Spandan Das59ee5d72024-11-18 19:36:32 +0000617 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.OdmKernelModules).Strings()
Spandan Das5b493cd2024-11-07 20:55:56 +0000618 props.Odm_dlkm_specific = proptools.BoolPtr(true)
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000619 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.OdmKernelBlocklistFile; blocklistFile != "" {
620 props.Blocklist_file = proptools.StringPtr(blocklistFile)
621 }
Spandan Das0eda1162024-12-10 20:44:49 +0000622 props.Strip_debug_symbols = proptools.BoolPtr(false)
Jihoon Kanga8fa0712024-11-26 23:11:07 +0000623 case "vendor_ramdisk":
624 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorRamdiskKernelModules).Strings()
625 props.Vendor_ramdisk = proptools.BoolPtr(true)
626 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorRamdiskKernelBlocklistFile; blocklistFile != "" {
627 props.Blocklist_file = proptools.StringPtr(blocklistFile)
628 }
Jihoon Kang72dd6fc2024-11-27 01:16:39 +0000629 if optionsFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorRamdiskKernelOptionsFile; optionsFile != "" {
630 props.Options_file = proptools.StringPtr(optionsFile)
631 }
632
Spandan Das5b493cd2024-11-07 20:55:56 +0000633 default:
634 ctx.ModuleErrorf("DLKM is not supported for %s\n", partitionType)
Spandan Das912d26b2024-11-06 19:35:17 +0000635 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000636
637 if len(props.Srcs) == 0 {
638 return // do not generate `prebuilt_kernel_modules` if there are no sources
639 }
640
Spandan Das7b25a512024-11-06 20:41:26 +0000641 kernelModule := ctx.CreateModuleInDirectory(
642 kernel.PrebuiltKernelModulesFactory,
643 ".", // create in root directory for now
644 props,
645 )
646 kernelModule.HideFromMake()
647 // Add to deps
648 (*fsGenState.fsDeps[partitionType])[name] = defaultDepCandidateProps(ctx.Config())
Spandan Das5e336422024-11-01 22:31:20 +0000649}
650
Spandan Das4cd93b52024-11-05 23:27:03 +0000651// Create a build_prop and android_info module. This will be used to create /vendor/build.prop
652func (f *filesystemCreator) createVendorBuildProp(ctx android.LoadHookContext) {
653 // Create a android_info for vendor
654 // The board info files might be in a directory outside the root soong namespace, so create
655 // the module in "."
656 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
657 androidInfoProps := &struct {
658 Name *string
659 Board_info_files []string
660 Bootloader_board_name *string
661 }{
662 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "android-info.prop")),
663 Board_info_files: partitionVars.BoardInfoFiles,
664 }
665 if len(androidInfoProps.Board_info_files) == 0 {
666 androidInfoProps.Bootloader_board_name = proptools.StringPtr(partitionVars.BootLoaderBoardName)
667 }
668 androidInfoProp := ctx.CreateModuleInDirectory(
669 android.AndroidInfoFactory,
670 ".",
671 androidInfoProps,
672 )
673 androidInfoProp.HideFromMake()
674 // Create a build prop for vendor
675 vendorBuildProps := &struct {
676 Name *string
677 Vendor *bool
678 Stem *string
679 Product_config *string
680 Android_info *string
681 }{
682 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "vendor-build.prop")),
683 Vendor: proptools.BoolPtr(true),
684 Stem: proptools.StringPtr("build.prop"),
685 Product_config: proptools.StringPtr(":product_config"),
686 Android_info: proptools.StringPtr(":" + androidInfoProp.Name()),
687 }
688 vendorBuildProp := ctx.CreateModule(
689 android.BuildPropFactory,
690 vendorBuildProps,
691 )
692 vendorBuildProp.HideFromMake()
693}
694
Spandan Das8fe68dc2024-10-29 18:20:11 +0000695// createLinkerConfigSourceFilegroups creates filegroup modules to generate linker.config.pb for the following partitions
696// 1. vendor: Using PRODUCT_VENDOR_LINKER_CONFIG_FRAGMENTS (space separated file list)
697// 1. product: Using PRODUCT_PRODUCT_LINKER_CONFIG_FRAGMENTS (space separated file list)
698// It creates a filegroup for each file in the fragment list
Spandan Das312cc412024-10-29 18:20:11 +0000699// The filegroup modules are then added to `linker_config_srcs` of the autogenerated vendor `android_filesystem`.
Spandan Das8fe68dc2024-10-29 18:20:11 +0000700func (f *filesystemCreator) createLinkerConfigSourceFilegroups(ctx android.LoadHookContext, partitionType string) []string {
Spandan Das312cc412024-10-29 18:20:11 +0000701 ret := []string{}
702 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Spandan Das8fe68dc2024-10-29 18:20:11 +0000703 var linkerConfigSrcs []string
704 if partitionType == "vendor" {
705 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.VendorLinkerConfigSrcs)
706 } else if partitionType == "product" {
707 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.ProductLinkerConfigSrcs)
708 } else {
709 ctx.ModuleErrorf("linker.config.pb is only supported for vendor and product partitions. For system partition, use `android_system_image`")
710 }
711
712 if len(linkerConfigSrcs) > 0 {
Spandan Das312cc412024-10-29 18:20:11 +0000713 // Create a filegroup, and add `:<filegroup_name>` to ret.
714 for index, linkerConfigSrc := range linkerConfigSrcs {
715 dir := filepath.Dir(linkerConfigSrc)
716 base := filepath.Base(linkerConfigSrc)
Spandan Das8fe68dc2024-10-29 18:20:11 +0000717 fgName := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-linker-config-src%s", partitionType, strconv.Itoa(index)))
Spandan Das312cc412024-10-29 18:20:11 +0000718 srcs := []string{base}
719 fgProps := &struct {
720 Name *string
721 Srcs proptools.Configurable[[]string]
722 }{
723 Name: proptools.StringPtr(fgName),
724 Srcs: proptools.NewSimpleConfigurable(srcs),
725 }
726 ctx.CreateModuleInDirectory(
727 android.FileGroupFactory,
728 dir,
729 fgProps,
730 )
731 ret = append(ret, ":"+fgName)
732 }
733 }
734 return ret
735}
736
mrziwang4b0ca972024-10-17 14:56:19 -0700737type filesystemBaseProperty struct {
738 Name *string
739 Compile_multilib *string
Cole Faust3552eb62024-11-06 18:07:26 -0800740 Visibility []string
mrziwang4b0ca972024-10-17 14:56:19 -0700741}
742
743func generateBaseProps(namePtr *string) *filesystemBaseProperty {
744 return &filesystemBaseProperty{
745 Name: namePtr,
746 Compile_multilib: proptools.StringPtr("both"),
Cole Faust3552eb62024-11-06 18:07:26 -0800747 // The vbmeta modules are currently in the root directory and depend on the partitions
748 Visibility: []string{"//.", "//build/soong:__subpackages__"},
mrziwang4b0ca972024-10-17 14:56:19 -0700749 }
750}
751
752func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700753 fsProps := &filesystem.FilesystemProperties{}
754
mrziwang4b0ca972024-10-17 14:56:19 -0700755 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Cole Faust0c4b4152024-11-20 16:42:53 -0800756 var avbInfo avbInfo
Cole Faust76a6e952024-11-07 16:56:45 -0800757 var fsType string
758 if strings.Contains(partitionType, "ramdisk") {
759 fsType = "compressed_cpio"
760 } else {
Cole Faust953476f2024-11-14 14:11:29 -0800761 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
Cole Faust76a6e952024-11-07 16:56:45 -0800762 fsType = specificPartitionVars.BoardFileSystemType
Cole Faust0c4b4152024-11-20 16:42:53 -0800763 avbInfo = getAvbInfo(ctx.Config(), partitionType)
Cole Faust953476f2024-11-14 14:11:29 -0800764 if fsType == "" {
765 fsType = "ext4" //default
766 }
Cole Faust76a6e952024-11-07 16:56:45 -0800767 }
Cole Faust76a6e952024-11-07 16:56:45 -0800768
mrziwang4b0ca972024-10-17 14:56:19 -0700769 fsProps.Type = proptools.StringPtr(fsType)
770 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
771 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
772 return nil, false
773 }
774
Cole Faust3e730972024-12-03 13:12:08 -0800775 if *fsProps.Type == "erofs" {
776 if partitionVars.BoardErofsCompressor != "" {
777 fsProps.Erofs.Compressor = proptools.StringPtr(partitionVars.BoardErofsCompressor)
778 }
779 if partitionVars.BoardErofsCompressorHints != "" {
780 fsProps.Erofs.Compress_hints = proptools.StringPtr(":soong_generated_board_erofs_compress_hints_filegroup")
781 }
782 }
783
Cole Faust92ccbe22024-10-03 14:38:37 -0700784 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
785 // and sometimes don't build.
786 fsProps.Unchecked_module = proptools.BoolPtr(true)
787
Jihoon Kang98047cf2024-10-02 17:13:54 +0000788 // BOARD_AVB_ENABLE
Cole Faust0c4b4152024-11-20 16:42:53 -0800789 fsProps.Use_avb = avbInfo.avbEnable
Jihoon Kang98047cf2024-10-02 17:13:54 +0000790 // BOARD_AVB_KEY_PATH
Cole Faust0c4b4152024-11-20 16:42:53 -0800791 fsProps.Avb_private_key = avbInfo.avbkeyFilegroup
Jihoon Kang98047cf2024-10-02 17:13:54 +0000792 // BOARD_AVB_ALGORITHM
Cole Faust0c4b4152024-11-20 16:42:53 -0800793 fsProps.Avb_algorithm = avbInfo.avbAlgorithm
Jihoon Kang98047cf2024-10-02 17:13:54 +0000794 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust0c4b4152024-11-20 16:42:53 -0800795 fsProps.Rollback_index = avbInfo.avbRollbackIndex
Cole Fauste1676122024-12-03 17:32:25 -0800796 fsProps.Avb_hash_algorithm = avbInfo.avbHashAlgorithm
Jihoon Kang98047cf2024-10-02 17:13:54 +0000797
Cole Faust92ccbe22024-10-03 14:38:37 -0700798 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000799
Cole Faust0d467052024-12-04 17:19:19 -0800800 switch partitionType {
801 // The partitions that support file_contexts came from here:
802 // https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/Makefile;l=2270;drc=ad7cfb56010cb22c3aa0e70cf71c804352553526
803 case "system", "userdata", "cache", "vendor", "product", "system_ext", "odm", "vendor_dlkm", "odm_dlkm", "system_dlkm", "oem":
804 fsProps.Precompiled_file_contexts = proptools.StringPtr(":file_contexts_bin_gen")
805 }
806
Jihoon Kang0d545b82024-10-11 00:21:57 +0000807 fsProps.Is_auto_generated = proptools.BoolPtr(true)
808
Spandan Das71be42d2024-11-20 18:34:16 +0000809 partitionSpecificFsProps(ctx, fsProps, partitionVars, partitionType)
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000810
mrziwang4b0ca972024-10-17 14:56:19 -0700811 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700812}
813
Cole Faust0c4b4152024-11-20 16:42:53 -0800814type avbInfo struct {
815 avbEnable *bool
816 avbKeyPath *string
817 avbkeyFilegroup *string
818 avbAlgorithm *string
819 avbRollbackIndex *int64
820 avbMode *string
Cole Fauste1676122024-12-03 17:32:25 -0800821 avbHashAlgorithm *string
Cole Faust0c4b4152024-11-20 16:42:53 -0800822}
823
824func getAvbInfo(config android.Config, partitionType string) avbInfo {
825 partitionVars := config.ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
826 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
827 var result avbInfo
828 boardAvbEnable := partitionVars.BoardAvbEnable
829 if boardAvbEnable {
830 result.avbEnable = proptools.BoolPtr(true)
Cole Fauste1676122024-12-03 17:32:25 -0800831 // There are "global" and "specific" copies of a lot of these variables. Sometimes they
832 // choose the specific and then fall back to the global one if it's not set, other times
833 // the global one actually only applies to the vbmeta partition.
834 if partitionType == "vbmeta" {
835 if partitionVars.BoardAvbKeyPath != "" {
836 result.avbKeyPath = proptools.StringPtr(partitionVars.BoardAvbKeyPath)
837 }
838 if partitionVars.BoardAvbRollbackIndex != "" {
839 parsed, err := strconv.ParseInt(partitionVars.BoardAvbRollbackIndex, 10, 64)
840 if err != nil {
841 panic(fmt.Sprintf("Rollback index must be an int, got %s", partitionVars.BoardAvbRollbackIndex))
842 }
843 result.avbRollbackIndex = &parsed
844 }
845 }
Cole Faust0c4b4152024-11-20 16:42:53 -0800846 if specificPartitionVars.BoardAvbKeyPath != "" {
847 result.avbKeyPath = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Cole Faust0c4b4152024-11-20 16:42:53 -0800848 }
849 if specificPartitionVars.BoardAvbAlgorithm != "" {
850 result.avbAlgorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
851 } else if partitionVars.BoardAvbAlgorithm != "" {
852 result.avbAlgorithm = proptools.StringPtr(partitionVars.BoardAvbAlgorithm)
853 }
854 if specificPartitionVars.BoardAvbRollbackIndex != "" {
855 parsed, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64)
856 if err != nil {
857 panic(fmt.Sprintf("Rollback index must be an int, got %s", specificPartitionVars.BoardAvbRollbackIndex))
858 }
859 result.avbRollbackIndex = &parsed
Cole Fauste1676122024-12-03 17:32:25 -0800860 }
861 if specificPartitionVars.BoardAvbRollbackIndex != "" {
862 parsed, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64)
Cole Faust0c4b4152024-11-20 16:42:53 -0800863 if err != nil {
Cole Fauste1676122024-12-03 17:32:25 -0800864 panic(fmt.Sprintf("Rollback index must be an int, got %s", specificPartitionVars.BoardAvbRollbackIndex))
Cole Faust0c4b4152024-11-20 16:42:53 -0800865 }
866 result.avbRollbackIndex = &parsed
867 }
Cole Fauste1676122024-12-03 17:32:25 -0800868
869 // Make allows you to pass arbitrary arguments to avbtool via this variable, but in practice
870 // it's only used for --hash_algorithm. The soong module has a dedicated property for the
871 // hashtree algorithm, and doesn't allow custom arguments, so just extract the hashtree
872 // algorithm out of the arbitrary arguments.
873 addHashtreeFooterArgs := strings.Split(specificPartitionVars.BoardAvbAddHashtreeFooterArgs, " ")
874 if i := slices.Index(addHashtreeFooterArgs, "--hash_algorithm"); i >= 0 {
875 result.avbHashAlgorithm = &addHashtreeFooterArgs[i+1]
876 }
877
Cole Faust0c4b4152024-11-20 16:42:53 -0800878 result.avbMode = proptools.StringPtr("make_legacy")
879 }
880 if result.avbKeyPath != nil {
881 fsGenState := config.Get(fsGenStateOnceKey).(*FsGenState)
882 filegroup := fsGenState.avbKeyFilegroups[*result.avbKeyPath]
883 result.avbkeyFilegroup = proptools.StringPtr(":" + filegroup)
884 }
885 return result
886}
887
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800888func (f *filesystemCreator) createFileListDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000889 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700890 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
891 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
892 if !ok {
893 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
894 }
895 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 +0000896 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700897
898 builder := android.NewRuleBuilder(pctx, ctx)
899 builder.Command().BuiltTool("file_list_diff").
900 Input(makeFileList).
901 Input(filesystemInfo.FileListFile).
Cole Faust56301572024-11-07 15:22:42 -0800902 Text(partitionModuleName)
Cole Faust92ccbe22024-10-03 14:38:37 -0700903 builder.Command().Text("touch").Output(diffTestResultFile)
904 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
905 return diffTestResultFile
906}
907
908func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
909 hasher := sha256.New()
910 hasher.Write([]byte(message))
911 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
912 file := android.PathForModuleOut(ctx, filename)
913 builder := android.NewRuleBuilder(pctx, ctx)
914 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
915 builder.Command().Text("exit 1 #").Output(file)
916 builder.Build("failing command "+filename, "failing command "+filename)
917 return file
918}
919
Cole Faust3552eb62024-11-06 18:07:26 -0800920func createVbmetaDiff(ctx android.ModuleContext, vbmetaModuleName string, vbmetaPartitionName string) android.Path {
921 vbmetaModule := ctx.GetDirectDepWithTag(vbmetaModuleName, generatedVbmetaPartitionDepTag)
922 outputFilesProvider, ok := android.OtherModuleProvider(ctx, vbmetaModule, android.OutputFilesProvider)
923 if !ok {
924 ctx.ModuleErrorf("Expected module %s to provide OutputFiles", vbmetaModule)
925 }
926 if len(outputFilesProvider.DefaultOutputFiles) != 1 {
927 ctx.ModuleErrorf("Expected 1 output file from module %s", vbmetaModule)
928 }
929 soongVbMetaFile := outputFilesProvider.DefaultOutputFiles[0]
930 makeVbmetaFile := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/%s.img", ctx.Config().DeviceName(), vbmetaPartitionName))
931
932 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", vbmetaModuleName))
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800933 createDiffTest(ctx, diffTestResultFile, soongVbMetaFile, makeVbmetaFile)
934 return diffTestResultFile
935}
936
937func createDiffTest(ctx android.ModuleContext, diffTestResultFile android.WritablePath, file1 android.Path, file2 android.Path) {
Cole Faust3552eb62024-11-06 18:07:26 -0800938 builder := android.NewRuleBuilder(pctx, ctx)
939 builder.Command().Text("diff").
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800940 Input(file1).
941 Input(file2)
Cole Faust3552eb62024-11-06 18:07:26 -0800942 builder.Command().Text("touch").Output(diffTestResultFile)
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800943 builder.Build("diff test "+diffTestResultFile.String(), "diff test")
Cole Faust3552eb62024-11-06 18:07:26 -0800944}
945
Cole Faust92ccbe22024-10-03 14:38:37 -0700946type systemImageDepTagType struct {
947 blueprint.BaseDependencyTag
948}
949
950var generatedFilesystemDepTag systemImageDepTagType
Cole Faust3552eb62024-11-06 18:07:26 -0800951var generatedVbmetaPartitionDepTag systemImageDepTagType
Cole Faust92ccbe22024-10-03 14:38:37 -0700952
953func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
954 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000955 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700956 }
Cole Faust3552eb62024-11-06 18:07:26 -0800957 for _, vbmetaModule := range f.properties.Vbmeta_module_names {
958 ctx.AddDependency(ctx.Module(), generatedVbmetaPartitionDepTag, vbmetaModule)
959 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000960}
961
962func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700963 if ctx.ModuleDir() != "build/soong/fsgen" {
964 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
965 }
966 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000967
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000968 var content strings.Builder
969 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
970 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
971 content.WriteString(generateBpContent(ctx, partition))
972 content.WriteString("\n")
973 }
974 android.WriteFileRule(ctx, generatedBp, content.String())
975
mrziwang8f86c882024-10-03 12:34:33 -0700976 ctx.Phony("product_config_to_bp", generatedBp)
977
Cole Faust92ccbe22024-10-03 14:38:37 -0700978 var diffTestFiles []android.Path
979 for _, partitionType := range f.properties.Generated_partition_types {
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800980 diffTestFile := f.createFileListDiffTest(ctx, partitionType)
Jihoon Kang72f812f2024-10-17 18:46:24 +0000981 diffTestFiles = append(diffTestFiles, diffTestFile)
982 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700983 }
984 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000985 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
986 diffTestFiles = append(diffTestFiles, diffTestFile)
987 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700988 }
Cole Faust3552eb62024-11-06 18:07:26 -0800989 for i, vbmetaModule := range f.properties.Vbmeta_module_names {
990 diffTestFile := createVbmetaDiff(ctx, vbmetaModule, f.properties.Vbmeta_partition_names[i])
991 diffTestFiles = append(diffTestFiles, diffTestFile)
992 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", f.properties.Vbmeta_partition_names[i]), diffTestFile)
993 }
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800994 if f.properties.Boot_image != "" {
995 diffTestFile := android.PathForModuleOut(ctx, "boot_diff_test.txt")
996 soongBootImg := android.PathForModuleSrc(ctx, f.properties.Boot_image)
997 makeBootImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/boot.img", ctx.Config().DeviceName()))
998 createDiffTest(ctx, diffTestFile, soongBootImg, makeBootImage)
999 diffTestFiles = append(diffTestFiles, diffTestFile)
1000 ctx.Phony("soong_generated_boot_filesystem_test", diffTestFile)
1001 }
Cole Faust24938e22024-11-18 14:01:58 -08001002 if f.properties.Vendor_boot_image != "" {
1003 diffTestFile := android.PathForModuleOut(ctx, "vendor_boot_diff_test.txt")
Jihoon Kang95eb1da2024-11-19 20:55:20 +00001004 soongBootImg := android.PathForModuleSrc(ctx, f.properties.Vendor_boot_image)
Cole Faust24938e22024-11-18 14:01:58 -08001005 makeBootImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/vendor_boot.img", ctx.Config().DeviceName()))
1006 createDiffTest(ctx, diffTestFile, soongBootImg, makeBootImage)
1007 diffTestFiles = append(diffTestFiles, diffTestFile)
1008 ctx.Phony("soong_generated_vendor_boot_filesystem_test", diffTestFile)
1009 }
Jihoon Kang95eb1da2024-11-19 20:55:20 +00001010 if f.properties.Init_boot_image != "" {
1011 diffTestFile := android.PathForModuleOut(ctx, "init_boot_diff_test.txt")
1012 soongBootImg := android.PathForModuleSrc(ctx, f.properties.Init_boot_image)
1013 makeBootImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/init_boot.img", ctx.Config().DeviceName()))
1014 createDiffTest(ctx, diffTestFile, soongBootImg, makeBootImage)
1015 diffTestFiles = append(diffTestFiles, diffTestFile)
1016 ctx.Phony("soong_generated_init_boot_filesystem_test", diffTestFile)
1017 }
mrziwang79730d42024-12-02 22:13:59 -08001018 if f.properties.Super_image != "" {
1019 diffTestFile := android.PathForModuleOut(ctx, "super_diff_test.txt")
1020 soongSuperImg := android.PathForModuleSrc(ctx, f.properties.Super_image)
1021 makeSuperImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/super.img", ctx.Config().DeviceName()))
1022 createDiffTest(ctx, diffTestFile, soongSuperImg, makeSuperImage)
1023 diffTestFiles = append(diffTestFiles, diffTestFile)
1024 ctx.Phony("soong_generated_super_filesystem_test", diffTestFile)
1025 }
Cole Faust92ccbe22024-10-03 14:38:37 -07001026 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +00001027}
mrziwang8f86c882024-10-03 12:34:33 -07001028
mrziwang8f86c882024-10-03 12:34:33 -07001029func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -07001030 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
1031 if !fsTypeSupported {
1032 return ""
mrziwang8f86c882024-10-03 12:34:33 -07001033 }
1034
mrziwang4b0ca972024-10-17 14:56:19 -07001035 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
Jihoon Kang0d7b0112024-11-13 20:44:05 +00001036 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
1037 deps := fsGenState.fsDeps[partitionType]
1038 highPriorityDeps := fsGenState.generatedPrebuiltEtcModuleNames
1039 depProps := generateDepStruct(*deps, highPriorityDeps)
mrziwang8f86c882024-10-03 12:34:33 -07001040
mrziwang4b0ca972024-10-17 14:56:19 -07001041 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -07001042 if err != nil {
Cole Faustae3e1d32024-11-05 13:22:50 -08001043 ctx.ModuleErrorf("%s", err.Error())
1044 return ""
mrziwang8f86c882024-10-03 12:34:33 -07001045 }
1046
Jihoon Kang4e5d8de2024-10-19 01:59:58 +00001047 moduleType := "android_filesystem"
1048 if partitionType == "system" {
1049 moduleType = "android_system_image"
1050 }
1051
mrziwang8f86c882024-10-03 12:34:33 -07001052 file := &parser.File{
1053 Defs: []parser.Definition{
1054 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +00001055 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -07001056 Map: *result,
1057 },
1058 },
1059 }
1060 bytes, err := parser.Print(file)
1061 if err != nil {
1062 ctx.ModuleErrorf(err.Error())
1063 }
1064 return strings.TrimSpace(string(bytes))
1065}