blob: b580ea9b7fe47787424aaf928556da584ebaa130 [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"
Jihoon Kang98047cf2024-10-02 17:13:54 +000021 "strconv"
mrziwang8f86c882024-10-03 12:34:33 -070022 "strings"
mrziwang8f86c882024-10-03 12:34:33 -070023
24 "android/soong/android"
25 "android/soong/filesystem"
Spandan Das5e336422024-11-01 22:31:20 +000026 "android/soong/kernel"
Jihoon Kang98047cf2024-10-02 17:13:54 +000027
Cole Faust92ccbe22024-10-03 14:38:37 -070028 "github.com/google/blueprint"
mrziwang8f86c882024-10-03 12:34:33 -070029 "github.com/google/blueprint/parser"
Jihoon Kang98047cf2024-10-02 17:13:54 +000030 "github.com/google/blueprint/proptools"
31)
32
Cole Faust92ccbe22024-10-03 14:38:37 -070033var pctx = android.NewPackageContext("android/soong/fsgen")
34
Jihoon Kang98047cf2024-10-02 17:13:54 +000035func init() {
36 registerBuildComponents(android.InitRegistrationContext)
37}
38
39func registerBuildComponents(ctx android.RegistrationContext) {
40 ctx.RegisterModuleType("soong_filesystem_creator", filesystemCreatorFactory)
mrziwang8f86c882024-10-03 12:34:33 -070041 ctx.PreDepsMutators(RegisterCollectFileSystemDepsMutators)
42}
43
Cole Faust92ccbe22024-10-03 14:38:37 -070044type filesystemCreatorProps struct {
45 Generated_partition_types []string `blueprint:"mutated"`
46 Unsupported_partition_types []string `blueprint:"mutated"`
Cole Faust1fa1c6d2024-11-06 18:07:26 -080047
48 Vbmeta_module_names []string `blueprint:"mutated"`
49 Vbmeta_partition_names []string `blueprint:"mutated"`
Cole Faust92ccbe22024-10-03 14:38:37 -070050}
51
Jihoon Kang98047cf2024-10-02 17:13:54 +000052type filesystemCreator struct {
53 android.ModuleBase
Cole Faust92ccbe22024-10-03 14:38:37 -070054
55 properties filesystemCreatorProps
Jihoon Kang98047cf2024-10-02 17:13:54 +000056}
57
58func filesystemCreatorFactory() android.Module {
59 module := &filesystemCreator{}
60
Cole Faust69788792024-10-10 11:00:36 -070061 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
Cole Faust92ccbe22024-10-03 14:38:37 -070062 module.AddProperties(&module.properties)
Jihoon Kang98047cf2024-10-02 17:13:54 +000063 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jihoon Kang675d4682024-10-24 23:45:11 +000064 generatedPrebuiltEtcModuleNames := createPrebuiltEtcModules(ctx)
65 createFsGenState(ctx, generatedPrebuiltEtcModuleNames)
Jihoon Kang98047cf2024-10-02 17:13:54 +000066 module.createInternalModules(ctx)
67 })
68
69 return module
70}
71
72func (f *filesystemCreator) createInternalModules(ctx android.LoadHookContext) {
Cole Faust1fa1c6d2024-11-06 18:07:26 -080073 soongGeneratedPartitions := generatedPartitions(ctx)
74 finalSoongGeneratedPartitions := make([]string, 0, len(soongGeneratedPartitions))
75 for _, partitionType := range soongGeneratedPartitions {
Cole Faust92ccbe22024-10-03 14:38:37 -070076 if f.createPartition(ctx, partitionType) {
77 f.properties.Generated_partition_types = append(f.properties.Generated_partition_types, partitionType)
Cole Faust1fa1c6d2024-11-06 18:07:26 -080078 finalSoongGeneratedPartitions = append(finalSoongGeneratedPartitions, partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -070079 } else {
80 f.properties.Unsupported_partition_types = append(f.properties.Unsupported_partition_types, partitionType)
81 }
82 }
Cole Faust1fa1c6d2024-11-06 18:07:26 -080083
84 for _, x := range createVbmetaPartitions(ctx, finalSoongGeneratedPartitions) {
85 f.properties.Vbmeta_module_names = append(f.properties.Vbmeta_module_names, x.moduleName)
86 f.properties.Vbmeta_partition_names = append(f.properties.Vbmeta_partition_names, x.partitionName)
87 }
88
89 ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions = finalSoongGeneratedPartitions
90 f.createDeviceModule(ctx, finalSoongGeneratedPartitions, f.properties.Vbmeta_module_names)
Jihoon Kang98047cf2024-10-02 17:13:54 +000091}
92
Jihoon Kang0d545b82024-10-11 00:21:57 +000093func generatedModuleName(cfg android.Config, suffix string) string {
Cole Faust92ccbe22024-10-03 14:38:37 -070094 prefix := "soong"
95 if cfg.HasDeviceProduct() {
96 prefix = cfg.DeviceProduct()
97 }
Jihoon Kangf1c79ca2024-10-09 20:18:38 +000098 return fmt.Sprintf("%s_generated_%s", prefix, suffix)
99}
100
Jihoon Kang0d545b82024-10-11 00:21:57 +0000101func generatedModuleNameForPartition(cfg android.Config, partitionType string) string {
102 return generatedModuleName(cfg, fmt.Sprintf("%s_image", partitionType))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000103}
104
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800105func (f *filesystemCreator) createDeviceModule(
106 ctx android.LoadHookContext,
107 generatedPartitionTypes []string,
108 vbmetaPartitions []string,
109) {
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000110 baseProps := &struct {
111 Name *string
112 }{
Jihoon Kang0d545b82024-10-11 00:21:57 +0000113 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "device")),
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000114 }
115
Priyanka Advani (xWF)dafaa7f2024-10-21 22:55:13 +0000116 // Currently, only the system and system_ext partition module is created.
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000117 partitionProps := &filesystem.PartitionNameProperties{}
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800118 if android.InList("system", generatedPartitionTypes) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000119 partitionProps.System_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000120 }
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800121 if android.InList("system_ext", generatedPartitionTypes) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000122 partitionProps.System_ext_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
Spandan Das7a46f6c2024-10-14 18:41:18 +0000123 }
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800124 if android.InList("vendor", generatedPartitionTypes) {
Spandan Dase3b65312024-10-22 00:27:27 +0000125 partitionProps.Vendor_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "vendor"))
126 }
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800127 if android.InList("product", generatedPartitionTypes) {
Jihoon Kang6dd13b62024-10-22 23:21:02 +0000128 partitionProps.Product_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "product"))
129 }
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800130 if android.InList("odm", generatedPartitionTypes) {
Spandan Dasc5717162024-11-01 18:33:57 +0000131 partitionProps.Odm_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "odm"))
132 }
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800133 partitionProps.Vbmeta_partitions = vbmetaPartitions
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000134
135 ctx.CreateModule(filesystem.AndroidDeviceFactory, baseProps, partitionProps)
Cole Faust92ccbe22024-10-03 14:38:37 -0700136}
137
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000138func partitionSpecificFsProps(fsProps *filesystem.FilesystemProperties, partitionType string) {
139 switch partitionType {
140 case "system":
141 fsProps.Build_logtags = proptools.BoolPtr(true)
142 // https://source.corp.google.com/h/googleplex-android/platform/build//639d79f5012a6542ab1f733b0697db45761ab0f3:core/packaging/flags.mk;l=21;drc=5ba8a8b77507f93aa48cc61c5ba3f31a4d0cbf37;bpv=1;bpt=0
143 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000144 // Identical to that of the generic_system_image
145 fsProps.Fsverity.Inputs = []string{
146 "etc/boot-image.prof",
147 "etc/dirty-image-objects",
148 "etc/preloaded-classes",
149 "etc/classpaths/*.pb",
150 "framework/*",
151 "framework/*/*", // framework/{arch}
152 "framework/oat/*/*", // framework/oat/{arch}
153 }
154 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
155 case "system_ext":
156 fsProps.Fsverity.Inputs = []string{
157 "framework/*",
158 "framework/*/*", // framework/{arch}
159 "framework/oat/*/*", // framework/oat/{arch}
160 }
161 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000162 case "product":
163 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
164 case "vendor":
165 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das69464c32024-10-25 20:08:06 +0000166 fsProps.Symlinks = []filesystem.SymlinkDefinition{
167 filesystem.SymlinkDefinition{
168 Target: proptools.StringPtr("/odm"),
169 Name: proptools.StringPtr("vendor/odm"),
170 },
171 filesystem.SymlinkDefinition{
172 Target: proptools.StringPtr("/vendor_dlkm/lib/modules"),
173 Name: proptools.StringPtr("vendor/lib/modules"),
174 },
175 }
176 fsProps.Base_dir = proptools.StringPtr("vendor")
Spandan Dasc5717162024-11-01 18:33:57 +0000177 case "odm":
178 fsProps.Symlinks = []filesystem.SymlinkDefinition{
179 filesystem.SymlinkDefinition{
180 Target: proptools.StringPtr("/odm_dlkm/lib/modules"),
181 Name: proptools.StringPtr("odm/lib/modules"),
182 },
183 }
184 fsProps.Base_dir = proptools.StringPtr("odm")
185
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000186 }
187}
Spandan Dascbe641a2024-10-14 21:07:34 +0000188
Cole Faust92ccbe22024-10-03 14:38:37 -0700189// Creates a soong module to build the given partition. Returns false if we can't support building
190// it.
191func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700192 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
193
194 fsProps, supported := generateFsProps(ctx, partitionType)
195 if !supported {
196 return false
mrziwanga077b942024-10-16 16:00:06 -0700197 }
mrziwanga077b942024-10-16 16:00:06 -0700198
Spandan Das8fe68dc2024-10-29 18:20:11 +0000199 if partitionType == "vendor" || partitionType == "product" {
Spandan Das173256b2024-10-31 19:59:30 +0000200 fsProps.Linkerconfig.Gen_linker_config = proptools.BoolPtr(true)
201 fsProps.Linkerconfig.Linker_config_srcs = f.createLinkerConfigSourceFilegroups(ctx, partitionType)
Spandan Das312cc412024-10-29 18:20:11 +0000202 }
203
Spandan Das5e336422024-11-01 22:31:20 +0000204 if partitionType == "system_dlkm" {
205 kernelModules := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules
206 f.createPrebuiltKernelModules(ctx, partitionType, kernelModules)
207 }
208
mrziwang4b0ca972024-10-17 14:56:19 -0700209 var module android.Module
210 if partitionType == "system" {
211 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
Spandan Das5e336422024-11-01 22:31:20 +0000212 } else if partitionType == "system_dlkm" {
213 // Do not set partition_type. build/soong/android/paths#modulePartition currently does not support dlkm
214 // partitions. Since `android_filesystem` uses a partition based filter, setting the partition here
215 // would result in missing in entries.
216 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
mrziwang4b0ca972024-10-17 14:56:19 -0700217 } else {
218 // Explicitly set the partition.
219 fsProps.Partition_type = proptools.StringPtr(partitionType)
220 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
221 }
222 module.HideFromMake()
Spandan Das168098c2024-10-28 19:44:34 +0000223 if partitionType == "vendor" {
Spandan Das4cd93b52024-11-05 23:27:03 +0000224 f.createVendorBuildProp(ctx)
Spandan Das168098c2024-10-28 19:44:34 +0000225 }
mrziwang4b0ca972024-10-17 14:56:19 -0700226 return true
227}
228
Spandan Das5e336422024-11-01 22:31:20 +0000229// createPrebuiltKernelModules creates `prebuilt_kernel_modules`. These modules will be added to deps of the
230// autogenerated *_dlkm filsystem modules.
231// The input `kernelModules` is a space separated list of .ko files in the workspace. This will be partitioned per directory
232// and a `prebuilt_kernel_modules` will be created per partition.
233// These autogenerated modules will be subsequently added to the deps of the top level *_dlkm android_filesystem
234func (f *filesystemCreator) createPrebuiltKernelModules(ctx android.LoadHookContext, partitionType string, kernelModules []string) {
235 // Partition the files per directory
236 dirToFiles := map[string][]string{}
237 for _, kernelModule := range kernelModules {
238 dir := filepath.Dir(kernelModule)
239 base := filepath.Base(kernelModule)
240 dirToFiles[dir] = append(dirToFiles[dir], base)
241 }
242 // Create a prebuilt_kernel_modules module per partition
243 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
244 for index, dir := range android.SortedKeys(dirToFiles) {
245 name := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-kernel-modules-%s", partitionType, strconv.Itoa(index)))
246 props := &struct {
247 Name *string
248 Srcs []string
249 }{
250 Name: proptools.StringPtr(name),
251 Srcs: dirToFiles[dir],
252 }
253 kernelModule := ctx.CreateModuleInDirectory(
254 kernel.PrebuiltKernelModulesFactory,
255 dir,
256 props,
257 )
258 kernelModule.HideFromMake()
259 // Add to deps
260 (*fsGenState.fsDeps[partitionType])[name] = defaultDepCandidateProps(ctx.Config())
261 }
262}
263
Spandan Das4cd93b52024-11-05 23:27:03 +0000264// Create a build_prop and android_info module. This will be used to create /vendor/build.prop
265func (f *filesystemCreator) createVendorBuildProp(ctx android.LoadHookContext) {
266 // Create a android_info for vendor
267 // The board info files might be in a directory outside the root soong namespace, so create
268 // the module in "."
269 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
270 androidInfoProps := &struct {
271 Name *string
272 Board_info_files []string
273 Bootloader_board_name *string
274 }{
275 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "android-info.prop")),
276 Board_info_files: partitionVars.BoardInfoFiles,
277 }
278 if len(androidInfoProps.Board_info_files) == 0 {
279 androidInfoProps.Bootloader_board_name = proptools.StringPtr(partitionVars.BootLoaderBoardName)
280 }
281 androidInfoProp := ctx.CreateModuleInDirectory(
282 android.AndroidInfoFactory,
283 ".",
284 androidInfoProps,
285 )
286 androidInfoProp.HideFromMake()
287 // Create a build prop for vendor
288 vendorBuildProps := &struct {
289 Name *string
290 Vendor *bool
291 Stem *string
292 Product_config *string
293 Android_info *string
294 }{
295 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "vendor-build.prop")),
296 Vendor: proptools.BoolPtr(true),
297 Stem: proptools.StringPtr("build.prop"),
298 Product_config: proptools.StringPtr(":product_config"),
299 Android_info: proptools.StringPtr(":" + androidInfoProp.Name()),
300 }
301 vendorBuildProp := ctx.CreateModule(
302 android.BuildPropFactory,
303 vendorBuildProps,
304 )
305 vendorBuildProp.HideFromMake()
306}
307
Spandan Das8fe68dc2024-10-29 18:20:11 +0000308// createLinkerConfigSourceFilegroups creates filegroup modules to generate linker.config.pb for the following partitions
309// 1. vendor: Using PRODUCT_VENDOR_LINKER_CONFIG_FRAGMENTS (space separated file list)
310// 1. product: Using PRODUCT_PRODUCT_LINKER_CONFIG_FRAGMENTS (space separated file list)
311// It creates a filegroup for each file in the fragment list
Spandan Das312cc412024-10-29 18:20:11 +0000312// The filegroup modules are then added to `linker_config_srcs` of the autogenerated vendor `android_filesystem`.
Spandan Das8fe68dc2024-10-29 18:20:11 +0000313func (f *filesystemCreator) createLinkerConfigSourceFilegroups(ctx android.LoadHookContext, partitionType string) []string {
Spandan Das312cc412024-10-29 18:20:11 +0000314 ret := []string{}
315 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Spandan Das8fe68dc2024-10-29 18:20:11 +0000316 var linkerConfigSrcs []string
317 if partitionType == "vendor" {
318 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.VendorLinkerConfigSrcs)
319 } else if partitionType == "product" {
320 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.ProductLinkerConfigSrcs)
321 } else {
322 ctx.ModuleErrorf("linker.config.pb is only supported for vendor and product partitions. For system partition, use `android_system_image`")
323 }
324
325 if len(linkerConfigSrcs) > 0 {
Spandan Das312cc412024-10-29 18:20:11 +0000326 // Create a filegroup, and add `:<filegroup_name>` to ret.
327 for index, linkerConfigSrc := range linkerConfigSrcs {
328 dir := filepath.Dir(linkerConfigSrc)
329 base := filepath.Base(linkerConfigSrc)
Spandan Das8fe68dc2024-10-29 18:20:11 +0000330 fgName := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-linker-config-src%s", partitionType, strconv.Itoa(index)))
Spandan Das312cc412024-10-29 18:20:11 +0000331 srcs := []string{base}
332 fgProps := &struct {
333 Name *string
334 Srcs proptools.Configurable[[]string]
335 }{
336 Name: proptools.StringPtr(fgName),
337 Srcs: proptools.NewSimpleConfigurable(srcs),
338 }
339 ctx.CreateModuleInDirectory(
340 android.FileGroupFactory,
341 dir,
342 fgProps,
343 )
344 ret = append(ret, ":"+fgName)
345 }
346 }
347 return ret
348}
349
mrziwang4b0ca972024-10-17 14:56:19 -0700350type filesystemBaseProperty struct {
351 Name *string
352 Compile_multilib *string
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800353 Visibility []string
mrziwang4b0ca972024-10-17 14:56:19 -0700354}
355
356func generateBaseProps(namePtr *string) *filesystemBaseProperty {
357 return &filesystemBaseProperty{
358 Name: namePtr,
359 Compile_multilib: proptools.StringPtr("both"),
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800360 // The vbmeta modules are currently in the root directory and depend on the partitions
361 Visibility: []string{"//.", "//build/soong:__subpackages__"},
mrziwang4b0ca972024-10-17 14:56:19 -0700362 }
363}
364
365func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700366 fsProps := &filesystem.FilesystemProperties{}
367
mrziwang4b0ca972024-10-17 14:56:19 -0700368 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
369 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
370
371 // BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE
372 fsType := specificPartitionVars.BoardFileSystemType
373 if fsType == "" {
374 fsType = "ext4" //default
375 }
376 fsProps.Type = proptools.StringPtr(fsType)
377 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
378 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
379 return nil, false
380 }
381
Cole Faust92ccbe22024-10-03 14:38:37 -0700382 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
383 // and sometimes don't build.
384 fsProps.Unchecked_module = proptools.BoolPtr(true)
385
Jihoon Kang98047cf2024-10-02 17:13:54 +0000386 // BOARD_AVB_ENABLE
387 fsProps.Use_avb = proptools.BoolPtr(partitionVars.BoardAvbEnable)
388 // BOARD_AVB_KEY_PATH
Cole Faust92ccbe22024-10-03 14:38:37 -0700389 fsProps.Avb_private_key = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000390 // BOARD_AVB_ALGORITHM
Cole Faust92ccbe22024-10-03 14:38:37 -0700391 fsProps.Avb_algorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000392 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust92ccbe22024-10-03 14:38:37 -0700393 if rollbackIndex, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64); err == nil {
Jihoon Kang98047cf2024-10-02 17:13:54 +0000394 fsProps.Rollback_index = proptools.Int64Ptr(rollbackIndex)
395 }
396
Cole Faust92ccbe22024-10-03 14:38:37 -0700397 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000398
Cole Faust92ccbe22024-10-03 14:38:37 -0700399 fsProps.Base_dir = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000400
Jihoon Kang0d545b82024-10-11 00:21:57 +0000401 fsProps.Is_auto_generated = proptools.BoolPtr(true)
402
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000403 partitionSpecificFsProps(fsProps, partitionType)
404
Jihoon Kang98047cf2024-10-02 17:13:54 +0000405 // system_image properties that are not set:
406 // - filesystemProperties.Avb_hash_algorithm
407 // - filesystemProperties.File_contexts
408 // - filesystemProperties.Dirs
409 // - filesystemProperties.Symlinks
410 // - filesystemProperties.Fake_timestamp
411 // - filesystemProperties.Uuid
412 // - filesystemProperties.Mount_point
413 // - filesystemProperties.Include_make_built_files
414 // - filesystemProperties.Build_logtags
Jihoon Kang98047cf2024-10-02 17:13:54 +0000415 // - systemImageProperties.Linker_config_src
mrziwang4b0ca972024-10-17 14:56:19 -0700416
417 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700418}
419
420func (f *filesystemCreator) createDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000421 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700422 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
423 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
424 if !ok {
425 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
426 }
427 makeFileList := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/obj/PACKAGING/%s_intermediates/file_list.txt", ctx.Config().DeviceName(), partitionType))
428 // For now, don't allowlist anything. The test will fail, but that's fine in the current
429 // early stages where we're just figuring out what we need
Jihoon Kang9e866c82024-10-07 22:39:18 +0000430 emptyAllowlistFile := android.PathForModuleOut(ctx, fmt.Sprintf("allowlist_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700431 android.WriteFileRule(ctx, emptyAllowlistFile, "")
Jihoon Kang9e866c82024-10-07 22:39:18 +0000432 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700433
434 builder := android.NewRuleBuilder(pctx, ctx)
435 builder.Command().BuiltTool("file_list_diff").
436 Input(makeFileList).
437 Input(filesystemInfo.FileListFile).
Jihoon Kang9e866c82024-10-07 22:39:18 +0000438 Text(partitionModuleName).
439 FlagWithInput("--allowlists ", emptyAllowlistFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700440 builder.Command().Text("touch").Output(diffTestResultFile)
441 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
442 return diffTestResultFile
443}
444
445func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
446 hasher := sha256.New()
447 hasher.Write([]byte(message))
448 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
449 file := android.PathForModuleOut(ctx, filename)
450 builder := android.NewRuleBuilder(pctx, ctx)
451 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
452 builder.Command().Text("exit 1 #").Output(file)
453 builder.Build("failing command "+filename, "failing command "+filename)
454 return file
455}
456
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800457func createVbmetaDiff(ctx android.ModuleContext, vbmetaModuleName string, vbmetaPartitionName string) android.Path {
458 vbmetaModule := ctx.GetDirectDepWithTag(vbmetaModuleName, generatedVbmetaPartitionDepTag)
459 outputFilesProvider, ok := android.OtherModuleProvider(ctx, vbmetaModule, android.OutputFilesProvider)
460 if !ok {
461 ctx.ModuleErrorf("Expected module %s to provide OutputFiles", vbmetaModule)
462 }
463 if len(outputFilesProvider.DefaultOutputFiles) != 1 {
464 ctx.ModuleErrorf("Expected 1 output file from module %s", vbmetaModule)
465 }
466 soongVbMetaFile := outputFilesProvider.DefaultOutputFiles[0]
467 makeVbmetaFile := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/%s.img", ctx.Config().DeviceName(), vbmetaPartitionName))
468
469 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", vbmetaModuleName))
470 builder := android.NewRuleBuilder(pctx, ctx)
471 builder.Command().Text("diff").
472 Input(soongVbMetaFile).
473 Input(makeVbmetaFile)
474 builder.Command().Text("touch").Output(diffTestResultFile)
475 builder.Build(vbmetaModuleName+" diff test", vbmetaModuleName+" diff test")
476 return diffTestResultFile
477}
478
Cole Faust92ccbe22024-10-03 14:38:37 -0700479type systemImageDepTagType struct {
480 blueprint.BaseDependencyTag
481}
482
483var generatedFilesystemDepTag systemImageDepTagType
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800484var generatedVbmetaPartitionDepTag systemImageDepTagType
Cole Faust92ccbe22024-10-03 14:38:37 -0700485
486func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
487 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000488 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700489 }
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800490 for _, vbmetaModule := range f.properties.Vbmeta_module_names {
491 ctx.AddDependency(ctx.Module(), generatedVbmetaPartitionDepTag, vbmetaModule)
492 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000493}
494
495func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700496 if ctx.ModuleDir() != "build/soong/fsgen" {
497 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
498 }
499 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000500
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000501 var content strings.Builder
502 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
503 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
504 content.WriteString(generateBpContent(ctx, partition))
505 content.WriteString("\n")
506 }
507 android.WriteFileRule(ctx, generatedBp, content.String())
508
mrziwang8f86c882024-10-03 12:34:33 -0700509 ctx.Phony("product_config_to_bp", generatedBp)
510
Cole Faust92ccbe22024-10-03 14:38:37 -0700511 var diffTestFiles []android.Path
512 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000513 diffTestFile := f.createDiffTest(ctx, partitionType)
514 diffTestFiles = append(diffTestFiles, diffTestFile)
515 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700516 }
517 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000518 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
519 diffTestFiles = append(diffTestFiles, diffTestFile)
520 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700521 }
Cole Faust1fa1c6d2024-11-06 18:07:26 -0800522 for i, vbmetaModule := range f.properties.Vbmeta_module_names {
523 diffTestFile := createVbmetaDiff(ctx, vbmetaModule, f.properties.Vbmeta_partition_names[i])
524 diffTestFiles = append(diffTestFiles, diffTestFile)
525 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", f.properties.Vbmeta_partition_names[i]), diffTestFile)
526 }
Cole Faust92ccbe22024-10-03 14:38:37 -0700527 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000528}
mrziwang8f86c882024-10-03 12:34:33 -0700529
mrziwang8f86c882024-10-03 12:34:33 -0700530func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -0700531 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
532 if !fsTypeSupported {
533 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700534 }
535
mrziwang4b0ca972024-10-17 14:56:19 -0700536 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
mrziwang2a506cf2024-10-17 15:38:37 -0700537 deps := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).fsDeps[partitionType]
538 depProps := generateDepStruct(*deps)
mrziwang8f86c882024-10-03 12:34:33 -0700539
mrziwang4b0ca972024-10-17 14:56:19 -0700540 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -0700541 if err != nil {
Cole Faustae3e1d32024-11-05 13:22:50 -0800542 ctx.ModuleErrorf("%s", err.Error())
543 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700544 }
545
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000546 moduleType := "android_filesystem"
547 if partitionType == "system" {
548 moduleType = "android_system_image"
549 }
550
mrziwang8f86c882024-10-03 12:34:33 -0700551 file := &parser.File{
552 Defs: []parser.Definition{
553 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000554 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -0700555 Map: *result,
556 },
557 },
558 }
559 bytes, err := parser.Print(file)
560 if err != nil {
561 ctx.ModuleErrorf(err.Error())
562 }
563 return strings.TrimSpace(string(bytes))
564}