blob: bcf2361604f76d6f60a1adf1efe6aed6b9a5dc8e [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)
Spandan Das5e336422024-11-01 22:31:20 +0000237 } else if partitionType == "system_dlkm" {
238 // Do not set partition_type. build/soong/android/paths#modulePartition currently does not support dlkm
239 // partitions. Since `android_filesystem` uses a partition based filter, setting the partition here
240 // would result in missing in entries.
241 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
mrziwang4b0ca972024-10-17 14:56:19 -0700242 } else {
243 // Explicitly set the partition.
244 fsProps.Partition_type = proptools.StringPtr(partitionType)
245 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
246 }
247 module.HideFromMake()
Spandan Das168098c2024-10-28 19:44:34 +0000248 if partitionType == "vendor" {
Spandan Das4cd93b52024-11-05 23:27:03 +0000249 f.createVendorBuildProp(ctx)
Spandan Das168098c2024-10-28 19:44:34 +0000250 }
mrziwang4b0ca972024-10-17 14:56:19 -0700251 return true
252}
253
Spandan Das5e336422024-11-01 22:31:20 +0000254// createPrebuiltKernelModules creates `prebuilt_kernel_modules`. These modules will be added to deps of the
Spandan Das7b25a512024-11-06 20:41:26 +0000255// autogenerated *_dlkm filsystem modules. Each _dlkm partition should have a single prebuilt_kernel_modules dependency.
256// This ensures that the depmod artifacts (modules.* installed in /lib/modules/) are generated with a complete view.
257
258// The input `kernelModules` is a space separated list of .ko files in the workspace.
Spandan Das5e336422024-11-01 22:31:20 +0000259func (f *filesystemCreator) createPrebuiltKernelModules(ctx android.LoadHookContext, partitionType string, kernelModules []string) {
Spandan Das5e336422024-11-01 22:31:20 +0000260 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
Spandan Das7b25a512024-11-06 20:41:26 +0000261 name := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-kernel-modules", partitionType))
262 props := &struct {
263 Name *string
264 Srcs []string
265 }{
266 Name: proptools.StringPtr(name),
267 Srcs: kernelModules,
Spandan Das5e336422024-11-01 22:31:20 +0000268 }
Spandan Das7b25a512024-11-06 20:41:26 +0000269 kernelModule := ctx.CreateModuleInDirectory(
270 kernel.PrebuiltKernelModulesFactory,
271 ".", // create in root directory for now
272 props,
273 )
274 kernelModule.HideFromMake()
275 // Add to deps
276 (*fsGenState.fsDeps[partitionType])[name] = defaultDepCandidateProps(ctx.Config())
Spandan Das5e336422024-11-01 22:31:20 +0000277}
278
Spandan Das4cd93b52024-11-05 23:27:03 +0000279// Create a build_prop and android_info module. This will be used to create /vendor/build.prop
280func (f *filesystemCreator) createVendorBuildProp(ctx android.LoadHookContext) {
281 // Create a android_info for vendor
282 // The board info files might be in a directory outside the root soong namespace, so create
283 // the module in "."
284 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
285 androidInfoProps := &struct {
286 Name *string
287 Board_info_files []string
288 Bootloader_board_name *string
289 }{
290 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "android-info.prop")),
291 Board_info_files: partitionVars.BoardInfoFiles,
292 }
293 if len(androidInfoProps.Board_info_files) == 0 {
294 androidInfoProps.Bootloader_board_name = proptools.StringPtr(partitionVars.BootLoaderBoardName)
295 }
296 androidInfoProp := ctx.CreateModuleInDirectory(
297 android.AndroidInfoFactory,
298 ".",
299 androidInfoProps,
300 )
301 androidInfoProp.HideFromMake()
302 // Create a build prop for vendor
303 vendorBuildProps := &struct {
304 Name *string
305 Vendor *bool
306 Stem *string
307 Product_config *string
308 Android_info *string
309 }{
310 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "vendor-build.prop")),
311 Vendor: proptools.BoolPtr(true),
312 Stem: proptools.StringPtr("build.prop"),
313 Product_config: proptools.StringPtr(":product_config"),
314 Android_info: proptools.StringPtr(":" + androidInfoProp.Name()),
315 }
316 vendorBuildProp := ctx.CreateModule(
317 android.BuildPropFactory,
318 vendorBuildProps,
319 )
320 vendorBuildProp.HideFromMake()
321}
322
Spandan Das8fe68dc2024-10-29 18:20:11 +0000323// createLinkerConfigSourceFilegroups creates filegroup modules to generate linker.config.pb for the following partitions
324// 1. vendor: Using PRODUCT_VENDOR_LINKER_CONFIG_FRAGMENTS (space separated file list)
325// 1. product: Using PRODUCT_PRODUCT_LINKER_CONFIG_FRAGMENTS (space separated file list)
326// It creates a filegroup for each file in the fragment list
Spandan Das312cc412024-10-29 18:20:11 +0000327// The filegroup modules are then added to `linker_config_srcs` of the autogenerated vendor `android_filesystem`.
Spandan Das8fe68dc2024-10-29 18:20:11 +0000328func (f *filesystemCreator) createLinkerConfigSourceFilegroups(ctx android.LoadHookContext, partitionType string) []string {
Spandan Das312cc412024-10-29 18:20:11 +0000329 ret := []string{}
330 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Spandan Das8fe68dc2024-10-29 18:20:11 +0000331 var linkerConfigSrcs []string
332 if partitionType == "vendor" {
333 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.VendorLinkerConfigSrcs)
334 } else if partitionType == "product" {
335 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.ProductLinkerConfigSrcs)
336 } else {
337 ctx.ModuleErrorf("linker.config.pb is only supported for vendor and product partitions. For system partition, use `android_system_image`")
338 }
339
340 if len(linkerConfigSrcs) > 0 {
Spandan Das312cc412024-10-29 18:20:11 +0000341 // Create a filegroup, and add `:<filegroup_name>` to ret.
342 for index, linkerConfigSrc := range linkerConfigSrcs {
343 dir := filepath.Dir(linkerConfigSrc)
344 base := filepath.Base(linkerConfigSrc)
Spandan Das8fe68dc2024-10-29 18:20:11 +0000345 fgName := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-linker-config-src%s", partitionType, strconv.Itoa(index)))
Spandan Das312cc412024-10-29 18:20:11 +0000346 srcs := []string{base}
347 fgProps := &struct {
348 Name *string
349 Srcs proptools.Configurable[[]string]
350 }{
351 Name: proptools.StringPtr(fgName),
352 Srcs: proptools.NewSimpleConfigurable(srcs),
353 }
354 ctx.CreateModuleInDirectory(
355 android.FileGroupFactory,
356 dir,
357 fgProps,
358 )
359 ret = append(ret, ":"+fgName)
360 }
361 }
362 return ret
363}
364
mrziwang4b0ca972024-10-17 14:56:19 -0700365type filesystemBaseProperty struct {
366 Name *string
367 Compile_multilib *string
Cole Faust3552eb62024-11-06 18:07:26 -0800368 Visibility []string
mrziwang4b0ca972024-10-17 14:56:19 -0700369}
370
371func generateBaseProps(namePtr *string) *filesystemBaseProperty {
372 return &filesystemBaseProperty{
373 Name: namePtr,
374 Compile_multilib: proptools.StringPtr("both"),
Cole Faust3552eb62024-11-06 18:07:26 -0800375 // The vbmeta modules are currently in the root directory and depend on the partitions
376 Visibility: []string{"//.", "//build/soong:__subpackages__"},
mrziwang4b0ca972024-10-17 14:56:19 -0700377 }
378}
379
380func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700381 fsProps := &filesystem.FilesystemProperties{}
382
mrziwang4b0ca972024-10-17 14:56:19 -0700383 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
384 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
385
386 // BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE
387 fsType := specificPartitionVars.BoardFileSystemType
388 if fsType == "" {
389 fsType = "ext4" //default
390 }
391 fsProps.Type = proptools.StringPtr(fsType)
392 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
393 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
394 return nil, false
395 }
396
Cole Faust92ccbe22024-10-03 14:38:37 -0700397 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
398 // and sometimes don't build.
399 fsProps.Unchecked_module = proptools.BoolPtr(true)
400
Jihoon Kang98047cf2024-10-02 17:13:54 +0000401 // BOARD_AVB_ENABLE
402 fsProps.Use_avb = proptools.BoolPtr(partitionVars.BoardAvbEnable)
403 // BOARD_AVB_KEY_PATH
Cole Faust92ccbe22024-10-03 14:38:37 -0700404 fsProps.Avb_private_key = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000405 // BOARD_AVB_ALGORITHM
Cole Faust92ccbe22024-10-03 14:38:37 -0700406 fsProps.Avb_algorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000407 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust92ccbe22024-10-03 14:38:37 -0700408 if rollbackIndex, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64); err == nil {
Jihoon Kang98047cf2024-10-02 17:13:54 +0000409 fsProps.Rollback_index = proptools.Int64Ptr(rollbackIndex)
410 }
411
Cole Faust92ccbe22024-10-03 14:38:37 -0700412 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000413
Cole Faust92ccbe22024-10-03 14:38:37 -0700414 fsProps.Base_dir = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000415
Jihoon Kang0d545b82024-10-11 00:21:57 +0000416 fsProps.Is_auto_generated = proptools.BoolPtr(true)
417
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000418 partitionSpecificFsProps(fsProps, partitionType)
419
Jihoon Kang98047cf2024-10-02 17:13:54 +0000420 // system_image properties that are not set:
421 // - filesystemProperties.Avb_hash_algorithm
422 // - filesystemProperties.File_contexts
423 // - filesystemProperties.Dirs
424 // - filesystemProperties.Symlinks
425 // - filesystemProperties.Fake_timestamp
426 // - filesystemProperties.Uuid
427 // - filesystemProperties.Mount_point
428 // - filesystemProperties.Include_make_built_files
429 // - filesystemProperties.Build_logtags
Jihoon Kang98047cf2024-10-02 17:13:54 +0000430 // - systemImageProperties.Linker_config_src
mrziwang4b0ca972024-10-17 14:56:19 -0700431
432 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700433}
434
435func (f *filesystemCreator) createDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000436 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700437 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
438 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
439 if !ok {
440 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
441 }
442 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 +0000443 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700444
445 builder := android.NewRuleBuilder(pctx, ctx)
446 builder.Command().BuiltTool("file_list_diff").
447 Input(makeFileList).
448 Input(filesystemInfo.FileListFile).
Cole Faust56301572024-11-07 15:22:42 -0800449 Text(partitionModuleName)
Cole Faust92ccbe22024-10-03 14:38:37 -0700450 builder.Command().Text("touch").Output(diffTestResultFile)
451 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
452 return diffTestResultFile
453}
454
455func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
456 hasher := sha256.New()
457 hasher.Write([]byte(message))
458 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
459 file := android.PathForModuleOut(ctx, filename)
460 builder := android.NewRuleBuilder(pctx, ctx)
461 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
462 builder.Command().Text("exit 1 #").Output(file)
463 builder.Build("failing command "+filename, "failing command "+filename)
464 return file
465}
466
Cole Faust3552eb62024-11-06 18:07:26 -0800467func createVbmetaDiff(ctx android.ModuleContext, vbmetaModuleName string, vbmetaPartitionName string) android.Path {
468 vbmetaModule := ctx.GetDirectDepWithTag(vbmetaModuleName, generatedVbmetaPartitionDepTag)
469 outputFilesProvider, ok := android.OtherModuleProvider(ctx, vbmetaModule, android.OutputFilesProvider)
470 if !ok {
471 ctx.ModuleErrorf("Expected module %s to provide OutputFiles", vbmetaModule)
472 }
473 if len(outputFilesProvider.DefaultOutputFiles) != 1 {
474 ctx.ModuleErrorf("Expected 1 output file from module %s", vbmetaModule)
475 }
476 soongVbMetaFile := outputFilesProvider.DefaultOutputFiles[0]
477 makeVbmetaFile := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/%s.img", ctx.Config().DeviceName(), vbmetaPartitionName))
478
479 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", vbmetaModuleName))
480 builder := android.NewRuleBuilder(pctx, ctx)
481 builder.Command().Text("diff").
482 Input(soongVbMetaFile).
483 Input(makeVbmetaFile)
484 builder.Command().Text("touch").Output(diffTestResultFile)
485 builder.Build(vbmetaModuleName+" diff test", vbmetaModuleName+" diff test")
486 return diffTestResultFile
487}
488
Cole Faust92ccbe22024-10-03 14:38:37 -0700489type systemImageDepTagType struct {
490 blueprint.BaseDependencyTag
491}
492
493var generatedFilesystemDepTag systemImageDepTagType
Cole Faust3552eb62024-11-06 18:07:26 -0800494var generatedVbmetaPartitionDepTag systemImageDepTagType
Cole Faust92ccbe22024-10-03 14:38:37 -0700495
496func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
497 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000498 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700499 }
Cole Faust3552eb62024-11-06 18:07:26 -0800500 for _, vbmetaModule := range f.properties.Vbmeta_module_names {
501 ctx.AddDependency(ctx.Module(), generatedVbmetaPartitionDepTag, vbmetaModule)
502 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000503}
504
505func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700506 if ctx.ModuleDir() != "build/soong/fsgen" {
507 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
508 }
509 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000510
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000511 var content strings.Builder
512 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
513 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
514 content.WriteString(generateBpContent(ctx, partition))
515 content.WriteString("\n")
516 }
517 android.WriteFileRule(ctx, generatedBp, content.String())
518
mrziwang8f86c882024-10-03 12:34:33 -0700519 ctx.Phony("product_config_to_bp", generatedBp)
520
Cole Faust92ccbe22024-10-03 14:38:37 -0700521 var diffTestFiles []android.Path
522 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000523 diffTestFile := f.createDiffTest(ctx, partitionType)
524 diffTestFiles = append(diffTestFiles, diffTestFile)
525 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700526 }
527 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000528 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
529 diffTestFiles = append(diffTestFiles, diffTestFile)
530 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700531 }
Cole Faust3552eb62024-11-06 18:07:26 -0800532 for i, vbmetaModule := range f.properties.Vbmeta_module_names {
533 diffTestFile := createVbmetaDiff(ctx, vbmetaModule, f.properties.Vbmeta_partition_names[i])
534 diffTestFiles = append(diffTestFiles, diffTestFile)
535 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", f.properties.Vbmeta_partition_names[i]), diffTestFile)
536 }
Cole Faust92ccbe22024-10-03 14:38:37 -0700537 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000538}
mrziwang8f86c882024-10-03 12:34:33 -0700539
mrziwang8f86c882024-10-03 12:34:33 -0700540func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -0700541 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
542 if !fsTypeSupported {
543 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700544 }
545
mrziwang4b0ca972024-10-17 14:56:19 -0700546 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
mrziwang2a506cf2024-10-17 15:38:37 -0700547 deps := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).fsDeps[partitionType]
548 depProps := generateDepStruct(*deps)
mrziwang8f86c882024-10-03 12:34:33 -0700549
mrziwang4b0ca972024-10-17 14:56:19 -0700550 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -0700551 if err != nil {
Cole Faustae3e1d32024-11-05 13:22:50 -0800552 ctx.ModuleErrorf("%s", err.Error())
553 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700554 }
555
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000556 moduleType := "android_filesystem"
557 if partitionType == "system" {
558 moduleType = "android_system_image"
559 }
560
mrziwang8f86c882024-10-03 12:34:33 -0700561 file := &parser.File{
562 Defs: []parser.Definition{
563 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000564 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -0700565 Map: *result,
566 },
567 },
568 }
569 bytes, err := parser.Print(file)
570 if err != nil {
571 ctx.ModuleErrorf(err.Error())
572 }
573 return strings.TrimSpace(string(bytes))
574}