blob: fde344b5bf22ec1f7feb7123ef20d7e3dcc76cfb [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"
mrziwang8f86c882024-10-03 12:34:33 -070020 "slices"
Jihoon Kang98047cf2024-10-02 17:13:54 +000021 "strconv"
mrziwang8f86c882024-10-03 12:34:33 -070022 "strings"
23 "sync"
24
25 "android/soong/android"
26 "android/soong/filesystem"
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
44func RegisterCollectFileSystemDepsMutators(ctx android.RegisterMutatorsContext) {
45 ctx.BottomUp("fs_collect_deps", collectDepsMutator).MutatesGlobalState()
Jihoon Kang0d545b82024-10-11 00:21:57 +000046 ctx.BottomUp("fs_set_deps", setDepsMutator)
mrziwang8f86c882024-10-03 12:34:33 -070047}
48
Jihoon Kang0d545b82024-10-11 00:21:57 +000049var fsGenStateOnceKey = android.NewOnceKey("FsGenState")
50
51// Map of partition module name to its partition that may be generated by Soong.
52// Note that it is not guaranteed that all modules returned by this function are successfully
53// created.
54func getAllSoongGeneratedPartitionNames(config android.Config, partitions []string) map[string]string {
55 ret := map[string]string{}
56 for _, partition := range partitions {
57 ret[generatedModuleNameForPartition(config, partition)] = partition
58 }
59 return ret
60}
61
62type depCandidateProps struct {
63 Namespace string
64 Multilib string
65 Arch []android.ArchType
66}
67
68// Map of module name to depCandidateProps
69type multilibDeps *map[string]*depCandidateProps
70
71// Information necessary to generate the filesystem modules, including details about their
72// dependencies
73type FsGenState struct {
74 // List of modules in `PRODUCT_PACKAGES` and `PRODUCT_PACKAGES_DEBUG`
75 depCandidates []string
76 // Map of names of partition to the information of modules to be added as deps
77 fsDeps map[string]multilibDeps
78 // List of name of partitions to be generated by the filesystem_creator module
79 soongGeneratedPartitions []string
80 // Mutex to protect the fsDeps
81 fsDepsMutex sync.Mutex
82}
83
84func newMultilibDeps() multilibDeps {
85 return &map[string]*depCandidateProps{}
86}
87
88func defaultDepCandidateProps(config android.Config) *depCandidateProps {
89 return &depCandidateProps{
90 Namespace: ".",
91 Arch: []android.ArchType{config.BuildArch},
92 }
93}
94
95func createFsGenState(ctx android.LoadHookContext) *FsGenState {
96 return ctx.Config().Once(fsGenStateOnceKey, func() interface{} {
97 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
98 candidates := android.FirstUniqueStrings(android.Concat(partitionVars.ProductPackages, partitionVars.ProductPackagesDebug))
99
100 generatedPartitions := []string{"system"}
101 if ctx.DeviceConfig().SystemExtPath() == "system_ext" {
102 generatedPartitions = append(generatedPartitions, "system_ext")
103 }
Spandan Dase3b65312024-10-22 00:27:27 +0000104 if ctx.DeviceConfig().BuildingVendorImage() && ctx.DeviceConfig().VendorPath() == "vendor" {
105 generatedPartitions = append(generatedPartitions, "vendor")
106 }
Jihoon Kang6dd13b62024-10-22 23:21:02 +0000107 if ctx.DeviceConfig().BuildingProductImage() && ctx.DeviceConfig().ProductPath() == "product" {
108 generatedPartitions = append(generatedPartitions, "product")
109 }
Jihoon Kang0d545b82024-10-11 00:21:57 +0000110
111 return &FsGenState{
112 depCandidates: candidates,
113 fsDeps: map[string]multilibDeps{
114 // These additional deps are added according to the cuttlefish system image bp.
115 "system": &map[string]*depCandidateProps{
116 "com.android.apex.cts.shim.v1_prebuilt": defaultDepCandidateProps(ctx.Config()),
117 "dex_bootjars": defaultDepCandidateProps(ctx.Config()),
118 "framework_compatibility_matrix.device.xml": defaultDepCandidateProps(ctx.Config()),
119 "idc_data": defaultDepCandidateProps(ctx.Config()),
120 "init.environ.rc-soong": defaultDepCandidateProps(ctx.Config()),
121 "keychars_data": defaultDepCandidateProps(ctx.Config()),
122 "keylayout_data": defaultDepCandidateProps(ctx.Config()),
123 "libclang_rt.asan": defaultDepCandidateProps(ctx.Config()),
124 "libcompiler_rt": defaultDepCandidateProps(ctx.Config()),
125 "libdmabufheap": defaultDepCandidateProps(ctx.Config()),
126 "libgsi": defaultDepCandidateProps(ctx.Config()),
127 "llndk.libraries.txt": defaultDepCandidateProps(ctx.Config()),
128 "logpersist.start": defaultDepCandidateProps(ctx.Config()),
129 "preloaded-classes": defaultDepCandidateProps(ctx.Config()),
130 "public.libraries.android.txt": defaultDepCandidateProps(ctx.Config()),
131 "update_engine_sideload": defaultDepCandidateProps(ctx.Config()),
132 },
Spandan Dasd9875bc2024-10-17 21:36:17 +0000133 "vendor": newMultilibDeps(),
134 "odm": newMultilibDeps(),
135 "product": newMultilibDeps(),
136 "system_ext": &map[string]*depCandidateProps{
137 // VNDK apexes are automatically included.
138 // This hardcoded list will need to be updated if `PRODUCT_EXTRA_VNDK_VERSIONS` is updated.
139 // https://cs.android.com/android/_/android/platform/build/+/adba533072b00c53ac0f198c550a3cbd7a00e4cd:core/main.mk;l=984;bpv=1;bpt=0;drc=174db7b179592cf07cbfd2adb0119486fda911e7
140 "com.android.vndk.v30": defaultDepCandidateProps(ctx.Config()),
141 "com.android.vndk.v31": defaultDepCandidateProps(ctx.Config()),
142 "com.android.vndk.v32": defaultDepCandidateProps(ctx.Config()),
143 "com.android.vndk.v33": defaultDepCandidateProps(ctx.Config()),
144 "com.android.vndk.v34": defaultDepCandidateProps(ctx.Config()),
145 },
Jihoon Kang0d545b82024-10-11 00:21:57 +0000146 },
147 soongGeneratedPartitions: generatedPartitions,
148 fsDepsMutex: sync.Mutex{},
149 }
150 }).(*FsGenState)
151}
152
153func checkDepModuleInMultipleNamespaces(mctx android.BottomUpMutatorContext, foundDeps map[string]*depCandidateProps, module string, partitionName string) {
154 otherNamespace := mctx.Namespace().Path
155 if val, found := foundDeps[module]; found && otherNamespace != "." && !android.InList(val.Namespace, []string{".", otherNamespace}) {
156 mctx.ModuleErrorf("found in multiple namespaces(%s and %s) when including in %s partition", val.Namespace, otherNamespace, partitionName)
157 }
158}
159
160func appendDepIfAppropriate(mctx android.BottomUpMutatorContext, deps *map[string]*depCandidateProps, installPartition string) {
161 checkDepModuleInMultipleNamespaces(mctx, *deps, mctx.Module().Name(), installPartition)
162 if _, ok := (*deps)[mctx.Module().Name()]; ok {
163 // Prefer the namespace-specific module over the platform module
164 if mctx.Namespace().Path != "." {
165 (*deps)[mctx.Module().Name()].Namespace = mctx.Namespace().Path
166 }
167 (*deps)[mctx.Module().Name()].Arch = append((*deps)[mctx.Module().Name()].Arch, mctx.Module().Target().Arch.ArchType)
168 } else {
169 multilib, _ := mctx.Module().DecodeMultilib(mctx)
170 (*deps)[mctx.Module().Name()] = &depCandidateProps{
171 Namespace: mctx.Namespace().Path,
172 Multilib: multilib,
173 Arch: []android.ArchType{mctx.Module().Target().Arch.ArchType},
174 }
175 }
176}
mrziwang8f86c882024-10-03 12:34:33 -0700177
178func collectDepsMutator(mctx android.BottomUpMutatorContext) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000179 fsGenState := mctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
mrziwang8f86c882024-10-03 12:34:33 -0700180
181 m := mctx.Module()
Spandan Dasfcc07c02024-10-21 23:33:43 +0000182 if m.Target().Os.Class == android.Device && slices.Contains(fsGenState.depCandidates, m.Name()) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000183 installPartition := m.PartitionTag(mctx.DeviceConfig())
184 fsGenState.fsDepsMutex.Lock()
185 // Only add the module as dependency when:
186 // - its enabled
187 // - its namespace is included in PRODUCT_SOONG_NAMESPACES
188 if m.Enabled(mctx) && m.ExportedToMake() {
189 appendDepIfAppropriate(mctx, fsGenState.fsDeps[installPartition], installPartition)
190 }
191 fsGenState.fsDepsMutex.Unlock()
192 }
193}
194
195type depsStruct struct {
196 Deps []string
197}
198
199type multilibDepsStruct struct {
200 Common depsStruct
201 Lib32 depsStruct
202 Lib64 depsStruct
203 Both depsStruct
204 Prefer32 depsStruct
205}
206
207type packagingPropsStruct struct {
208 Deps []string
209 Multilib multilibDepsStruct
210}
211
212func fullyQualifiedModuleName(moduleName, namespace string) string {
213 if namespace == "." {
214 return moduleName
215 }
216 return fmt.Sprintf("//%s:%s", namespace, moduleName)
217}
218
Jihoon Kang0d545b82024-10-11 00:21:57 +0000219func getBitness(archTypes []android.ArchType) (ret []string) {
220 for _, archType := range archTypes {
221 if archType.Multilib == "" {
222 ret = append(ret, android.COMMON_VARIANT)
223 } else {
224 ret = append(ret, archType.Bitness())
225 }
226 }
227 return ret
228}
229
230func setDepsMutator(mctx android.BottomUpMutatorContext) {
231 fsGenState := mctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
232 fsDeps := fsGenState.fsDeps
233 soongGeneratedPartitionMap := getAllSoongGeneratedPartitionNames(mctx.Config(), fsGenState.soongGeneratedPartitions)
234 m := mctx.Module()
235 if partition, ok := soongGeneratedPartitionMap[m.Name()]; ok {
mrziwang2a506cf2024-10-17 15:38:37 -0700236 depsStruct := generateDepStruct(*fsDeps[partition])
237 if err := proptools.AppendMatchingProperties(m.GetProperties(), depsStruct, nil); err != nil {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000238 mctx.ModuleErrorf(err.Error())
mrziwang8f86c882024-10-03 12:34:33 -0700239 }
240 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000241}
242
mrziwang2a506cf2024-10-17 15:38:37 -0700243func generateDepStruct(deps map[string]*depCandidateProps) *packagingPropsStruct {
244 depsStruct := packagingPropsStruct{}
245 for depName, depProps := range deps {
246 bitness := getBitness(depProps.Arch)
247 fullyQualifiedDepName := fullyQualifiedModuleName(depName, depProps.Namespace)
248 if android.InList("32", bitness) && android.InList("64", bitness) {
249 // If both 32 and 64 bit variants are enabled for this module
250 switch depProps.Multilib {
251 case string(android.MultilibBoth):
252 depsStruct.Multilib.Both.Deps = append(depsStruct.Multilib.Both.Deps, fullyQualifiedDepName)
253 case string(android.MultilibCommon), string(android.MultilibFirst):
254 depsStruct.Deps = append(depsStruct.Deps, fullyQualifiedDepName)
255 case "32":
256 depsStruct.Multilib.Lib32.Deps = append(depsStruct.Multilib.Lib32.Deps, fullyQualifiedDepName)
257 case "64", "darwin_universal":
258 depsStruct.Multilib.Lib64.Deps = append(depsStruct.Multilib.Lib64.Deps, fullyQualifiedDepName)
259 case "prefer32", "first_prefer32":
260 depsStruct.Multilib.Prefer32.Deps = append(depsStruct.Multilib.Prefer32.Deps, fullyQualifiedDepName)
261 default:
262 depsStruct.Multilib.Both.Deps = append(depsStruct.Multilib.Both.Deps, fullyQualifiedDepName)
263 }
264 } else if android.InList("64", bitness) {
265 // If only 64 bit variant is enabled
266 depsStruct.Multilib.Lib64.Deps = append(depsStruct.Multilib.Lib64.Deps, fullyQualifiedDepName)
267 } else if android.InList("32", bitness) {
268 // If only 32 bit variant is enabled
269 depsStruct.Multilib.Lib32.Deps = append(depsStruct.Multilib.Lib32.Deps, fullyQualifiedDepName)
270 } else {
271 // If only common variant is enabled
272 depsStruct.Multilib.Common.Deps = append(depsStruct.Multilib.Common.Deps, fullyQualifiedDepName)
273 }
274 }
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000275 depsStruct.Deps = android.SortedUniqueStrings(depsStruct.Deps)
276 depsStruct.Multilib.Lib32.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Lib32.Deps)
277 depsStruct.Multilib.Lib64.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Lib64.Deps)
278 depsStruct.Multilib.Prefer32.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Prefer32.Deps)
279 depsStruct.Multilib.Both.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Both.Deps)
280 depsStruct.Multilib.Common.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Common.Deps)
281
mrziwang2a506cf2024-10-17 15:38:37 -0700282 return &depsStruct
283}
284
Cole Faust92ccbe22024-10-03 14:38:37 -0700285type filesystemCreatorProps struct {
286 Generated_partition_types []string `blueprint:"mutated"`
287 Unsupported_partition_types []string `blueprint:"mutated"`
288}
289
Jihoon Kang98047cf2024-10-02 17:13:54 +0000290type filesystemCreator struct {
291 android.ModuleBase
Cole Faust92ccbe22024-10-03 14:38:37 -0700292
293 properties filesystemCreatorProps
Jihoon Kang98047cf2024-10-02 17:13:54 +0000294}
295
296func filesystemCreatorFactory() android.Module {
297 module := &filesystemCreator{}
298
Cole Faust69788792024-10-10 11:00:36 -0700299 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
Cole Faust92ccbe22024-10-03 14:38:37 -0700300 module.AddProperties(&module.properties)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000301 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000302 createFsGenState(ctx)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000303 module.createInternalModules(ctx)
304 })
305
306 return module
307}
308
309func (f *filesystemCreator) createInternalModules(ctx android.LoadHookContext) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000310 soongGeneratedPartitions := &ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions
311 for _, partitionType := range *soongGeneratedPartitions {
Cole Faust92ccbe22024-10-03 14:38:37 -0700312 if f.createPartition(ctx, partitionType) {
313 f.properties.Generated_partition_types = append(f.properties.Generated_partition_types, partitionType)
314 } else {
315 f.properties.Unsupported_partition_types = append(f.properties.Unsupported_partition_types, partitionType)
Jihoon Kang0d545b82024-10-11 00:21:57 +0000316 _, *soongGeneratedPartitions = android.RemoveFromList(partitionType, *soongGeneratedPartitions)
Cole Faust92ccbe22024-10-03 14:38:37 -0700317 }
318 }
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000319 f.createDeviceModule(ctx)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000320}
321
Jihoon Kang0d545b82024-10-11 00:21:57 +0000322func generatedModuleName(cfg android.Config, suffix string) string {
Cole Faust92ccbe22024-10-03 14:38:37 -0700323 prefix := "soong"
324 if cfg.HasDeviceProduct() {
325 prefix = cfg.DeviceProduct()
326 }
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000327 return fmt.Sprintf("%s_generated_%s", prefix, suffix)
328}
329
Jihoon Kang0d545b82024-10-11 00:21:57 +0000330func generatedModuleNameForPartition(cfg android.Config, partitionType string) string {
331 return generatedModuleName(cfg, fmt.Sprintf("%s_image", partitionType))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000332}
333
334func (f *filesystemCreator) createDeviceModule(ctx android.LoadHookContext) {
335 baseProps := &struct {
336 Name *string
337 }{
Jihoon Kang0d545b82024-10-11 00:21:57 +0000338 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "device")),
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000339 }
340
Priyanka Advani (xWF)dafaa7f2024-10-21 22:55:13 +0000341 // Currently, only the system and system_ext partition module is created.
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000342 partitionProps := &filesystem.PartitionNameProperties{}
343 if android.InList("system", f.properties.Generated_partition_types) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000344 partitionProps.System_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000345 }
Spandan Das7a46f6c2024-10-14 18:41:18 +0000346 if android.InList("system_ext", f.properties.Generated_partition_types) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000347 partitionProps.System_ext_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
Spandan Das7a46f6c2024-10-14 18:41:18 +0000348 }
Spandan Dase3b65312024-10-22 00:27:27 +0000349 if android.InList("vendor", f.properties.Generated_partition_types) {
350 partitionProps.Vendor_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "vendor"))
351 }
Jihoon Kang6dd13b62024-10-22 23:21:02 +0000352 if android.InList("product", f.properties.Generated_partition_types) {
353 partitionProps.Product_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "product"))
354 }
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000355
356 ctx.CreateModule(filesystem.AndroidDeviceFactory, baseProps, partitionProps)
Cole Faust92ccbe22024-10-03 14:38:37 -0700357}
358
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000359func partitionSpecificFsProps(fsProps *filesystem.FilesystemProperties, partitionType string) {
360 switch partitionType {
361 case "system":
362 fsProps.Build_logtags = proptools.BoolPtr(true)
363 // https://source.corp.google.com/h/googleplex-android/platform/build//639d79f5012a6542ab1f733b0697db45761ab0f3:core/packaging/flags.mk;l=21;drc=5ba8a8b77507f93aa48cc61c5ba3f31a4d0cbf37;bpv=1;bpt=0
364 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
365 case "product":
366 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
367 case "vendor":
368 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
369 }
370}
Spandan Dascbe641a2024-10-14 21:07:34 +0000371
Cole Faust92ccbe22024-10-03 14:38:37 -0700372// Creates a soong module to build the given partition. Returns false if we can't support building
373// it.
374func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700375 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
376
377 fsProps, supported := generateFsProps(ctx, partitionType)
378 if !supported {
379 return false
mrziwanga077b942024-10-16 16:00:06 -0700380 }
mrziwanga077b942024-10-16 16:00:06 -0700381
mrziwang4b0ca972024-10-17 14:56:19 -0700382 var module android.Module
383 if partitionType == "system" {
384 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
385 } else {
386 // Explicitly set the partition.
387 fsProps.Partition_type = proptools.StringPtr(partitionType)
388 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
389 }
390 module.HideFromMake()
391 return true
392}
393
394type filesystemBaseProperty struct {
395 Name *string
396 Compile_multilib *string
397}
398
399func generateBaseProps(namePtr *string) *filesystemBaseProperty {
400 return &filesystemBaseProperty{
401 Name: namePtr,
402 Compile_multilib: proptools.StringPtr("both"),
403 }
404}
405
406func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700407 fsProps := &filesystem.FilesystemProperties{}
408
mrziwang4b0ca972024-10-17 14:56:19 -0700409 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
410 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
411
412 // BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE
413 fsType := specificPartitionVars.BoardFileSystemType
414 if fsType == "" {
415 fsType = "ext4" //default
416 }
417 fsProps.Type = proptools.StringPtr(fsType)
418 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
419 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
420 return nil, false
421 }
422
Cole Faust92ccbe22024-10-03 14:38:37 -0700423 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
424 // and sometimes don't build.
425 fsProps.Unchecked_module = proptools.BoolPtr(true)
426
Jihoon Kang98047cf2024-10-02 17:13:54 +0000427 // BOARD_AVB_ENABLE
428 fsProps.Use_avb = proptools.BoolPtr(partitionVars.BoardAvbEnable)
429 // BOARD_AVB_KEY_PATH
Cole Faust92ccbe22024-10-03 14:38:37 -0700430 fsProps.Avb_private_key = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000431 // BOARD_AVB_ALGORITHM
Cole Faust92ccbe22024-10-03 14:38:37 -0700432 fsProps.Avb_algorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000433 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust92ccbe22024-10-03 14:38:37 -0700434 if rollbackIndex, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64); err == nil {
Jihoon Kang98047cf2024-10-02 17:13:54 +0000435 fsProps.Rollback_index = proptools.Int64Ptr(rollbackIndex)
436 }
437
Cole Faust92ccbe22024-10-03 14:38:37 -0700438 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000439
Cole Faust92ccbe22024-10-03 14:38:37 -0700440 fsProps.Base_dir = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000441
Jihoon Kang0d545b82024-10-11 00:21:57 +0000442 fsProps.Is_auto_generated = proptools.BoolPtr(true)
443
Jihoon Kang98047cf2024-10-02 17:13:54 +0000444 // Identical to that of the generic_system_image
445 fsProps.Fsverity.Inputs = []string{
446 "etc/boot-image.prof",
447 "etc/dirty-image-objects",
448 "etc/preloaded-classes",
449 "etc/classpaths/*.pb",
450 "framework/*",
451 "framework/*/*", // framework/{arch}
452 "framework/oat/*/*", // framework/oat/{arch}
453 }
Jihoon Kang3c7be412024-10-10 22:14:22 +0000454 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Jihoon Kang98047cf2024-10-02 17:13:54 +0000455
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000456 partitionSpecificFsProps(fsProps, partitionType)
457
Jihoon Kang98047cf2024-10-02 17:13:54 +0000458 // system_image properties that are not set:
459 // - filesystemProperties.Avb_hash_algorithm
460 // - filesystemProperties.File_contexts
461 // - filesystemProperties.Dirs
462 // - filesystemProperties.Symlinks
463 // - filesystemProperties.Fake_timestamp
464 // - filesystemProperties.Uuid
465 // - filesystemProperties.Mount_point
466 // - filesystemProperties.Include_make_built_files
467 // - filesystemProperties.Build_logtags
Jihoon Kang98047cf2024-10-02 17:13:54 +0000468 // - systemImageProperties.Linker_config_src
mrziwang4b0ca972024-10-17 14:56:19 -0700469
470 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700471}
472
473func (f *filesystemCreator) createDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000474 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700475 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
476 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
477 if !ok {
478 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
479 }
480 makeFileList := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/obj/PACKAGING/%s_intermediates/file_list.txt", ctx.Config().DeviceName(), partitionType))
481 // For now, don't allowlist anything. The test will fail, but that's fine in the current
482 // early stages where we're just figuring out what we need
Jihoon Kang9e866c82024-10-07 22:39:18 +0000483 emptyAllowlistFile := android.PathForModuleOut(ctx, fmt.Sprintf("allowlist_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700484 android.WriteFileRule(ctx, emptyAllowlistFile, "")
Jihoon Kang9e866c82024-10-07 22:39:18 +0000485 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700486
487 builder := android.NewRuleBuilder(pctx, ctx)
488 builder.Command().BuiltTool("file_list_diff").
489 Input(makeFileList).
490 Input(filesystemInfo.FileListFile).
Jihoon Kang9e866c82024-10-07 22:39:18 +0000491 Text(partitionModuleName).
492 FlagWithInput("--allowlists ", emptyAllowlistFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700493 builder.Command().Text("touch").Output(diffTestResultFile)
494 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
495 return diffTestResultFile
496}
497
498func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
499 hasher := sha256.New()
500 hasher.Write([]byte(message))
501 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
502 file := android.PathForModuleOut(ctx, filename)
503 builder := android.NewRuleBuilder(pctx, ctx)
504 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
505 builder.Command().Text("exit 1 #").Output(file)
506 builder.Build("failing command "+filename, "failing command "+filename)
507 return file
508}
509
510type systemImageDepTagType struct {
511 blueprint.BaseDependencyTag
512}
513
514var generatedFilesystemDepTag systemImageDepTagType
515
516func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
517 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000518 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700519 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000520}
521
522func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700523 if ctx.ModuleDir() != "build/soong/fsgen" {
524 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
525 }
526 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000527
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000528 var content strings.Builder
529 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
530 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
531 content.WriteString(generateBpContent(ctx, partition))
532 content.WriteString("\n")
533 }
534 android.WriteFileRule(ctx, generatedBp, content.String())
535
mrziwang8f86c882024-10-03 12:34:33 -0700536 ctx.Phony("product_config_to_bp", generatedBp)
537
Cole Faust92ccbe22024-10-03 14:38:37 -0700538 var diffTestFiles []android.Path
539 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000540 diffTestFile := f.createDiffTest(ctx, partitionType)
541 diffTestFiles = append(diffTestFiles, diffTestFile)
542 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700543 }
544 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000545 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
546 diffTestFiles = append(diffTestFiles, diffTestFile)
547 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700548 }
549 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000550}
mrziwang8f86c882024-10-03 12:34:33 -0700551
mrziwang8f86c882024-10-03 12:34:33 -0700552func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -0700553 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
554 if !fsTypeSupported {
555 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700556 }
557
mrziwang4b0ca972024-10-17 14:56:19 -0700558 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
mrziwang2a506cf2024-10-17 15:38:37 -0700559 deps := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).fsDeps[partitionType]
560 depProps := generateDepStruct(*deps)
mrziwang8f86c882024-10-03 12:34:33 -0700561
mrziwang4b0ca972024-10-17 14:56:19 -0700562 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -0700563 if err != nil {
564 ctx.ModuleErrorf(err.Error())
565 }
566
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000567 moduleType := "android_filesystem"
568 if partitionType == "system" {
569 moduleType = "android_system_image"
570 }
571
mrziwang8f86c882024-10-03 12:34:33 -0700572 file := &parser.File{
573 Defs: []parser.Definition{
574 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000575 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -0700576 Map: *result,
577 },
578 },
579 }
580 bytes, err := parser.Print(file)
581 if err != nil {
582 ctx.ModuleErrorf(err.Error())
583 }
584 return strings.TrimSpace(string(bytes))
585}