blob: 5f6475afa64f32d4a48f1f8d74d988d727ac54cd [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 Faust3552eb62024-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 Faust3552eb62024-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 Faust3552eb62024-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 Faust3552eb62024-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 Faust3552eb62024-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 Faust3552eb62024-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 Faust3552eb62024-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 Faust3552eb62024-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 Faust3552eb62024-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 Faust3552eb62024-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 }
mrziwang23ba8762024-11-07 16:21:53 -0800133 if android.InList("userdata", f.properties.Generated_partition_types) {
134 partitionProps.Userdata_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "userdata"))
135 }
Cole Faust3552eb62024-11-06 18:07:26 -0800136 partitionProps.Vbmeta_partitions = vbmetaPartitions
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000137
138 ctx.CreateModule(filesystem.AndroidDeviceFactory, baseProps, partitionProps)
Cole Faust92ccbe22024-10-03 14:38:37 -0700139}
140
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000141func partitionSpecificFsProps(fsProps *filesystem.FilesystemProperties, partitionType string) {
142 switch partitionType {
143 case "system":
144 fsProps.Build_logtags = proptools.BoolPtr(true)
145 // https://source.corp.google.com/h/googleplex-android/platform/build//639d79f5012a6542ab1f733b0697db45761ab0f3:core/packaging/flags.mk;l=21;drc=5ba8a8b77507f93aa48cc61c5ba3f31a4d0cbf37;bpv=1;bpt=0
146 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000147 // Identical to that of the generic_system_image
148 fsProps.Fsverity.Inputs = []string{
149 "etc/boot-image.prof",
150 "etc/dirty-image-objects",
151 "etc/preloaded-classes",
152 "etc/classpaths/*.pb",
153 "framework/*",
154 "framework/*/*", // framework/{arch}
155 "framework/oat/*/*", // framework/oat/{arch}
156 }
157 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
mrziwang9afc2982024-11-05 14:29:48 -0800158 // TODO(b/377734331): only generate the symlinks if the relevant partitions exist
159 fsProps.Symlinks = []filesystem.SymlinkDefinition{
160 filesystem.SymlinkDefinition{
161 Target: proptools.StringPtr("/product"),
162 Name: proptools.StringPtr("system/product"),
163 },
164 filesystem.SymlinkDefinition{
165 Target: proptools.StringPtr("/system_ext"),
166 Name: proptools.StringPtr("system/system_ext"),
167 },
168 filesystem.SymlinkDefinition{
169 Target: proptools.StringPtr("/vendor"),
170 Name: proptools.StringPtr("system/vendor"),
171 },
172 filesystem.SymlinkDefinition{
173 Target: proptools.StringPtr("/system_dlkm/lib/modules"),
174 Name: proptools.StringPtr("system/lib/modules"),
175 },
176 }
177 fsProps.Base_dir = proptools.StringPtr("system")
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000178 case "system_ext":
179 fsProps.Fsverity.Inputs = []string{
180 "framework/*",
181 "framework/*/*", // framework/{arch}
182 "framework/oat/*/*", // framework/oat/{arch}
183 }
184 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000185 case "product":
186 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
187 case "vendor":
188 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das69464c32024-10-25 20:08:06 +0000189 fsProps.Symlinks = []filesystem.SymlinkDefinition{
190 filesystem.SymlinkDefinition{
191 Target: proptools.StringPtr("/odm"),
192 Name: proptools.StringPtr("vendor/odm"),
193 },
194 filesystem.SymlinkDefinition{
195 Target: proptools.StringPtr("/vendor_dlkm/lib/modules"),
196 Name: proptools.StringPtr("vendor/lib/modules"),
197 },
198 }
199 fsProps.Base_dir = proptools.StringPtr("vendor")
Spandan Dasc5717162024-11-01 18:33:57 +0000200 case "odm":
201 fsProps.Symlinks = []filesystem.SymlinkDefinition{
202 filesystem.SymlinkDefinition{
203 Target: proptools.StringPtr("/odm_dlkm/lib/modules"),
204 Name: proptools.StringPtr("odm/lib/modules"),
205 },
206 }
207 fsProps.Base_dir = proptools.StringPtr("odm")
mrziwang23ba8762024-11-07 16:21:53 -0800208 case "userdata":
209 fsProps.Base_dir = proptools.StringPtr("data")
Spandan Dasc5717162024-11-01 18:33:57 +0000210
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000211 }
212}
Spandan Dascbe641a2024-10-14 21:07:34 +0000213
Cole Faust92ccbe22024-10-03 14:38:37 -0700214// Creates a soong module to build the given partition. Returns false if we can't support building
215// it.
216func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700217 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
218
219 fsProps, supported := generateFsProps(ctx, partitionType)
220 if !supported {
221 return false
mrziwanga077b942024-10-16 16:00:06 -0700222 }
mrziwanga077b942024-10-16 16:00:06 -0700223
Spandan Das8fe68dc2024-10-29 18:20:11 +0000224 if partitionType == "vendor" || partitionType == "product" {
Spandan Das173256b2024-10-31 19:59:30 +0000225 fsProps.Linkerconfig.Gen_linker_config = proptools.BoolPtr(true)
226 fsProps.Linkerconfig.Linker_config_srcs = f.createLinkerConfigSourceFilegroups(ctx, partitionType)
Spandan Das312cc412024-10-29 18:20:11 +0000227 }
228
Spandan Das5e336422024-11-01 22:31:20 +0000229 if partitionType == "system_dlkm" {
230 kernelModules := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules
231 f.createPrebuiltKernelModules(ctx, partitionType, kernelModules)
232 }
233
mrziwang4b0ca972024-10-17 14:56:19 -0700234 var module android.Module
235 if partitionType == "system" {
236 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
237 } else {
238 // Explicitly set the partition.
239 fsProps.Partition_type = proptools.StringPtr(partitionType)
240 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
241 }
242 module.HideFromMake()
Spandan Das168098c2024-10-28 19:44:34 +0000243 if partitionType == "vendor" {
Spandan Das4cd93b52024-11-05 23:27:03 +0000244 f.createVendorBuildProp(ctx)
Spandan Das168098c2024-10-28 19:44:34 +0000245 }
mrziwang4b0ca972024-10-17 14:56:19 -0700246 return true
247}
248
Spandan Das5e336422024-11-01 22:31:20 +0000249// createPrebuiltKernelModules creates `prebuilt_kernel_modules`. These modules will be added to deps of the
Spandan Das7b25a512024-11-06 20:41:26 +0000250// autogenerated *_dlkm filsystem modules. Each _dlkm partition should have a single prebuilt_kernel_modules dependency.
251// This ensures that the depmod artifacts (modules.* installed in /lib/modules/) are generated with a complete view.
252
253// The input `kernelModules` is a space separated list of .ko files in the workspace.
Spandan Das5e336422024-11-01 22:31:20 +0000254func (f *filesystemCreator) createPrebuiltKernelModules(ctx android.LoadHookContext, partitionType string, kernelModules []string) {
Spandan Das5e336422024-11-01 22:31:20 +0000255 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
Spandan Das7b25a512024-11-06 20:41:26 +0000256 name := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-kernel-modules", partitionType))
257 props := &struct {
Spandan Das912d26b2024-11-06 19:35:17 +0000258 Name *string
259 Srcs []string
260 System_dlkm_specific *bool
261 Vendor_dlkm_specific *bool // TODO (b/377562851)
262 Odm_dlkm_specific *bool // TODO (b/377563262)
Spandan Das7b25a512024-11-06 20:41:26 +0000263 }{
264 Name: proptools.StringPtr(name),
265 Srcs: kernelModules,
Spandan Das5e336422024-11-01 22:31:20 +0000266 }
Spandan Das912d26b2024-11-06 19:35:17 +0000267 if partitionType == "system_dlkm" {
268 props.System_dlkm_specific = proptools.BoolPtr(true)
269 }
Spandan Das7b25a512024-11-06 20:41:26 +0000270 kernelModule := ctx.CreateModuleInDirectory(
271 kernel.PrebuiltKernelModulesFactory,
272 ".", // create in root directory for now
273 props,
274 )
275 kernelModule.HideFromMake()
276 // Add to deps
277 (*fsGenState.fsDeps[partitionType])[name] = defaultDepCandidateProps(ctx.Config())
Spandan Das5e336422024-11-01 22:31:20 +0000278}
279
Spandan Das4cd93b52024-11-05 23:27:03 +0000280// Create a build_prop and android_info module. This will be used to create /vendor/build.prop
281func (f *filesystemCreator) createVendorBuildProp(ctx android.LoadHookContext) {
282 // Create a android_info for vendor
283 // The board info files might be in a directory outside the root soong namespace, so create
284 // the module in "."
285 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
286 androidInfoProps := &struct {
287 Name *string
288 Board_info_files []string
289 Bootloader_board_name *string
290 }{
291 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "android-info.prop")),
292 Board_info_files: partitionVars.BoardInfoFiles,
293 }
294 if len(androidInfoProps.Board_info_files) == 0 {
295 androidInfoProps.Bootloader_board_name = proptools.StringPtr(partitionVars.BootLoaderBoardName)
296 }
297 androidInfoProp := ctx.CreateModuleInDirectory(
298 android.AndroidInfoFactory,
299 ".",
300 androidInfoProps,
301 )
302 androidInfoProp.HideFromMake()
303 // Create a build prop for vendor
304 vendorBuildProps := &struct {
305 Name *string
306 Vendor *bool
307 Stem *string
308 Product_config *string
309 Android_info *string
310 }{
311 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "vendor-build.prop")),
312 Vendor: proptools.BoolPtr(true),
313 Stem: proptools.StringPtr("build.prop"),
314 Product_config: proptools.StringPtr(":product_config"),
315 Android_info: proptools.StringPtr(":" + androidInfoProp.Name()),
316 }
317 vendorBuildProp := ctx.CreateModule(
318 android.BuildPropFactory,
319 vendorBuildProps,
320 )
321 vendorBuildProp.HideFromMake()
322}
323
Spandan Das8fe68dc2024-10-29 18:20:11 +0000324// createLinkerConfigSourceFilegroups creates filegroup modules to generate linker.config.pb for the following partitions
325// 1. vendor: Using PRODUCT_VENDOR_LINKER_CONFIG_FRAGMENTS (space separated file list)
326// 1. product: Using PRODUCT_PRODUCT_LINKER_CONFIG_FRAGMENTS (space separated file list)
327// It creates a filegroup for each file in the fragment list
Spandan Das312cc412024-10-29 18:20:11 +0000328// The filegroup modules are then added to `linker_config_srcs` of the autogenerated vendor `android_filesystem`.
Spandan Das8fe68dc2024-10-29 18:20:11 +0000329func (f *filesystemCreator) createLinkerConfigSourceFilegroups(ctx android.LoadHookContext, partitionType string) []string {
Spandan Das312cc412024-10-29 18:20:11 +0000330 ret := []string{}
331 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Spandan Das8fe68dc2024-10-29 18:20:11 +0000332 var linkerConfigSrcs []string
333 if partitionType == "vendor" {
334 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.VendorLinkerConfigSrcs)
335 } else if partitionType == "product" {
336 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.ProductLinkerConfigSrcs)
337 } else {
338 ctx.ModuleErrorf("linker.config.pb is only supported for vendor and product partitions. For system partition, use `android_system_image`")
339 }
340
341 if len(linkerConfigSrcs) > 0 {
Spandan Das312cc412024-10-29 18:20:11 +0000342 // Create a filegroup, and add `:<filegroup_name>` to ret.
343 for index, linkerConfigSrc := range linkerConfigSrcs {
344 dir := filepath.Dir(linkerConfigSrc)
345 base := filepath.Base(linkerConfigSrc)
Spandan Das8fe68dc2024-10-29 18:20:11 +0000346 fgName := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-linker-config-src%s", partitionType, strconv.Itoa(index)))
Spandan Das312cc412024-10-29 18:20:11 +0000347 srcs := []string{base}
348 fgProps := &struct {
349 Name *string
350 Srcs proptools.Configurable[[]string]
351 }{
352 Name: proptools.StringPtr(fgName),
353 Srcs: proptools.NewSimpleConfigurable(srcs),
354 }
355 ctx.CreateModuleInDirectory(
356 android.FileGroupFactory,
357 dir,
358 fgProps,
359 )
360 ret = append(ret, ":"+fgName)
361 }
362 }
363 return ret
364}
365
mrziwang4b0ca972024-10-17 14:56:19 -0700366type filesystemBaseProperty struct {
367 Name *string
368 Compile_multilib *string
Cole Faust3552eb62024-11-06 18:07:26 -0800369 Visibility []string
mrziwang4b0ca972024-10-17 14:56:19 -0700370}
371
372func generateBaseProps(namePtr *string) *filesystemBaseProperty {
373 return &filesystemBaseProperty{
374 Name: namePtr,
375 Compile_multilib: proptools.StringPtr("both"),
Cole Faust3552eb62024-11-06 18:07:26 -0800376 // The vbmeta modules are currently in the root directory and depend on the partitions
377 Visibility: []string{"//.", "//build/soong:__subpackages__"},
mrziwang4b0ca972024-10-17 14:56:19 -0700378 }
379}
380
381func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700382 fsProps := &filesystem.FilesystemProperties{}
383
mrziwang4b0ca972024-10-17 14:56:19 -0700384 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
385 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
386
387 // BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE
388 fsType := specificPartitionVars.BoardFileSystemType
389 if fsType == "" {
390 fsType = "ext4" //default
391 }
392 fsProps.Type = proptools.StringPtr(fsType)
393 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
394 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
395 return nil, false
396 }
397
Cole Faust92ccbe22024-10-03 14:38:37 -0700398 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
399 // and sometimes don't build.
400 fsProps.Unchecked_module = proptools.BoolPtr(true)
401
Jihoon Kang98047cf2024-10-02 17:13:54 +0000402 // BOARD_AVB_ENABLE
403 fsProps.Use_avb = proptools.BoolPtr(partitionVars.BoardAvbEnable)
404 // BOARD_AVB_KEY_PATH
Cole Faust92ccbe22024-10-03 14:38:37 -0700405 fsProps.Avb_private_key = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000406 // BOARD_AVB_ALGORITHM
Cole Faust92ccbe22024-10-03 14:38:37 -0700407 fsProps.Avb_algorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000408 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust92ccbe22024-10-03 14:38:37 -0700409 if rollbackIndex, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64); err == nil {
Jihoon Kang98047cf2024-10-02 17:13:54 +0000410 fsProps.Rollback_index = proptools.Int64Ptr(rollbackIndex)
411 }
412
Cole Faust92ccbe22024-10-03 14:38:37 -0700413 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000414
Cole Faust92ccbe22024-10-03 14:38:37 -0700415 fsProps.Base_dir = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000416
Jihoon Kang0d545b82024-10-11 00:21:57 +0000417 fsProps.Is_auto_generated = proptools.BoolPtr(true)
418
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000419 partitionSpecificFsProps(fsProps, partitionType)
420
Jihoon Kang98047cf2024-10-02 17:13:54 +0000421 // system_image properties that are not set:
422 // - filesystemProperties.Avb_hash_algorithm
423 // - filesystemProperties.File_contexts
424 // - filesystemProperties.Dirs
425 // - filesystemProperties.Symlinks
426 // - filesystemProperties.Fake_timestamp
427 // - filesystemProperties.Uuid
428 // - filesystemProperties.Mount_point
429 // - filesystemProperties.Include_make_built_files
430 // - filesystemProperties.Build_logtags
Jihoon Kang98047cf2024-10-02 17:13:54 +0000431 // - systemImageProperties.Linker_config_src
mrziwang4b0ca972024-10-17 14:56:19 -0700432
433 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700434}
435
436func (f *filesystemCreator) createDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000437 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700438 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
439 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
440 if !ok {
441 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
442 }
443 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 +0000444 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700445
446 builder := android.NewRuleBuilder(pctx, ctx)
447 builder.Command().BuiltTool("file_list_diff").
448 Input(makeFileList).
449 Input(filesystemInfo.FileListFile).
Cole Faust56301572024-11-07 15:22:42 -0800450 Text(partitionModuleName)
Cole Faust92ccbe22024-10-03 14:38:37 -0700451 builder.Command().Text("touch").Output(diffTestResultFile)
452 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
453 return diffTestResultFile
454}
455
456func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
457 hasher := sha256.New()
458 hasher.Write([]byte(message))
459 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
460 file := android.PathForModuleOut(ctx, filename)
461 builder := android.NewRuleBuilder(pctx, ctx)
462 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
463 builder.Command().Text("exit 1 #").Output(file)
464 builder.Build("failing command "+filename, "failing command "+filename)
465 return file
466}
467
Cole Faust3552eb62024-11-06 18:07:26 -0800468func createVbmetaDiff(ctx android.ModuleContext, vbmetaModuleName string, vbmetaPartitionName string) android.Path {
469 vbmetaModule := ctx.GetDirectDepWithTag(vbmetaModuleName, generatedVbmetaPartitionDepTag)
470 outputFilesProvider, ok := android.OtherModuleProvider(ctx, vbmetaModule, android.OutputFilesProvider)
471 if !ok {
472 ctx.ModuleErrorf("Expected module %s to provide OutputFiles", vbmetaModule)
473 }
474 if len(outputFilesProvider.DefaultOutputFiles) != 1 {
475 ctx.ModuleErrorf("Expected 1 output file from module %s", vbmetaModule)
476 }
477 soongVbMetaFile := outputFilesProvider.DefaultOutputFiles[0]
478 makeVbmetaFile := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/%s.img", ctx.Config().DeviceName(), vbmetaPartitionName))
479
480 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", vbmetaModuleName))
481 builder := android.NewRuleBuilder(pctx, ctx)
482 builder.Command().Text("diff").
483 Input(soongVbMetaFile).
484 Input(makeVbmetaFile)
485 builder.Command().Text("touch").Output(diffTestResultFile)
486 builder.Build(vbmetaModuleName+" diff test", vbmetaModuleName+" diff test")
487 return diffTestResultFile
488}
489
Cole Faust92ccbe22024-10-03 14:38:37 -0700490type systemImageDepTagType struct {
491 blueprint.BaseDependencyTag
492}
493
494var generatedFilesystemDepTag systemImageDepTagType
Cole Faust3552eb62024-11-06 18:07:26 -0800495var generatedVbmetaPartitionDepTag systemImageDepTagType
Cole Faust92ccbe22024-10-03 14:38:37 -0700496
497func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
498 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000499 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700500 }
Cole Faust3552eb62024-11-06 18:07:26 -0800501 for _, vbmetaModule := range f.properties.Vbmeta_module_names {
502 ctx.AddDependency(ctx.Module(), generatedVbmetaPartitionDepTag, vbmetaModule)
503 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000504}
505
506func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700507 if ctx.ModuleDir() != "build/soong/fsgen" {
508 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
509 }
510 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000511
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000512 var content strings.Builder
513 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
514 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
515 content.WriteString(generateBpContent(ctx, partition))
516 content.WriteString("\n")
517 }
518 android.WriteFileRule(ctx, generatedBp, content.String())
519
mrziwang8f86c882024-10-03 12:34:33 -0700520 ctx.Phony("product_config_to_bp", generatedBp)
521
Cole Faust92ccbe22024-10-03 14:38:37 -0700522 var diffTestFiles []android.Path
523 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000524 diffTestFile := f.createDiffTest(ctx, partitionType)
525 diffTestFiles = append(diffTestFiles, diffTestFile)
526 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700527 }
528 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000529 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
530 diffTestFiles = append(diffTestFiles, diffTestFile)
531 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700532 }
Cole Faust3552eb62024-11-06 18:07:26 -0800533 for i, vbmetaModule := range f.properties.Vbmeta_module_names {
534 diffTestFile := createVbmetaDiff(ctx, vbmetaModule, f.properties.Vbmeta_partition_names[i])
535 diffTestFiles = append(diffTestFiles, diffTestFile)
536 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", f.properties.Vbmeta_partition_names[i]), diffTestFile)
537 }
Cole Faust92ccbe22024-10-03 14:38:37 -0700538 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000539}
mrziwang8f86c882024-10-03 12:34:33 -0700540
mrziwang8f86c882024-10-03 12:34:33 -0700541func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -0700542 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
543 if !fsTypeSupported {
544 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700545 }
546
mrziwang4b0ca972024-10-17 14:56:19 -0700547 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
mrziwang2a506cf2024-10-17 15:38:37 -0700548 deps := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).fsDeps[partitionType]
549 depProps := generateDepStruct(*deps)
mrziwang8f86c882024-10-03 12:34:33 -0700550
mrziwang4b0ca972024-10-17 14:56:19 -0700551 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -0700552 if err != nil {
Cole Faustae3e1d32024-11-05 13:22:50 -0800553 ctx.ModuleErrorf("%s", err.Error())
554 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700555 }
556
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000557 moduleType := "android_filesystem"
558 if partitionType == "system" {
559 moduleType = "android_system_image"
560 }
561
mrziwang8f86c882024-10-03 12:34:33 -0700562 file := &parser.File{
563 Defs: []parser.Definition{
564 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000565 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -0700566 Map: *result,
567 },
568 },
569 }
570 bytes, err := parser.Print(file)
571 if err != nil {
572 ctx.ModuleErrorf(err.Error())
573 }
574 return strings.TrimSpace(string(bytes))
575}