blob: 8fcaa20c460a53db3199223f5849eed81506917c [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 Kang0d545b82024-10-11 00:21:57 +0000107
108 return &FsGenState{
109 depCandidates: candidates,
110 fsDeps: map[string]multilibDeps{
111 // These additional deps are added according to the cuttlefish system image bp.
112 "system": &map[string]*depCandidateProps{
113 "com.android.apex.cts.shim.v1_prebuilt": defaultDepCandidateProps(ctx.Config()),
114 "dex_bootjars": defaultDepCandidateProps(ctx.Config()),
115 "framework_compatibility_matrix.device.xml": defaultDepCandidateProps(ctx.Config()),
116 "idc_data": defaultDepCandidateProps(ctx.Config()),
117 "init.environ.rc-soong": defaultDepCandidateProps(ctx.Config()),
118 "keychars_data": defaultDepCandidateProps(ctx.Config()),
119 "keylayout_data": defaultDepCandidateProps(ctx.Config()),
120 "libclang_rt.asan": defaultDepCandidateProps(ctx.Config()),
121 "libcompiler_rt": defaultDepCandidateProps(ctx.Config()),
122 "libdmabufheap": defaultDepCandidateProps(ctx.Config()),
123 "libgsi": defaultDepCandidateProps(ctx.Config()),
124 "llndk.libraries.txt": defaultDepCandidateProps(ctx.Config()),
125 "logpersist.start": defaultDepCandidateProps(ctx.Config()),
126 "preloaded-classes": defaultDepCandidateProps(ctx.Config()),
127 "public.libraries.android.txt": defaultDepCandidateProps(ctx.Config()),
128 "update_engine_sideload": defaultDepCandidateProps(ctx.Config()),
129 },
Spandan Dasd9875bc2024-10-17 21:36:17 +0000130 "vendor": newMultilibDeps(),
131 "odm": newMultilibDeps(),
132 "product": newMultilibDeps(),
133 "system_ext": &map[string]*depCandidateProps{
134 // VNDK apexes are automatically included.
135 // This hardcoded list will need to be updated if `PRODUCT_EXTRA_VNDK_VERSIONS` is updated.
136 // https://cs.android.com/android/_/android/platform/build/+/adba533072b00c53ac0f198c550a3cbd7a00e4cd:core/main.mk;l=984;bpv=1;bpt=0;drc=174db7b179592cf07cbfd2adb0119486fda911e7
137 "com.android.vndk.v30": defaultDepCandidateProps(ctx.Config()),
138 "com.android.vndk.v31": defaultDepCandidateProps(ctx.Config()),
139 "com.android.vndk.v32": defaultDepCandidateProps(ctx.Config()),
140 "com.android.vndk.v33": defaultDepCandidateProps(ctx.Config()),
141 "com.android.vndk.v34": defaultDepCandidateProps(ctx.Config()),
142 },
Jihoon Kang0d545b82024-10-11 00:21:57 +0000143 },
144 soongGeneratedPartitions: generatedPartitions,
145 fsDepsMutex: sync.Mutex{},
146 }
147 }).(*FsGenState)
148}
149
150func checkDepModuleInMultipleNamespaces(mctx android.BottomUpMutatorContext, foundDeps map[string]*depCandidateProps, module string, partitionName string) {
151 otherNamespace := mctx.Namespace().Path
152 if val, found := foundDeps[module]; found && otherNamespace != "." && !android.InList(val.Namespace, []string{".", otherNamespace}) {
153 mctx.ModuleErrorf("found in multiple namespaces(%s and %s) when including in %s partition", val.Namespace, otherNamespace, partitionName)
154 }
155}
156
157func appendDepIfAppropriate(mctx android.BottomUpMutatorContext, deps *map[string]*depCandidateProps, installPartition string) {
158 checkDepModuleInMultipleNamespaces(mctx, *deps, mctx.Module().Name(), installPartition)
159 if _, ok := (*deps)[mctx.Module().Name()]; ok {
160 // Prefer the namespace-specific module over the platform module
161 if mctx.Namespace().Path != "." {
162 (*deps)[mctx.Module().Name()].Namespace = mctx.Namespace().Path
163 }
164 (*deps)[mctx.Module().Name()].Arch = append((*deps)[mctx.Module().Name()].Arch, mctx.Module().Target().Arch.ArchType)
165 } else {
166 multilib, _ := mctx.Module().DecodeMultilib(mctx)
167 (*deps)[mctx.Module().Name()] = &depCandidateProps{
168 Namespace: mctx.Namespace().Path,
169 Multilib: multilib,
170 Arch: []android.ArchType{mctx.Module().Target().Arch.ArchType},
171 }
172 }
173}
mrziwang8f86c882024-10-03 12:34:33 -0700174
175func collectDepsMutator(mctx android.BottomUpMutatorContext) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000176 fsGenState := mctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
mrziwang8f86c882024-10-03 12:34:33 -0700177
178 m := mctx.Module()
Jihoon Kang0d545b82024-10-11 00:21:57 +0000179 if slices.Contains(fsGenState.depCandidates, m.Name()) {
180 installPartition := m.PartitionTag(mctx.DeviceConfig())
181 fsGenState.fsDepsMutex.Lock()
182 // Only add the module as dependency when:
183 // - its enabled
184 // - its namespace is included in PRODUCT_SOONG_NAMESPACES
185 if m.Enabled(mctx) && m.ExportedToMake() {
186 appendDepIfAppropriate(mctx, fsGenState.fsDeps[installPartition], installPartition)
187 }
188 fsGenState.fsDepsMutex.Unlock()
189 }
190}
191
192type depsStruct struct {
193 Deps []string
194}
195
196type multilibDepsStruct struct {
197 Common depsStruct
198 Lib32 depsStruct
199 Lib64 depsStruct
200 Both depsStruct
201 Prefer32 depsStruct
202}
203
204type packagingPropsStruct struct {
205 Deps []string
206 Multilib multilibDepsStruct
207}
208
209func fullyQualifiedModuleName(moduleName, namespace string) string {
210 if namespace == "." {
211 return moduleName
212 }
213 return fmt.Sprintf("//%s:%s", namespace, moduleName)
214}
215
Jihoon Kang0d545b82024-10-11 00:21:57 +0000216func getBitness(archTypes []android.ArchType) (ret []string) {
217 for _, archType := range archTypes {
218 if archType.Multilib == "" {
219 ret = append(ret, android.COMMON_VARIANT)
220 } else {
221 ret = append(ret, archType.Bitness())
222 }
223 }
224 return ret
225}
226
227func setDepsMutator(mctx android.BottomUpMutatorContext) {
228 fsGenState := mctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
229 fsDeps := fsGenState.fsDeps
230 soongGeneratedPartitionMap := getAllSoongGeneratedPartitionNames(mctx.Config(), fsGenState.soongGeneratedPartitions)
231 m := mctx.Module()
232 if partition, ok := soongGeneratedPartitionMap[m.Name()]; ok {
mrziwang2a506cf2024-10-17 15:38:37 -0700233 depsStruct := generateDepStruct(*fsDeps[partition])
234 if err := proptools.AppendMatchingProperties(m.GetProperties(), depsStruct, nil); err != nil {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000235 mctx.ModuleErrorf(err.Error())
mrziwang8f86c882024-10-03 12:34:33 -0700236 }
237 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000238}
239
mrziwang2a506cf2024-10-17 15:38:37 -0700240func generateDepStruct(deps map[string]*depCandidateProps) *packagingPropsStruct {
241 depsStruct := packagingPropsStruct{}
242 for depName, depProps := range deps {
243 bitness := getBitness(depProps.Arch)
244 fullyQualifiedDepName := fullyQualifiedModuleName(depName, depProps.Namespace)
245 if android.InList("32", bitness) && android.InList("64", bitness) {
246 // If both 32 and 64 bit variants are enabled for this module
247 switch depProps.Multilib {
248 case string(android.MultilibBoth):
249 depsStruct.Multilib.Both.Deps = append(depsStruct.Multilib.Both.Deps, fullyQualifiedDepName)
250 case string(android.MultilibCommon), string(android.MultilibFirst):
251 depsStruct.Deps = append(depsStruct.Deps, fullyQualifiedDepName)
252 case "32":
253 depsStruct.Multilib.Lib32.Deps = append(depsStruct.Multilib.Lib32.Deps, fullyQualifiedDepName)
254 case "64", "darwin_universal":
255 depsStruct.Multilib.Lib64.Deps = append(depsStruct.Multilib.Lib64.Deps, fullyQualifiedDepName)
256 case "prefer32", "first_prefer32":
257 depsStruct.Multilib.Prefer32.Deps = append(depsStruct.Multilib.Prefer32.Deps, fullyQualifiedDepName)
258 default:
259 depsStruct.Multilib.Both.Deps = append(depsStruct.Multilib.Both.Deps, fullyQualifiedDepName)
260 }
261 } else if android.InList("64", bitness) {
262 // If only 64 bit variant is enabled
263 depsStruct.Multilib.Lib64.Deps = append(depsStruct.Multilib.Lib64.Deps, fullyQualifiedDepName)
264 } else if android.InList("32", bitness) {
265 // If only 32 bit variant is enabled
266 depsStruct.Multilib.Lib32.Deps = append(depsStruct.Multilib.Lib32.Deps, fullyQualifiedDepName)
267 } else {
268 // If only common variant is enabled
269 depsStruct.Multilib.Common.Deps = append(depsStruct.Multilib.Common.Deps, fullyQualifiedDepName)
270 }
271 }
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000272 depsStruct.Deps = android.SortedUniqueStrings(depsStruct.Deps)
273 depsStruct.Multilib.Lib32.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Lib32.Deps)
274 depsStruct.Multilib.Lib64.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Lib64.Deps)
275 depsStruct.Multilib.Prefer32.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Prefer32.Deps)
276 depsStruct.Multilib.Both.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Both.Deps)
277 depsStruct.Multilib.Common.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Common.Deps)
278
mrziwang2a506cf2024-10-17 15:38:37 -0700279 return &depsStruct
280}
281
Cole Faust92ccbe22024-10-03 14:38:37 -0700282type filesystemCreatorProps struct {
283 Generated_partition_types []string `blueprint:"mutated"`
284 Unsupported_partition_types []string `blueprint:"mutated"`
285}
286
Jihoon Kang98047cf2024-10-02 17:13:54 +0000287type filesystemCreator struct {
288 android.ModuleBase
Cole Faust92ccbe22024-10-03 14:38:37 -0700289
290 properties filesystemCreatorProps
Jihoon Kang98047cf2024-10-02 17:13:54 +0000291}
292
293func filesystemCreatorFactory() android.Module {
294 module := &filesystemCreator{}
295
Cole Faust69788792024-10-10 11:00:36 -0700296 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
Cole Faust92ccbe22024-10-03 14:38:37 -0700297 module.AddProperties(&module.properties)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000298 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000299 createFsGenState(ctx)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000300 module.createInternalModules(ctx)
301 })
302
303 return module
304}
305
306func (f *filesystemCreator) createInternalModules(ctx android.LoadHookContext) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000307 soongGeneratedPartitions := &ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions
308 for _, partitionType := range *soongGeneratedPartitions {
Cole Faust92ccbe22024-10-03 14:38:37 -0700309 if f.createPartition(ctx, partitionType) {
310 f.properties.Generated_partition_types = append(f.properties.Generated_partition_types, partitionType)
311 } else {
312 f.properties.Unsupported_partition_types = append(f.properties.Unsupported_partition_types, partitionType)
Jihoon Kang0d545b82024-10-11 00:21:57 +0000313 _, *soongGeneratedPartitions = android.RemoveFromList(partitionType, *soongGeneratedPartitions)
Cole Faust92ccbe22024-10-03 14:38:37 -0700314 }
315 }
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000316 f.createDeviceModule(ctx)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000317}
318
Jihoon Kang0d545b82024-10-11 00:21:57 +0000319func generatedModuleName(cfg android.Config, suffix string) string {
Cole Faust92ccbe22024-10-03 14:38:37 -0700320 prefix := "soong"
321 if cfg.HasDeviceProduct() {
322 prefix = cfg.DeviceProduct()
323 }
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000324 return fmt.Sprintf("%s_generated_%s", prefix, suffix)
325}
326
Jihoon Kang0d545b82024-10-11 00:21:57 +0000327func generatedModuleNameForPartition(cfg android.Config, partitionType string) string {
328 return generatedModuleName(cfg, fmt.Sprintf("%s_image", partitionType))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000329}
330
331func (f *filesystemCreator) createDeviceModule(ctx android.LoadHookContext) {
332 baseProps := &struct {
333 Name *string
334 }{
Jihoon Kang0d545b82024-10-11 00:21:57 +0000335 Name: proptools.StringPtr(generatedModuleName(ctx.Config(), "device")),
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000336 }
337
Priyanka Advani (xWF)dafaa7f2024-10-21 22:55:13 +0000338 // Currently, only the system and system_ext partition module is created.
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000339 partitionProps := &filesystem.PartitionNameProperties{}
340 if android.InList("system", f.properties.Generated_partition_types) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000341 partitionProps.System_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system"))
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000342 }
Spandan Das7a46f6c2024-10-14 18:41:18 +0000343 if android.InList("system_ext", f.properties.Generated_partition_types) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000344 partitionProps.System_ext_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "system_ext"))
Spandan Das7a46f6c2024-10-14 18:41:18 +0000345 }
Spandan Dase3b65312024-10-22 00:27:27 +0000346 if android.InList("vendor", f.properties.Generated_partition_types) {
347 partitionProps.Vendor_partition_name = proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), "vendor"))
348 }
Jihoon Kangf1c79ca2024-10-09 20:18:38 +0000349
350 ctx.CreateModule(filesystem.AndroidDeviceFactory, baseProps, partitionProps)
Cole Faust92ccbe22024-10-03 14:38:37 -0700351}
352
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000353func partitionSpecificFsProps(fsProps *filesystem.FilesystemProperties, partitionType string) {
354 switch partitionType {
355 case "system":
356 fsProps.Build_logtags = proptools.BoolPtr(true)
357 // https://source.corp.google.com/h/googleplex-android/platform/build//639d79f5012a6542ab1f733b0697db45761ab0f3:core/packaging/flags.mk;l=21;drc=5ba8a8b77507f93aa48cc61c5ba3f31a4d0cbf37;bpv=1;bpt=0
358 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
359 case "product":
360 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
361 case "vendor":
362 fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)
363 }
364}
Spandan Dascbe641a2024-10-14 21:07:34 +0000365
Cole Faust92ccbe22024-10-03 14:38:37 -0700366// Creates a soong module to build the given partition. Returns false if we can't support building
367// it.
368func (f *filesystemCreator) createPartition(ctx android.LoadHookContext, partitionType string) bool {
mrziwang4b0ca972024-10-17 14:56:19 -0700369 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
370
371 fsProps, supported := generateFsProps(ctx, partitionType)
372 if !supported {
373 return false
mrziwanga077b942024-10-16 16:00:06 -0700374 }
mrziwanga077b942024-10-16 16:00:06 -0700375
mrziwang4b0ca972024-10-17 14:56:19 -0700376 var module android.Module
377 if partitionType == "system" {
378 module = ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)
379 } else {
380 // Explicitly set the partition.
381 fsProps.Partition_type = proptools.StringPtr(partitionType)
382 module = ctx.CreateModule(filesystem.FilesystemFactory, baseProps, fsProps)
383 }
384 module.HideFromMake()
385 return true
386}
387
388type filesystemBaseProperty struct {
389 Name *string
390 Compile_multilib *string
391}
392
393func generateBaseProps(namePtr *string) *filesystemBaseProperty {
394 return &filesystemBaseProperty{
395 Name: namePtr,
396 Compile_multilib: proptools.StringPtr("both"),
397 }
398}
399
400func generateFsProps(ctx android.EarlyModuleContext, partitionType string) (*filesystem.FilesystemProperties, bool) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700401 fsProps := &filesystem.FilesystemProperties{}
402
mrziwang4b0ca972024-10-17 14:56:19 -0700403 partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
404 specificPartitionVars := partitionVars.PartitionQualifiedVariables[partitionType]
405
406 // BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE
407 fsType := specificPartitionVars.BoardFileSystemType
408 if fsType == "" {
409 fsType = "ext4" //default
410 }
411 fsProps.Type = proptools.StringPtr(fsType)
412 if filesystem.GetFsTypeFromString(ctx, *fsProps.Type).IsUnknown() {
413 // Currently the android_filesystem module type only supports a handful of FS types like ext4, erofs
414 return nil, false
415 }
416
Cole Faust92ccbe22024-10-03 14:38:37 -0700417 // Don't build this module on checkbuilds, the soong-built partitions are still in-progress
418 // and sometimes don't build.
419 fsProps.Unchecked_module = proptools.BoolPtr(true)
420
Jihoon Kang98047cf2024-10-02 17:13:54 +0000421 // BOARD_AVB_ENABLE
422 fsProps.Use_avb = proptools.BoolPtr(partitionVars.BoardAvbEnable)
423 // BOARD_AVB_KEY_PATH
Cole Faust92ccbe22024-10-03 14:38:37 -0700424 fsProps.Avb_private_key = proptools.StringPtr(specificPartitionVars.BoardAvbKeyPath)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000425 // BOARD_AVB_ALGORITHM
Cole Faust92ccbe22024-10-03 14:38:37 -0700426 fsProps.Avb_algorithm = proptools.StringPtr(specificPartitionVars.BoardAvbAlgorithm)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000427 // BOARD_AVB_SYSTEM_ROLLBACK_INDEX
Cole Faust92ccbe22024-10-03 14:38:37 -0700428 if rollbackIndex, err := strconv.ParseInt(specificPartitionVars.BoardAvbRollbackIndex, 10, 64); err == nil {
Jihoon Kang98047cf2024-10-02 17:13:54 +0000429 fsProps.Rollback_index = proptools.Int64Ptr(rollbackIndex)
430 }
431
Cole Faust92ccbe22024-10-03 14:38:37 -0700432 fsProps.Partition_name = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000433
Cole Faust92ccbe22024-10-03 14:38:37 -0700434 fsProps.Base_dir = proptools.StringPtr(partitionType)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000435
Jihoon Kang0d545b82024-10-11 00:21:57 +0000436 fsProps.Is_auto_generated = proptools.BoolPtr(true)
437
Jihoon Kang98047cf2024-10-02 17:13:54 +0000438 // Identical to that of the generic_system_image
439 fsProps.Fsverity.Inputs = []string{
440 "etc/boot-image.prof",
441 "etc/dirty-image-objects",
442 "etc/preloaded-classes",
443 "etc/classpaths/*.pb",
444 "framework/*",
445 "framework/*/*", // framework/{arch}
446 "framework/oat/*/*", // framework/oat/{arch}
447 }
Jihoon Kang3c7be412024-10-10 22:14:22 +0000448 fsProps.Fsverity.Libs = []string{":framework-res{.export-package.apk}"}
Jihoon Kang98047cf2024-10-02 17:13:54 +0000449
Jihoon Kang6850d8f2024-10-17 20:45:58 +0000450 partitionSpecificFsProps(fsProps, partitionType)
451
Jihoon Kang98047cf2024-10-02 17:13:54 +0000452 // system_image properties that are not set:
453 // - filesystemProperties.Avb_hash_algorithm
454 // - filesystemProperties.File_contexts
455 // - filesystemProperties.Dirs
456 // - filesystemProperties.Symlinks
457 // - filesystemProperties.Fake_timestamp
458 // - filesystemProperties.Uuid
459 // - filesystemProperties.Mount_point
460 // - filesystemProperties.Include_make_built_files
461 // - filesystemProperties.Build_logtags
Jihoon Kang98047cf2024-10-02 17:13:54 +0000462 // - systemImageProperties.Linker_config_src
mrziwang4b0ca972024-10-17 14:56:19 -0700463
464 return fsProps, true
Cole Faust92ccbe22024-10-03 14:38:37 -0700465}
466
467func (f *filesystemCreator) createDiffTest(ctx android.ModuleContext, partitionType string) android.Path {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000468 partitionModuleName := generatedModuleNameForPartition(ctx.Config(), partitionType)
Cole Faust92ccbe22024-10-03 14:38:37 -0700469 systemImage := ctx.GetDirectDepWithTag(partitionModuleName, generatedFilesystemDepTag)
470 filesystemInfo, ok := android.OtherModuleProvider(ctx, systemImage, filesystem.FilesystemProvider)
471 if !ok {
472 ctx.ModuleErrorf("Expected module %s to provide FileysystemInfo", partitionModuleName)
473 }
474 makeFileList := android.PathForArbitraryOutput(ctx, fmt.Sprintf("target/product/%s/obj/PACKAGING/%s_intermediates/file_list.txt", ctx.Config().DeviceName(), partitionType))
475 // For now, don't allowlist anything. The test will fail, but that's fine in the current
476 // early stages where we're just figuring out what we need
Jihoon Kang9e866c82024-10-07 22:39:18 +0000477 emptyAllowlistFile := android.PathForModuleOut(ctx, fmt.Sprintf("allowlist_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700478 android.WriteFileRule(ctx, emptyAllowlistFile, "")
Jihoon Kang9e866c82024-10-07 22:39:18 +0000479 diffTestResultFile := android.PathForModuleOut(ctx, fmt.Sprintf("diff_test_%s.txt", partitionModuleName))
Cole Faust92ccbe22024-10-03 14:38:37 -0700480
481 builder := android.NewRuleBuilder(pctx, ctx)
482 builder.Command().BuiltTool("file_list_diff").
483 Input(makeFileList).
484 Input(filesystemInfo.FileListFile).
Jihoon Kang9e866c82024-10-07 22:39:18 +0000485 Text(partitionModuleName).
486 FlagWithInput("--allowlists ", emptyAllowlistFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700487 builder.Command().Text("touch").Output(diffTestResultFile)
488 builder.Build(partitionModuleName+" diff test", partitionModuleName+" diff test")
489 return diffTestResultFile
490}
491
492func createFailingCommand(ctx android.ModuleContext, message string) android.Path {
493 hasher := sha256.New()
494 hasher.Write([]byte(message))
495 filename := fmt.Sprintf("failing_command_%x.txt", hasher.Sum(nil))
496 file := android.PathForModuleOut(ctx, filename)
497 builder := android.NewRuleBuilder(pctx, ctx)
498 builder.Command().Textf("echo %s", proptools.NinjaAndShellEscape(message))
499 builder.Command().Text("exit 1 #").Output(file)
500 builder.Build("failing command "+filename, "failing command "+filename)
501 return file
502}
503
504type systemImageDepTagType struct {
505 blueprint.BaseDependencyTag
506}
507
508var generatedFilesystemDepTag systemImageDepTagType
509
510func (f *filesystemCreator) DepsMutator(ctx android.BottomUpMutatorContext) {
511 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000512 ctx.AddDependency(ctx.Module(), generatedFilesystemDepTag, generatedModuleNameForPartition(ctx.Config(), partitionType))
Cole Faust92ccbe22024-10-03 14:38:37 -0700513 }
Jihoon Kang98047cf2024-10-02 17:13:54 +0000514}
515
516func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -0700517 if ctx.ModuleDir() != "build/soong/fsgen" {
518 ctx.ModuleErrorf("There can only be one soong_filesystem_creator in build/soong/fsgen")
519 }
520 f.HideFromMake()
Jihoon Kang98047cf2024-10-02 17:13:54 +0000521
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000522 var content strings.Builder
523 generatedBp := android.PathForModuleOut(ctx, "soong_generated_product_config.bp")
524 for _, partition := range ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).soongGeneratedPartitions {
525 content.WriteString(generateBpContent(ctx, partition))
526 content.WriteString("\n")
527 }
528 android.WriteFileRule(ctx, generatedBp, content.String())
529
mrziwang8f86c882024-10-03 12:34:33 -0700530 ctx.Phony("product_config_to_bp", generatedBp)
531
Cole Faust92ccbe22024-10-03 14:38:37 -0700532 var diffTestFiles []android.Path
533 for _, partitionType := range f.properties.Generated_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000534 diffTestFile := f.createDiffTest(ctx, partitionType)
535 diffTestFiles = append(diffTestFiles, diffTestFile)
536 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700537 }
538 for _, partitionType := range f.properties.Unsupported_partition_types {
Jihoon Kang72f812f2024-10-17 18:46:24 +0000539 diffTestFile := createFailingCommand(ctx, fmt.Sprintf("Couldn't build %s partition", partitionType))
540 diffTestFiles = append(diffTestFiles, diffTestFile)
541 ctx.Phony(fmt.Sprintf("soong_generated_%s_filesystem_test", partitionType), diffTestFile)
Cole Faust92ccbe22024-10-03 14:38:37 -0700542 }
543 ctx.Phony("soong_generated_filesystem_tests", diffTestFiles...)
Jihoon Kang98047cf2024-10-02 17:13:54 +0000544}
mrziwang8f86c882024-10-03 12:34:33 -0700545
mrziwang8f86c882024-10-03 12:34:33 -0700546func generateBpContent(ctx android.EarlyModuleContext, partitionType string) string {
mrziwang4b0ca972024-10-17 14:56:19 -0700547 fsProps, fsTypeSupported := generateFsProps(ctx, partitionType)
548 if !fsTypeSupported {
549 return ""
mrziwang8f86c882024-10-03 12:34:33 -0700550 }
551
mrziwang4b0ca972024-10-17 14:56:19 -0700552 baseProps := generateBaseProps(proptools.StringPtr(generatedModuleNameForPartition(ctx.Config(), partitionType)))
mrziwang2a506cf2024-10-17 15:38:37 -0700553 deps := ctx.Config().Get(fsGenStateOnceKey).(*FsGenState).fsDeps[partitionType]
554 depProps := generateDepStruct(*deps)
mrziwang8f86c882024-10-03 12:34:33 -0700555
mrziwang4b0ca972024-10-17 14:56:19 -0700556 result, err := proptools.RepackProperties([]interface{}{baseProps, fsProps, depProps})
mrziwang8f86c882024-10-03 12:34:33 -0700557 if err != nil {
558 ctx.ModuleErrorf(err.Error())
559 }
560
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000561 moduleType := "android_filesystem"
562 if partitionType == "system" {
563 moduleType = "android_system_image"
564 }
565
mrziwang8f86c882024-10-03 12:34:33 -0700566 file := &parser.File{
567 Defs: []parser.Definition{
568 &parser.Module{
Jihoon Kang4e5d8de2024-10-19 01:59:58 +0000569 Type: moduleType,
mrziwang8f86c882024-10-03 12:34:33 -0700570 Map: *result,
571 },
572 },
573 }
574 bytes, err := parser.Print(file)
575 if err != nil {
576 ctx.ModuleErrorf(err.Error())
577 }
578 return strings.TrimSpace(string(bytes))
579}