blob: c9bbf3fa6d1b5c3e152dfb83ab1b75fb31007b9e [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 }
Cole Faust3552eb62024-11-06 18:07:26 -0800133 partitionProps.Vbmeta_partitions = vbmetaPartitions
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000134
135 ctx.CreateModule(filesystem.AndroidDeviceFactory, baseProps, partitionProps)
Cole Faust92ccbe22024-10-03 14:38:37 -0700136}
137
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000138func partitionSpecificFsProps(fsProps *filesystem.FilesystemProperties, partitionType string) {
139 switch partitionType {
140 case "system":
141 fsProps.Build_logtags = proptools.BoolPtr(true)
142 // https://source.corp.google.com/h/googleplex-android/platform/build//639d79f5012a6542ab1f733b0697db45761ab0f3:core/packaging/flags.mk;l=21;drc=5ba8a8b77507f93aa48cc61c5ba3f31a4d0cbf37;bpv=1;bpt=0
143 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000144 // Identical to that of the generic_system_image
145 fsProps.Fsverity.Inputs = []string{
146 "etc/boot-image.prof",
147 "etc/dirty-image-objects",
148 "etc/preloaded-classes",
149 "etc/classpaths/*.pb",
150 "framework/*",
151 "framework/*/*", // framework/{arch}
152 "framework/oat/*/*", // framework/oat/{arch}
153 }
154 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
mrziwang9afc2982024-11-05 14:29:48 -0800155 // TODO(b/377734331): only generate the symlinks if the relevant partitions exist
156 fsProps.Symlinks = []filesystem.SymlinkDefinition{
157 filesystem.SymlinkDefinition{
158 Target: proptools.StringPtr("/product"),
159 Name: proptools.StringPtr("system/product"),
160 },
161 filesystem.SymlinkDefinition{
162 Target: proptools.StringPtr("/system_ext"),
163 Name: proptools.StringPtr("system/system_ext"),
164 },
165 filesystem.SymlinkDefinition{
166 Target: proptools.StringPtr("/vendor"),
167 Name: proptools.StringPtr("system/vendor"),
168 },
169 filesystem.SymlinkDefinition{
170 Target: proptools.StringPtr("/system_dlkm/lib/modules"),
171 Name: proptools.StringPtr("system/lib/modules"),
172 },
173 }
174 fsProps.Base_dir = proptools.StringPtr("system")
Spandan Dasa8fa6b42024-10-23 00:45:29 +0000175 case "system_ext":
176 fsProps.Fsverity.Inputs = []string{
177 "framework/*",
178 "framework/*/*", // framework/{arch}
179 "framework/oat/*/*", // framework/oat/{arch}
180 }
181 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000182 case "product":
183 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
184 case "vendor":
185 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
Spandan Das69464c32024-10-25 20:08:06 +0000186 fsProps.Symlinks = []filesystem.SymlinkDefinition{
187 filesystem.SymlinkDefinition{
188 Target: proptools.StringPtr("/odm"),
189 Name: proptools.StringPtr("vendor/odm"),
190 },
191 filesystem.SymlinkDefinition{
192 Target: proptools.StringPtr("/vendor_dlkm/lib/modules"),
193 Name: proptools.StringPtr("vendor/lib/modules"),
194 },
195 }
196 fsProps.Base_dir = proptools.StringPtr("vendor")
Spandan Dasc5717162024-11-01 18:33:57 +0000197 case "odm":
198 fsProps.Symlinks = []filesystem.SymlinkDefinition{
199 filesystem.SymlinkDefinition{
200 Target: proptools.StringPtr("/odm_dlkm/lib/modules"),
201 Name: proptools.StringPtr("odm/lib/modules"),
202 },
203 }
204 fsProps.Base_dir = proptools.StringPtr("odm")
205
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000206 }
207}
Spandan Dascbe641a2024-10-14 21:07:34 +0000208
Cole Faust92ccbe22024-10-03 14:38:37 -0700209// Creates a soong module to build the given partition. Returns false if we can't support building
210// it.
211func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700212 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
213
214 fsProps, supported := generateFsProps(ctx, partitionType)
215 if !supported {
216 return false
mrziwanga077b942024-10-16 16:00:06 -0700217 }
mrziwanga077b942024-10-16 16:00:06 -0700218
Spandan Das8fe68dc2024-10-29 18:20:11 +0000219 if partitionType == "vendor" || partitionType == "product" {
Spandan Das173256b2024-10-31 19:59:30 +0000220 fsProps.Linkerconfig.Gen_linker_config = proptools.BoolPtr(true)
221 fsProps.Linkerconfig.Linker_config_srcs = f.createLinkerConfigSourceFilegroups(ctx, partitionType)
Spandan Das312cc412024-10-29 18:20:11 +0000222 }
223
Spandan Das5e336422024-11-01 22:31:20 +0000224 if partitionType == "system_dlkm" {
225 kernelModules := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse.SystemKernelModules
226 f.createPrebuiltKernelModules(ctx, partitionType, kernelModules)
227 }
228
mrziwang4b0ca972024-10-17 14:56:19 -0700229 var module android.Module
230 if partitionType == "system" {
231 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
Spandan Das5e336422024-11-01 22:31:20 +0000232 } else if partitionType == "system_dlkm" {
233 // Do not set partition_type. build/soong/android/paths#modulePartition currently does not support dlkm
234 // partitions. Since `android_filesystem` uses a partition based filter, setting the partition here
235 // would result in missing in entries.
236 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
mrziwang4b0ca972024-10-17 14:56:19 -0700237 } else {
238 // Explicitly set the partition.
239 fsProps.Partition_type = proptools.StringPtr(partitionType)
240 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
241 }
242 module.HideFromMake()
Spandan Das168098c2024-10-28 19:44:34 +0000243 if partitionType == "vendor" {
Spandan Das4cd93b52024-11-05 23:27:03 +0000244 f.createVendorBuildProp(ctx)
Spandan Das168098c2024-10-28 19:44:34 +0000245 }
mrziwang4b0ca972024-10-17 14:56:19 -0700246 return true
247}
248
Spandan Das5e336422024-11-01 22:31:20 +0000249// createPrebuiltKernelModules creates `prebuilt_kernel_modules`. These modules will be added to deps of the
Spandan Das7b25a512024-11-06 20:41:26 +0000250// autogenerated *_dlkm filsystem modules. Each _dlkm partition should have a single prebuilt_kernel_modules dependency.
251// This ensures that the depmod artifacts (modules.* installed in /lib/modules/) are generated with a complete view.
252
253// The input `kernelModules` is a space separated list of .ko files in the workspace.
Spandan Das5e336422024-11-01 22:31:20 +0000254func (f *filesystemCreator) createPrebuiltKernelModules(ctx android.LoadHookContext, partitionType string, kernelModules []string) {
Spandan Das5e336422024-11-01 22:31:20 +0000255 fsGenState := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
Spandan Das7b25a512024-11-06 20:41:26 +0000256 name := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-kernel-modules", partitionType))
257 props := &struct {
258 Name *string
259 Srcs []string
260 }{
261 Name: proptools.StringPtr(name),
262 Srcs: kernelModules,
Spandan Das5e336422024-11-01 22:31:20 +0000263 }
Spandan Das7b25a512024-11-06 20:41:26 +0000264 kernelModule := ctx.CreateModuleInDirectory(
265 kernel.PrebuiltKernelModulesFactory,
266 ".", // create in root directory for now
267 props,
268 )
269 kernelModule.HideFromMake()
270 // Add to deps
271 (*fsGenState.fsDeps[partitionType])[name] = defaultDepCandidateProps(ctx.Config())
Spandan Das5e336422024-11-01 22:31:20 +0000272}
273
Spandan Das4cd93b52024-11-05 23:27:03 +0000274// Create a build_prop and android_info module. This will be used to create /vendor/build.prop
275func (f *filesystemCreator) createVendorBuildProp(ctx android.LoadHookContext) {
276 // Create a android_info for vendor
277 // The board info files might be in a directory outside the root soong namespace, so create
278 // the module in "."
279 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
280 androidInfoProps := &struct {
281 Name *string
282 Board_info_files []string
283 Bootloader_board_name *string
284 }{
285 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "android-info.prop")),
286 Board_info_files: partitionVars.BoardInfoFiles,
287 }
288 if len(androidInfoProps.Board_info_files) == 0 {
289 androidInfoProps.Bootloader_board_name = proptools.StringPtr(partitionVars.BootLoaderBoardName)
290 }
291 androidInfoProp := ctx.CreateModuleInDirectory(
292 android.AndroidInfoFactory,
293 ".",
294 androidInfoProps,
295 )
296 androidInfoProp.HideFromMake()
297 // Create a build prop for vendor
298 vendorBuildProps := &struct {
299 Name *string
300 Vendor *bool
301 Stem *string
302 Product_config *string
303 Android_info *string
304 }{
305 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "vendor-build.prop")),
306 Vendor: proptools.BoolPtr(true),
307 Stem: proptools.StringPtr("build.prop"),
308 Product_config: proptools.StringPtr(":product_config"),
309 Android_info: proptools.StringPtr(":" + androidInfoProp.Name()),
310 }
311 vendorBuildProp := ctx.CreateModule(
312 android.BuildPropFactory,
313 vendorBuildProps,
314 )
315 vendorBuildProp.HideFromMake()
316}
317
Spandan Das8fe68dc2024-10-29 18:20:11 +0000318// createLinkerConfigSourceFilegroups creates filegroup modules to generate linker.config.pb for the following partitions
319// 1. vendor: Using PRODUCT_VENDOR_LINKER_CONFIG_FRAGMENTS (space separated file list)
320// 1. product: Using PRODUCT_PRODUCT_LINKER_CONFIG_FRAGMENTS (space separated file list)
321// It creates a filegroup for each file in the fragment list
Spandan Das312cc412024-10-29 18:20:11 +0000322// The filegroup modules are then added to `linker_config_srcs` of the autogenerated vendor `android_filesystem`.
Spandan Das8fe68dc2024-10-29 18:20:11 +0000323func (f *filesystemCreator) createLinkerConfigSourceFilegroups(ctx android.LoadHookContext, partitionType string) []string {
Spandan Das312cc412024-10-29 18:20:11 +0000324 ret := []string{}
325 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
Spandan Das8fe68dc2024-10-29 18:20:11 +0000326 var linkerConfigSrcs []string
327 if partitionType == "vendor" {
328 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.VendorLinkerConfigSrcs)
329 } else if partitionType == "product" {
330 linkerConfigSrcs = android.FirstUniqueStrings(partitionVars.ProductLinkerConfigSrcs)
331 } else {
332 ctx.ModuleErrorf("linker.config.pb is only supported for vendor and product partitions. For system partition, use `android_system_image`")
333 }
334
335 if len(linkerConfigSrcs) > 0 {
Spandan Das312cc412024-10-29 18:20:11 +0000336 // Create a filegroup, and add `:<filegroup_name>` to ret.
337 for index, linkerConfigSrc := range linkerConfigSrcs {
338 dir := filepath.Dir(linkerConfigSrc)
339 base := filepath.Base(linkerConfigSrc)
Spandan Das8fe68dc2024-10-29 18:20:11 +0000340 fgName := generatedModuleName(ctx.Config(), fmt.Sprintf("%s-linker-config-src%s", partitionType, strconv.Itoa(index)))
Spandan Das312cc412024-10-29 18:20:11 +0000341 srcs := []string{base}
342 fgProps := &struct {
343 Name *string
344 Srcs proptools.Configurable[[]string]
345 }{
346 Name: proptools.StringPtr(fgName),
347 Srcs: proptools.NewSimpleConfigurable(srcs),
348 }
349 ctx.CreateModuleInDirectory(
350 android.FileGroupFactory,
351 dir,
352 fgProps,
353 )
354 ret = append(ret, ":"+fgName)
355 }
356 }
357 return ret
358}
359
mrziwang4b0ca972024-10-17 14:56:19 -0700360type filesystemBaseProperty struct {
361 Name *string
362 Compile_multilib *string
Cole Faust3552eb62024-11-06 18:07:26 -0800363 Visibility []string
mrziwang4b0ca972024-10-17 14:56:19 -0700364}
365
366func generateBaseProps(namePtr *string) *filesystemBaseProperty {
367 return &filesystemBaseProperty{
368 Name: namePtr,
369 Compile_multilib: proptools.StringPtr("both"),
Cole Faust3552eb62024-11-06 18:07:26 -0800370 // The vbmeta modules are currently in the root directory and depend on the partitions
371 Visibility: []string{"//.", "//build/soong:__subpackages__"},
mrziwang4b0ca972024-10-17 14:56:19 -0700372 }
373}
374
375func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700376 fsProps := &filesystem.FilesystemProperties{}
377
mrziwang4b0ca972024-10-17 14:56:19 -0700378 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
379 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
380
381 // BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE
382 fsType := specificPartitionVars.BoardFileSystemType
383 if fsType == "" {
384 fsType = "ext4" //default
385 }
386 fsProps.Type = proptools.StringPtr(fsType)
387 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
388 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
389 return nil, false
390 }
391
Cole Faust92ccbe22024-10-03 14:38:37 -0700392 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
393 // and sometimes don't build.
394 fsProps.Unchecked_module = proptools.BoolPtr(true)
395
Jihoon Kang98047cf2024-10-02 17:13:54 +0000396 // BOARD_AVB_ENABLE
397 fsProps.Use_avb = proptools.BoolPtr(partitionVars.BoardAvbEnable)
398 // BOARD_AVB_KEY_PATH
Cole Faust92ccbe22024-10-03 14:38:37 -0700399 fsProps.Avb_private_key = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000400 // BOARD_AVB_ALGORITHM
Cole Faust92ccbe22024-10-03 14:38:37 -0700401 fsProps.Avb_algorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000402 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust92ccbe22024-10-03 14:38:37 -0700403 if rollbackIndex, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64); err == nil {
Jihoon Kang98047cf2024-10-02 17:13:54 +0000404 fsProps.Rollback_index = proptools.Int64Ptr(rollbackIndex)
405 }
406
Cole Faust92ccbe22024-10-03 14:38:37 -0700407 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000408
Cole Faust92ccbe22024-10-03 14:38:37 -0700409 fsProps.Base_dir = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000410
Jihoon Kang0d545b82024-10-11 00:21:57 +0000411 fsProps.Is_auto_generated = proptools.BoolPtr(true)
412
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000413 partitionSpecificFsProps(fsProps, partitionType)
414
Jihoon Kang98047cf2024-10-02 17:13:54 +0000415 // system_image properties that are not set:
416 // - filesystemProperties.Avb_hash_algorithm
417 // - filesystemProperties.File_contexts
418 // - filesystemProperties.Dirs
419 // - filesystemProperties.Symlinks
420 // - filesystemProperties.Fake_timestamp
421 // - filesystemProperties.Uuid
422 // - filesystemProperties.Mount_point
423 // - filesystemProperties.Include_make_built_files
424 // - filesystemProperties.Build_logtags
Jihoon Kang98047cf2024-10-02 17:13:54 +0000425 // - systemImageProperties.Linker_config_src
mrziwang4b0ca972024-10-17 14:56:19 -0700426
427 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700428}
429
430func (f *filesystemCreator) createDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000431 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700432 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
433 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
434 if !ok {
435 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
436 }
437 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 +0000438 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700439
440 builder := android.NewRuleBuilder(pctx, ctx)
441 builder.Command().BuiltTool("file_list_diff").
442 Input(makeFileList).
443 Input(filesystemInfo.FileListFile).
Cole Faust56301572024-11-07 15:22:42 -0800444 Text(partitionModuleName)
Cole Faust92ccbe22024-10-03 14:38:37 -0700445 builder.Command().Text("touch").Output(diffTestResultFile)
446 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
447 return diffTestResultFile
448}
449
450func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
451 hasher := sha256.New()
452 hasher.Write([]byte(message))
453 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
454 file := android.PathForModuleOut(ctx, filename)
455 builder := android.NewRuleBuilder(pctx, ctx)
456 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
457 builder.Command().Text("exit 1 #").Output(file)
458 builder.Build("failing command "+filename, "failing command "+filename)
459 return file
460}
461
Cole Faust3552eb62024-11-06 18:07:26 -0800462func createVbmetaDiff(ctx android.ModuleContext, vbmetaModuleName string, vbmetaPartitionName string) android.Path {
463 vbmetaModule := ctx.GetDirectDepWithTag(vbmetaModuleName, generatedVbmetaPartitionDepTag)
464 outputFilesProvider, ok := android.OtherModuleProvider(ctx, vbmetaModule, android.OutputFilesProvider)
465 if !ok {
466 ctx.ModuleErrorf("Expected module %s to provide OutputFiles", vbmetaModule)
467 }
468 if len(outputFilesProvider.DefaultOutputFiles) != 1 {
469 ctx.ModuleErrorf("Expected 1 output file from module %s", vbmetaModule)
470 }
471 soongVbMetaFile := outputFilesProvider.DefaultOutputFiles[0]
472 makeVbmetaFile := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/%s.img", ctx.Config().DeviceName(), vbmetaPartitionName))
473
474 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", vbmetaModuleName))
475 builder := android.NewRuleBuilder(pctx, ctx)
476 builder.Command().Text("diff").
477 Input(soongVbMetaFile).
478 Input(makeVbmetaFile)
479 builder.Command().Text("touch").Output(diffTestResultFile)
480 builder.Build(vbmetaModuleName+" diff test", vbmetaModuleName+" diff test")
481 return diffTestResultFile
482}
483
Cole Faust92ccbe22024-10-03 14:38:37 -0700484type systemImageDepTagType struct {
485 blueprint.BaseDependencyTag
486}
487
488var generatedFilesystemDepTag systemImageDepTagType
Cole Faust3552eb62024-11-06 18:07:26 -0800489var generatedVbmetaPartitionDepTag systemImageDepTagType
Cole Faust92ccbe22024-10-03 14:38:37 -0700490
491func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
492 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000493 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700494 }
Cole Faust3552eb62024-11-06 18:07:26 -0800495 for _, vbmetaModule := range f.properties.Vbmeta_module_names {
496 ctx.AddDependency(ctx.Module(), generatedVbmetaPartitionDepTag, vbmetaModule)
497 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000498}
499
500func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700501 if ctx.ModuleDir() != "build/soong/fsgen" {
502 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
503 }
504 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000505
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000506 var content strings.Builder
507 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
508 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
509 content.WriteString(generateBpContent(ctx, partition))
510 content.WriteString("\n")
511 }
512 android.WriteFileRule(ctx, generatedBp, content.String())
513
mrziwang8f86c882024-10-03 12:34:33 -0700514 ctx.Phony("product_config_to_bp", generatedBp)
515
Cole Faust92ccbe22024-10-03 14:38:37 -0700516 var diffTestFiles []android.Path
517 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000518 diffTestFile := f.createDiffTest(ctx, partitionType)
519 diffTestFiles = append(diffTestFiles, diffTestFile)
520 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700521 }
522 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000523 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", 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 }
Cole Faust3552eb62024-11-06 18:07:26 -0800527 for i, vbmetaModule := range f.properties.Vbmeta_module_names {
528 diffTestFile := createVbmetaDiff(ctx, vbmetaModule, f.properties.Vbmeta_partition_names[i])
529 diffTestFiles = append(diffTestFiles, diffTestFile)
530 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", f.properties.Vbmeta_partition_names[i]), diffTestFile)
531 }
Cole Faust92ccbe22024-10-03 14:38:37 -0700532 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000533}
mrziwang8f86c882024-10-03 12:34:33 -0700534
mrziwang8f86c882024-10-03 12:34:33 -0700535func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -0700536 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
537 if !fsTypeSupported {
538 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700539 }
540
mrziwang4b0ca972024-10-17 14:56:19 -0700541 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
mrziwang2a506cf2024-10-17 15:38:37 -0700542 deps := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).fsDeps[partitionType]
543 depProps := generateDepStruct(*deps)
mrziwang8f86c882024-10-03 12:34:33 -0700544
mrziwang4b0ca972024-10-17 14:56:19 -0700545 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -0700546 if err != nil {
Cole Faustae3e1d32024-11-05 13:22:50 -0800547 ctx.ModuleErrorf("%s", err.Error())
548 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700549 }
550
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000551 moduleType := "android_filesystem"
552 if partitionType == "system" {
553 moduleType = "android_system_image"
554 }
555
mrziwang8f86c882024-10-03 12:34:33 -0700556 file := &parser.File{
557 Defs: []parser.Definition{
558 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000559 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -0700560 Map: *result,
561 },
562 },
563 }
564 bytes, err := parser.Print(file)
565 if err != nil {
566 ctx.ModuleErrorf(err.Error())
567 }
568 return strings.TrimSpace(string(bytes))
569}