blob: 2b967f7b6df25e67c74f36e9e27927c34963348a [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)
Jihoon Kang04f12c92024-11-12 23:03:08 +000065 avbpubkeyGenerated := createAvbpubkeyModule(ctx)
66 createFsGenState(ctx, generatedPrebuiltEtcModuleNames, avbpubkeyGenerated)
Jihoon Kang98047cf2024-10-02 17:13:54 +000067 module.createInternalModules(ctx)
68 })
69
70 return module
71}
72
73func (f *filesystemCreator) createInternalModules(ctx android.LoadHookContext) {
Cole Faust3552eb62024-11-06 18:07:26 -080074 soongGeneratedPartitions := generatedPartitions(ctx)
75 finalSoongGeneratedPartitions := make([]string, 0, len(soongGeneratedPartitions))
76 for _, partitionType := range soongGeneratedPartitions {
Cole Faust92ccbe22024-10-03 14:38:37 -070077 if f.createPartition(ctx, partitionType) {
78 f.properties.Generated_partition_types = append(f.properties.Generated_partition_types, partitionType)
Cole Faust3552eb62024-11-06 18:07:26 -080079 finalSoongGeneratedPartitions = append(finalSoongGeneratedPartitions, partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -070080 } else {
81 f.properties.Unsupported_partition_types = append(f.properties.Unsupported_partition_types, partitionType)
82 }
83 }
Cole Faust3552eb62024-11-06 18:07:26 -080084
85 for _, x := range createVbmetaPartitions(ctx, finalSoongGeneratedPartitions) {
86 f.properties.Vbmeta_module_names = append(f.properties.Vbmeta_module_names, x.moduleName)
87 f.properties.Vbmeta_partition_names = append(f.properties.Vbmeta_partition_names, x.partitionName)
88 }
89
90 ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions = finalSoongGeneratedPartitions
91 f.createDeviceModule(ctx, finalSoongGeneratedPartitions, f.properties.Vbmeta_module_names)
Jihoon Kang98047cf2024-10-02 17:13:54 +000092}
93
Jihoon Kang0d545b82024-10-11 00:21:57 +000094func generatedModuleName(cfg android.Config, suffix string) string {
Cole Faust92ccbe22024-10-03 14:38:37 -070095 prefix := "soong"
96 if cfg.HasDeviceProduct() {
97 prefix = cfg.DeviceProduct()
98 }
Jihoon Kangf1c79ca2024-10-09 20:18:38 +000099 return fmt.Sprintf("%s_generated_%s", prefix, suffix)
100}
101
Jihoon Kang0d545b82024-10-11 00:21:57 +0000102func generatedModuleNameForPartition(cfg android.Config, partitionType string) string {
103 return generatedModuleName(cfg, fmt.Sprintf("%s_image", partitionType))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000104}
105
Cole Faust3552eb62024-11-06 18:07:26 -0800106func (f *filesystemCreator) createDeviceModule(
107 ctx android.LoadHookContext,
108 generatedPartitionTypes []string,
109 vbmetaPartitions []string,
110) {
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000111 baseProps := &struct {
112 Name *string
113 }{
Jihoon Kang0d545b82024-10-11 00:21:57 +0000114 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "device")),
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000115 }
116
Priyanka Advani (xWF)dafaa7f2024-10-21 22:55:13 +0000117 // Currently, only the system and system_ext partition module is created.
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000118 partitionProps := &filesystem.PartitionNameProperties{}
Cole Faust3552eb62024-11-06 18:07:26 -0800119 if android.InList("system", generatedPartitionTypes) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000120 partitionProps.System_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000121 }
Cole Faust3552eb62024-11-06 18:07:26 -0800122 if android.InList("system_ext", generatedPartitionTypes) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000123 partitionProps.System_ext_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
Spandan Das7a46f6c2024-10-14 18:41:18 +0000124 }
Cole Faust3552eb62024-11-06 18:07:26 -0800125 if android.InList("vendor", generatedPartitionTypes) {
Spandan Dase3b65312024-10-22 00:27:27 +0000126 partitionProps.Vendor_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "vendor"))
127 }
Cole Faust3552eb62024-11-06 18:07:26 -0800128 if android.InList("product", generatedPartitionTypes) {
Jihoon Kang6dd13b62024-10-22 23:21:02 +0000129 partitionProps.Product_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "product"))
130 }
Cole Faust3552eb62024-11-06 18:07:26 -0800131 if android.InList("odm", generatedPartitionTypes) {
Spandan Dasc5717162024-11-01 18:33:57 +0000132 partitionProps.Odm_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "odm"))
133 }
mrziwang23ba8762024-11-07 16:21:53 -0800134 if android.InList("userdata", f.properties.Generated_partition_types) {
135 partitionProps.Userdata_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "userdata"))
136 }
Cole Faust3552eb62024-11-06 18:07:26 -0800137 partitionProps.Vbmeta_partitions = vbmetaPartitions
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000138
139 ctx.CreateModule(filesystem.AndroidDeviceFactory, baseProps, partitionProps)
Cole Faust92ccbe22024-10-03 14:38:37 -0700140}
141
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000142func partitionSpecificFsProps(fsProps *filesystem.FilesystemProperties, partitionType string) {
143 switch partitionType {
144 case "system":
145 fsProps.Build_logtags = proptools.BoolPtr(true)
146 // https://source.corp.google.com/h/googleplex-android/platform/build//639d79f5012a6542ab1f733b0697db45761ab0f3:core/packaging/flags.mk;l=21;drc=5ba8a8b77507f93aa48cc61c5ba3f31a4d0cbf37;bpv=1;bpt=0
147 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000148 // Identical to that of the generic_system_image
149 fsProps.Fsverity.Inputs = []string{
150 "etc/boot-image.prof",
151 "etc/dirty-image-objects",
152 "etc/preloaded-classes",
153 "etc/classpaths/*.pb",
154 "framework/*",
155 "framework/*/*", // framework/{arch}
156 "framework/oat/*/*", // framework/oat/{arch}
157 }
158 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
mrziwang9afc2982024-11-05 14:29:48 -0800159 // TODO(b/377734331): only generate the symlinks if the relevant partitions exist
160 fsProps.Symlinks = []filesystem.SymlinkDefinition{
161 filesystem.SymlinkDefinition{
162 Target: proptools.StringPtr("/product"),
163 Name: proptools.StringPtr("system/product"),
164 },
165 filesystem.SymlinkDefinition{
166 Target: proptools.StringPtr("/system_ext"),
167 Name: proptools.StringPtr("system/system_ext"),
168 },
169 filesystem.SymlinkDefinition{
170 Target: proptools.StringPtr("/vendor"),
171 Name: proptools.StringPtr("system/vendor"),
172 },
173 filesystem.SymlinkDefinition{
174 Target: proptools.StringPtr("/system_dlkm/lib/modules"),
175 Name: proptools.StringPtr("system/lib/modules"),
176 },
177 }
178 fsProps.Base_dir = proptools.StringPtr("system")
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000179 case "system_ext":
180 fsProps.Fsverity.Inputs = []string{
181 "framework/*",
182 "framework/*/*", // framework/{arch}
183 "framework/oat/*/*", // framework/oat/{arch}
184 }
185 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000186 case "product":
187 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
188 case "vendor":
189 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das69464c32024-10-25 20:08:06 +0000190 fsProps.Symlinks = []filesystem.SymlinkDefinition{
191 filesystem.SymlinkDefinition{
192 Target: proptools.StringPtr("/odm"),
193 Name: proptools.StringPtr("vendor/odm"),
194 },
195 filesystem.SymlinkDefinition{
196 Target: proptools.StringPtr("/vendor_dlkm/lib/modules"),
197 Name: proptools.StringPtr("vendor/lib/modules"),
198 },
199 }
200 fsProps.Base_dir = proptools.StringPtr("vendor")
Spandan Dasc5717162024-11-01 18:33:57 +0000201 case "odm":
202 fsProps.Symlinks = []filesystem.SymlinkDefinition{
203 filesystem.SymlinkDefinition{
204 Target: proptools.StringPtr("/odm_dlkm/lib/modules"),
205 Name: proptools.StringPtr("odm/lib/modules"),
206 },
207 }
208 fsProps.Base_dir = proptools.StringPtr("odm")
mrziwang23ba8762024-11-07 16:21:53 -0800209 case "userdata":
210 fsProps.Base_dir = proptools.StringPtr("data")
Spandan Dasc5717162024-11-01 18:33:57 +0000211
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000212 }
213}
Spandan Dascbe641a2024-10-14 21:07:34 +0000214
Spandan Das5b493cd2024-11-07 20:55:56 +0000215var (
216 dlkmPartitions = []string{
217 "system_dlkm",
218 "vendor_dlkm",
219 "odm_dlkm",
220 }
221)
222
Cole Faust92ccbe22024-10-03 14:38:37 -0700223// Creates a soong module to build the given partition. Returns false if we can't support building
224// it.
225func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700226 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
227
228 fsProps, supported := generateFsProps(ctx, partitionType)
229 if !supported {
230 return false
mrziwanga077b942024-10-16 16:00:06 -0700231 }
mrziwanga077b942024-10-16 16:00:06 -0700232
Spandan Das8fe68dc2024-10-29 18:20:11 +0000233 if partitionType == "vendor" || partitionType == "product" {
Spandan Das2047a4c2024-11-11 21:24:58 +0000234 fsProps.Linker_config.Gen_linker_config = proptools.BoolPtr(true)
235 fsProps.Linker_config.Linker_config_srcs = f.createLinkerConfigSourceFilegroups(ctx, partitionType)
Spandan Das312cc412024-10-29 18:20:11 +0000236 }
237
Spandan Das5b493cd2024-11-07 20:55:56 +0000238 if android.InList(partitionType, dlkmPartitions) {
239 f.createPrebuiltKernelModules(ctx, partitionType)
Spandan Das5e336422024-11-01 22:31:20 +0000240 }
241
mrziwang4b0ca972024-10-17 14:56:19 -0700242 var module android.Module
243 if partitionType == "system" {
244 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
245 } else {
246 // Explicitly set the partition.
247 fsProps.Partition_type = proptools.StringPtr(partitionType)
248 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
249 }
250 module.HideFromMake()
Spandan Das168098c2024-10-28 19:44:34 +0000251 if partitionType == "vendor" {
Spandan Das4cd93b52024-11-05 23:27:03 +0000252 f.createVendorBuildProp(ctx)
Spandan Das168098c2024-10-28 19:44:34 +0000253 }
mrziwang4b0ca972024-10-17 14:56:19 -0700254 return true
255}
256
Spandan Das5e336422024-11-01 22:31:20 +0000257// createPrebuiltKernelModules creates `prebuilt_kernel_modules`. These modules will be added to deps of the
Spandan Das7b25a512024-11-06 20:41:26 +0000258// autogenerated *_dlkm filsystem modules. Each _dlkm partition should have a single prebuilt_kernel_modules dependency.
259// This ensures that the depmod artifacts (modules.* installed in /lib/modules/) are generated with a complete view.
Spandan Das5b493cd2024-11-07 20:55:56 +0000260func (f *filesystemCreator) createPrebuiltKernelModules(ctx android.LoadHookContext, partitionType string) {
Spandan Das5e336422024-11-01 22:31:20 +0000261 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
Spandan Das7b25a512024-11-06 20:41:26 +0000262 name := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-kernel-modules", partitionType))
263 props := &struct {
Spandan Das912d26b2024-11-06 19:35:17 +0000264 Name *string
265 Srcs []string
Spandan Das5b493cd2024-11-07 20:55:56 +0000266 System_deps []string
Spandan Das912d26b2024-11-06 19:35:17 +0000267 System_dlkm_specific *bool
Spandan Das5b493cd2024-11-07 20:55:56 +0000268 Vendor_dlkm_specific *bool
269 Odm_dlkm_specific *bool
270 Load_by_default *bool
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000271 Blocklist_file *string
Spandan Das7b25a512024-11-06 20:41:26 +0000272 }{
273 Name: proptools.StringPtr(name),
Spandan Das5e336422024-11-01 22:31:20 +0000274 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000275 switch partitionType {
276 case "system_dlkm":
277 props.Srcs = ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules
Spandan Das912d26b2024-11-06 19:35:17 +0000278 props.System_dlkm_specific = proptools.BoolPtr(true)
Spandan Das5b493cd2024-11-07 20:55:56 +0000279 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelLoadModules) == 0 {
280 // Create empty modules.load file for system
281 // https://source.corp.google.com/h/googleplex-android/platform/build/+/ef55daac9954896161b26db4f3ef1781b5a5694c:core/Makefile;l=695-700;drc=549fe2a5162548bd8b47867d35f907eb22332023;bpv=1;bpt=0
282 props.Load_by_default = proptools.BoolPtr(false)
283 }
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000284 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelBlocklistFile; blocklistFile != "" {
285 props.Blocklist_file = proptools.StringPtr(blocklistFile)
286 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000287 case "vendor_dlkm":
288 props.Srcs = ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorKernelModules
289 if len(ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules) > 0 {
290 props.System_deps = []string{":" + generatedModuleName(ctx.Config(), "system_dlkm-kernel-modules") + "{.modules}"}
291 }
292 props.Vendor_dlkm_specific = proptools.BoolPtr(true)
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000293 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.VendorKernelBlocklistFile; blocklistFile != "" {
294 props.Blocklist_file = proptools.StringPtr(blocklistFile)
295 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000296 case "odm_dlkm":
297 props.Srcs = ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.OdmKernelModules
298 props.Odm_dlkm_specific = proptools.BoolPtr(true)
Spandan Das6dfcbdf2024-11-11 18:43:07 +0000299 if blocklistFile := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.OdmKernelBlocklistFile; blocklistFile != "" {
300 props.Blocklist_file = proptools.StringPtr(blocklistFile)
301 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000302 default:
303 ctx.ModuleErrorf("DLKM is not supported for %s\n", partitionType)
Spandan Das912d26b2024-11-06 19:35:17 +0000304 }
Spandan Das5b493cd2024-11-07 20:55:56 +0000305
306 if len(props.Srcs) == 0 {
307 return // do not generate `prebuilt_kernel_modules` if there are no sources
308 }
309
Spandan Das7b25a512024-11-06 20:41:26 +0000310 kernelModule := ctx.CreateModuleInDirectory(
311 kernel.PrebuiltKernelModulesFactory,
312 ".", // create in root directory for now
313 props,
314 )
315 kernelModule.HideFromMake()
316 // Add to deps
317 (*fsGenState.fsDeps[partitionType])[name] = defaultDepCandidateProps(ctx.Config())
Spandan Das5e336422024-11-01 22:31:20 +0000318}
319
Spandan Das4cd93b52024-11-05 23:27:03 +0000320// Create a build_prop and android_info module. This will be used to create /vendor/build.prop
321func (f *filesystemCreator) createVendorBuildProp(ctx android.LoadHookContext) {
322 // Create a android_info for vendor
323 // The board info files might be in a directory outside the root soong namespace, so create
324 // the module in "."
325 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
326 androidInfoProps := &struct {
327 Name *string
328 Board_info_files []string
329 Bootloader_board_name *string
330 }{
331 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "android-info.prop")),
332 Board_info_files: partitionVars.BoardInfoFiles,
333 }
334 if len(androidInfoProps.Board_info_files) == 0 {
335 androidInfoProps.Bootloader_board_name = proptools.StringPtr(partitionVars.BootLoaderBoardName)
336 }
337 androidInfoProp := ctx.CreateModuleInDirectory(
338 android.AndroidInfoFactory,
339 ".",
340 androidInfoProps,
341 )
342 androidInfoProp.HideFromMake()
343 // Create a build prop for vendor
344 vendorBuildProps := &struct {
345 Name *string
346 Vendor *bool
347 Stem *string
348 Product_config *string
349 Android_info *string
350 }{
351 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "vendor-build.prop")),
352 Vendor: proptools.BoolPtr(true),
353 Stem: proptools.StringPtr("build.prop"),
354 Product_config: proptools.StringPtr(":product_config"),
355 Android_info: proptools.StringPtr(":" + androidInfoProp.Name()),
356 }
357 vendorBuildProp := ctx.CreateModule(
358 android.BuildPropFactory,
359 vendorBuildProps,
360 )
361 vendorBuildProp.HideFromMake()
362}
363
Spandan Das8fe68dc2024-10-29 18:20:11 +0000364// createLinkerConfigSourceFilegroups creates filegroup modules to generate linker.config.pb for the following partitions
365// 1. vendor: Using PRODUCT_VENDOR_LINKER_CONFIG_FRAGMENTS (space separated file list)
366// 1. product: Using PRODUCT_PRODUCT_LINKER_CONFIG_FRAGMENTS (space separated file list)
367// It creates a filegroup for each file in the fragment list
Spandan Das312cc412024-10-29 18:20:11 +0000368// The filegroup modules are then added to `linker_config_srcs` of the autogenerated vendor `android_filesystem`.
Spandan Das8fe68dc2024-10-29 18:20:11 +0000369func (f *filesystemCreator) createLinkerConfigSourceFilegroups(ctx android.LoadHookContext, partitionType string) []string {
Spandan Das312cc412024-10-29 18:20:11 +0000370 ret := []string{}
371 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Spandan Das8fe68dc2024-10-29 18:20:11 +0000372 var linkerConfigSrcs []string
373 if partitionType == "vendor" {
374 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.VendorLinkerConfigSrcs)
375 } else if partitionType == "product" {
376 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.ProductLinkerConfigSrcs)
377 } else {
378 ctx.ModuleErrorf("linker.config.pb is only supported for vendor and product partitions. For system partition, use `android_system_image`")
379 }
380
381 if len(linkerConfigSrcs) > 0 {
Spandan Das312cc412024-10-29 18:20:11 +0000382 // Create a filegroup, and add `:<filegroup_name>` to ret.
383 for index, linkerConfigSrc := range linkerConfigSrcs {
384 dir := filepath.Dir(linkerConfigSrc)
385 base := filepath.Base(linkerConfigSrc)
Spandan Das8fe68dc2024-10-29 18:20:11 +0000386 fgName := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-linker-config-src%s", partitionType, strconv.Itoa(index)))
Spandan Das312cc412024-10-29 18:20:11 +0000387 srcs := []string{base}
388 fgProps := &struct {
389 Name *string
390 Srcs proptools.Configurable[[]string]
391 }{
392 Name: proptools.StringPtr(fgName),
393 Srcs: proptools.NewSimpleConfigurable(srcs),
394 }
395 ctx.CreateModuleInDirectory(
396 android.FileGroupFactory,
397 dir,
398 fgProps,
399 )
400 ret = append(ret, ":"+fgName)
401 }
402 }
403 return ret
404}
405
mrziwang4b0ca972024-10-17 14:56:19 -0700406type filesystemBaseProperty struct {
407 Name *string
408 Compile_multilib *string
Cole Faust3552eb62024-11-06 18:07:26 -0800409 Visibility []string
mrziwang4b0ca972024-10-17 14:56:19 -0700410}
411
412func generateBaseProps(namePtr *string) *filesystemBaseProperty {
413 return &filesystemBaseProperty{
414 Name: namePtr,
415 Compile_multilib: proptools.StringPtr("both"),
Cole Faust3552eb62024-11-06 18:07:26 -0800416 // The vbmeta modules are currently in the root directory and depend on the partitions
417 Visibility: []string{"//.", "//build/soong:__subpackages__"},
mrziwang4b0ca972024-10-17 14:56:19 -0700418 }
419}
420
421func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700422 fsProps := &filesystem.FilesystemProperties{}
423
mrziwang4b0ca972024-10-17 14:56:19 -0700424 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Cole Faust76a6e952024-11-07 16:56:45 -0800425 var specificPartitionVars android.PartitionQualifiedVariablesType
426 var boardAvbEnable bool
427 var fsType string
428 if strings.Contains(partitionType, "ramdisk") {
429 fsType = "compressed_cpio"
430 } else {
431 specificPartitionVars = partitionVars.PartitionQualifiedVariables[partitionType]
432 boardAvbEnable = partitionVars.BoardAvbEnable
433 fsType = specificPartitionVars.BoardFileSystemType
434 }
mrziwang4b0ca972024-10-17 14:56:19 -0700435 if fsType == "" {
436 fsType = "ext4" //default
437 }
Cole Faust76a6e952024-11-07 16:56:45 -0800438
mrziwang4b0ca972024-10-17 14:56:19 -0700439 fsProps.Type = proptools.StringPtr(fsType)
440 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
441 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
442 return nil, false
443 }
444
Cole Faust92ccbe22024-10-03 14:38:37 -0700445 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
446 // and sometimes don't build.
447 fsProps.Unchecked_module = proptools.BoolPtr(true)
448
Jihoon Kang98047cf2024-10-02 17:13:54 +0000449 // BOARD_AVB_ENABLE
Cole Faust76a6e952024-11-07 16:56:45 -0800450 fsProps.Use_avb = proptools.BoolPtr(boardAvbEnable)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000451 // BOARD_AVB_KEY_PATH
Cole Faust92ccbe22024-10-03 14:38:37 -0700452 fsProps.Avb_private_key = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000453 // BOARD_AVB_ALGORITHM
Cole Faust92ccbe22024-10-03 14:38:37 -0700454 fsProps.Avb_algorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000455 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust92ccbe22024-10-03 14:38:37 -0700456 if rollbackIndex, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64); err == nil {
Jihoon Kang98047cf2024-10-02 17:13:54 +0000457 fsProps.Rollback_index = proptools.Int64Ptr(rollbackIndex)
458 }
459
Cole Faust92ccbe22024-10-03 14:38:37 -0700460 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000461
Cole Faust92ccbe22024-10-03 14:38:37 -0700462 fsProps.Base_dir = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000463
Jihoon Kang0d545b82024-10-11 00:21:57 +0000464 fsProps.Is_auto_generated = proptools.BoolPtr(true)
465
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000466 partitionSpecificFsProps(fsProps, partitionType)
467
Jihoon Kang98047cf2024-10-02 17:13:54 +0000468 // system_image properties that are not set:
469 // - filesystemProperties.Avb_hash_algorithm
470 // - filesystemProperties.File_contexts
471 // - filesystemProperties.Dirs
472 // - filesystemProperties.Symlinks
473 // - filesystemProperties.Fake_timestamp
474 // - filesystemProperties.Uuid
475 // - filesystemProperties.Mount_point
476 // - filesystemProperties.Include_make_built_files
477 // - filesystemProperties.Build_logtags
Jihoon Kang98047cf2024-10-02 17:13:54 +0000478 // - systemImageProperties.Linker_config_src
mrziwang4b0ca972024-10-17 14:56:19 -0700479
480 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700481}
482
483func (f *filesystemCreator) createDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000484 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700485 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
486 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
487 if !ok {
488 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
489 }
490 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 +0000491 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700492
493 builder := android.NewRuleBuilder(pctx, ctx)
494 builder.Command().BuiltTool("file_list_diff").
495 Input(makeFileList).
496 Input(filesystemInfo.FileListFile).
Cole Faust56301572024-11-07 15:22:42 -0800497 Text(partitionModuleName)
Cole Faust92ccbe22024-10-03 14:38:37 -0700498 builder.Command().Text("touch").Output(diffTestResultFile)
499 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
500 return diffTestResultFile
501}
502
503func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
504 hasher := sha256.New()
505 hasher.Write([]byte(message))
506 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
507 file := android.PathForModuleOut(ctx, filename)
508 builder := android.NewRuleBuilder(pctx, ctx)
509 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
510 builder.Command().Text("exit 1 #").Output(file)
511 builder.Build("failing command "+filename, "failing command "+filename)
512 return file
513}
514
Cole Faust3552eb62024-11-06 18:07:26 -0800515func createVbmetaDiff(ctx android.ModuleContext, vbmetaModuleName string, vbmetaPartitionName string) android.Path {
516 vbmetaModule := ctx.GetDirectDepWithTag(vbmetaModuleName, generatedVbmetaPartitionDepTag)
517 outputFilesProvider, ok := android.OtherModuleProvider(ctx, vbmetaModule, android.OutputFilesProvider)
518 if !ok {
519 ctx.ModuleErrorf("Expected module %s to provide OutputFiles", vbmetaModule)
520 }
521 if len(outputFilesProvider.DefaultOutputFiles) != 1 {
522 ctx.ModuleErrorf("Expected 1 output file from module %s", vbmetaModule)
523 }
524 soongVbMetaFile := outputFilesProvider.DefaultOutputFiles[0]
525 makeVbmetaFile := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/%s.img", ctx.Config().DeviceName(), vbmetaPartitionName))
526
527 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", vbmetaModuleName))
528 builder := android.NewRuleBuilder(pctx, ctx)
529 builder.Command().Text("diff").
530 Input(soongVbMetaFile).
531 Input(makeVbmetaFile)
532 builder.Command().Text("touch").Output(diffTestResultFile)
533 builder.Build(vbmetaModuleName+" diff test", vbmetaModuleName+" diff test")
534 return diffTestResultFile
535}
536
Cole Faust92ccbe22024-10-03 14:38:37 -0700537type systemImageDepTagType struct {
538 blueprint.BaseDependencyTag
539}
540
541var generatedFilesystemDepTag systemImageDepTagType
Cole Faust3552eb62024-11-06 18:07:26 -0800542var generatedVbmetaPartitionDepTag systemImageDepTagType
Cole Faust92ccbe22024-10-03 14:38:37 -0700543
544func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
545 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000546 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700547 }
Cole Faust3552eb62024-11-06 18:07:26 -0800548 for _, vbmetaModule := range f.properties.Vbmeta_module_names {
549 ctx.AddDependency(ctx.Module(), generatedVbmetaPartitionDepTag, vbmetaModule)
550 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000551}
552
553func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700554 if ctx.ModuleDir() != "build/soong/fsgen" {
555 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
556 }
557 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000558
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000559 var content strings.Builder
560 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
561 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
562 content.WriteString(generateBpContent(ctx, partition))
563 content.WriteString("\n")
564 }
565 android.WriteFileRule(ctx, generatedBp, content.String())
566
mrziwang8f86c882024-10-03 12:34:33 -0700567 ctx.Phony("product_config_to_bp", generatedBp)
568
Cole Faust92ccbe22024-10-03 14:38:37 -0700569 var diffTestFiles []android.Path
570 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000571 diffTestFile := f.createDiffTest(ctx, partitionType)
572 diffTestFiles = append(diffTestFiles, diffTestFile)
573 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700574 }
575 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000576 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
577 diffTestFiles = append(diffTestFiles, diffTestFile)
578 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700579 }
Cole Faust3552eb62024-11-06 18:07:26 -0800580 for i, vbmetaModule := range f.properties.Vbmeta_module_names {
581 diffTestFile := createVbmetaDiff(ctx, vbmetaModule, f.properties.Vbmeta_partition_names[i])
582 diffTestFiles = append(diffTestFiles, diffTestFile)
583 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", f.properties.Vbmeta_partition_names[i]), diffTestFile)
584 }
Cole Faust92ccbe22024-10-03 14:38:37 -0700585 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000586}
mrziwang8f86c882024-10-03 12:34:33 -0700587
mrziwang8f86c882024-10-03 12:34:33 -0700588func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -0700589 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
590 if !fsTypeSupported {
591 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700592 }
593
mrziwang4b0ca972024-10-17 14:56:19 -0700594 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
mrziwang2a506cf2024-10-17 15:38:37 -0700595 deps := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).fsDeps[partitionType]
596 depProps := generateDepStruct(*deps)
mrziwang8f86c882024-10-03 12:34:33 -0700597
mrziwang4b0ca972024-10-17 14:56:19 -0700598 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -0700599 if err != nil {
Cole Faustae3e1d32024-11-05 13:22:50 -0800600 ctx.ModuleErrorf("%s", err.Error())
601 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700602 }
603
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000604 moduleType := "android_filesystem"
605 if partitionType == "system" {
606 moduleType = "android_system_image"
607 }
608
mrziwang8f86c882024-10-03 12:34:33 -0700609 file := &parser.File{
610 Defs: []parser.Definition{
611 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000612 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -0700613 Map: *result,
614 },
615 },
616 }
617 bytes, err := parser.Print(file)
618 if err != nil {
619 ctx.ModuleErrorf(err.Error())
620 }
621 return strings.TrimSpace(string(bytes))
622}