blob: 376c5d96894b34ca58dea2abc42f4bdc8b5e6629 [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
Jihoon Kang6da80752024-12-23 18:53:32 +000081func generatedPartitions(ctx android.EarlyModuleContext) []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)
Jihoon Kang1259eff2025-01-09 22:11:03 +0000164 f.properties.Super_image = ":" + generatedModuleNameForPartition(ctx.Config(), "super")
mrziwang79730d42024-12-02 22:13:59 -0800165 }
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
Jihoon Kang3be17162025-01-09 20:51:54 +0000183func (f *filesystemCreator) createBootloaderFilegroup(ctx android.LoadHookContext) (string, bool) {
184 bootloaderPath := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.PrebuiltBootloader
185 if len(bootloaderPath) == 0 {
186 return "", false
187 }
188
189 bootloaderFilegroupName := generatedModuleName(ctx.Config(), "bootloader")
190 filegroupProps := &struct {
191 Name *string
192 Srcs []string
193 Visibility []string
194 }{
195 Name: proptools.StringPtr(bootloaderFilegroupName),
196 Srcs: []string{bootloaderPath},
197 Visibility: []string{"//visibility:public"},
198 }
199 ctx.CreateModuleInDirectory(android.FileGroupFactory, ".", filegroupProps)
200 return bootloaderFilegroupName, true
201}
202
Cole Faust3552eb62024-11-06 18:07:26 -0800203func (f *filesystemCreator) createDeviceModule(
204 ctx android.LoadHookContext,
205 generatedPartitionTypes []string,
206 vbmetaPartitions []string,
207) {
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000208 baseProps := &struct {
209 Name *string
210 }{
Jihoon Kang0d545b82024-10-11 00:21:57 +0000211 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "device")),
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000212 }
213
Priyanka Advani (xWF)dafaa7f2024-10-21 22:55:13 +0000214 // Currently, only the system and system_ext partition module is created.
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000215 partitionProps := &filesystem.PartitionNameProperties{}
Cole Faust3552eb62024-11-06 18:07:26 -0800216 if android.InList("system", generatedPartitionTypes) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000217 partitionProps.System_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000218 }
Cole Faust3552eb62024-11-06 18:07:26 -0800219 if android.InList("system_ext", generatedPartitionTypes) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000220 partitionProps.System_ext_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
Spandan Das7a46f6c2024-10-14 18:41:18 +0000221 }
Cole Faust3552eb62024-11-06 18:07:26 -0800222 if android.InList("vendor", generatedPartitionTypes) {
Spandan Dase3b65312024-10-22 00:27:27 +0000223 partitionProps.Vendor_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "vendor"))
224 }
Cole Faust3552eb62024-11-06 18:07:26 -0800225 if android.InList("product", generatedPartitionTypes) {
Jihoon Kang6dd13b62024-10-22 23:21:02 +0000226 partitionProps.Product_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "product"))
227 }
Cole Faust3552eb62024-11-06 18:07:26 -0800228 if android.InList("odm", generatedPartitionTypes) {
Spandan Dasc5717162024-11-01 18:33:57 +0000229 partitionProps.Odm_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "odm"))
230 }
mrziwang23ba8762024-11-07 16:21:53 -0800231 if android.InList("userdata", f.properties.Generated_partition_types) {
232 partitionProps.Userdata_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "userdata"))
233 }
Jihoon Kange7e3ec82025-01-02 21:29:14 +0000234 if android.InList("recovery", f.properties.Generated_partition_types) {
235 partitionProps.Recovery_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "recovery"))
236 }
Spandan Dasa0394002025-01-07 18:38:34 +0000237 if android.InList("system_dlkm", f.properties.Generated_partition_types) {
238 partitionProps.System_dlkm_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_dlkm"))
239 }
240 if android.InList("vendor_dlkm", f.properties.Generated_partition_types) {
241 partitionProps.Vendor_dlkm_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "vendor_dlkm"))
242 }
243 if android.InList("odm_dlkm", f.properties.Generated_partition_types) {
244 partitionProps.Odm_dlkm_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "odm_dlkm"))
245 }
Jihoon Kange7e3ec82025-01-02 21:29:14 +0000246 if f.properties.Boot_image != "" {
247 partitionProps.Boot_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "boot"))
248 }
249 if f.properties.Vendor_boot_image != "" {
250 partitionProps.Vendor_boot_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "vendor_boot"))
251 }
252 if f.properties.Init_boot_image != "" {
253 partitionProps.Init_boot_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "init_boot"))
254 }
Cole Faust3552eb62024-11-06 18:07:26 -0800255 partitionProps.Vbmeta_partitions = vbmetaPartitions
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000256
Jihoon Kang3be17162025-01-09 20:51:54 +0000257 deviceProps := &filesystem.DeviceProperties{}
258 if bootloader, ok := f.createBootloaderFilegroup(ctx); ok {
259 deviceProps.Bootloader = proptools.StringPtr(":" + bootloader)
260 }
261
262 ctx.CreateModule(filesystem.AndroidDeviceFactory, baseProps, partitionProps, deviceProps)
Cole Faust92ccbe22024-10-03 14:38:37 -0700263}
264
Spandan Das71be42d2024-11-20 18:34:16 +0000265func partitionSpecificFsProps(ctx android.EarlyModuleContext, fsProps *filesystem.FilesystemProperties, partitionVars android.PartitionVariables, partitionType string) {
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000266 switch partitionType {
267 case "system":
268 fsProps.Build_logtags = proptools.BoolPtr(true)
269 // https://source.corp.google.com/h/googleplex-android/platform/build//639d79f5012a6542ab1f733b0697db45761ab0f3:core/packaging/flags.mk;l=21;drc=5ba8a8b77507f93aa48cc61c5ba3f31a4d0cbf37;bpv=1;bpt=0
270 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Justin Yuned3dbce2024-11-15 11:57:24 +0900271 // Identical to that of the aosp_shared_system_image
Spandan Das2b4bf4c2024-12-02 19:41:04 +0000272 if partitionVars.ProductFsverityGenerateMetadata {
273 fsProps.Fsverity.Inputs = []string{
274 "etc/boot-image.prof",
275 "etc/dirty-image-objects",
276 "etc/preloaded-classes",
277 "etc/classpaths/*.pb",
278 "framework/*",
279 "framework/*/*", // framework/{arch}
280 "framework/oat/*/*", // framework/oat/{arch}
281 }
282 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000283 }
Jihoon Kang0a453892024-12-09 22:16:26 +0000284 fsProps.Symlinks = commonSymlinksFromRoot
285 fsProps.Symlinks = append(fsProps.Symlinks,
286 []filesystem.SymlinkDefinition{
287 {
288 Target: proptools.StringPtr("/data/cache"),
289 Name: proptools.StringPtr("cache"),
290 },
291 {
292 Target: proptools.StringPtr("/storage/self/primary"),
293 Name: proptools.StringPtr("sdcard"),
294 },
295 {
296 Target: proptools.StringPtr("/system_dlkm/lib/modules"),
297 Name: proptools.StringPtr("system/lib/modules"),
298 },
299 {
300 Target: proptools.StringPtr("/product"),
301 Name: proptools.StringPtr("system/product"),
302 },
303 {
304 Target: proptools.StringPtr("/system_ext"),
305 Name: proptools.StringPtr("system/system_ext"),
306 },
307 {
308 Target: proptools.StringPtr("/vendor"),
309 Name: proptools.StringPtr("system/vendor"),
310 },
311 }...,
312 )
Spandan Das978f4532024-12-05 21:05:43 +0000313 fsProps.Base_dir = proptools.StringPtr("system")
Jihoon Kang0a453892024-12-09 22:16:26 +0000314 fsProps.Dirs = proptools.NewSimpleConfigurable(commonPartitionDirs)
Spandan Dase5c393c2024-12-12 19:25:07 +0000315 fsProps.Security_patch = proptools.StringPtr(ctx.Config().PlatformSecurityPatch())
Cole Faust34592c02024-12-13 11:20:24 -0800316
317 if ctx.DeviceConfig().SystemExtPath() == "system_ext" {
318 fsProps.Import_aconfig_flags_from = []string{generatedModuleNameForPartition(ctx.Config(), "system_ext")}
319 }
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000320 case "system_ext":
Spandan Das2b4bf4c2024-12-02 19:41:04 +0000321 if partitionVars.ProductFsverityGenerateMetadata {
322 fsProps.Fsverity.Inputs = []string{
323 "framework/*",
324 "framework/*/*", // framework/{arch}
325 "framework/oat/*/*", // framework/oat/{arch}
326 }
327 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000328 }
Spandan Dase5c393c2024-12-12 19:25:07 +0000329 fsProps.Security_patch = proptools.StringPtr(ctx.Config().PlatformSecurityPatch())
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000330 case "product":
331 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das71be42d2024-11-20 18:34:16 +0000332 fsProps.Android_filesystem_deps.System = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
333 if ctx.DeviceConfig().SystemExtPath() == "system_ext" {
334 fsProps.Android_filesystem_deps.System_ext = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
335 }
Spandan Dase5c393c2024-12-12 19:25:07 +0000336 fsProps.Security_patch = proptools.StringPtr(ctx.Config().PlatformSecurityPatch())
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000337 case "vendor":
338 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das69464c32024-10-25 20:08:06 +0000339 fsProps.Symlinks = []filesystem.SymlinkDefinition{
340 filesystem.SymlinkDefinition{
341 Target: proptools.StringPtr("/odm"),
Spandan Das978f4532024-12-05 21:05:43 +0000342 Name: proptools.StringPtr("odm"),
Spandan Das69464c32024-10-25 20:08:06 +0000343 },
344 filesystem.SymlinkDefinition{
345 Target: proptools.StringPtr("/vendor_dlkm/lib/modules"),
Spandan Das978f4532024-12-05 21:05:43 +0000346 Name: proptools.StringPtr("lib/modules"),
Spandan Das69464c32024-10-25 20:08:06 +0000347 },
348 }
Spandan Das71be42d2024-11-20 18:34:16 +0000349 fsProps.Android_filesystem_deps.System = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
350 if ctx.DeviceConfig().SystemExtPath() == "system_ext" {
351 fsProps.Android_filesystem_deps.System_ext = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
352 }
Spandan Dase5c393c2024-12-12 19:25:07 +0000353 fsProps.Security_patch = proptools.StringPtr(partitionVars.VendorSecurityPatch)
Spandan Dasc5717162024-11-01 18:33:57 +0000354 case "odm":
355 fsProps.Symlinks = []filesystem.SymlinkDefinition{
356 filesystem.SymlinkDefinition{
357 Target: proptools.StringPtr("/odm_dlkm/lib/modules"),
Spandan Das978f4532024-12-05 21:05:43 +0000358 Name: proptools.StringPtr("lib/modules"),
Spandan Dasc5717162024-11-01 18:33:57 +0000359 },
360 }
Spandan Dase5c393c2024-12-12 19:25:07 +0000361 fsProps.Security_patch = proptools.StringPtr(partitionVars.OdmSecurityPatch)
mrziwang23ba8762024-11-07 16:21:53 -0800362 case "userdata":
363 fsProps.Base_dir = proptools.StringPtr("data")
Jihoon Kangd098d442024-11-19 00:03:22 +0000364 case "ramdisk":
365 // Following the logic in https://cs.android.com/android/platform/superproject/main/+/c3c5063df32748a8806ce5da5dd0db158eab9ad9:build/make/core/Makefile;l=1307
366 fsProps.Dirs = android.NewSimpleConfigurable([]string{
367 "debug_ramdisk",
368 "dev",
369 "metadata",
370 "mnt",
371 "proc",
372 "second_stage_resources",
373 "sys",
374 })
375 if partitionVars.BoardUsesGenericKernelImage {
376 fsProps.Dirs.AppendSimpleValue([]string{
377 "first_stage_ramdisk/debug_ramdisk",
378 "first_stage_ramdisk/dev",
379 "first_stage_ramdisk/metadata",
380 "first_stage_ramdisk/mnt",
381 "first_stage_ramdisk/proc",
382 "first_stage_ramdisk/second_stage_resources",
383 "first_stage_ramdisk/sys",
384 })
385 }
Jihoon Kang9007f382024-12-04 00:43:52 +0000386 case "recovery":
Jihoon Kang0a453892024-12-09 22:16:26 +0000387 dirs := append(commonPartitionDirs, []string{
Jihoon Kang9007f382024-12-04 00:43:52 +0000388 "sdcard",
Jihoon Kang0a453892024-12-09 22:16:26 +0000389 }...)
390
391 dirsWithRoot := make([]string, len(dirs))
392 for i, dir := range dirs {
393 dirsWithRoot[i] = filepath.Join("root", dir)
Jihoon Kang9007f382024-12-04 00:43:52 +0000394 }
Jihoon Kang0a453892024-12-09 22:16:26 +0000395
396 fsProps.Dirs = proptools.NewSimpleConfigurable(dirsWithRoot)
397 fsProps.Symlinks = symlinksWithNamePrefix(append(commonSymlinksFromRoot, filesystem.SymlinkDefinition{
398 Target: proptools.StringPtr("prop.default"),
399 Name: proptools.StringPtr("default.prop"),
400 }), "root")
Spandan Dase5c393c2024-12-12 19:25:07 +0000401 case "system_dlkm":
402 fsProps.Security_patch = proptools.StringPtr(partitionVars.SystemDlkmSecurityPatch)
403 case "vendor_dlkm":
404 fsProps.Security_patch = proptools.StringPtr(partitionVars.VendorDlkmSecurityPatch)
405 case "odm_dlkm":
406 fsProps.Security_patch = proptools.StringPtr(partitionVars.OdmDlkmSecurityPatch)
Jihoon Kang6da80752024-12-23 18:53:32 +0000407 case "vendor_ramdisk":
408 if android.InList("recovery", generatedPartitions(ctx)) {
409 fsProps.Include_files_of = []string{generatedModuleNameForPartition(ctx.Config(), "recovery")}
410 }
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000411 }
412}
Spandan Dascbe641a2024-10-14 21:07:34 +0000413
Spandan Das5b493cd2024-11-07 20:55:56 +0000414var (
415 dlkmPartitions = []string{
416 "system_dlkm",
417 "vendor_dlkm",
418 "odm_dlkm",
419 }
420)
421
Cole Faust92ccbe22024-10-03 14:38:37 -0700422// Creates a soong module to build the given partition. Returns false if we can't support building
423// it.
424func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700425 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
426
427 fsProps, supported := generateFsProps(ctx, partitionType)
428 if !supported {
429 return false
mrziwanga077b942024-10-16 16:00:06 -0700430 }
mrziwanga077b942024-10-16 16:00:06 -0700431
Cole Faust7db05752024-11-21 13:30:41 -0800432 if partitionType == "vendor" || partitionType == "product" || partitionType == "system" {
Spandan Das2047a4c2024-11-11 21:24:58 +0000433 fsProps.Linker_config.Gen_linker_config = proptools.BoolPtr(true)
Cole Faust7db05752024-11-21 13:30:41 -0800434 if partitionType != "system" {
435 fsProps.Linker_config.Linker_config_srcs = f.createLinkerConfigSourceFilegroups(ctx, partitionType)
436 }
Spandan Das312cc412024-10-29 18:20:11 +0000437 }
438
Jihoon Kanga8fa0712024-11-26 23:11:07 +0000439 if android.InList(partitionType, append(dlkmPartitions, "vendor_ramdisk")) {
Spandan Das5b493cd2024-11-07 20:55:56 +0000440 f.createPrebuiltKernelModules(ctx, partitionType)
Spandan Das5e336422024-11-01 22:31:20 +0000441 }
442
mrziwang4b0ca972024-10-17 14:56:19 -0700443 var module android.Module
444 if partitionType == "system" {
445 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
446 } else {
447 // Explicitly set the partition.
448 fsProps.Partition_type = proptools.StringPtr(partitionType)
449 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
450 }
451 module.HideFromMake()
Spandan Das168098c2024-10-28 19:44:34 +0000452 if partitionType == "vendor" {
Spandan Das4cd93b52024-11-05 23:27:03 +0000453 f.createVendorBuildProp(ctx)
Spandan Das168098c2024-10-28 19:44:34 +0000454 }
mrziwang4b0ca972024-10-17 14:56:19 -0700455 return true
456}
457
Cole Faust953476f2024-11-14 14:11:29 -0800458// Creates filegroups for the files specified in BOARD_(partition_)AVB_KEY_PATH
459func (f *filesystemCreator) createAvbKeyFilegroups(ctx android.LoadHookContext) {
460 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
461 var files []string
462
463 if len(partitionVars.BoardAvbKeyPath) > 0 {
464 files = append(files, partitionVars.BoardAvbKeyPath)
465 }
466 for _, partition := range android.SortedKeys(partitionVars.PartitionQualifiedVariables) {
467 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partition]
468 if len(specificPartitionVars.BoardAvbKeyPath) > 0 {
469 files = append(files, specificPartitionVars.BoardAvbKeyPath)
470 }
471 }
472
473 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
474 for _, file := range files {
475 if _, ok := fsGenState.avbKeyFilegroups[file]; ok {
476 continue
477 }
478 if file == "external/avb/test/data/testkey_rsa4096.pem" {
479 // There already exists a checked-in filegroup for this commonly-used key, just use that
480 fsGenState.avbKeyFilegroups[file] = "avb_testkey_rsa4096"
481 continue
482 }
483 dir := filepath.Dir(file)
484 base := filepath.Base(file)
485 name := fmt.Sprintf("avb_key_%x", strings.ReplaceAll(file, "/", "_"))
486 ctx.CreateModuleInDirectory(
487 android.FileGroupFactory,
488 dir,
489 &struct {
490 Name *string
491 Srcs []string
492 Visibility []string
493 }{
494 Name: proptools.StringPtr(name),
495 Srcs: []string{base},
496 Visibility: []string{"//visibility:public"},
497 },
498 )
499 fsGenState.avbKeyFilegroups[file] = name
500 }
501}
502
Cole Faust3e730972024-12-03 13:12:08 -0800503// Creates filegroups for miscellaneous other files
504func (f *filesystemCreator) createMiscFilegroups(ctx android.LoadHookContext) {
505 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
506
507 if partitionVars.BoardErofsCompressorHints != "" {
508 dir := filepath.Dir(partitionVars.BoardErofsCompressorHints)
509 base := filepath.Base(partitionVars.BoardErofsCompressorHints)
510 ctx.CreateModuleInDirectory(
511 android.FileGroupFactory,
512 dir,
513 &struct {
514 Name *string
515 Srcs []string
516 Visibility []string
517 }{
518 Name: proptools.StringPtr("soong_generated_board_erofs_compress_hints_filegroup"),
519 Srcs: []string{base},
520 Visibility: []string{"//visibility:public"},
521 },
522 )
523 }
524}
525
Spandan Das5e336422024-11-01 22:31:20 +0000526// createPrebuiltKernelModules creates `prebuilt_kernel_modules`. These modules will be added to deps of the
Spandan Das7b25a512024-11-06 20:41:26 +0000527// autogenerated *_dlkm filsystem modules. Each _dlkm partition should have a single prebuilt_kernel_modules dependency.
528// This ensures that the depmod artifacts (modules.* installed in /lib/modules/) are generated with a complete view.
Spandan Das5b493cd2024-11-07 20:55:56 +0000529func (f *filesystemCreator) createPrebuiltKernelModules(ctx android.LoadHookContext, partitionType string) {
Spandan Das5e336422024-11-01 22:31:20 +0000530 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
Spandan Das7b25a512024-11-06 20:41:26 +0000531 name := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-kernel-modules", partitionType))
532 props := &struct {
Spandan Das912d26b2024-11-06 19:35:17 +0000533 Name *string
534 Srcs []string
Spandan Das5b493cd2024-11-07 20:55:56 +0000535 System_deps []string
Spandan Das912d26b2024-11-06 19:35:17 +0000536 System_dlkm_specific *bool
Spandan Das5b493cd2024-11-07 20:55:56 +0000537 Vendor_dlkm_specific *bool
538 Odm_dlkm_specific *bool
Jihoon Kanga8fa0712024-11-26 23:11:07 +0000539 Vendor_ramdisk *bool
Spandan Das5b493cd2024-11-07 20:55:56 +0000540 Load_by_default *bool
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000541 Blocklist_file *string
Jihoon Kang72dd6fc2024-11-27 01:16:39 +0000542 Options_file *string
Spandan Das0eda1162024-12-10 20:44:49 +0000543 Strip_debug_symbols *bool
Spandan Das7b25a512024-11-06 20:41:26 +0000544 }{
Jihoon Kang6cbcd5d2024-12-20 00:51:52 +0000545 Name: proptools.StringPtr(name),
546 Strip_debug_symbols: proptools.BoolPtr(false),
Spandan Das5e336422024-11-01 22:31:20 +0000547 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000548 switch partitionType {
549 case "system_dlkm":
Spandan Das59ee5d72024-11-18 19:36:32 +0000550 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules).Strings()
Spandan Das912d26b2024-11-06 19:35:17 +0000551 props.System_dlkm_specific = proptools.BoolPtr(true)
Spandan Das5b493cd2024-11-07 20:55:56 +0000552 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelLoadModules) == 0 {
553 // Create empty modules.load file for system
554 // https://source.corp.google.com/h/googleplex-android/platform/build/+/ef55daac9954896161b26db4f3ef1781b5a5694c:core/Makefile;l=695-700;drc=549fe2a5162548bd8b47867d35f907eb22332023;bpv=1;bpt=0
555 props.Load_by_default = proptools.BoolPtr(false)
556 }
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000557 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelBlocklistFile; blocklistFile != "" {
558 props.Blocklist_file = proptools.StringPtr(blocklistFile)
559 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000560 case "vendor_dlkm":
Spandan Das59ee5d72024-11-18 19:36:32 +0000561 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorKernelModules).Strings()
Spandan Das5b493cd2024-11-07 20:55:56 +0000562 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules) > 0 {
563 props.System_deps = []string{":" + generatedModuleName(ctx.Config(), "system_dlkm-kernel-modules") + "{.modules}"}
564 }
565 props.Vendor_dlkm_specific = proptools.BoolPtr(true)
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000566 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorKernelBlocklistFile; blocklistFile != "" {
567 props.Blocklist_file = proptools.StringPtr(blocklistFile)
568 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000569 case "odm_dlkm":
Spandan Das59ee5d72024-11-18 19:36:32 +0000570 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.OdmKernelModules).Strings()
Spandan Das5b493cd2024-11-07 20:55:56 +0000571 props.Odm_dlkm_specific = proptools.BoolPtr(true)
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000572 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.OdmKernelBlocklistFile; blocklistFile != "" {
573 props.Blocklist_file = proptools.StringPtr(blocklistFile)
574 }
Jihoon Kanga8fa0712024-11-26 23:11:07 +0000575 case "vendor_ramdisk":
576 props.Srcs = android.ExistentPathsForSources(ctx, ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorRamdiskKernelModules).Strings()
577 props.Vendor_ramdisk = proptools.BoolPtr(true)
578 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorRamdiskKernelBlocklistFile; blocklistFile != "" {
579 props.Blocklist_file = proptools.StringPtr(blocklistFile)
580 }
Jihoon Kang72dd6fc2024-11-27 01:16:39 +0000581 if optionsFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorRamdiskKernelOptionsFile; optionsFile != "" {
582 props.Options_file = proptools.StringPtr(optionsFile)
583 }
584
Spandan Das5b493cd2024-11-07 20:55:56 +0000585 default:
586 ctx.ModuleErrorf("DLKM is not supported for %s\n", partitionType)
Spandan Das912d26b2024-11-06 19:35:17 +0000587 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000588
589 if len(props.Srcs) == 0 {
590 return // do not generate `prebuilt_kernel_modules` if there are no sources
591 }
592
Spandan Das7b25a512024-11-06 20:41:26 +0000593 kernelModule := ctx.CreateModuleInDirectory(
594 kernel.PrebuiltKernelModulesFactory,
595 ".", // create in root directory for now
596 props,
597 )
598 kernelModule.HideFromMake()
599 // Add to deps
600 (*fsGenState.fsDeps[partitionType])[name] = defaultDepCandidateProps(ctx.Config())
Spandan Das5e336422024-11-01 22:31:20 +0000601}
602
Spandan Das4cd93b52024-11-05 23:27:03 +0000603// Create a build_prop and android_info module. This will be used to create /vendor/build.prop
604func (f *filesystemCreator) createVendorBuildProp(ctx android.LoadHookContext) {
605 // Create a android_info for vendor
606 // The board info files might be in a directory outside the root soong namespace, so create
607 // the module in "."
608 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
609 androidInfoProps := &struct {
610 Name *string
611 Board_info_files []string
612 Bootloader_board_name *string
Spandan Das301c2302024-12-12 23:40:52 +0000613 Stem *string
Spandan Das4cd93b52024-11-05 23:27:03 +0000614 }{
Spandan Das301c2302024-12-12 23:40:52 +0000615 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "android_info.prop")),
Spandan Das4cd93b52024-11-05 23:27:03 +0000616 Board_info_files: partitionVars.BoardInfoFiles,
Spandan Dasf8ac1962025-01-07 17:16:42 -0800617 Stem: proptools.StringPtr("android-info.txt"),
Spandan Das4cd93b52024-11-05 23:27:03 +0000618 }
619 if len(androidInfoProps.Board_info_files) == 0 {
620 androidInfoProps.Bootloader_board_name = proptools.StringPtr(partitionVars.BootLoaderBoardName)
621 }
622 androidInfoProp := ctx.CreateModuleInDirectory(
623 android.AndroidInfoFactory,
624 ".",
625 androidInfoProps,
626 )
627 androidInfoProp.HideFromMake()
628 // Create a build prop for vendor
629 vendorBuildProps := &struct {
630 Name *string
631 Vendor *bool
632 Stem *string
633 Product_config *string
634 Android_info *string
Spandan Dasf76de202024-12-17 23:26:35 +0000635 Licenses []string
Spandan Das4cd93b52024-11-05 23:27:03 +0000636 }{
637 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "vendor-build.prop")),
638 Vendor: proptools.BoolPtr(true),
639 Stem: proptools.StringPtr("build.prop"),
640 Product_config: proptools.StringPtr(":product_config"),
641 Android_info: proptools.StringPtr(":" + androidInfoProp.Name()),
Spandan Dasf76de202024-12-17 23:26:35 +0000642 Licenses: []string{"Android-Apache-2.0"},
Spandan Das4cd93b52024-11-05 23:27:03 +0000643 }
644 vendorBuildProp := ctx.CreateModule(
645 android.BuildPropFactory,
646 vendorBuildProps,
647 )
648 vendorBuildProp.HideFromMake()
649}
650
Jihoon Kangefd04b92024-12-10 23:35:09 +0000651func createRecoveryBuildProp(ctx android.LoadHookContext) string {
652 moduleName := generatedModuleName(ctx.Config(), "recovery-prop.default")
653
654 var vendorBuildProp *string
655 if android.InList("vendor", generatedPartitions(ctx)) {
656 vendorBuildProp = proptools.StringPtr(":" + generatedModuleName(ctx.Config(), "vendor-build.prop"))
657 }
658
659 recoveryBuildProps := &struct {
660 Name *string
661 System_build_prop *string
662 Vendor_build_prop *string
663 Odm_build_prop *string
664 Product_build_prop *string
665 System_ext_build_prop *string
666
667 Recovery *bool
668 No_full_install *bool
669 Visibility []string
670 }{
671 Name: proptools.StringPtr(moduleName),
672 System_build_prop: proptools.StringPtr(":system-build.prop"),
673 Vendor_build_prop: vendorBuildProp,
674 Odm_build_prop: proptools.StringPtr(":odm-build.prop"),
675 Product_build_prop: proptools.StringPtr(":product-build.prop"),
676 System_ext_build_prop: proptools.StringPtr(":system_ext-build.prop"),
677
678 Recovery: proptools.BoolPtr(true),
679 No_full_install: proptools.BoolPtr(true),
680 Visibility: []string{"//visibility:public"},
681 }
682
683 ctx.CreateModule(android.RecoveryBuildPropModuleFactory, recoveryBuildProps)
684
685 return moduleName
686}
687
Spandan Das8fe68dc2024-10-29 18:20:11 +0000688// createLinkerConfigSourceFilegroups creates filegroup modules to generate linker.config.pb for the following partitions
689// 1. vendor: Using PRODUCT_VENDOR_LINKER_CONFIG_FRAGMENTS (space separated file list)
690// 1. product: Using PRODUCT_PRODUCT_LINKER_CONFIG_FRAGMENTS (space separated file list)
691// It creates a filegroup for each file in the fragment list
Spandan Das312cc412024-10-29 18:20:11 +0000692// The filegroup modules are then added to `linker_config_srcs` of the autogenerated vendor `android_filesystem`.
Spandan Das8fe68dc2024-10-29 18:20:11 +0000693func (f *filesystemCreator) createLinkerConfigSourceFilegroups(ctx android.LoadHookContext, partitionType string) []string {
Spandan Das312cc412024-10-29 18:20:11 +0000694 ret := []string{}
695 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Spandan Das8fe68dc2024-10-29 18:20:11 +0000696 var linkerConfigSrcs []string
697 if partitionType == "vendor" {
698 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.VendorLinkerConfigSrcs)
699 } else if partitionType == "product" {
700 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.ProductLinkerConfigSrcs)
701 } else {
702 ctx.ModuleErrorf("linker.config.pb is only supported for vendor and product partitions. For system partition, use `android_system_image`")
703 }
704
705 if len(linkerConfigSrcs) > 0 {
Spandan Das312cc412024-10-29 18:20:11 +0000706 // Create a filegroup, and add `:<filegroup_name>` to ret.
707 for index, linkerConfigSrc := range linkerConfigSrcs {
708 dir := filepath.Dir(linkerConfigSrc)
709 base := filepath.Base(linkerConfigSrc)
Spandan Das8fe68dc2024-10-29 18:20:11 +0000710 fgName := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-linker-config-src%s", partitionType, strconv.Itoa(index)))
Spandan Das312cc412024-10-29 18:20:11 +0000711 srcs := []string{base}
712 fgProps := &struct {
713 Name *string
714 Srcs proptools.Configurable[[]string]
715 }{
716 Name: proptools.StringPtr(fgName),
717 Srcs: proptools.NewSimpleConfigurable(srcs),
718 }
719 ctx.CreateModuleInDirectory(
720 android.FileGroupFactory,
721 dir,
722 fgProps,
723 )
724 ret = append(ret, ":"+fgName)
725 }
726 }
727 return ret
728}
729
mrziwang4b0ca972024-10-17 14:56:19 -0700730type filesystemBaseProperty struct {
731 Name *string
732 Compile_multilib *string
Cole Faust3552eb62024-11-06 18:07:26 -0800733 Visibility []string
mrziwang4b0ca972024-10-17 14:56:19 -0700734}
735
736func generateBaseProps(namePtr *string) *filesystemBaseProperty {
737 return &filesystemBaseProperty{
738 Name: namePtr,
739 Compile_multilib: proptools.StringPtr("both"),
Cole Faust3552eb62024-11-06 18:07:26 -0800740 // The vbmeta modules are currently in the root directory and depend on the partitions
741 Visibility: []string{"//.", "//build/soong:__subpackages__"},
mrziwang4b0ca972024-10-17 14:56:19 -0700742 }
743}
744
745func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700746 fsProps := &filesystem.FilesystemProperties{}
747
mrziwang4b0ca972024-10-17 14:56:19 -0700748 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Cole Faust0c4b4152024-11-20 16:42:53 -0800749 var avbInfo avbInfo
Cole Faust76a6e952024-11-07 16:56:45 -0800750 var fsType string
751 if strings.Contains(partitionType, "ramdisk") {
752 fsType = "compressed_cpio"
753 } else {
Cole Faust953476f2024-11-14 14:11:29 -0800754 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
Cole Faust76a6e952024-11-07 16:56:45 -0800755 fsType = specificPartitionVars.BoardFileSystemType
Cole Faust0c4b4152024-11-20 16:42:53 -0800756 avbInfo = getAvbInfo(ctx.Config(), partitionType)
Cole Faust953476f2024-11-14 14:11:29 -0800757 if fsType == "" {
758 fsType = "ext4" //default
759 }
Cole Faust76a6e952024-11-07 16:56:45 -0800760 }
Cole Faust76a6e952024-11-07 16:56:45 -0800761
mrziwang4b0ca972024-10-17 14:56:19 -0700762 fsProps.Type = proptools.StringPtr(fsType)
763 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
764 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
765 return nil, false
766 }
767
Cole Faust3e730972024-12-03 13:12:08 -0800768 if *fsProps.Type == "erofs" {
769 if partitionVars.BoardErofsCompressor != "" {
770 fsProps.Erofs.Compressor = proptools.StringPtr(partitionVars.BoardErofsCompressor)
771 }
772 if partitionVars.BoardErofsCompressorHints != "" {
773 fsProps.Erofs.Compress_hints = proptools.StringPtr(":soong_generated_board_erofs_compress_hints_filegroup")
774 }
775 }
776
Cole Faust92ccbe22024-10-03 14:38:37 -0700777 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
778 // and sometimes don't build.
779 fsProps.Unchecked_module = proptools.BoolPtr(true)
780
Jihoon Kang98047cf2024-10-02 17:13:54 +0000781 // BOARD_AVB_ENABLE
Cole Faust0c4b4152024-11-20 16:42:53 -0800782 fsProps.Use_avb = avbInfo.avbEnable
Jihoon Kang98047cf2024-10-02 17:13:54 +0000783 // BOARD_AVB_KEY_PATH
Cole Faust0c4b4152024-11-20 16:42:53 -0800784 fsProps.Avb_private_key = avbInfo.avbkeyFilegroup
Jihoon Kang98047cf2024-10-02 17:13:54 +0000785 // BOARD_AVB_ALGORITHM
Cole Faust0c4b4152024-11-20 16:42:53 -0800786 fsProps.Avb_algorithm = avbInfo.avbAlgorithm
Jihoon Kang98047cf2024-10-02 17:13:54 +0000787 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust0c4b4152024-11-20 16:42:53 -0800788 fsProps.Rollback_index = avbInfo.avbRollbackIndex
Cole Fauste1676122024-12-03 17:32:25 -0800789 fsProps.Avb_hash_algorithm = avbInfo.avbHashAlgorithm
Jihoon Kang98047cf2024-10-02 17:13:54 +0000790
Cole Faust92ccbe22024-10-03 14:38:37 -0700791 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000792
Cole Faust0d467052024-12-04 17:19:19 -0800793 switch partitionType {
794 // The partitions that support file_contexts came from here:
795 // https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/Makefile;l=2270;drc=ad7cfb56010cb22c3aa0e70cf71c804352553526
796 case "system", "userdata", "cache", "vendor", "product", "system_ext", "odm", "vendor_dlkm", "odm_dlkm", "system_dlkm", "oem":
797 fsProps.Precompiled_file_contexts = proptools.StringPtr(":file_contexts_bin_gen")
798 }
799
Jihoon Kang0d545b82024-10-11 00:21:57 +0000800 fsProps.Is_auto_generated = proptools.BoolPtr(true)
Cole Faust1c026062024-12-16 14:28:23 -0800801 if partitionType != "system" {
802 fsProps.Mount_point = proptools.StringPtr(partitionType)
803 }
Jihoon Kang0d545b82024-10-11 00:21:57 +0000804
Spandan Das71be42d2024-11-20 18:34:16 +0000805 partitionSpecificFsProps(ctx, fsProps, partitionVars, partitionType)
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000806
mrziwang4b0ca972024-10-17 14:56:19 -0700807 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700808}
809
Cole Faust0c4b4152024-11-20 16:42:53 -0800810type avbInfo struct {
811 avbEnable *bool
812 avbKeyPath *string
813 avbkeyFilegroup *string
814 avbAlgorithm *string
815 avbRollbackIndex *int64
816 avbMode *string
Cole Fauste1676122024-12-03 17:32:25 -0800817 avbHashAlgorithm *string
Cole Faust0c4b4152024-11-20 16:42:53 -0800818}
819
820func getAvbInfo(config android.Config, partitionType string) avbInfo {
821 partitionVars := config.ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
822 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
823 var result avbInfo
824 boardAvbEnable := partitionVars.BoardAvbEnable
825 if boardAvbEnable {
826 result.avbEnable = proptools.BoolPtr(true)
Cole Fauste1676122024-12-03 17:32:25 -0800827 // There are "global" and "specific" copies of a lot of these variables. Sometimes they
828 // choose the specific and then fall back to the global one if it's not set, other times
829 // the global one actually only applies to the vbmeta partition.
830 if partitionType == "vbmeta" {
831 if partitionVars.BoardAvbKeyPath != "" {
832 result.avbKeyPath = proptools.StringPtr(partitionVars.BoardAvbKeyPath)
833 }
834 if partitionVars.BoardAvbRollbackIndex != "" {
835 parsed, err := strconv.ParseInt(partitionVars.BoardAvbRollbackIndex, 10, 64)
836 if err != nil {
837 panic(fmt.Sprintf("Rollback index must be an int, got %s", partitionVars.BoardAvbRollbackIndex))
838 }
839 result.avbRollbackIndex = &parsed
840 }
841 }
Cole Faust0c4b4152024-11-20 16:42:53 -0800842 if specificPartitionVars.BoardAvbKeyPath != "" {
843 result.avbKeyPath = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Cole Faust0c4b4152024-11-20 16:42:53 -0800844 }
845 if specificPartitionVars.BoardAvbAlgorithm != "" {
846 result.avbAlgorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
847 } else if partitionVars.BoardAvbAlgorithm != "" {
848 result.avbAlgorithm = proptools.StringPtr(partitionVars.BoardAvbAlgorithm)
849 }
850 if specificPartitionVars.BoardAvbRollbackIndex != "" {
851 parsed, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64)
852 if err != nil {
853 panic(fmt.Sprintf("Rollback index must be an int, got %s", specificPartitionVars.BoardAvbRollbackIndex))
854 }
855 result.avbRollbackIndex = &parsed
Cole Fauste1676122024-12-03 17:32:25 -0800856 }
857 if specificPartitionVars.BoardAvbRollbackIndex != "" {
858 parsed, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64)
Cole Faust0c4b4152024-11-20 16:42:53 -0800859 if err != nil {
Cole Fauste1676122024-12-03 17:32:25 -0800860 panic(fmt.Sprintf("Rollback index must be an int, got %s", specificPartitionVars.BoardAvbRollbackIndex))
Cole Faust0c4b4152024-11-20 16:42:53 -0800861 }
862 result.avbRollbackIndex = &parsed
863 }
Cole Fauste1676122024-12-03 17:32:25 -0800864
865 // Make allows you to pass arbitrary arguments to avbtool via this variable, but in practice
866 // it's only used for --hash_algorithm. The soong module has a dedicated property for the
867 // hashtree algorithm, and doesn't allow custom arguments, so just extract the hashtree
868 // algorithm out of the arbitrary arguments.
869 addHashtreeFooterArgs := strings.Split(specificPartitionVars.BoardAvbAddHashtreeFooterArgs, " ")
870 if i := slices.Index(addHashtreeFooterArgs, "--hash_algorithm"); i >= 0 {
871 result.avbHashAlgorithm = &addHashtreeFooterArgs[i+1]
872 }
873
Cole Faust0c4b4152024-11-20 16:42:53 -0800874 result.avbMode = proptools.StringPtr("make_legacy")
875 }
876 if result.avbKeyPath != nil {
877 fsGenState := config.Get(fsGenStateOnceKey).(*FsGenState)
878 filegroup := fsGenState.avbKeyFilegroups[*result.avbKeyPath]
879 result.avbkeyFilegroup = proptools.StringPtr(":" + filegroup)
880 }
881 return result
882}
883
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800884func (f *filesystemCreator) createFileListDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000885 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
mrziwang6aefe7d2025-01-07 16:27:53 -0800886 partitionImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
887 filesystemInfo, ok := android.OtherModuleProvider(ctx, partitionImage, filesystem.FilesystemProvider)
Cole Faust92ccbe22024-10-03 14:38:37 -0700888 if !ok {
889 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
890 }
891 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 +0000892 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700893
894 builder := android.NewRuleBuilder(pctx, ctx)
895 builder.Command().BuiltTool("file_list_diff").
896 Input(makeFileList).
897 Input(filesystemInfo.FileListFile).
Cole Faust56301572024-11-07 15:22:42 -0800898 Text(partitionModuleName)
Cole Faust92ccbe22024-10-03 14:38:37 -0700899 builder.Command().Text("touch").Output(diffTestResultFile)
900 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
901 return diffTestResultFile
902}
903
904func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
905 hasher := sha256.New()
906 hasher.Write([]byte(message))
907 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
908 file := android.PathForModuleOut(ctx, filename)
909 builder := android.NewRuleBuilder(pctx, ctx)
910 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
911 builder.Command().Text("exit 1 #").Output(file)
912 builder.Build("failing command "+filename, "failing command "+filename)
913 return file
914}
915
Cole Faust3552eb62024-11-06 18:07:26 -0800916func createVbmetaDiff(ctx android.ModuleContext, vbmetaModuleName string, vbmetaPartitionName string) android.Path {
917 vbmetaModule := ctx.GetDirectDepWithTag(vbmetaModuleName, generatedVbmetaPartitionDepTag)
918 outputFilesProvider, ok := android.OtherModuleProvider(ctx, vbmetaModule, android.OutputFilesProvider)
919 if !ok {
920 ctx.ModuleErrorf("Expected module %s to provide OutputFiles", vbmetaModule)
921 }
922 if len(outputFilesProvider.DefaultOutputFiles) != 1 {
923 ctx.ModuleErrorf("Expected 1 output file from module %s", vbmetaModule)
924 }
925 soongVbMetaFile := outputFilesProvider.DefaultOutputFiles[0]
926 makeVbmetaFile := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/%s.img", ctx.Config().DeviceName(), vbmetaPartitionName))
927
928 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", vbmetaModuleName))
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800929 createDiffTest(ctx, diffTestResultFile, soongVbMetaFile, makeVbmetaFile)
930 return diffTestResultFile
931}
932
933func createDiffTest(ctx android.ModuleContext, diffTestResultFile android.WritablePath, file1 android.Path, file2 android.Path) {
Cole Faust3552eb62024-11-06 18:07:26 -0800934 builder := android.NewRuleBuilder(pctx, ctx)
935 builder.Command().Text("diff").
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800936 Input(file1).
937 Input(file2)
Cole Faust3552eb62024-11-06 18:07:26 -0800938 builder.Command().Text("touch").Output(diffTestResultFile)
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800939 builder.Build("diff test "+diffTestResultFile.String(), "diff test")
Cole Faust3552eb62024-11-06 18:07:26 -0800940}
941
mrziwang6aefe7d2025-01-07 16:27:53 -0800942type imageDepTagType struct {
Cole Faust92ccbe22024-10-03 14:38:37 -0700943 blueprint.BaseDependencyTag
944}
945
mrziwang6aefe7d2025-01-07 16:27:53 -0800946var generatedFilesystemDepTag imageDepTagType
947var generatedVbmetaPartitionDepTag imageDepTagType
Cole Faust92ccbe22024-10-03 14:38:37 -0700948
949func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
950 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000951 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700952 }
Cole Faust3552eb62024-11-06 18:07:26 -0800953 for _, vbmetaModule := range f.properties.Vbmeta_module_names {
954 ctx.AddDependency(ctx.Module(), generatedVbmetaPartitionDepTag, vbmetaModule)
955 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000956}
957
958func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700959 if ctx.ModuleDir() != "build/soong/fsgen" {
960 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
961 }
962 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000963
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000964 var content strings.Builder
965 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
966 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
967 content.WriteString(generateBpContent(ctx, partition))
968 content.WriteString("\n")
969 }
970 android.WriteFileRule(ctx, generatedBp, content.String())
971
mrziwang8f86c882024-10-03 12:34:33 -0700972 ctx.Phony("product_config_to_bp", generatedBp)
973
Cole Faust92ccbe22024-10-03 14:38:37 -0700974 var diffTestFiles []android.Path
975 for _, partitionType := range f.properties.Generated_partition_types {
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800976 diffTestFile := f.createFileListDiffTest(ctx, partitionType)
Jihoon Kang72f812f2024-10-17 18:46:24 +0000977 diffTestFiles = append(diffTestFiles, diffTestFile)
978 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700979 }
980 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000981 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
982 diffTestFiles = append(diffTestFiles, diffTestFile)
983 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700984 }
Cole Faust3552eb62024-11-06 18:07:26 -0800985 for i, vbmetaModule := range f.properties.Vbmeta_module_names {
986 diffTestFile := createVbmetaDiff(ctx, vbmetaModule, f.properties.Vbmeta_partition_names[i])
987 diffTestFiles = append(diffTestFiles, diffTestFile)
988 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", f.properties.Vbmeta_partition_names[i]), diffTestFile)
989 }
Cole Faustf2a6e8b2024-11-14 10:54:48 -0800990 if f.properties.Boot_image != "" {
991 diffTestFile := android.PathForModuleOut(ctx, "boot_diff_test.txt")
992 soongBootImg := android.PathForModuleSrc(ctx, f.properties.Boot_image)
993 makeBootImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/boot.img", ctx.Config().DeviceName()))
994 createDiffTest(ctx, diffTestFile, soongBootImg, makeBootImage)
995 diffTestFiles = append(diffTestFiles, diffTestFile)
996 ctx.Phony("soong_generated_boot_filesystem_test", diffTestFile)
997 }
Cole Faust24938e22024-11-18 14:01:58 -0800998 if f.properties.Vendor_boot_image != "" {
999 diffTestFile := android.PathForModuleOut(ctx, "vendor_boot_diff_test.txt")
Jihoon Kang95eb1da2024-11-19 20:55:20 +00001000 soongBootImg := android.PathForModuleSrc(ctx, f.properties.Vendor_boot_image)
Cole Faust24938e22024-11-18 14:01:58 -08001001 makeBootImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/vendor_boot.img", ctx.Config().DeviceName()))
1002 createDiffTest(ctx, diffTestFile, soongBootImg, makeBootImage)
1003 diffTestFiles = append(diffTestFiles, diffTestFile)
1004 ctx.Phony("soong_generated_vendor_boot_filesystem_test", diffTestFile)
1005 }
Jihoon Kang95eb1da2024-11-19 20:55:20 +00001006 if f.properties.Init_boot_image != "" {
1007 diffTestFile := android.PathForModuleOut(ctx, "init_boot_diff_test.txt")
1008 soongBootImg := android.PathForModuleSrc(ctx, f.properties.Init_boot_image)
1009 makeBootImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/init_boot.img", ctx.Config().DeviceName()))
1010 createDiffTest(ctx, diffTestFile, soongBootImg, makeBootImage)
1011 diffTestFiles = append(diffTestFiles, diffTestFile)
1012 ctx.Phony("soong_generated_init_boot_filesystem_test", diffTestFile)
1013 }
mrziwang79730d42024-12-02 22:13:59 -08001014 if f.properties.Super_image != "" {
1015 diffTestFile := android.PathForModuleOut(ctx, "super_diff_test.txt")
1016 soongSuperImg := android.PathForModuleSrc(ctx, f.properties.Super_image)
1017 makeSuperImage := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/super.img", ctx.Config().DeviceName()))
1018 createDiffTest(ctx, diffTestFile, soongSuperImg, makeSuperImage)
1019 diffTestFiles = append(diffTestFiles, diffTestFile)
1020 ctx.Phony("soong_generated_super_filesystem_test", diffTestFile)
1021 }
Cole Faust92ccbe22024-10-03 14:38:37 -07001022 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +00001023}
mrziwang8f86c882024-10-03 12:34:33 -07001024
mrziwang8f86c882024-10-03 12:34:33 -07001025func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -07001026 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
1027 if !fsTypeSupported {
1028 return ""
mrziwang8f86c882024-10-03 12:34:33 -07001029 }
1030
mrziwang4b0ca972024-10-17 14:56:19 -07001031 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
Jihoon Kang0d7b0112024-11-13 20:44:05 +00001032 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
1033 deps := fsGenState.fsDeps[partitionType]
1034 highPriorityDeps := fsGenState.generatedPrebuiltEtcModuleNames
1035 depProps := generateDepStruct(*deps, highPriorityDeps)
mrziwang8f86c882024-10-03 12:34:33 -07001036
mrziwang4b0ca972024-10-17 14:56:19 -07001037 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -07001038 if err != nil {
Cole Faustae3e1d32024-11-05 13:22:50 -08001039 ctx.ModuleErrorf("%s", err.Error())
1040 return ""
mrziwang8f86c882024-10-03 12:34:33 -07001041 }
1042
Jihoon Kang4e5d8de2024-10-19 01:59:58 +00001043 moduleType := "android_filesystem"
1044 if partitionType == "system" {
1045 moduleType = "android_system_image"
1046 }
1047
mrziwang8f86c882024-10-03 12:34:33 -07001048 file := &parser.File{
1049 Defs: []parser.Definition{
1050 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +00001051 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -07001052 Map: *result,
1053 },
1054 },
1055 }
1056 bytes, err := parser.Print(file)
1057 if err != nil {
1058 ctx.ModuleErrorf(err.Error())
1059 }
1060 return strings.TrimSpace(string(bytes))
1061}