blob: 9cada0b36297d2db5e59a96bbe270f33f2203a52 [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
Spandan Das5b493cd2024-11-07 20:55:56 +0000214var (
215 dlkmPartitions = []string{
216 "system_dlkm",
217 "vendor_dlkm",
218 "odm_dlkm",
219 }
220)
221
Cole Faust92ccbe22024-10-03 14:38:37 -0700222// Creates a soong module to build the given partition. Returns false if we can't support building
223// it.
224func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700225 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
226
227 fsProps, supported := generateFsProps(ctx, partitionType)
228 if !supported {
229 return false
mrziwanga077b942024-10-16 16:00:06 -0700230 }
mrziwanga077b942024-10-16 16:00:06 -0700231
Spandan Das8fe68dc2024-10-29 18:20:11 +0000232 if partitionType == "vendor" || partitionType == "product" {
Spandan Das173256b2024-10-31 19:59:30 +0000233 fsProps.Linkerconfig.Gen_linker_config = proptools.BoolPtr(true)
234 fsProps.Linkerconfig.Linker_config_srcs = f.createLinkerConfigSourceFilegroups(ctx, partitionType)
Spandan Das312cc412024-10-29 18:20:11 +0000235 }
236
Spandan Das5b493cd2024-11-07 20:55:56 +0000237 if android.InList(partitionType, dlkmPartitions) {
238 f.createPrebuiltKernelModules(ctx, partitionType)
Spandan Das5e336422024-11-01 22:31:20 +0000239 }
240
mrziwang4b0ca972024-10-17 14:56:19 -0700241 var module android.Module
242 if partitionType == "system" {
243 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
244 } else {
245 // Explicitly set the partition.
246 fsProps.Partition_type = proptools.StringPtr(partitionType)
247 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
248 }
249 module.HideFromMake()
Spandan Das168098c2024-10-28 19:44:34 +0000250 if partitionType == "vendor" {
Spandan Das4cd93b52024-11-05 23:27:03 +0000251 f.createVendorBuildProp(ctx)
Spandan Das168098c2024-10-28 19:44:34 +0000252 }
mrziwang4b0ca972024-10-17 14:56:19 -0700253 return true
254}
255
Spandan Das5e336422024-11-01 22:31:20 +0000256// createPrebuiltKernelModules creates `prebuilt_kernel_modules`. These modules will be added to deps of the
Spandan Das7b25a512024-11-06 20:41:26 +0000257// autogenerated *_dlkm filsystem modules. Each _dlkm partition should have a single prebuilt_kernel_modules dependency.
258// This ensures that the depmod artifacts (modules.* installed in /lib/modules/) are generated with a complete view.
Spandan Das5b493cd2024-11-07 20:55:56 +0000259func (f *filesystemCreator) createPrebuiltKernelModules(ctx android.LoadHookContext, partitionType 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 {
Spandan Das912d26b2024-11-06 19:35:17 +0000263 Name *string
264 Srcs []string
Spandan Das5b493cd2024-11-07 20:55:56 +0000265 System_deps []string
Spandan Das912d26b2024-11-06 19:35:17 +0000266 System_dlkm_specific *bool
Spandan Das5b493cd2024-11-07 20:55:56 +0000267 Vendor_dlkm_specific *bool
268 Odm_dlkm_specific *bool
269 Load_by_default *bool
Spandan Das7b25a512024-11-06 20:41:26 +0000270 }{
271 Name: proptools.StringPtr(name),
Spandan Das5e336422024-11-01 22:31:20 +0000272 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000273 switch partitionType {
274 case "system_dlkm":
275 props.Srcs = ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules
Spandan Das912d26b2024-11-06 19:35:17 +0000276 props.System_dlkm_specific = proptools.BoolPtr(true)
Spandan Das5b493cd2024-11-07 20:55:56 +0000277 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelLoadModules) == 0 {
278 // Create empty modules.load file for system
279 // https://source.corp.google.com/h/googleplex-android/platform/build/+/ef55daac9954896161b26db4f3ef1781b5a5694c:core/Makefile;l=695-700;drc=549fe2a5162548bd8b47867d35f907eb22332023;bpv=1;bpt=0
280 props.Load_by_default = proptools.BoolPtr(false)
281 }
282 case "vendor_dlkm":
283 props.Srcs = ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorKernelModules
284 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules) > 0 {
285 props.System_deps = []string{":" + generatedModuleName(ctx.Config(), "system_dlkm-kernel-modules") + "{.modules}"}
286 }
287 props.Vendor_dlkm_specific = proptools.BoolPtr(true)
288 case "odm_dlkm":
289 props.Srcs = ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.OdmKernelModules
290 props.Odm_dlkm_specific = proptools.BoolPtr(true)
291 default:
292 ctx.ModuleErrorf("DLKM is not supported for %s\n", partitionType)
Spandan Das912d26b2024-11-06 19:35:17 +0000293 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000294
295 if len(props.Srcs) == 0 {
296 return // do not generate `prebuilt_kernel_modules` if there are no sources
297 }
298
Spandan Das7b25a512024-11-06 20:41:26 +0000299 kernelModule := ctx.CreateModuleInDirectory(
300 kernel.PrebuiltKernelModulesFactory,
301 ".", // create in root directory for now
302 props,
303 )
304 kernelModule.HideFromMake()
305 // Add to deps
306 (*fsGenState.fsDeps[partitionType])[name] = defaultDepCandidateProps(ctx.Config())
Spandan Das5e336422024-11-01 22:31:20 +0000307}
308
Spandan Das4cd93b52024-11-05 23:27:03 +0000309// Create a build_prop and android_info module. This will be used to create /vendor/build.prop
310func (f *filesystemCreator) createVendorBuildProp(ctx android.LoadHookContext) {
311 // Create a android_info for vendor
312 // The board info files might be in a directory outside the root soong namespace, so create
313 // the module in "."
314 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
315 androidInfoProps := &struct {
316 Name *string
317 Board_info_files []string
318 Bootloader_board_name *string
319 }{
320 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "android-info.prop")),
321 Board_info_files: partitionVars.BoardInfoFiles,
322 }
323 if len(androidInfoProps.Board_info_files) == 0 {
324 androidInfoProps.Bootloader_board_name = proptools.StringPtr(partitionVars.BootLoaderBoardName)
325 }
326 androidInfoProp := ctx.CreateModuleInDirectory(
327 android.AndroidInfoFactory,
328 ".",
329 androidInfoProps,
330 )
331 androidInfoProp.HideFromMake()
332 // Create a build prop for vendor
333 vendorBuildProps := &struct {
334 Name *string
335 Vendor *bool
336 Stem *string
337 Product_config *string
338 Android_info *string
339 }{
340 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "vendor-build.prop")),
341 Vendor: proptools.BoolPtr(true),
342 Stem: proptools.StringPtr("build.prop"),
343 Product_config: proptools.StringPtr(":product_config"),
344 Android_info: proptools.StringPtr(":" + androidInfoProp.Name()),
345 }
346 vendorBuildProp := ctx.CreateModule(
347 android.BuildPropFactory,
348 vendorBuildProps,
349 )
350 vendorBuildProp.HideFromMake()
351}
352
Spandan Das8fe68dc2024-10-29 18:20:11 +0000353// createLinkerConfigSourceFilegroups creates filegroup modules to generate linker.config.pb for the following partitions
354// 1. vendor: Using PRODUCT_VENDOR_LINKER_CONFIG_FRAGMENTS (space separated file list)
355// 1. product: Using PRODUCT_PRODUCT_LINKER_CONFIG_FRAGMENTS (space separated file list)
356// It creates a filegroup for each file in the fragment list
Spandan Das312cc412024-10-29 18:20:11 +0000357// The filegroup modules are then added to `linker_config_srcs` of the autogenerated vendor `android_filesystem`.
Spandan Das8fe68dc2024-10-29 18:20:11 +0000358func (f *filesystemCreator) createLinkerConfigSourceFilegroups(ctx android.LoadHookContext, partitionType string) []string {
Spandan Das312cc412024-10-29 18:20:11 +0000359 ret := []string{}
360 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Spandan Das8fe68dc2024-10-29 18:20:11 +0000361 var linkerConfigSrcs []string
362 if partitionType == "vendor" {
363 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.VendorLinkerConfigSrcs)
364 } else if partitionType == "product" {
365 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.ProductLinkerConfigSrcs)
366 } else {
367 ctx.ModuleErrorf("linker.config.pb is only supported for vendor and product partitions. For system partition, use `android_system_image`")
368 }
369
370 if len(linkerConfigSrcs) > 0 {
Spandan Das312cc412024-10-29 18:20:11 +0000371 // Create a filegroup, and add `:<filegroup_name>` to ret.
372 for index, linkerConfigSrc := range linkerConfigSrcs {
373 dir := filepath.Dir(linkerConfigSrc)
374 base := filepath.Base(linkerConfigSrc)
Spandan Das8fe68dc2024-10-29 18:20:11 +0000375 fgName := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-linker-config-src%s", partitionType, strconv.Itoa(index)))
Spandan Das312cc412024-10-29 18:20:11 +0000376 srcs := []string{base}
377 fgProps := &struct {
378 Name *string
379 Srcs proptools.Configurable[[]string]
380 }{
381 Name: proptools.StringPtr(fgName),
382 Srcs: proptools.NewSimpleConfigurable(srcs),
383 }
384 ctx.CreateModuleInDirectory(
385 android.FileGroupFactory,
386 dir,
387 fgProps,
388 )
389 ret = append(ret, ":"+fgName)
390 }
391 }
392 return ret
393}
394
mrziwang4b0ca972024-10-17 14:56:19 -0700395type filesystemBaseProperty struct {
396 Name *string
397 Compile_multilib *string
Cole Faust3552eb62024-11-06 18:07:26 -0800398 Visibility []string
mrziwang4b0ca972024-10-17 14:56:19 -0700399}
400
401func generateBaseProps(namePtr *string) *filesystemBaseProperty {
402 return &filesystemBaseProperty{
403 Name: namePtr,
404 Compile_multilib: proptools.StringPtr("both"),
Cole Faust3552eb62024-11-06 18:07:26 -0800405 // The vbmeta modules are currently in the root directory and depend on the partitions
406 Visibility: []string{"//.", "//build/soong:__subpackages__"},
mrziwang4b0ca972024-10-17 14:56:19 -0700407 }
408}
409
410func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700411 fsProps := &filesystem.FilesystemProperties{}
412
mrziwang4b0ca972024-10-17 14:56:19 -0700413 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
414 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
415
416 // BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE
417 fsType := specificPartitionVars.BoardFileSystemType
418 if fsType == "" {
419 fsType = "ext4" //default
420 }
421 fsProps.Type = proptools.StringPtr(fsType)
422 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
423 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
424 return nil, false
425 }
426
Cole Faust92ccbe22024-10-03 14:38:37 -0700427 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
428 // and sometimes don't build.
429 fsProps.Unchecked_module = proptools.BoolPtr(true)
430
Jihoon Kang98047cf2024-10-02 17:13:54 +0000431 // BOARD_AVB_ENABLE
432 fsProps.Use_avb = proptools.BoolPtr(partitionVars.BoardAvbEnable)
433 // BOARD_AVB_KEY_PATH
Cole Faust92ccbe22024-10-03 14:38:37 -0700434 fsProps.Avb_private_key = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000435 // BOARD_AVB_ALGORITHM
Cole Faust92ccbe22024-10-03 14:38:37 -0700436 fsProps.Avb_algorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000437 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust92ccbe22024-10-03 14:38:37 -0700438 if rollbackIndex, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64); err == nil {
Jihoon Kang98047cf2024-10-02 17:13:54 +0000439 fsProps.Rollback_index = proptools.Int64Ptr(rollbackIndex)
440 }
441
Cole Faust92ccbe22024-10-03 14:38:37 -0700442 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000443
Cole Faust92ccbe22024-10-03 14:38:37 -0700444 fsProps.Base_dir = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000445
Jihoon Kang0d545b82024-10-11 00:21:57 +0000446 fsProps.Is_auto_generated = proptools.BoolPtr(true)
447
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000448 partitionSpecificFsProps(fsProps, partitionType)
449
Jihoon Kang98047cf2024-10-02 17:13:54 +0000450 // system_image properties that are not set:
451 // - filesystemProperties.Avb_hash_algorithm
452 // - filesystemProperties.File_contexts
453 // - filesystemProperties.Dirs
454 // - filesystemProperties.Symlinks
455 // - filesystemProperties.Fake_timestamp
456 // - filesystemProperties.Uuid
457 // - filesystemProperties.Mount_point
458 // - filesystemProperties.Include_make_built_files
459 // - filesystemProperties.Build_logtags
Jihoon Kang98047cf2024-10-02 17:13:54 +0000460 // - systemImageProperties.Linker_config_src
mrziwang4b0ca972024-10-17 14:56:19 -0700461
462 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700463}
464
465func (f *filesystemCreator) createDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000466 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700467 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
468 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
469 if !ok {
470 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
471 }
472 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 +0000473 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700474
475 builder := android.NewRuleBuilder(pctx, ctx)
476 builder.Command().BuiltTool("file_list_diff").
477 Input(makeFileList).
478 Input(filesystemInfo.FileListFile).
Cole Faust56301572024-11-07 15:22:42 -0800479 Text(partitionModuleName)
Cole Faust92ccbe22024-10-03 14:38:37 -0700480 builder.Command().Text("touch").Output(diffTestResultFile)
481 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
482 return diffTestResultFile
483}
484
485func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
486 hasher := sha256.New()
487 hasher.Write([]byte(message))
488 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
489 file := android.PathForModuleOut(ctx, filename)
490 builder := android.NewRuleBuilder(pctx, ctx)
491 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
492 builder.Command().Text("exit 1 #").Output(file)
493 builder.Build("failing command "+filename, "failing command "+filename)
494 return file
495}
496
Cole Faust3552eb62024-11-06 18:07:26 -0800497func createVbmetaDiff(ctx android.ModuleContext, vbmetaModuleName string, vbmetaPartitionName string) android.Path {
498 vbmetaModule := ctx.GetDirectDepWithTag(vbmetaModuleName, generatedVbmetaPartitionDepTag)
499 outputFilesProvider, ok := android.OtherModuleProvider(ctx, vbmetaModule, android.OutputFilesProvider)
500 if !ok {
501 ctx.ModuleErrorf("Expected module %s to provide OutputFiles", vbmetaModule)
502 }
503 if len(outputFilesProvider.DefaultOutputFiles) != 1 {
504 ctx.ModuleErrorf("Expected 1 output file from module %s", vbmetaModule)
505 }
506 soongVbMetaFile := outputFilesProvider.DefaultOutputFiles[0]
507 makeVbmetaFile := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/%s.img", ctx.Config().DeviceName(), vbmetaPartitionName))
508
509 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", vbmetaModuleName))
510 builder := android.NewRuleBuilder(pctx, ctx)
511 builder.Command().Text("diff").
512 Input(soongVbMetaFile).
513 Input(makeVbmetaFile)
514 builder.Command().Text("touch").Output(diffTestResultFile)
515 builder.Build(vbmetaModuleName+" diff test", vbmetaModuleName+" diff test")
516 return diffTestResultFile
517}
518
Cole Faust92ccbe22024-10-03 14:38:37 -0700519type systemImageDepTagType struct {
520 blueprint.BaseDependencyTag
521}
522
523var generatedFilesystemDepTag systemImageDepTagType
Cole Faust3552eb62024-11-06 18:07:26 -0800524var generatedVbmetaPartitionDepTag systemImageDepTagType
Cole Faust92ccbe22024-10-03 14:38:37 -0700525
526func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
527 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000528 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700529 }
Cole Faust3552eb62024-11-06 18:07:26 -0800530 for _, vbmetaModule := range f.properties.Vbmeta_module_names {
531 ctx.AddDependency(ctx.Module(), generatedVbmetaPartitionDepTag, vbmetaModule)
532 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000533}
534
535func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700536 if ctx.ModuleDir() != "build/soong/fsgen" {
537 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
538 }
539 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000540
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000541 var content strings.Builder
542 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
543 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
544 content.WriteString(generateBpContent(ctx, partition))
545 content.WriteString("\n")
546 }
547 android.WriteFileRule(ctx, generatedBp, content.String())
548
mrziwang8f86c882024-10-03 12:34:33 -0700549 ctx.Phony("product_config_to_bp", generatedBp)
550
Cole Faust92ccbe22024-10-03 14:38:37 -0700551 var diffTestFiles []android.Path
552 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000553 diffTestFile := f.createDiffTest(ctx, partitionType)
554 diffTestFiles = append(diffTestFiles, diffTestFile)
555 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700556 }
557 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000558 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
559 diffTestFiles = append(diffTestFiles, diffTestFile)
560 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700561 }
Cole Faust3552eb62024-11-06 18:07:26 -0800562 for i, vbmetaModule := range f.properties.Vbmeta_module_names {
563 diffTestFile := createVbmetaDiff(ctx, vbmetaModule, f.properties.Vbmeta_partition_names[i])
564 diffTestFiles = append(diffTestFiles, diffTestFile)
565 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", f.properties.Vbmeta_partition_names[i]), diffTestFile)
566 }
Cole Faust92ccbe22024-10-03 14:38:37 -0700567 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000568}
mrziwang8f86c882024-10-03 12:34:33 -0700569
mrziwang8f86c882024-10-03 12:34:33 -0700570func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -0700571 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
572 if !fsTypeSupported {
573 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700574 }
575
mrziwang4b0ca972024-10-17 14:56:19 -0700576 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
mrziwang2a506cf2024-10-17 15:38:37 -0700577 deps := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).fsDeps[partitionType]
578 depProps := generateDepStruct(*deps)
mrziwang8f86c882024-10-03 12:34:33 -0700579
mrziwang4b0ca972024-10-17 14:56:19 -0700580 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -0700581 if err != nil {
Cole Faustae3e1d32024-11-05 13:22:50 -0800582 ctx.ModuleErrorf("%s", err.Error())
583 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700584 }
585
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000586 moduleType := "android_filesystem"
587 if partitionType == "system" {
588 moduleType = "android_system_image"
589 }
590
mrziwang8f86c882024-10-03 12:34:33 -0700591 file := &parser.File{
592 Defs: []parser.Definition{
593 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000594 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -0700595 Map: *result,
596 },
597 },
598 }
599 bytes, err := parser.Print(file)
600 if err != nil {
601 ctx.ModuleErrorf(err.Error())
602 }
603 return strings.TrimSpace(string(bytes))
604}