blob: af14e811ae3f9be828381919db6adcebd6050a2e [file] [log] [blame]
Jiyong Park6f0f6882020-11-12 13:14:30 +09001// Copyright (C) 2020 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 filesystem
16
17import (
Jooyung Han65f402b2022-04-21 14:24:04 +090018 "crypto/sha256"
Jiyong Park6f0f6882020-11-12 13:14:30 +090019 "fmt"
Jooyung Han65f402b2022-04-21 14:24:04 +090020 "io"
Inseob Kim14199b02021-02-09 21:18:31 +090021 "path/filepath"
Cole Faust4a2a7c92024-03-12 12:44:40 -070022 "slices"
Cole Fauste03ab892025-01-17 13:55:04 -080023 "sort"
Nikita Ioffe2c8cdc62024-03-27 22:19:30 +000024 "strconv"
Inseob Kim14199b02021-02-09 21:18:31 +090025 "strings"
Jiyong Park6f0f6882020-11-12 13:14:30 +090026
27 "android/soong/android"
Jooyung Hane6067592023-03-16 13:11:17 +090028 "android/soong/cc"
Spandan Das71be42d2024-11-20 18:34:16 +000029 "android/soong/java"
Spandan Das92631882024-10-28 22:49:38 +000030 "android/soong/linkerconfig"
Jiyong Park65b62242020-11-25 12:44:59 +090031
32 "github.com/google/blueprint"
Jihoon Kangdd49f412025-03-07 01:30:43 +000033 "github.com/google/blueprint/depset"
Jiyong Park71baa762021-01-18 21:11:03 +090034 "github.com/google/blueprint/proptools"
Jiyong Park6f0f6882020-11-12 13:14:30 +090035)
36
Cole Faust1dcf9e42025-02-19 17:23:34 -080037var pctx = android.NewPackageContext("android/soong/filesystem")
38
Jiyong Park6f0f6882020-11-12 13:14:30 +090039func init() {
Jooyung Han9706cbc2021-04-15 22:43:48 +090040 registerBuildComponents(android.InitRegistrationContext)
Spandan Das71be42d2024-11-20 18:34:16 +000041 registerMutators(android.InitRegistrationContext)
Jihoon Kangf67b7de2025-02-12 01:01:09 +000042 pctx.HostBinToolVariable("fileslist", "fileslist")
Spandan Dasdd262fb2025-02-13 00:15:59 +000043 pctx.HostBinToolVariable("fs_config", "fs_config")
Cole Faust1dcf9e42025-02-19 17:23:34 -080044 pctx.HostBinToolVariable("symbols_map", "symbols_map")
Jooyung Han9706cbc2021-04-15 22:43:48 +090045}
46
47func registerBuildComponents(ctx android.RegistrationContext) {
Cole Faust92ccbe22024-10-03 14:38:37 -070048 ctx.RegisterModuleType("android_filesystem", FilesystemFactory)
Jiyong Parkf46b1af2024-04-05 18:13:33 +090049 ctx.RegisterModuleType("android_filesystem_defaults", filesystemDefaultsFactory)
Jihoon Kang98047cf2024-10-02 17:13:54 +000050 ctx.RegisterModuleType("android_system_image", SystemImageFactory)
Jiyong Parkbc485482022-11-15 22:31:49 +090051 ctx.RegisterModuleType("avb_add_hash_footer", avbAddHashFooterFactory)
Inseob Kim87230e62023-11-22 18:55:07 +090052 ctx.RegisterModuleType("avb_add_hash_footer_defaults", avbAddHashFooterDefaultsFactory)
Alice Wang000e3a32023-01-03 16:11:20 +000053 ctx.RegisterModuleType("avb_gen_vbmeta_image", avbGenVbmetaImageFactory)
Inseob Kim87230e62023-11-22 18:55:07 +090054 ctx.RegisterModuleType("avb_gen_vbmeta_image_defaults", avbGenVbmetaImageDefaultsFactory)
Jiyong Park6f0f6882020-11-12 13:14:30 +090055}
56
Spandan Das71be42d2024-11-20 18:34:16 +000057func registerMutators(ctx android.RegistrationContext) {
58 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
59 ctx.BottomUp("add_autogenerated_rro_deps", addAutogeneratedRroDeps)
60 })
61}
62
Jihoon Kangf67b7de2025-02-12 01:01:09 +000063var (
64 // Remember to add referenced files to implicits!
65 textFileProcessorRule = pctx.AndroidStaticRule("text_file_processing", blueprint.RuleParams{
66 Command: "build/soong/scripts/text_file_processor.py $in $out",
67 CommandDeps: []string{"build/soong/scripts/text_file_processor.py"},
68 })
69
70 // Remember to add the output image file as an implicit dependency!
71 installedFilesJsonRule = pctx.AndroidStaticRule("installed_files_json", blueprint.RuleParams{
72 Command: `${fileslist} ${rootDir} > ${out}`,
73 CommandDeps: []string{"${fileslist}"},
74 }, "rootDir")
75
76 installedFilesTxtRule = pctx.AndroidStaticRule("installed_files_txt", blueprint.RuleParams{
77 Command: `build/make/tools/fileslist_util.py -c ${in} > ${out}`,
78 CommandDeps: []string{"build/make/tools/fileslist_util.py"},
79 })
Spandan Dasdd262fb2025-02-13 00:15:59 +000080 fsConfigRule = pctx.AndroidStaticRule("fs_config_rule", blueprint.RuleParams{
81 Command: `(cd ${rootDir}; find . -type d | sed 's,$$,/,'; find . \! -type d) | cut -c 3- | sort | sed 's,^,${prefix},' | ${fs_config} -C -D ${rootDir} -R "${prefix}" > ${out}`,
82 CommandDeps: []string{"${fs_config}"},
83 }, "rootDir", "prefix")
Jihoon Kangf67b7de2025-02-12 01:01:09 +000084)
Cole Fauste1676122024-12-03 17:32:25 -080085
Jiyong Park6f0f6882020-11-12 13:14:30 +090086type filesystem struct {
87 android.ModuleBase
88 android.PackagingBase
Jiyong Parkf46b1af2024-04-05 18:13:33 +090089 android.DefaultableModuleBase
Jiyong Park65c49f52020-11-24 14:23:26 +090090
Jihoon Kang98047cf2024-10-02 17:13:54 +000091 properties FilesystemProperties
Jiyong Park71baa762021-01-18 21:11:03 +090092
Cole Faust4e9f5922024-11-13 16:09:23 -080093 output android.Path
Jiyong Park65c49f52020-11-24 14:23:26 +090094 installDir android.InstallPath
Jooyung Han0fbbc2b2022-03-25 12:35:46 +090095
Cole Faust4e9f5922024-11-13 16:09:23 -080096 fileListFile android.Path
Kiyoung Kim99a954d2024-06-21 14:22:20 +090097
98 // Keeps the entries installed from this filesystem
Jooyung Han0fbbc2b2022-03-25 12:35:46 +090099 entries []string
Kiyoung Kim67118212024-11-07 13:23:44 +0900100
101 filesystemBuilder filesystemBuilder
Spandan Dasf12ff9b2025-02-12 22:27:43 +0000102
103 selinuxFc android.Path
Jiyong Park6f0f6882020-11-12 13:14:30 +0900104}
105
Kiyoung Kim67118212024-11-07 13:23:44 +0900106type filesystemBuilder interface {
Cole Faust19fbb072025-01-30 18:19:29 -0800107 BuildLinkerConfigFile(ctx android.ModuleContext, builder *android.RuleBuilder, rebasedDir android.OutputPath, fullInstallPaths *[]FullInstallPathInfo)
Kiyoung Kim67118212024-11-07 13:23:44 +0900108 // Function that filters PackagingSpec in PackagingBase.GatherPackagingSpecs()
109 FilterPackagingSpec(spec android.PackagingSpec) bool
Inseob Kim3c0a0422024-11-05 17:21:37 +0900110 // Function that modifies PackagingSpec in PackagingBase.GatherPackagingSpecs() to customize.
111 // For example, GSI system.img contains system_ext and product artifacts and their
112 // relPathInPackage need to be rebased to system/system_ext and system/system_product.
113 ModifyPackagingSpec(spec *android.PackagingSpec)
Kiyoung Kim23be5bb2024-11-27 00:50:30 +0000114
115 // Function to check if the filesystem should not use `vintf_fragments` property,
116 // but use `vintf_fragment` module type instead
117 ShouldUseVintfFragmentModuleOnly() bool
Kiyoung Kim67118212024-11-07 13:23:44 +0900118}
119
120var _ filesystemBuilder = (*filesystem)(nil)
121
Spandan Das69464c32024-10-25 20:08:06 +0000122type SymlinkDefinition struct {
Inseob Kim14199b02021-02-09 21:18:31 +0900123 Target *string
124 Name *string
125}
126
Jihoon Kang0a453892024-12-09 22:16:26 +0000127// CopyWithNamePrefix returns a new [SymlinkDefinition] with prefix added to Name.
128func (s *SymlinkDefinition) CopyWithNamePrefix(prefix string) SymlinkDefinition {
129 return SymlinkDefinition{
130 Target: s.Target,
131 Name: proptools.StringPtr(filepath.Join(prefix, proptools.String(s.Name))),
132 }
133}
134
Jihoon Kang98047cf2024-10-02 17:13:54 +0000135type FilesystemProperties struct {
Jiyong Park71baa762021-01-18 21:11:03 +0900136 // When set to true, sign the image with avbtool. Default is false.
137 Use_avb *bool
138
139 // Path to the private key that avbtool will use to sign this filesystem image.
140 // TODO(jiyong): allow apex_key to be specified here
141 Avb_private_key *string `android:"path"`
142
Shikha Panwar01403bb2022-12-22 12:22:57 +0000143 // Signing algorithm for avbtool. Default is SHA256_RSA4096.
Jiyong Park71baa762021-01-18 21:11:03 +0900144 Avb_algorithm *string
Jiyong Park11a65972021-02-01 21:09:38 +0900145
Shikha Panwar01403bb2022-12-22 12:22:57 +0000146 // Hash algorithm used for avbtool (for descriptors). This is passed as hash_algorithm to
Nikita Ioffe50fb49c2025-01-24 13:49:00 +0000147 // avbtool. Default is sha256.
Shikha Panware6f30632022-12-21 12:54:45 +0000148 Avb_hash_algorithm *string
149
Spandan Dase5c393c2024-12-12 19:25:07 +0000150 // The security patch passed to as the com.android.build.<type>.security_patch avb property.
151 Security_patch *string
152
Cole Fauste1676122024-12-03 17:32:25 -0800153 // Whether or not to use forward-error-correction codes when signing with AVB. Defaults to true.
154 Use_fec *bool
155
Nikita Ioffe2c8cdc62024-03-27 22:19:30 +0000156 // The index used to prevent rollback of the image. Only used if use_avb is true.
157 Rollback_index *int64
158
Luca Stefani9235f4c2025-02-08 12:09:34 +0100159 // Rollback index location of this image. Must be 1, 2, 3, etc.
Jihoon Kang2f0d1932025-01-17 19:22:44 +0000160 Rollback_index_location *int64
161
Jiyong Parkac4076d2021-03-15 23:21:30 +0900162 // Name of the partition stored in vbmeta desc. Defaults to the name of this module.
163 Partition_name *string
164
Spandan Dasc35d6fb2024-10-10 17:51:14 +0000165 // Type of the filesystem. Currently, ext4, erofs, cpio, and compressed_cpio are supported. Default
Jiyong Park837cdb22021-02-05 00:17:14 +0900166 // is ext4.
Jiyong Park11a65972021-02-01 21:09:38 +0900167 Type *string
Inseob Kimcc8e5362021-02-03 14:05:24 +0900168
Cole Faust9a24d902024-03-18 15:38:12 -0700169 // Identifies which partition this is for //visibility:any_system_image (and others) visibility
170 // checks, and will be used in the future for API surface checks.
171 Partition_type *string
172
Cole Faust0d467052024-12-04 17:19:19 -0800173 // file_contexts file to make image. Currently, only ext4 is supported. These file contexts
174 // will be compiled with sefcontext_compile
Inseob Kimcc8e5362021-02-03 14:05:24 +0900175 File_contexts *string `android:"path"`
Inseob Kim2ce1b5d2021-02-15 17:01:04 +0900176
Cole Faust0d467052024-12-04 17:19:19 -0800177 // The selinux file contexts, after having already run them through sefcontext_compile
178 Precompiled_file_contexts *string `android:"path"`
179
Inseob Kim2ce1b5d2021-02-15 17:01:04 +0900180 // Base directory relative to root, to which deps are installed, e.g. "system". Default is "."
181 // (root).
182 Base_dir *string
Inseob Kim14199b02021-02-09 21:18:31 +0900183
184 // Directories to be created under root. e.g. /dev, /proc, etc.
Cole Faustd9c6a5b2024-05-21 14:54:00 -0700185 Dirs proptools.Configurable[[]string]
Inseob Kim14199b02021-02-09 21:18:31 +0900186
Jihoon Kang6da80752024-12-23 18:53:32 +0000187 // List of filesystem modules to include in creating the partition. The root directory of
188 // the provided filesystem modules are included in creating the partition.
189 // This is only supported for cpio and compressed cpio filesystem types.
190 Include_files_of []string
191
Inseob Kim14199b02021-02-09 21:18:31 +0900192 // Symbolic links to be created under root with "ln -sf <target> <name>".
Spandan Das69464c32024-10-25 20:08:06 +0000193 Symlinks []SymlinkDefinition
Jooyung Han65f402b2022-04-21 14:24:04 +0900194
195 // Seconds since unix epoch to override timestamps of file entries
196 Fake_timestamp *string
197
198 // When set, passed to mkuserimg_mke2fs --mke2fs_uuid & --mke2fs_hash_seed.
199 // Otherwise, they'll be set as random which might cause indeterministic build output.
200 Uuid *string
Inseob Kim376d72f2023-11-01 15:40:25 +0900201
202 // Mount point for this image. Default is "/"
203 Mount_point *string
Cole Faust4a2a7c92024-03-12 12:44:40 -0700204
Inseob Kimb7b84572024-04-30 10:51:47 +0900205 // When set, builds etc/event-log-tags file by merging logtags from all dependencies.
206 // Default is false
207 Build_logtags *bool
208
Justin Yun74f3f302024-05-07 14:32:14 +0900209 // Install aconfig_flags.pb file for the modules installed in this partition.
210 Gen_aconfig_flags_pb *bool
211
Inseob Kim53391842024-03-29 17:44:07 +0900212 Fsverity fsverityProperties
Cole Faust92ccbe22024-10-03 14:38:37 -0700213
214 // If this property is set to true, the filesystem will call ctx.UncheckedModule(), causing
215 // it to not be built on checkbuilds. Used for the automatic migration from make to soong
216 // build modules, where we want to emit some not-yet-working filesystems and we don't want them
217 // to be built.
218 Unchecked_module *bool `blueprint:"mutated"`
Spandan Dasc35d6fb2024-10-10 17:51:14 +0000219
220 Erofs ErofsProperties
Jihoon Kang0d545b82024-10-11 00:21:57 +0000221
mrziwang1a6291f2024-11-07 14:29:25 -0800222 F2fs F2fsProperties
223
Spandan Das2047a4c2024-11-11 21:24:58 +0000224 Linker_config LinkerConfigProperties
Spandan Das92631882024-10-28 22:49:38 +0000225
Jihoon Kang0d545b82024-10-11 00:21:57 +0000226 // Determines if the module is auto-generated from Soong or not. If the module is
227 // auto-generated, its deps are exempted from visibility enforcement.
228 Is_auto_generated *bool
Jihoon Kang6c03c8e2024-11-18 21:30:22 +0000229
230 // Path to the dev nodes description file. This is only needed for building the ramdisk
231 // partition and should not be explicitly specified.
232 Dev_nodes_description_file *string `android:"path" blueprint:"mutated"`
Spandan Das71be42d2024-11-20 18:34:16 +0000233
234 // Additional dependencies used for building android products
235 Android_filesystem_deps AndroidFilesystemDeps
Spandan Dasc49b85e2025-01-10 00:51:25 +0000236
237 // Name of the output. Default is $(module_name).img
238 Stem *string
Jihoon Kang983dd882025-01-13 23:14:11 +0000239
240 // The size of the partition on the device. It will be a build error if this built partition
241 // image exceeds this size.
242 Partition_size *int64
Jihoon Kang6d08d922025-01-14 18:31:57 +0000243
244 // Whether to format f2fs and ext4 in a way that supports casefolding
245 Support_casefolding *bool
246
247 // Whether to format f2fs and ext4 in a way that supports project quotas
248 Support_project_quota *bool
249
250 // Whether to enable per-file compression in f2fs
251 Enable_compression *bool
Spandan Das71be42d2024-11-20 18:34:16 +0000252}
253
254type AndroidFilesystemDeps struct {
255 System *string
256 System_ext *string
Spandan Dasc35d6fb2024-10-10 17:51:14 +0000257}
258
259// Additional properties required to generate erofs FS partitions.
260type ErofsProperties struct {
261 // Compressor and Compression level passed to mkfs.erofs. e.g. (lz4hc,9)
262 // Please see external/erofs-utils/README for complete documentation.
263 Compressor *string
264
265 // Used as --compress-hints for mkfs.erofs
266 Compress_hints *string `android:"path"`
267
268 Sparse *bool
Jiyong Park71baa762021-01-18 21:11:03 +0900269}
270
mrziwang1a6291f2024-11-07 14:29:25 -0800271// Additional properties required to generate f2fs FS partitions.
272type F2fsProperties struct {
273 Sparse *bool
274}
275
Spandan Das173256b2024-10-31 19:59:30 +0000276type LinkerConfigProperties struct {
277
278 // Build a linker.config.pb file
279 Gen_linker_config *bool
280
281 // List of files (in .json format) that will be converted to a linker config file (in .pb format).
282 // The linker config file be installed in the filesystem at /etc/linker.config.pb
283 Linker_config_srcs []string `android:"path"`
284}
285
Jiyong Park65c49f52020-11-24 14:23:26 +0900286// android_filesystem packages a set of modules and their transitive dependencies into a filesystem
287// image. The filesystem images are expected to be mounted in the target device, which means the
288// modules in the filesystem image are built for the target device (i.e. Android, not Linux host).
289// The modules are placed in the filesystem image just like they are installed to the ordinary
290// partitions like system.img. For example, cc_library modules are placed under ./lib[64] directory.
Cole Faust92ccbe22024-10-03 14:38:37 -0700291func FilesystemFactory() android.Module {
Jiyong Park6f0f6882020-11-12 13:14:30 +0900292 module := &filesystem{}
Kiyoung Kim67118212024-11-07 13:23:44 +0900293 module.filesystemBuilder = module
Cole Faust2cfe6962024-09-17 11:31:14 -0700294 initFilesystemModule(module, module)
Jiyong Parkfa616132021-04-20 11:36:40 +0900295 return module
296}
297
Cole Faust2cfe6962024-09-17 11:31:14 -0700298func initFilesystemModule(module android.DefaultableModule, filesystemModule *filesystem) {
299 module.AddProperties(&filesystemModule.properties)
300 android.InitPackageModule(filesystemModule)
301 filesystemModule.PackagingBase.DepsCollectFirstTargetOnly = true
Jihoon Kang79196c52024-10-30 18:49:47 +0000302 filesystemModule.PackagingBase.AllowHighPriorityDeps = true
Jiyong Park6f0f6882020-11-12 13:14:30 +0900303 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
Jiyong Parkf46b1af2024-04-05 18:13:33 +0900304 android.InitDefaultableModule(module)
Jihoon Kang6c03c8e2024-11-18 21:30:22 +0000305
306 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
307 filesystemModule.setDevNodesDescriptionProp()
308 })
Jiyong Park6f0f6882020-11-12 13:14:30 +0900309}
310
Jihoon Kang0d545b82024-10-11 00:21:57 +0000311type depTag struct {
Jiyong Park12a719c2021-01-07 15:31:24 +0900312 blueprint.BaseDependencyTag
Jooyung Han092ef812021-03-10 15:40:34 +0900313 android.PackagingItemAlwaysDepTag
Jihoon Kang0d545b82024-10-11 00:21:57 +0000314}
315
316var dependencyTag = depTag{}
317
318type depTagWithVisibilityEnforcementBypass struct {
319 depTag
320}
321
Spandan Das71be42d2024-11-20 18:34:16 +0000322type interPartitionDepTag struct {
323 blueprint.BaseDependencyTag
324}
325
326var interPartitionDependencyTag = interPartitionDepTag{}
327
Jihoon Kang6da80752024-12-23 18:53:32 +0000328var interPartitionInstallDependencyTag = interPartitionDepTag{}
329
Jihoon Kang0d545b82024-10-11 00:21:57 +0000330var _ android.ExcludeFromVisibilityEnforcementTag = (*depTagWithVisibilityEnforcementBypass)(nil)
331
332func (t depTagWithVisibilityEnforcementBypass) ExcludeFromVisibilityEnforcement() {}
333
334var dependencyTagWithVisibilityEnforcementBypass = depTagWithVisibilityEnforcementBypass{}
Jiyong Park65b62242020-11-25 12:44:59 +0900335
Jihoon Kang6c03c8e2024-11-18 21:30:22 +0000336// ramdiskDevNodesDescription is the name of the filegroup module that provides the file that
337// contains the description of dev nodes added to the CPIO archive for the ramdisk partition.
338const ramdiskDevNodesDescription = "ramdisk_node_list"
339
340func (f *filesystem) setDevNodesDescriptionProp() {
341 if proptools.String(f.properties.Partition_name) == "ramdisk" {
342 f.properties.Dev_nodes_description_file = proptools.StringPtr(":" + ramdiskDevNodesDescription)
343 }
344}
345
Jiyong Park6f0f6882020-11-12 13:14:30 +0900346func (f *filesystem) DepsMutator(ctx android.BottomUpMutatorContext) {
Jihoon Kang0d545b82024-10-11 00:21:57 +0000347 if proptools.Bool(f.properties.Is_auto_generated) {
348 f.AddDeps(ctx, dependencyTagWithVisibilityEnforcementBypass)
349 } else {
350 f.AddDeps(ctx, dependencyTag)
351 }
Spandan Das71be42d2024-11-20 18:34:16 +0000352 if f.properties.Android_filesystem_deps.System != nil {
353 ctx.AddDependency(ctx.Module(), interPartitionDependencyTag, proptools.String(f.properties.Android_filesystem_deps.System))
354 }
355 if f.properties.Android_filesystem_deps.System_ext != nil {
356 ctx.AddDependency(ctx.Module(), interPartitionDependencyTag, proptools.String(f.properties.Android_filesystem_deps.System_ext))
357 }
Jihoon Kang6da80752024-12-23 18:53:32 +0000358 for _, partition := range f.properties.Include_files_of {
359 ctx.AddDependency(ctx.Module(), interPartitionInstallDependencyTag, partition)
360 }
Jiyong Park6f0f6882020-11-12 13:14:30 +0900361}
362
Jiyong Park11a65972021-02-01 21:09:38 +0900363type fsType int
364
365const (
366 ext4Type fsType = iota
Spandan Dasc35d6fb2024-10-10 17:51:14 +0000367 erofsType
mrziwang1a6291f2024-11-07 14:29:25 -0800368 f2fsType
Jiyong Park11a65972021-02-01 21:09:38 +0900369 compressedCpioType
Jiyong Park837cdb22021-02-05 00:17:14 +0900370 cpioType // uncompressed
Jiyong Park11a65972021-02-01 21:09:38 +0900371 unknown
372)
373
Spandan Das7a46f6c2024-10-14 18:41:18 +0000374func (fs fsType) IsUnknown() bool {
375 return fs == unknown
376}
377
Spandan Das8dd97102025-03-14 00:06:43 +0000378// Type string that build_image.py accepts.
379func (t fsType) String() string {
380 switch t {
381 // TODO(372522486): add more types like f2fs, erofs, etc.
382 case ext4Type:
383 return "ext4"
384 case erofsType:
385 return "erofs"
386 case f2fsType:
387 return "f2fs"
388 }
389 panic(fmt.Errorf("unsupported fs type %d", t))
390}
391
Jihoon Kangf67b7de2025-02-12 01:01:09 +0000392type InstalledFilesStruct struct {
393 Txt android.Path
394 Json android.Path
395}
396
Jihoon Kangabec3ec2025-02-19 00:55:10 +0000397type InstalledModuleInfo struct {
398 Name string
399 Variation string
400}
401
Cole Faust92ccbe22024-10-03 14:38:37 -0700402type FilesystemInfo struct {
Cole Faust44080412024-12-20 14:17:07 -0800403 // The built filesystem image
404 Output android.Path
Yu Liu0a37d422025-02-13 02:05:00 +0000405 // Returns the output file that is signed by avbtool. If this module is not signed, returns
406 // nil.
407 SignedOutputPath android.Path
Spandan Das1f0a5a12025-01-15 00:53:15 +0000408 // An additional hermetic filesystem image.
409 // e.g. this will contain inodes with pinned timestamps.
410 // This will be copied to target_files.zip
411 OutputHermetic android.Path
Cole Faust92ccbe22024-10-03 14:38:37 -0700412 // A text file containing the list of paths installed on the partition.
413 FileListFile android.Path
Cole Faust44080412024-12-20 14:17:07 -0800414 // The root staging directory used to build the output filesystem. If consuming this, make sure
415 // to add a dependency on the Output file, as you cannot add dependencies on directories
416 // in ninja.
417 RootDir android.Path
Cole Faustb36763e2025-02-18 15:21:44 -0800418 // Extra root directories that are also built into the partition. Currently only used for
419 // including the recovery partition files into the vendor_boot image.
420 ExtraRootDirs android.Paths
Cole Faust11fda332025-01-14 16:47:19 -0800421 // The rebased staging directory used to build the output filesystem. If consuming this, make
422 // sure to add a dependency on the Output file, as you cannot add dependencies on directories
423 // in ninja. In many cases this is the same as RootDir, only in the system partition is it
424 // different. There, it points to the "system" sub-directory of RootDir.
425 RebasedDir android.Path
Spandan Das33c9c472025-01-14 19:26:23 +0000426 // A text file with block data of the .img file
427 // This is an implicit output of `build_image`
428 MapFile android.Path
Cole Faust11fda332025-01-14 16:47:19 -0800429 // Name of the module that produced this FilesystemInfo origionally. (though it may be
430 // re-exported by super images or boot images)
431 ModuleName string
Cole Faust74ee4e02025-01-16 14:55:35 -0800432 // The property file generated by this module and passed to build_image.
433 // It's exported here so that system_other can reuse system's property file.
434 BuildImagePropFile android.Path
435 // Paths to all the tools referenced inside of the build image property file.
436 BuildImagePropFileDeps android.Paths
Cole Faustb8e280f2025-01-16 16:33:26 -0800437 // Packaging specs to be installed on the system_other image, for the initial boot's dexpreopt.
438 SpecsForSystemOther map[string]android.PackagingSpec
Cole Faust19fbb072025-01-30 18:19:29 -0800439
440 FullInstallPaths []FullInstallPathInfo
Jihoon Kangf67b7de2025-02-12 01:01:09 +0000441
Jihoon Kangdd49f412025-03-07 01:30:43 +0000442 // Installed files dep set of this module and its dependency filesystem modules
443 InstalledFilesDepSet depset.DepSet[InstalledFilesStruct]
Spandan Dasd71af182025-02-12 18:03:29 +0000444
445 // Path to compress hints file for erofs filesystems
446 // This will be nil for other fileystems like ext4
447 ErofsCompressHints android.Path
Spandan Dasf12ff9b2025-02-12 22:27:43 +0000448
449 SelinuxFc android.Path
Spandan Dasdd262fb2025-02-13 00:15:59 +0000450
451 FilesystemConfig android.Path
Jihoon Kangabec3ec2025-02-19 00:55:10 +0000452
453 Owners []InstalledModuleInfo
Spandan Das447a0ab2025-03-04 23:10:19 +0000454
Spandan Das38afe712025-03-05 23:27:55 +0000455 HasFsverity bool
Spandan Das227c9492025-03-17 20:14:00 +0000456
457 PropFileForMiscInfo android.Path
Cole Faust19fbb072025-01-30 18:19:29 -0800458}
459
460// FullInstallPathInfo contains information about the "full install" paths of all the files
461// inside this partition. The full install paths are the files installed in
462// out/target/product/<device>/<partition>. This is essentially legacy behavior, maintained for
463// tools like adb sync and adevice, but we should update them to query the build system for the
464// installed files no matter where they are.
465type FullInstallPathInfo struct {
466 // RequiresFullInstall tells us if the origional module did the install to FullInstallPath
467 // already. If it's false, the android_device module needs to emit the install rule.
468 RequiresFullInstall bool
469 // The "full install" paths for the files in this filesystem. This is the paths in the
470 // out/target/product/<device>/<partition> folder. They're not used by this filesystem,
471 // but can be depended on by the top-level android_device module to cause the staging
472 // directories to be built.
473 FullInstallPath android.InstallPath
474
475 // The file that's copied to FullInstallPath. May be nil if SymlinkTarget is set or IsDir is
476 // true.
477 SourcePath android.Path
478
479 // The target of the symlink, if this file is a symlink.
480 SymlinkTarget string
481
482 // If this file is a directory. Only used for empty directories, which are mostly mount points.
483 IsDir bool
Cole Faust92ccbe22024-10-03 14:38:37 -0700484}
485
486var FilesystemProvider = blueprint.NewProvider[FilesystemInfo]()
487
Yu Liu71f1ea32025-02-26 23:39:20 +0000488type FilesystemDefaultsInfo struct{}
Yu Liufc8d5c12025-01-09 00:19:06 +0000489
490var FilesystemDefaultsInfoProvider = blueprint.NewProvider[FilesystemDefaultsInfo]()
491
Spandan Das7a46f6c2024-10-14 18:41:18 +0000492func GetFsTypeFromString(ctx android.EarlyModuleContext, typeStr string) fsType {
Jiyong Park11a65972021-02-01 21:09:38 +0900493 switch typeStr {
494 case "ext4":
495 return ext4Type
Spandan Dasc35d6fb2024-10-10 17:51:14 +0000496 case "erofs":
497 return erofsType
mrziwang1a6291f2024-11-07 14:29:25 -0800498 case "f2fs":
499 return f2fsType
Jiyong Park11a65972021-02-01 21:09:38 +0900500 case "compressed_cpio":
501 return compressedCpioType
Jiyong Park837cdb22021-02-05 00:17:14 +0900502 case "cpio":
503 return cpioType
Jiyong Park11a65972021-02-01 21:09:38 +0900504 default:
Jiyong Park11a65972021-02-01 21:09:38 +0900505 return unknown
506 }
507}
508
Spandan Das7a46f6c2024-10-14 18:41:18 +0000509func (f *filesystem) fsType(ctx android.ModuleContext) fsType {
510 typeStr := proptools.StringDefault(f.properties.Type, "ext4")
511 fsType := GetFsTypeFromString(ctx, typeStr)
512 if fsType == unknown {
513 ctx.PropertyErrorf("type", "%q not supported", typeStr)
514 }
515 return fsType
516}
517
Jiyong Park65c49f52020-11-24 14:23:26 +0900518func (f *filesystem) installFileName() string {
Spandan Dasc49b85e2025-01-10 00:51:25 +0000519 return proptools.StringDefault(f.properties.Stem, f.BaseModuleName()+".img")
Jiyong Park65c49f52020-11-24 14:23:26 +0900520}
521
Inseob Kim53391842024-03-29 17:44:07 +0900522func (f *filesystem) partitionName() string {
523 return proptools.StringDefault(f.properties.Partition_name, f.Name())
524}
525
Kiyoung Kim67118212024-11-07 13:23:44 +0900526func (f *filesystem) FilterPackagingSpec(ps android.PackagingSpec) bool {
Jiyong Park7e7d4af2024-05-01 12:36:10 +0000527 // Filesystem module respects the installation semantic. A PackagingSpec from a module with
528 // IsSkipInstall() is skipped.
Cole Faust76a6e952024-11-07 16:56:45 -0800529 if ps.SkipInstall() {
530 return false
Spandan Das6d056502024-10-21 15:40:32 +0000531 }
Cole Faust0d3fd562025-01-31 13:17:58 -0800532 // "apex" is a fake partition used to install files in out/target/product/<device>/apex/.
533 // Don't include these files in the partition. We should also look into removing the following
534 // TODO to check the PackagingSpec's partition against this filesystem's partition for all
535 // modules, not just autogenerated ones, which will fix this as well.
536 if ps.Partition() == "apex" {
537 return false
538 }
Cole Faust76a6e952024-11-07 16:56:45 -0800539 if proptools.Bool(f.properties.Is_auto_generated) { // TODO (spandandas): Remove this.
540 pt := f.PartitionType()
Cole Faustc88cff12024-11-12 13:24:05 -0800541 return ps.Partition() == pt || strings.HasPrefix(ps.Partition(), pt+"/")
Cole Faust76a6e952024-11-07 16:56:45 -0800542 }
543 return true
Jiyong Park7e7d4af2024-05-01 12:36:10 +0000544}
545
Inseob Kim3c0a0422024-11-05 17:21:37 +0900546func (f *filesystem) ModifyPackagingSpec(ps *android.PackagingSpec) {
Cole Faustc88cff12024-11-12 13:24:05 -0800547 // Sometimes, android.modulePartition() returns a path with >1 path components.
548 // This makes the partition field of packagingSpecs have multiple components, like
549 // "system/product". Right now, the filesystem module doesn't look at the partition field
550 // when deciding what path to install the file under, only the RelPathInPackage field, so
551 // we move the later path components from partition to relPathInPackage. This should probably
552 // be revisited in the future.
553 prefix := f.PartitionType() + "/"
554 if strings.HasPrefix(ps.Partition(), prefix) {
555 subPartition := strings.TrimPrefix(ps.Partition(), prefix)
556 ps.SetPartition(f.PartitionType())
557 ps.SetRelPathInPackage(filepath.Join(subPartition, ps.RelPathInPackage()))
558 }
Inseob Kim3c0a0422024-11-05 17:21:37 +0900559}
560
Jihoon Kangdd49f412025-03-07 01:30:43 +0000561func buildInstalledFiles(ctx android.ModuleContext, partition string, rootDir android.Path, image android.Path) InstalledFilesStruct {
Jihoon Kangf67b7de2025-02-12 01:01:09 +0000562 fileName := "installed-files"
563 if len(partition) > 0 {
564 fileName += fmt.Sprintf("-%s", partition)
565 }
Jihoon Kangdd49f412025-03-07 01:30:43 +0000566 txt := android.PathForModuleOut(ctx, fmt.Sprintf("%s.txt", fileName))
567 json := android.PathForModuleOut(ctx, fmt.Sprintf("%s.json", fileName))
Jihoon Kangf67b7de2025-02-12 01:01:09 +0000568
569 ctx.Build(pctx, android.BuildParams{
570 Rule: installedFilesJsonRule,
571 Implicit: image,
572 Output: json,
573 Description: "Installed file list json",
574 Args: map[string]string{
575 "rootDir": rootDir.String(),
576 },
577 })
578
579 ctx.Build(pctx, android.BuildParams{
580 Rule: installedFilesTxtRule,
581 Input: json,
582 Output: txt,
583 Description: "Installed file list txt",
584 })
585
Jihoon Kangdd49f412025-03-07 01:30:43 +0000586 return InstalledFilesStruct{
587 Txt: txt,
588 Json: json,
589 }
Jihoon Kangf67b7de2025-02-12 01:01:09 +0000590}
591
Jiyong Park6f0f6882020-11-12 13:14:30 +0900592func (f *filesystem) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jiyong Parkf46b1af2024-04-05 18:13:33 +0900593 validatePartitionType(ctx, f)
Kiyoung Kim23be5bb2024-11-27 00:50:30 +0000594 if f.filesystemBuilder.ShouldUseVintfFragmentModuleOnly() {
595 f.validateVintfFragments(ctx)
596 }
Jihoon Kang6da80752024-12-23 18:53:32 +0000597
598 if len(f.properties.Include_files_of) > 0 && !android.InList(f.fsType(ctx), []fsType{compressedCpioType, cpioType}) {
599 ctx.PropertyErrorf("include_files_of", "include_files_of is only supported for cpio and compressed cpio filesystem types.")
600 }
601
Cole Faust62cfaeb2025-01-15 18:06:40 -0800602 rootDir := android.PathForModuleOut(ctx, f.rootDirString()).OutputPath
603 rebasedDir := rootDir
604 if f.properties.Base_dir != nil {
605 rebasedDir = rootDir.Join(ctx, *f.properties.Base_dir)
606 }
607 builder := android.NewRuleBuilder(pctx, ctx)
608
609 // Wipe the root dir to get rid of leftover files from prior builds
610 builder.Command().Textf("rm -rf %s && mkdir -p %s", rootDir, rootDir)
611 specs := f.gatherFilteredPackagingSpecs(ctx)
Cole Faust62cfaeb2025-01-15 18:06:40 -0800612
Cole Faust19fbb072025-01-30 18:19:29 -0800613 var fullInstallPaths []FullInstallPathInfo
Cole Faust5db2f3e2025-02-19 12:49:37 -0800614 for _, specRel := range android.SortedKeys(specs) {
615 spec := specs[specRel]
Cole Faust19fbb072025-01-30 18:19:29 -0800616 fullInstallPaths = append(fullInstallPaths, FullInstallPathInfo{
617 FullInstallPath: spec.FullInstallPath(),
618 RequiresFullInstall: spec.RequiresFullInstall(),
619 SourcePath: spec.SrcPath(),
620 SymlinkTarget: spec.ToGob().SymlinkTarget,
621 })
622 }
623
624 f.entries = f.copyPackagingSpecs(ctx, builder, specs, rootDir, rebasedDir)
625 f.buildNonDepsFiles(ctx, builder, rootDir, rebasedDir, &fullInstallPaths)
626 f.buildFsverityMetadataFiles(ctx, builder, specs, rootDir, rebasedDir, &fullInstallPaths)
627 f.buildEventLogtagsFile(ctx, builder, rebasedDir, &fullInstallPaths)
628 f.buildAconfigFlagsFiles(ctx, builder, specs, rebasedDir, &fullInstallPaths)
629 f.filesystemBuilder.BuildLinkerConfigFile(ctx, builder, rebasedDir, &fullInstallPaths)
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000630 // Assemeble the staging dir and output a timestamp
631 builder.Command().Text("touch").Output(f.fileystemStagingDirTimestamp(ctx))
632 builder.Build("assemble_filesystem_staging_dir", fmt.Sprintf("Assemble filesystem staging dir %s", f.BaseModuleName()))
Cole Faust62cfaeb2025-01-15 18:06:40 -0800633
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000634 // Create a new rule builder for build_image
635 builder = android.NewRuleBuilder(pctx, ctx)
Spandan Das33c9c472025-01-14 19:26:23 +0000636 var mapFile android.Path
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000637 var outputHermetic android.WritablePath
Cole Faust74ee4e02025-01-16 14:55:35 -0800638 var buildImagePropFile android.Path
639 var buildImagePropFileDeps android.Paths
Cole Faustb36763e2025-02-18 15:21:44 -0800640 var extraRootDirs android.Paths
Spandan Das227c9492025-03-17 20:14:00 +0000641 var propFileForMiscInfo android.Path
Jiyong Park11a65972021-02-01 21:09:38 +0900642 switch f.fsType(ctx) {
mrziwang1a6291f2024-11-07 14:29:25 -0800643 case ext4Type, erofsType, f2fsType:
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000644 buildImagePropFile, buildImagePropFileDeps = f.buildPropFile(ctx)
Spandan Das227c9492025-03-17 20:14:00 +0000645 propFileForMiscInfo = f.buildPropFileForMiscInfo(ctx)
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000646 output := android.PathForModuleOut(ctx, f.installFileName())
647 f.buildImageUsingBuildImage(ctx, builder, buildImageParams{rootDir, buildImagePropFile, buildImagePropFileDeps, output})
648 f.output = output
649 // Create the hermetic img file using a separate rule builder so that it can be built independently
650 hermeticBuilder := android.NewRuleBuilder(pctx, ctx)
651 outputHermetic = android.PathForModuleOut(ctx, "for_target_files", f.installFileName())
652 propFileHermetic := f.propFileForHermeticImg(ctx, hermeticBuilder, buildImagePropFile)
653 f.buildImageUsingBuildImage(ctx, hermeticBuilder, buildImageParams{rootDir, propFileHermetic, buildImagePropFileDeps, outputHermetic})
Spandan Das33c9c472025-01-14 19:26:23 +0000654 mapFile = f.getMapFile(ctx)
Jiyong Park11a65972021-02-01 21:09:38 +0900655 case compressedCpioType:
Cole Faustb36763e2025-02-18 15:21:44 -0800656 f.output, extraRootDirs = f.buildCpioImage(ctx, builder, rootDir, true)
Jiyong Park837cdb22021-02-05 00:17:14 +0900657 case cpioType:
Cole Faustb36763e2025-02-18 15:21:44 -0800658 f.output, extraRootDirs = f.buildCpioImage(ctx, builder, rootDir, false)
Jiyong Park11a65972021-02-01 21:09:38 +0900659 default:
660 return
661 }
662
663 f.installDir = android.PathForModuleInstall(ctx, "etc")
664 ctx.InstallFile(f.installDir, f.installFileName(), f.output)
mrziwang555d1332024-06-07 11:15:33 -0700665 ctx.SetOutputFiles([]android.Path{f.output}, "")
Kiyoung Kim99a954d2024-06-21 14:22:20 +0900666
Jihoon Kang6da80752024-12-23 18:53:32 +0000667 if f.partitionName() == "recovery" {
668 rootDir = rootDir.Join(ctx, "root")
669 }
670
Cole Faust4e9f5922024-11-13 16:09:23 -0800671 fileListFile := android.PathForModuleOut(ctx, "fileList")
672 android.WriteFileRule(ctx, fileListFile, f.installedFilesList())
Cole Faust92ccbe22024-10-03 14:38:37 -0700673
Jihoon Kang52e53c62025-03-07 00:05:49 +0000674 var partitionNameForInstalledFiles string
675 switch f.partitionName() {
676 case "system":
677 partitionNameForInstalledFiles = ""
678 case "vendor_ramdisk":
679 partitionNameForInstalledFiles = "vendor-ramdisk"
680 default:
681 partitionNameForInstalledFiles = f.partitionName()
Jihoon Kangf67b7de2025-02-12 01:01:09 +0000682 }
Jihoon Kangf67b7de2025-02-12 01:01:09 +0000683
Spandan Dasd71af182025-02-12 18:03:29 +0000684 var erofsCompressHints android.Path
685 if f.properties.Erofs.Compress_hints != nil {
686 erofsCompressHints = android.PathForModuleSrc(ctx, *f.properties.Erofs.Compress_hints)
687 }
688
Spandan Das33c9c472025-01-14 19:26:23 +0000689 fsInfo := FilesystemInfo{
Yu Liu0a37d422025-02-13 02:05:00 +0000690 Output: f.OutputPath(),
691 SignedOutputPath: f.SignedOutputPath(),
Cole Faust74ee4e02025-01-16 14:55:35 -0800692 OutputHermetic: outputHermetic,
693 FileListFile: fileListFile,
694 RootDir: rootDir,
Cole Faustb36763e2025-02-18 15:21:44 -0800695 ExtraRootDirs: extraRootDirs,
Cole Faust74ee4e02025-01-16 14:55:35 -0800696 RebasedDir: rebasedDir,
697 MapFile: mapFile,
698 ModuleName: ctx.ModuleName(),
699 BuildImagePropFile: buildImagePropFile,
700 BuildImagePropFileDeps: buildImagePropFileDeps,
Cole Faustb8e280f2025-01-16 16:33:26 -0800701 SpecsForSystemOther: f.systemOtherFiles(ctx),
Cole Faust19fbb072025-01-30 18:19:29 -0800702 FullInstallPaths: fullInstallPaths,
Jihoon Kangdd49f412025-03-07 01:30:43 +0000703 InstalledFilesDepSet: depset.New(
704 depset.POSTORDER,
705 []InstalledFilesStruct{buildInstalledFiles(ctx, partitionNameForInstalledFiles, rootDir, f.output)},
706 includeFilesInstalledFiles(ctx),
707 ),
Spandan Das227c9492025-03-17 20:14:00 +0000708 ErofsCompressHints: erofsCompressHints,
709 SelinuxFc: f.selinuxFc,
710 FilesystemConfig: f.generateFilesystemConfig(ctx, rootDir, rebasedDir),
711 Owners: f.gatherOwners(specs),
712 HasFsverity: f.properties.Fsverity.Inputs.GetOrDefault(ctx, nil) != nil,
713 PropFileForMiscInfo: propFileForMiscInfo,
Spandan Das1f0a5a12025-01-15 00:53:15 +0000714 }
Spandan Das33c9c472025-01-14 19:26:23 +0000715
716 android.SetProvider(ctx, FilesystemProvider, fsInfo)
Spandan Das3ec6d062025-01-09 19:37:47 +0000717
Yu Liu71f1ea32025-02-26 23:39:20 +0000718 android.SetProvider(ctx, android.PartitionTypeInfoProvider, android.PartitionTypeInfo{
719 PartitionType: f.PartitionType(),
720 })
721
Cole Faust4e9f5922024-11-13 16:09:23 -0800722 f.fileListFile = fileListFile
Cole Faust92ccbe22024-10-03 14:38:37 -0700723
724 if proptools.Bool(f.properties.Unchecked_module) {
725 ctx.UncheckedModule()
726 }
Jihoon Kang2f0d1932025-01-17 19:22:44 +0000727
728 f.setVbmetaPartitionProvider(ctx)
Wei Li7b8455f2025-03-05 16:05:51 -0800729
730 // Dump metadata that can not be done in android/compliance-metadata.go
731 complianceMetadataInfo := ctx.ComplianceMetadataInfo()
732 filesContained := make([]string, 0, len(fullInstallPaths))
733 for _, file := range fullInstallPaths {
734 filesContained = append(filesContained, file.FullInstallPath.String())
735 }
736 complianceMetadataInfo.SetFilesContained(filesContained)
Jihoon Kang2f0d1932025-01-17 19:22:44 +0000737}
738
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000739func (f *filesystem) fileystemStagingDirTimestamp(ctx android.ModuleContext) android.WritablePath {
740 return android.PathForModuleOut(ctx, "staging_dir.timestamp")
741}
742
Spandan Dasdd262fb2025-02-13 00:15:59 +0000743func (f *filesystem) generateFilesystemConfig(ctx android.ModuleContext, rootDir android.Path, rebasedDir android.Path) android.Path {
744 rootDirString := rootDir.String()
745 prefix := f.partitionName() + "/"
746 if f.partitionName() == "system" {
747 rootDirString = rebasedDir.String()
748 }
749 if f.partitionName() == "ramdisk" || f.partitionName() == "recovery" {
750 // Hardcoded to match make behavior.
751 // https://cs.android.com/android/_/android/platform/build/+/2a0ef42a432d4da00201e8eb7697dcaa68fd2389:core/Makefile;l=6957-6962;drc=9ea8ad9232cef4d0a24d70133b1b9d2ce2defe5f;bpv=1;bpt=0
752 prefix = ""
753 }
754 out := android.PathForModuleOut(ctx, "filesystem_config.txt")
755 ctx.Build(pctx, android.BuildParams{
756 Rule: fsConfigRule,
757 Input: f.fileystemStagingDirTimestamp(ctx), // assemble the staging directory
758 Output: out,
759 Args: map[string]string{
760 "rootDir": rootDirString,
761 "prefix": prefix,
762 },
763 })
764 return out
765}
766
Jihoon Kang2f0d1932025-01-17 19:22:44 +0000767func (f *filesystem) setVbmetaPartitionProvider(ctx android.ModuleContext) {
768 var extractedPublicKey android.ModuleOutPath
769 if f.properties.Avb_private_key != nil {
770 key := android.PathForModuleSrc(ctx, proptools.String(f.properties.Avb_private_key))
771 extractedPublicKey = android.PathForModuleOut(ctx, f.partitionName()+".avbpubkey")
772 ctx.Build(pctx, android.BuildParams{
773 Rule: extractPublicKeyRule,
774 Input: key,
775 Output: extractedPublicKey,
776 })
777 }
778
779 var ril int
780 if f.properties.Rollback_index_location != nil {
781 ril = proptools.Int(f.properties.Rollback_index_location)
782 }
783
784 android.SetProvider(ctx, vbmetaPartitionProvider, vbmetaPartitionInfo{
785 Name: f.partitionName(),
786 RollbackIndexLocation: ril,
787 PublicKey: extractedPublicKey,
788 Output: f.output,
789 })
Kiyoung Kim99a954d2024-06-21 14:22:20 +0900790}
791
Spandan Das33c9c472025-01-14 19:26:23 +0000792func (f *filesystem) getMapFile(ctx android.ModuleContext) android.WritablePath {
793 // create the filepath by replacing the extension of the corresponding img file
794 return android.PathForModuleOut(ctx, f.installFileName()).ReplaceExtension(ctx, "map")
795}
796
Kiyoung Kim23be5bb2024-11-27 00:50:30 +0000797func (f *filesystem) validateVintfFragments(ctx android.ModuleContext) {
798 visitedModule := map[string]bool{}
799 packagingSpecs := f.gatherFilteredPackagingSpecs(ctx)
800
801 moduleInFileSystem := func(mod android.Module) bool {
802 for _, ps := range android.OtherModuleProviderOrDefault(
803 ctx, mod, android.InstallFilesProvider).PackagingSpecs {
804 if _, ok := packagingSpecs[ps.RelPathInPackage()]; ok {
805 return true
806 }
807 }
808 return false
809 }
810
811 ctx.WalkDeps(func(child, parent android.Module) bool {
812 if visitedModule[child.Name()] {
813 return false
814 }
815 if !moduleInFileSystem(child) {
816 visitedModule[child.Name()] = true
817 return true
818 }
819 if vintfFragments := child.VintfFragments(ctx); vintfFragments != nil {
820 ctx.PropertyErrorf(
821 "vintf_fragments",
822 "Module %s is referenced by soong-defined filesystem %s with property vintf_fragments(%s) in use."+
823 " Use vintf_fragment_modules property instead.",
824 child.Name(),
825 f.BaseModuleName(),
826 strings.Join(vintfFragments, ", "),
827 )
828 }
829 visitedModule[child.Name()] = true
830 return true
831 })
832}
833
Cole Faust4e9f5922024-11-13 16:09:23 -0800834func (f *filesystem) appendToEntry(ctx android.ModuleContext, installedFile android.Path) {
Spandan Das420e16a2024-12-11 18:10:52 +0000835 partitionBaseDir := android.PathForModuleOut(ctx, f.rootDirString(), proptools.String(f.properties.Base_dir)).String() + "/"
Kiyoung Kim99a954d2024-06-21 14:22:20 +0900836
837 relPath, inTargetPartition := strings.CutPrefix(installedFile.String(), partitionBaseDir)
838 if inTargetPartition {
839 f.entries = append(f.entries, relPath)
840 }
841}
842
843func (f *filesystem) installedFilesList() string {
844 installedFilePaths := android.FirstUniqueStrings(f.entries)
845 slices.Sort(installedFilePaths)
846
847 return strings.Join(installedFilePaths, "\n")
Jiyong Park11a65972021-02-01 21:09:38 +0900848}
849
Jiyong Parkf46b1af2024-04-05 18:13:33 +0900850func validatePartitionType(ctx android.ModuleContext, p partition) {
851 if !android.InList(p.PartitionType(), validPartitions) {
852 ctx.PropertyErrorf("partition_type", "partition_type must be one of %s, found: %s", validPartitions, p.PartitionType())
853 }
854
Yu Liufc8d5c12025-01-09 00:19:06 +0000855 ctx.VisitDirectDepsProxyWithTag(android.DefaultsDepTag, func(m android.ModuleProxy) {
Yu Liu71f1ea32025-02-26 23:39:20 +0000856 if _, ok := android.OtherModuleProvider(ctx, m, FilesystemDefaultsInfoProvider); ok {
857 partitionInfo := android.OtherModuleProviderOrDefault(ctx, m, android.PartitionTypeInfoProvider)
858 if p.PartitionType() != partitionInfo.PartitionType {
Jiyong Parkf46b1af2024-04-05 18:13:33 +0900859 ctx.PropertyErrorf("partition_type",
860 "%s doesn't match with the partition type %s of the filesystem default module %s",
Yu Liu71f1ea32025-02-26 23:39:20 +0000861 p.PartitionType(), partitionInfo.PartitionType, m.Name())
Jiyong Parkf46b1af2024-04-05 18:13:33 +0900862 }
863 }
864 })
865}
866
Cole Faust3b806d32024-03-11 15:15:03 -0700867// Copy extra files/dirs that are not from the `deps` property to `rootDir`, checking for conflicts with files
868// already in `rootDir`.
Cole Faust19fbb072025-01-30 18:19:29 -0800869func (f *filesystem) buildNonDepsFiles(
870 ctx android.ModuleContext,
871 builder *android.RuleBuilder,
872 rootDir android.OutputPath,
873 rebasedDir android.OutputPath,
874 fullInstallPaths *[]FullInstallPathInfo,
875) {
876 rebasedPrefix, err := filepath.Rel(rootDir.String(), rebasedDir.String())
877 if err != nil || strings.HasPrefix(rebasedPrefix, "../") {
878 panic("rebasedDir could not be made relative to rootDir")
879 }
880 if !strings.HasSuffix(rebasedPrefix, "/") {
881 rebasedPrefix += "/"
882 }
883 if rebasedPrefix == "./" {
884 rebasedPrefix = ""
885 }
886
Inseob Kim14199b02021-02-09 21:18:31 +0900887 // create dirs and symlinks
Cole Faustd9c6a5b2024-05-21 14:54:00 -0700888 for _, dir := range f.properties.Dirs.GetOrDefault(ctx, nil) {
Inseob Kim14199b02021-02-09 21:18:31 +0900889 // OutputPath.Join verifies dir
890 builder.Command().Text("mkdir -p").Text(rootDir.Join(ctx, dir).String())
Cole Faust19fbb072025-01-30 18:19:29 -0800891 // Only add the fullInstallPath logic for files in the rebased dir. The root dir
892 // is harder to install to.
893 if strings.HasPrefix(dir, rebasedPrefix) {
894 *fullInstallPaths = append(*fullInstallPaths, FullInstallPathInfo{
895 FullInstallPath: android.PathForModuleInPartitionInstall(ctx, f.PartitionType(), strings.TrimPrefix(dir, rebasedPrefix)),
896 IsDir: true,
897 })
898 }
Inseob Kim14199b02021-02-09 21:18:31 +0900899 }
900
901 for _, symlink := range f.properties.Symlinks {
902 name := strings.TrimSpace(proptools.String(symlink.Name))
903 target := strings.TrimSpace(proptools.String(symlink.Target))
904
905 if name == "" {
906 ctx.PropertyErrorf("symlinks", "Name can't be empty")
907 continue
908 }
909
910 if target == "" {
911 ctx.PropertyErrorf("symlinks", "Target can't be empty")
912 continue
913 }
914
915 // OutputPath.Join verifies name. don't need to verify target.
916 dst := rootDir.Join(ctx, name)
Cole Faust3b806d32024-03-11 15:15:03 -0700917 builder.Command().Textf("(! [ -e %s -o -L %s ] || (echo \"%s already exists from an earlier stage of the build\" && exit 1))", dst, dst, dst)
Inseob Kim14199b02021-02-09 21:18:31 +0900918 builder.Command().Text("mkdir -p").Text(filepath.Dir(dst.String()))
919 builder.Command().Text("ln -sf").Text(proptools.ShellEscape(target)).Text(dst.String())
Kiyoung Kim99a954d2024-06-21 14:22:20 +0900920 f.appendToEntry(ctx, dst)
Wei Li7b8455f2025-03-05 16:05:51 -0800921 // Add the fullInstallPath logic for files in the rebased dir, and for non-rebased files in "system" partition
922 // the fullInstallPath is changed to "root" which aligns to the behavior in Make.
923 if f.PartitionType() == "system" {
924 installPath := android.PathForModuleInPartitionInstall(ctx, f.PartitionType(), strings.TrimPrefix(name, rebasedPrefix))
925 if !strings.HasPrefix(name, rebasedPrefix) {
926 installPath = android.PathForModuleInPartitionInstall(ctx, "root", name)
927 }
Cole Faust19fbb072025-01-30 18:19:29 -0800928 *fullInstallPaths = append(*fullInstallPaths, FullInstallPathInfo{
Wei Li7b8455f2025-03-05 16:05:51 -0800929 FullInstallPath: installPath,
Cole Faust19fbb072025-01-30 18:19:29 -0800930 SymlinkTarget: target,
931 })
Wei Li7b8455f2025-03-05 16:05:51 -0800932 } else {
933 if strings.HasPrefix(name, rebasedPrefix) {
934 *fullInstallPaths = append(*fullInstallPaths, FullInstallPathInfo{
935 FullInstallPath: android.PathForModuleInPartitionInstall(ctx, f.PartitionType(), strings.TrimPrefix(name, rebasedPrefix)),
936 SymlinkTarget: target,
937 })
938 }
Cole Faust19fbb072025-01-30 18:19:29 -0800939 }
Inseob Kim14199b02021-02-09 21:18:31 +0900940 }
Jihoon Kang89e8a692024-12-18 19:28:33 +0000941
942 // https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/Makefile;l=2835;drc=b186569ef00ff2f2a1fab28aedc75ebc32bcd67b
943 if f.partitionName() == "recovery" {
944 builder.Command().Text("mkdir -p").Text(rootDir.Join(ctx, "root/linkerconfig").String())
945 builder.Command().Text("touch").Text(rootDir.Join(ctx, "root/linkerconfig/ld.config.txt").String())
946 }
Inseob Kim2ce1b5d2021-02-15 17:01:04 +0900947}
948
Inseob Kim33f95a92024-07-11 15:44:49 +0900949func (f *filesystem) copyPackagingSpecs(ctx android.ModuleContext, builder *android.RuleBuilder, specs map[string]android.PackagingSpec, rootDir, rebasedDir android.WritablePath) []string {
950 rootDirSpecs := make(map[string]android.PackagingSpec)
951 rebasedDirSpecs := make(map[string]android.PackagingSpec)
952
953 for rel, spec := range specs {
954 if spec.Partition() == "root" {
955 rootDirSpecs[rel] = spec
956 } else {
957 rebasedDirSpecs[rel] = spec
958 }
959 }
960
961 dirsToSpecs := make(map[android.WritablePath]map[string]android.PackagingSpec)
962 dirsToSpecs[rootDir] = rootDirSpecs
963 dirsToSpecs[rebasedDir] = rebasedDirSpecs
964
Cole Fauste3845052025-02-13 12:45:35 -0800965 // Preserve timestamps for adb sync, so that this staging dir file matches the timestamp in the
966 // out/target/product staging directory.
967 return f.CopySpecsToDirs(ctx, builder, dirsToSpecs, true)
Inseob Kim33f95a92024-07-11 15:44:49 +0900968}
969
Spandan Das420e16a2024-12-11 18:10:52 +0000970func (f *filesystem) rootDirString() string {
971 return f.partitionName()
972}
973
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000974type buildImageParams struct {
975 // inputs
976 rootDir android.OutputPath
977 propFile android.Path
978 toolDeps android.Paths
979 // outputs
980 output android.WritablePath
981}
982
Cole Faust62cfaeb2025-01-15 18:06:40 -0800983func (f *filesystem) buildImageUsingBuildImage(
984 ctx android.ModuleContext,
985 builder *android.RuleBuilder,
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000986 params buildImageParams) {
Nikita Ioffe519015f2022-12-23 15:36:29 +0000987 // run host_init_verifier
988 // Ideally we should have a concept of pluggable linters that verify the generated image.
989 // While such concept is not implement this will do.
990 // TODO(b/263574231): substitute with pluggable linter.
991 builder.Command().
992 BuiltTool("host_init_verifier").
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000993 FlagWithArg("--out_system=", params.rootDir.String()+"/system")
Cole Fauste1676122024-12-03 17:32:25 -0800994
995 // Most of the time, if build_image were to call a host tool, it accepts the path to the
996 // host tool in a field in the prop file. However, it doesn't have that option for fec, which
997 // it expects to just be on the PATH. Add fec to the PATH.
998 fec := ctx.Config().HostToolPath(ctx, "fec")
999 pathToolDirs := []string{filepath.Dir(fec.String())}
1000
Cole Fauste1676122024-12-03 17:32:25 -08001001 builder.Command().
1002 Textf("PATH=%s:$PATH", strings.Join(pathToolDirs, ":")).
1003 BuiltTool("build_image").
Spandan Das5ef1a9c2025-02-11 18:50:17 +00001004 Text(params.rootDir.String()). // input directory
1005 Input(params.propFile).
1006 Implicits(params.toolDeps).
Cole Fauste1676122024-12-03 17:32:25 -08001007 Implicit(fec).
Spandan Das5ef1a9c2025-02-11 18:50:17 +00001008 Implicit(f.fileystemStagingDirTimestamp(ctx)). // assemble the staging directory
1009 Output(params.output).
1010 Text(params.rootDir.String()) // directory where to find fs_config_files|dirs
Spandan Das1f0a5a12025-01-15 00:53:15 +00001011
Jihoon Kang983dd882025-01-13 23:14:11 +00001012 if f.properties.Partition_size != nil {
Spandan Das5ef1a9c2025-02-11 18:50:17 +00001013 assertMaxImageSize(builder, params.output, *f.properties.Partition_size, false)
Jihoon Kang983dd882025-01-13 23:14:11 +00001014 }
1015
Jiyong Park6f0f6882020-11-12 13:14:30 +09001016 // rootDir is not deleted. Might be useful for quick inspection.
Spandan Das5ef1a9c2025-02-11 18:50:17 +00001017 builder.Build("build_"+params.output.String(), fmt.Sprintf("Creating filesystem %s", f.BaseModuleName()))
1018}
Jiyong Park65c49f52020-11-24 14:23:26 +09001019
Spandan Das5ef1a9c2025-02-11 18:50:17 +00001020func (f *filesystem) propFileForHermeticImg(ctx android.ModuleContext, builder *android.RuleBuilder, inputPropFile android.Path) android.Path {
1021 propFilePinnedTimestamp := android.PathForModuleOut(ctx, "for_target_files", "prop")
1022 builder.Command().Textf("cat").Input(inputPropFile).Flag(">").Output(propFilePinnedTimestamp).
1023 Textf(" && echo use_fixed_timestamp=true >> %s", propFilePinnedTimestamp).
1024 Textf(" && echo block_list=%s >> %s", f.getMapFile(ctx).String(), propFilePinnedTimestamp) // mapfile will be an implicit output
1025 builder.Command().Text("touch").Output(f.getMapFile(ctx))
1026 return propFilePinnedTimestamp
Jiyong Park65c49f52020-11-24 14:23:26 +09001027}
1028
Cole Faust4e9f5922024-11-13 16:09:23 -08001029func (f *filesystem) buildFileContexts(ctx android.ModuleContext) android.Path {
Inseob Kimcc8e5362021-02-03 14:05:24 +09001030 builder := android.NewRuleBuilder(pctx, ctx)
1031 fcBin := android.PathForModuleOut(ctx, "file_contexts.bin")
1032 builder.Command().BuiltTool("sefcontext_compile").
1033 FlagWithOutput("-o ", fcBin).
1034 Input(android.PathForModuleSrc(ctx, proptools.String(f.properties.File_contexts)))
1035 builder.Build("build_filesystem_file_contexts", fmt.Sprintf("Creating filesystem file contexts for %s", f.BaseModuleName()))
Cole Faust4e9f5922024-11-13 16:09:23 -08001036 return fcBin
Inseob Kimcc8e5362021-02-03 14:05:24 +09001037}
1038
Cole Faust4e9f5922024-11-13 16:09:23 -08001039func (f *filesystem) buildPropFile(ctx android.ModuleContext) (android.Path, android.Paths) {
Jiyong Park72678312021-01-18 17:29:49 +09001040 var deps android.Paths
Cole Fauste03ab892025-01-17 13:55:04 -08001041 var lines []string
Jiyong Park72678312021-01-18 17:29:49 +09001042 addStr := func(name string, value string) {
Cole Fauste03ab892025-01-17 13:55:04 -08001043 lines = append(lines, fmt.Sprintf("%s=%s", name, value))
Jiyong Park72678312021-01-18 17:29:49 +09001044 }
1045 addPath := func(name string, path android.Path) {
Cole Faustcec230a2024-03-07 15:51:12 -08001046 addStr(name, path.String())
Jiyong Park72678312021-01-18 17:29:49 +09001047 deps = append(deps, path)
1048 }
1049
Spandan Das8dd97102025-03-14 00:06:43 +00001050 addStr("fs_type", f.fsType(ctx).String())
Inseob Kim376d72f2023-11-01 15:40:25 +09001051 addStr("mount_point", proptools.StringDefault(f.properties.Mount_point, "/"))
Jiyong Park72678312021-01-18 17:29:49 +09001052 addStr("use_dynamic_partition_size", "true")
1053 addPath("ext_mkuserimg", ctx.Config().HostToolPath(ctx, "mkuserimg_mke2fs"))
1054 // b/177813163 deps of the host tools have to be added. Remove this.
1055 for _, t := range []string{"mke2fs", "e2fsdroid", "tune2fs"} {
1056 deps = append(deps, ctx.Config().HostToolPath(ctx, t))
1057 }
1058
Jiyong Park71baa762021-01-18 21:11:03 +09001059 if proptools.Bool(f.properties.Use_avb) {
1060 addStr("avb_hashtree_enable", "true")
1061 addPath("avb_avbtool", ctx.Config().HostToolPath(ctx, "avbtool"))
1062 algorithm := proptools.StringDefault(f.properties.Avb_algorithm, "SHA256_RSA4096")
1063 addStr("avb_algorithm", algorithm)
Cole Fauste1676122024-12-03 17:32:25 -08001064 if f.properties.Avb_private_key != nil {
1065 key := android.PathForModuleSrc(ctx, *f.properties.Avb_private_key)
1066 addPath("avb_key_path", key)
1067 }
Inseob Kim53391842024-03-29 17:44:07 +09001068 addStr("partition_name", f.partitionName())
Spandan Das72128502025-03-13 23:53:02 +00001069 addStr("avb_add_hashtree_footer_args", f.getAvbAddHashtreeFooterArgs(ctx))
Jiyong Park71baa762021-01-18 21:11:03 +09001070 }
1071
Cole Faust0d467052024-12-04 17:19:19 -08001072 if f.properties.File_contexts != nil && f.properties.Precompiled_file_contexts != nil {
1073 ctx.ModuleErrorf("file_contexts and precompiled_file_contexts cannot both be set")
1074 } else if f.properties.File_contexts != nil {
Spandan Dasf12ff9b2025-02-12 22:27:43 +00001075 f.selinuxFc = f.buildFileContexts(ctx)
Cole Faust0d467052024-12-04 17:19:19 -08001076 } else if f.properties.Precompiled_file_contexts != nil {
Spandan Dasf12ff9b2025-02-12 22:27:43 +00001077 f.selinuxFc = android.PathForModuleSrc(ctx, *f.properties.Precompiled_file_contexts)
1078 }
1079 if f.selinuxFc != nil {
1080 addPath("selinux_fc", f.selinuxFc)
Inseob Kimcc8e5362021-02-03 14:05:24 +09001081 }
Jooyung Han65f402b2022-04-21 14:24:04 +09001082 if timestamp := proptools.String(f.properties.Fake_timestamp); timestamp != "" {
1083 addStr("timestamp", timestamp)
Spandan Dasa0ddc512025-01-06 20:23:55 +00001084 } else if ctx.Config().Getenv("USE_FIXED_TIMESTAMP_IMG_FILES") == "true" {
1085 addStr("use_fixed_timestamp", "true")
Jooyung Han65f402b2022-04-21 14:24:04 +09001086 }
Spandan Dasa0ddc512025-01-06 20:23:55 +00001087
Jooyung Han65f402b2022-04-21 14:24:04 +09001088 if uuid := proptools.String(f.properties.Uuid); uuid != "" {
1089 addStr("uuid", uuid)
1090 addStr("hash_seed", uuid)
1091 }
mrziwang1a6291f2024-11-07 14:29:25 -08001092
Jihoon Kang40551e62025-01-14 21:55:08 +00001093 // Disable sparse only when partition size is not defined. disable_sparse has the same
1094 // effect as <partition name>_disable_sparse.
1095 if f.properties.Partition_size == nil {
1096 addStr("disable_sparse", "true")
1097 }
Cole Faust43a52c72024-11-26 12:46:08 -08001098
mrziwang1a6291f2024-11-07 14:29:25 -08001099 fst := f.fsType(ctx)
1100 switch fst {
1101 case erofsType:
1102 // Add erofs properties
Cole Faust3e730972024-12-03 13:12:08 -08001103 addStr("erofs_default_compressor", proptools.StringDefault(f.properties.Erofs.Compressor, "lz4hc,9"))
1104 if f.properties.Erofs.Compress_hints != nil {
1105 src := android.PathForModuleSrc(ctx, *f.properties.Erofs.Compress_hints)
1106 addPath("erofs_default_compress_hints", src)
Spandan Dasc35d6fb2024-10-10 17:51:14 +00001107 }
1108 if proptools.BoolDefault(f.properties.Erofs.Sparse, true) {
1109 // https://source.corp.google.com/h/googleplex-android/platform/build/+/88b1c67239ca545b11580237242774b411f2fed9:core/Makefile;l=2292;bpv=1;bpt=0;drc=ea8f34bc1d6e63656b4ec32f2391e9d54b3ebb6b
1110 addStr("erofs_sparse_flag", "-s")
1111 }
mrziwang1a6291f2024-11-07 14:29:25 -08001112 case f2fsType:
1113 if proptools.BoolDefault(f.properties.F2fs.Sparse, true) {
1114 // https://source.corp.google.com/h/googleplex-android/platform/build/+/88b1c67239ca545b11580237242774b411f2fed9:core/Makefile;l=2294;drc=ea8f34bc1d6e63656b4ec32f2391e9d54b3ebb6b;bpv=1;bpt=0
1115 addStr("f2fs_sparse_flag", "-S")
1116 }
Spandan Dasc35d6fb2024-10-10 17:51:14 +00001117 }
Spandan Das8dd97102025-03-14 00:06:43 +00001118 f.checkFsTypePropertyError(ctx, fst, fst.String())
Spandan Dasc35d6fb2024-10-10 17:51:14 +00001119
Jihoon Kang983dd882025-01-13 23:14:11 +00001120 if f.properties.Partition_size != nil {
1121 addStr("partition_size", strconv.FormatInt(*f.properties.Partition_size, 10))
1122 }
1123
Jihoon Kang6d08d922025-01-14 18:31:57 +00001124 if proptools.BoolDefault(f.properties.Support_casefolding, false) {
1125 addStr("needs_casefold", "1")
1126 }
1127
1128 if proptools.BoolDefault(f.properties.Support_project_quota, false) {
1129 addStr("needs_projid", "1")
1130 }
1131
1132 if proptools.BoolDefault(f.properties.Enable_compression, false) {
1133 addStr("needs_compress", "1")
1134 }
1135
Cole Fauste03ab892025-01-17 13:55:04 -08001136 sort.Strings(lines)
1137
Cole Fauste1676122024-12-03 17:32:25 -08001138 propFilePreProcessing := android.PathForModuleOut(ctx, "prop_pre_processing")
Cole Fauste03ab892025-01-17 13:55:04 -08001139 android.WriteFileRule(ctx, propFilePreProcessing, strings.Join(lines, "\n"))
Cole Faust4e9f5922024-11-13 16:09:23 -08001140 propFile := android.PathForModuleOut(ctx, "prop")
Cole Fauste1676122024-12-03 17:32:25 -08001141 ctx.Build(pctx, android.BuildParams{
Cole Faustefeb5c42024-12-16 10:47:26 -08001142 Rule: textFileProcessorRule,
1143 Input: propFilePreProcessing,
1144 Output: propFile,
Cole Fauste1676122024-12-03 17:32:25 -08001145 })
Jiyong Park72678312021-01-18 17:29:49 +09001146 return propFile, deps
1147}
1148
Spandan Das227c9492025-03-17 20:14:00 +00001149func (f *filesystem) buildPropFileForMiscInfo(ctx android.ModuleContext) android.Path {
1150 var lines []string
1151 addStr := func(name string, value string) {
1152 lines = append(lines, fmt.Sprintf("%s=%s", name, value))
1153 }
1154
1155 addStr("use_dynamic_partition_size", "true")
1156 addStr("ext_mkuserimg", "mkuserimg_mke2fs")
1157
1158 addStr("building_"+f.partitionName()+"_image", "true")
1159 addStr(f.partitionName()+"_fs_type", f.fsType(ctx).String())
1160
1161 if proptools.Bool(f.properties.Use_avb) {
1162 addStr("avb_"+f.partitionName()+"_hashtree_enable", "true")
1163 if f.properties.Avb_private_key != nil {
1164 key := android.PathForModuleSrc(ctx, *f.properties.Avb_private_key)
1165 addStr("avb_"+f.partitionName()+"_key_path", key.String())
1166 }
1167 addStr("avb_"+f.partitionName()+"_add_hashtree_footer_args", strings.TrimSpace(f.getAvbAddHashtreeFooterArgs(ctx)))
1168 }
1169
1170 if f.selinuxFc != nil {
1171 addStr(f.partitionName()+"_selinux_fc", f.selinuxFc.String())
1172 }
1173
1174 // Disable sparse only when partition size is not defined. disable_sparse has the same
1175 // effect as <partition name>_disable_sparse.
1176 if f.properties.Partition_size == nil {
1177 addStr(f.partitionName()+"_disable_sparse", "true")
Spandan Das62eacae2025-03-18 20:37:42 +00001178 } else if f.partitionName() == "userdata" {
1179 // Add userdata's partition size to misc_info.txt.
1180 // userdata has been special-cased to make the make packaging misc_info.txt implementation
1181 addStr("userdata_size", strconv.FormatInt(*f.properties.Partition_size, 10))
Spandan Das227c9492025-03-17 20:14:00 +00001182 }
1183
1184 fst := f.fsType(ctx)
1185 switch fst {
1186 case erofsType:
1187 // Add erofs properties
1188 addStr("erofs_default_compressor", proptools.StringDefault(f.properties.Erofs.Compressor, "lz4hc,9"))
1189 if proptools.BoolDefault(f.properties.Erofs.Sparse, true) {
1190 // https://source.corp.google.com/h/googleplex-android/platform/build/+/88b1c67239ca545b11580237242774b411f2fed9:core/Makefile;l=2292;bpv=1;bpt=0;drc=ea8f34bc1d6e63656b4ec32f2391e9d54b3ebb6b
1191 addStr("erofs_sparse_flag", "-s")
1192 }
1193 case f2fsType:
1194 if proptools.BoolDefault(f.properties.F2fs.Sparse, true) {
1195 // https://source.corp.google.com/h/googleplex-android/platform/build/+/88b1c67239ca545b11580237242774b411f2fed9:core/Makefile;l=2294;drc=ea8f34bc1d6e63656b4ec32f2391e9d54b3ebb6b;bpv=1;bpt=0
1196 addStr("f2fs_sparse_flag", "-S")
1197 }
1198 }
1199
1200 if proptools.BoolDefault(f.properties.Support_casefolding, false) {
1201 addStr("needs_casefold", "1")
1202 }
1203
1204 if proptools.BoolDefault(f.properties.Support_project_quota, false) {
1205 addStr("needs_projid", "1")
1206 }
1207
1208 if proptools.BoolDefault(f.properties.Enable_compression, false) {
1209 addStr("needs_compress", "1")
1210 }
1211
1212 sort.Strings(lines)
1213
1214 propFilePreProcessing := android.PathForModuleOut(ctx, "prop_misc_info_pre_processing")
1215 android.WriteFileRule(ctx, propFilePreProcessing, strings.Join(lines, "\n"))
1216 propFile := android.PathForModuleOut(ctx, "prop_file_for_misc_info")
1217 ctx.Build(pctx, android.BuildParams{
1218 Rule: textFileProcessorRule,
1219 Input: propFilePreProcessing,
1220 Output: propFile,
1221 })
1222
1223 return propFile
1224}
1225
Spandan Das72128502025-03-13 23:53:02 +00001226func (f *filesystem) getAvbAddHashtreeFooterArgs(ctx android.ModuleContext) string {
1227 avb_add_hashtree_footer_args := ""
1228 if !proptools.BoolDefault(f.properties.Use_fec, true) {
1229 avb_add_hashtree_footer_args += " --do_not_generate_fec"
1230 }
1231 hashAlgorithm := proptools.StringDefault(f.properties.Avb_hash_algorithm, "sha256")
1232 avb_add_hashtree_footer_args += " --hash_algorithm " + hashAlgorithm
1233 if f.properties.Rollback_index != nil {
1234 rollbackIndex := proptools.Int(f.properties.Rollback_index)
1235 if rollbackIndex < 0 {
1236 ctx.PropertyErrorf("rollback_index", "Rollback index must be non-negative")
1237 }
1238 avb_add_hashtree_footer_args += " --rollback_index " + strconv.Itoa(rollbackIndex)
1239 }
1240 avb_add_hashtree_footer_args += fmt.Sprintf(" --prop com.android.build.%s.os_version:%s", f.partitionName(), ctx.Config().PlatformVersionLastStable())
1241 // We're not going to add BuildFingerPrintFile as a dep. If it changed, it's likely because
1242 // the build number changed, and we don't want to trigger rebuilds solely based on the build
1243 // number.
1244 avb_add_hashtree_footer_args += fmt.Sprintf(" --prop com.android.build.%s.fingerprint:{CONTENTS_OF:%s}", f.partitionName(), ctx.Config().BuildFingerprintFile(ctx))
1245 if f.properties.Security_patch != nil && proptools.String(f.properties.Security_patch) != "" {
1246 avb_add_hashtree_footer_args += fmt.Sprintf(" --prop com.android.build.%s.security_patch:%s", f.partitionName(), proptools.String(f.properties.Security_patch))
1247 }
1248 return avb_add_hashtree_footer_args
1249}
1250
mrziwang1a6291f2024-11-07 14:29:25 -08001251// This method checks if there is any property set for the fstype(s) other than
1252// the current fstype.
1253func (f *filesystem) checkFsTypePropertyError(ctx android.ModuleContext, t fsType, fs string) {
1254 raiseError := func(otherFsType, currentFsType string) {
1255 errMsg := fmt.Sprintf("%s is non-empty, but FS type is %s\n. Please delete %s properties if this partition should use %s\n", otherFsType, currentFsType, otherFsType, currentFsType)
1256 ctx.PropertyErrorf(otherFsType, errMsg)
1257 }
1258
1259 if t != erofsType {
1260 if f.properties.Erofs.Compressor != nil || f.properties.Erofs.Compress_hints != nil || f.properties.Erofs.Sparse != nil {
1261 raiseError("erofs", fs)
1262 }
1263 }
1264 if t != f2fsType {
1265 if f.properties.F2fs.Sparse != nil {
1266 raiseError("f2fs", fs)
1267 }
1268 }
1269}
1270
Jihoon Kang6da80752024-12-23 18:53:32 +00001271func includeFilesRootDir(ctx android.ModuleContext) (rootDirs android.Paths, partitions android.Paths) {
1272 ctx.VisitDirectDepsWithTag(interPartitionInstallDependencyTag, func(m android.Module) {
1273 if fsProvider, ok := android.OtherModuleProvider(ctx, m, FilesystemProvider); ok {
1274 rootDirs = append(rootDirs, fsProvider.RootDir)
1275 partitions = append(partitions, fsProvider.Output)
1276 } else {
1277 ctx.PropertyErrorf("include_files_of", "only filesystem modules can be listed in "+
1278 "include_files_of but %s is not a filesystem module", m.Name())
1279 }
1280 })
1281 return rootDirs, partitions
1282}
1283
Jihoon Kangdd49f412025-03-07 01:30:43 +00001284func includeFilesInstalledFiles(ctx android.ModuleContext) (ret []depset.DepSet[InstalledFilesStruct]) {
1285 ctx.VisitDirectDepsWithTag(interPartitionInstallDependencyTag, func(m android.Module) {
1286 if fsProvider, ok := android.OtherModuleProvider(ctx, m, FilesystemProvider); ok {
1287 ret = append(ret, fsProvider.InstalledFilesDepSet)
1288 }
1289 })
1290 return
1291}
1292
Cole Faust62cfaeb2025-01-15 18:06:40 -08001293func (f *filesystem) buildCpioImage(
1294 ctx android.ModuleContext,
1295 builder *android.RuleBuilder,
1296 rootDir android.OutputPath,
1297 compressed bool,
Cole Faustb36763e2025-02-18 15:21:44 -08001298) (android.Path, android.Paths) {
Jiyong Park11a65972021-02-01 21:09:38 +09001299 if proptools.Bool(f.properties.Use_avb) {
1300 ctx.PropertyErrorf("use_avb", "signing compresed cpio image using avbtool is not supported."+
1301 "Consider adding this to bootimg module and signing the entire boot image.")
1302 }
1303
Inseob Kimcc8e5362021-02-03 14:05:24 +09001304 if proptools.String(f.properties.File_contexts) != "" {
1305 ctx.PropertyErrorf("file_contexts", "file_contexts is not supported for compressed cpio image.")
1306 }
1307
Jihoon Kang6da80752024-12-23 18:53:32 +00001308 rootDirs, partitions := includeFilesRootDir(ctx)
1309
Cole Faust4e9f5922024-11-13 16:09:23 -08001310 output := android.PathForModuleOut(ctx, f.installFileName())
Jiyong Park837cdb22021-02-05 00:17:14 +09001311 cmd := builder.Command().
Jiyong Park11a65972021-02-01 21:09:38 +09001312 BuiltTool("mkbootfs").
Spandan Das5ef1a9c2025-02-11 18:50:17 +00001313 Implicit(f.fileystemStagingDirTimestamp(ctx)).
Jiyong Park837cdb22021-02-05 00:17:14 +09001314 Text(rootDir.String()) // input directory
Jihoon Kang6da80752024-12-23 18:53:32 +00001315
1316 for i := range len(rootDirs) {
1317 cmd.Text(rootDirs[i].String())
1318 }
1319 cmd.Implicits(partitions)
1320
Jihoon Kang6c03c8e2024-11-18 21:30:22 +00001321 if nodeList := f.properties.Dev_nodes_description_file; nodeList != nil {
1322 cmd.FlagWithInput("-n ", android.PathForModuleSrc(ctx, proptools.String(nodeList)))
1323 }
Jiyong Park837cdb22021-02-05 00:17:14 +09001324 if compressed {
1325 cmd.Text("|").
1326 BuiltTool("lz4").
1327 Flag("--favor-decSpeed"). // for faster boot
1328 Flag("-12"). // maximum compression level
1329 Flag("-l"). // legacy format for kernel
1330 Text(">").Output(output)
1331 } else {
1332 cmd.Text(">").Output(output)
1333 }
Jiyong Park11a65972021-02-01 21:09:38 +09001334
1335 // rootDir is not deleted. Might be useful for quick inspection.
Jiyong Park837cdb22021-02-05 00:17:14 +09001336 builder.Build("build_cpio_image", fmt.Sprintf("Creating filesystem %s", f.BaseModuleName()))
Jiyong Park11a65972021-02-01 21:09:38 +09001337
Cole Faustb36763e2025-02-18 15:21:44 -08001338 return output, rootDirs
Jiyong Park11a65972021-02-01 21:09:38 +09001339}
1340
Cole Faust4a2a7c92024-03-12 12:44:40 -07001341var validPartitions = []string{
1342 "system",
1343 "userdata",
1344 "cache",
1345 "system_other",
1346 "vendor",
1347 "product",
1348 "system_ext",
1349 "odm",
1350 "vendor_dlkm",
1351 "odm_dlkm",
1352 "system_dlkm",
Cole Faust76a6e952024-11-07 16:56:45 -08001353 "ramdisk",
Cole Faust24938e22024-11-18 14:01:58 -08001354 "vendor_ramdisk",
Jihoon Kang3216c982024-12-02 19:42:20 +00001355 "recovery",
Cole Faust4a2a7c92024-03-12 12:44:40 -07001356}
1357
Cole Faust19fbb072025-01-30 18:19:29 -08001358func (f *filesystem) buildEventLogtagsFile(
1359 ctx android.ModuleContext,
1360 builder *android.RuleBuilder,
1361 rebasedDir android.OutputPath,
1362 fullInstallPaths *[]FullInstallPathInfo,
1363) {
Inseob Kimb7b84572024-04-30 10:51:47 +09001364 if !proptools.Bool(f.properties.Build_logtags) {
1365 return
1366 }
1367
Inseob Kimb7b84572024-04-30 10:51:47 +09001368 etcPath := rebasedDir.Join(ctx, "etc")
1369 eventLogtagsPath := etcPath.Join(ctx, "event-log-tags")
1370 builder.Command().Text("mkdir").Flag("-p").Text(etcPath.String())
Cole Fauste4506af2024-12-11 14:14:50 -08001371 builder.Command().Text("cp").Input(android.MergedLogtagsPath(ctx)).Text(eventLogtagsPath.String())
Kiyoung Kim99a954d2024-06-21 14:22:20 +09001372
Cole Faust19fbb072025-01-30 18:19:29 -08001373 *fullInstallPaths = append(*fullInstallPaths, FullInstallPathInfo{
1374 FullInstallPath: android.PathForModuleInPartitionInstall(ctx, f.PartitionType(), "etc", "event-log-tags"),
1375 SourcePath: android.MergedLogtagsPath(ctx),
1376 })
1377
Kiyoung Kim99a954d2024-06-21 14:22:20 +09001378 f.appendToEntry(ctx, eventLogtagsPath)
Inseob Kimb7b84572024-04-30 10:51:47 +09001379}
1380
Cole Faust19fbb072025-01-30 18:19:29 -08001381func (f *filesystem) BuildLinkerConfigFile(
1382 ctx android.ModuleContext,
1383 builder *android.RuleBuilder,
1384 rebasedDir android.OutputPath,
1385 fullInstallPaths *[]FullInstallPathInfo,
1386) {
Spandan Das2047a4c2024-11-11 21:24:58 +00001387 if !proptools.Bool(f.properties.Linker_config.Gen_linker_config) {
Spandan Das92631882024-10-28 22:49:38 +00001388 return
1389 }
1390
Spandan Das918191e2024-10-31 18:27:23 +00001391 provideModules, _ := f.getLibsForLinkerConfig(ctx)
Cole Faustfee27012024-12-13 14:10:31 -08001392 intermediateOutput := android.PathForModuleOut(ctx, "linker.config.pb")
1393 linkerconfig.BuildLinkerConfig(ctx, android.PathsForModuleSrc(ctx, f.properties.Linker_config.Linker_config_srcs), provideModules, nil, intermediateOutput)
Spandan Das92631882024-10-28 22:49:38 +00001394 output := rebasedDir.Join(ctx, "etc", "linker.config.pb")
Cole Faustfee27012024-12-13 14:10:31 -08001395 builder.Command().Text("cp").Input(intermediateOutput).Output(output)
Spandan Das92631882024-10-28 22:49:38 +00001396
Cole Faust19fbb072025-01-30 18:19:29 -08001397 *fullInstallPaths = append(*fullInstallPaths, FullInstallPathInfo{
1398 FullInstallPath: android.PathForModuleInPartitionInstall(ctx, f.PartitionType(), "etc", "linker.config.pb"),
1399 SourcePath: intermediateOutput,
1400 })
1401
Spandan Das92631882024-10-28 22:49:38 +00001402 f.appendToEntry(ctx, output)
1403}
1404
Kiyoung Kim23be5bb2024-11-27 00:50:30 +00001405func (f *filesystem) ShouldUseVintfFragmentModuleOnly() bool {
1406 return false
1407}
1408
Jiyong Parkf46b1af2024-04-05 18:13:33 +09001409type partition interface {
1410 PartitionType() string
1411}
1412
Cole Faust9a24d902024-03-18 15:38:12 -07001413func (f *filesystem) PartitionType() string {
1414 return proptools.StringDefault(f.properties.Partition_type, "system")
1415}
1416
Jiyong Parkf46b1af2024-04-05 18:13:33 +09001417var _ partition = (*filesystem)(nil)
1418
Jiyong Park65c49f52020-11-24 14:23:26 +09001419var _ android.AndroidMkEntriesProvider = (*filesystem)(nil)
1420
1421// Implements android.AndroidMkEntriesProvider
1422func (f *filesystem) AndroidMkEntries() []android.AndroidMkEntries {
1423 return []android.AndroidMkEntries{android.AndroidMkEntries{
1424 Class: "ETC",
1425 OutputFile: android.OptionalPathForPath(f.output),
1426 ExtraEntries: []android.AndroidMkExtraEntriesFunc{
Colin Crossaa255532020-07-03 13:18:24 -07001427 func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
Colin Crossc68db4b2021-11-11 18:59:15 -08001428 entries.SetString("LOCAL_MODULE_PATH", f.installDir.String())
Jiyong Park65c49f52020-11-24 14:23:26 +09001429 entries.SetString("LOCAL_INSTALLED_MODULE_STEM", f.installFileName())
Kiyoung Kim99a954d2024-06-21 14:22:20 +09001430 entries.SetString("LOCAL_FILESYSTEM_FILELIST", f.fileListFile.String())
Jiyong Park65c49f52020-11-24 14:23:26 +09001431 },
1432 },
1433 }}
Jiyong Park6f0f6882020-11-12 13:14:30 +09001434}
Jiyong Park12a719c2021-01-07 15:31:24 +09001435
1436// Filesystem is the public interface for the filesystem struct. Currently, it's only for the apex
1437// package to have access to the output file.
1438type Filesystem interface {
1439 android.Module
1440 OutputPath() android.Path
Jiyong Park972e06c2021-03-15 23:32:49 +09001441
1442 // Returns the output file that is signed by avbtool. If this module is not signed, returns
1443 // nil.
1444 SignedOutputPath() android.Path
Jiyong Park12a719c2021-01-07 15:31:24 +09001445}
1446
1447var _ Filesystem = (*filesystem)(nil)
1448
1449func (f *filesystem) OutputPath() android.Path {
1450 return f.output
1451}
Jiyong Park972e06c2021-03-15 23:32:49 +09001452
1453func (f *filesystem) SignedOutputPath() android.Path {
1454 if proptools.Bool(f.properties.Use_avb) {
1455 return f.OutputPath()
1456 }
1457 return nil
1458}
Jooyung Han0fbbc2b2022-03-25 12:35:46 +09001459
1460// Filter the result of GatherPackagingSpecs to discard items targeting outside "system" partition.
1461// Note that "apex" module installs its contents to "apex"(fake partition) as well
1462// for symbol lookup by imitating "activated" paths.
1463func (f *filesystem) gatherFilteredPackagingSpecs(ctx android.ModuleContext) map[string]android.PackagingSpec {
Cole Faustb8e280f2025-01-16 16:33:26 -08001464 return f.PackagingBase.GatherPackagingSpecsWithFilterAndModifier(ctx, f.filesystemBuilder.FilterPackagingSpec, f.filesystemBuilder.ModifyPackagingSpec)
1465}
1466
Jihoon Kangabec3ec2025-02-19 00:55:10 +00001467func (f *filesystem) gatherOwners(specs map[string]android.PackagingSpec) []InstalledModuleInfo {
1468 var owners []InstalledModuleInfo
1469 for _, p := range android.SortedKeys(specs) {
1470 spec := specs[p]
1471 owners = append(owners, InstalledModuleInfo{
1472 Name: spec.Owner(),
1473 Variation: spec.Variation(),
1474 })
1475 }
1476 return owners
1477}
1478
Cole Faustb8e280f2025-01-16 16:33:26 -08001479// Dexpreopt files are installed to system_other. Collect the packaingSpecs for the dexpreopt files
1480// from this partition to export to the system_other partition later.
1481func (f *filesystem) systemOtherFiles(ctx android.ModuleContext) map[string]android.PackagingSpec {
1482 filter := func(spec android.PackagingSpec) bool {
1483 // For some reason system_other packaging specs don't set the partition field.
1484 return strings.HasPrefix(spec.RelPathInPackage(), "system_other/")
1485 }
1486 modifier := func(spec *android.PackagingSpec) {
1487 spec.SetRelPathInPackage(strings.TrimPrefix(spec.RelPathInPackage(), "system_other/"))
1488 spec.SetPartition("system_other")
1489 }
1490 return f.PackagingBase.GatherPackagingSpecsWithFilterAndModifier(ctx, filter, modifier)
Jooyung Han0fbbc2b2022-03-25 12:35:46 +09001491}
Jooyung Han65f402b2022-04-21 14:24:04 +09001492
1493func sha1sum(values []string) string {
1494 h := sha256.New()
1495 for _, value := range values {
1496 io.WriteString(h, value)
1497 }
1498 return fmt.Sprintf("%x", h.Sum(nil))
1499}
Jooyung Hane6067592023-03-16 13:11:17 +09001500
1501// Base cc.UseCoverage
1502
1503var _ cc.UseCoverage = (*filesystem)(nil)
1504
Colin Crosse1a85552024-06-14 12:17:37 -07001505func (*filesystem) IsNativeCoverageNeeded(ctx cc.IsNativeCoverageNeededContext) bool {
Jooyung Hane6067592023-03-16 13:11:17 +09001506 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
1507}
Jiyong Parkf46b1af2024-04-05 18:13:33 +09001508
1509// android_filesystem_defaults
1510
1511type filesystemDefaults struct {
1512 android.ModuleBase
1513 android.DefaultsModuleBase
1514
Inseob Kim3c0a0422024-11-05 17:21:37 +09001515 properties FilesystemProperties
Jiyong Parkf46b1af2024-04-05 18:13:33 +09001516}
1517
1518// android_filesystem_defaults is a default module for android_filesystem and android_system_image
1519func filesystemDefaultsFactory() android.Module {
1520 module := &filesystemDefaults{}
1521 module.AddProperties(&module.properties)
1522 module.AddProperties(&android.PackagingProperties{})
1523 android.InitDefaultsModule(module)
1524 return module
1525}
1526
1527func (f *filesystemDefaults) PartitionType() string {
1528 return proptools.StringDefault(f.properties.Partition_type, "system")
1529}
1530
1531var _ partition = (*filesystemDefaults)(nil)
1532
1533func (f *filesystemDefaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1534 validatePartitionType(ctx, f)
Yu Liu71f1ea32025-02-26 23:39:20 +00001535 android.SetProvider(ctx, FilesystemDefaultsInfoProvider, FilesystemDefaultsInfo{})
1536 android.SetProvider(ctx, android.PartitionTypeInfoProvider, android.PartitionTypeInfo{
Yu Liufc8d5c12025-01-09 00:19:06 +00001537 PartitionType: f.PartitionType(),
1538 })
Jiyong Parkf46b1af2024-04-05 18:13:33 +09001539}
Spandan Das918191e2024-10-31 18:27:23 +00001540
1541// getLibsForLinkerConfig returns
1542// 1. A list of libraries installed in this filesystem
1543// 2. A list of dep libraries _not_ installed in this filesystem
1544//
1545// `linkerconfig.BuildLinkerConfig` will convert these two to a linker.config.pb for the filesystem
1546// (1) will be added to --provideLibs if they are C libraries with a stable interface (has stubs)
1547// (2) will be added to --requireLibs if they are C libraries with a stable interface (has stubs)
Yu Liu68a70b72025-01-08 22:54:44 +00001548func (f *filesystem) getLibsForLinkerConfig(ctx android.ModuleContext) ([]android.ModuleProxy, []android.ModuleProxy) {
Spandan Das918191e2024-10-31 18:27:23 +00001549 // we need "Module"s for packaging items
Yu Liu68a70b72025-01-08 22:54:44 +00001550 modulesInPackageByModule := make(map[android.ModuleProxy]bool)
Spandan Das918191e2024-10-31 18:27:23 +00001551 modulesInPackageByName := make(map[string]bool)
1552
1553 deps := f.gatherFilteredPackagingSpecs(ctx)
Yu Liu68a70b72025-01-08 22:54:44 +00001554 ctx.WalkDepsProxy(func(child, parent android.ModuleProxy) bool {
Yu Liuef9e63e2025-03-04 19:01:28 +00001555 if !android.OtherModuleProviderOrDefault(ctx, child, android.CommonModuleInfoProvider).Enabled {
Yu Liu9c6b6762025-01-08 22:04:35 +00001556 return false
1557 }
Spandan Das918191e2024-10-31 18:27:23 +00001558 for _, ps := range android.OtherModuleProviderOrDefault(
1559 ctx, child, android.InstallFilesProvider).PackagingSpecs {
Spandan Dasecf667f2024-12-05 00:58:56 +00001560 if _, ok := deps[ps.RelPathInPackage()]; ok && ps.Partition() == f.PartitionType() {
Spandan Das918191e2024-10-31 18:27:23 +00001561 modulesInPackageByModule[child] = true
1562 modulesInPackageByName[child.Name()] = true
1563 return true
1564 }
1565 }
1566 return true
1567 })
1568
Yu Liu68a70b72025-01-08 22:54:44 +00001569 provideModules := make([]android.ModuleProxy, 0, len(modulesInPackageByModule))
Spandan Das918191e2024-10-31 18:27:23 +00001570 for mod := range modulesInPackageByModule {
1571 provideModules = append(provideModules, mod)
1572 }
1573
Yu Liu68a70b72025-01-08 22:54:44 +00001574 var requireModules []android.ModuleProxy
1575 ctx.WalkDepsProxy(func(child, parent android.ModuleProxy) bool {
Yu Liuef9e63e2025-03-04 19:01:28 +00001576 if !android.OtherModuleProviderOrDefault(ctx, child, android.CommonModuleInfoProvider).Enabled {
Yu Liu9c6b6762025-01-08 22:04:35 +00001577 return false
1578 }
Spandan Das918191e2024-10-31 18:27:23 +00001579 _, parentInPackage := modulesInPackageByModule[parent]
1580 _, childInPackageName := modulesInPackageByName[child.Name()]
1581
1582 // When parent is in the package, and child (or its variant) is not, this can be from an interface.
1583 if parentInPackage && !childInPackageName {
1584 requireModules = append(requireModules, child)
1585 }
1586 return true
1587 })
1588
1589 return provideModules, requireModules
1590}
Cole Faust26bdac52024-11-19 13:37:53 -08001591
1592// Checks that the given file doesn't exceed the given size, and will also print a warning
1593// if it's nearing the maximum size. Equivalent to assert-max-image-size in make:
1594// https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/definitions.mk;l=3455;drc=993c4de29a02a6accd60ceaaee153307e1a18d10
1595func assertMaxImageSize(builder *android.RuleBuilder, image android.Path, maxSize int64, addAvbLater bool) {
1596 if addAvbLater {
1597 // The value 69632 is derived from MAX_VBMETA_SIZE + MAX_FOOTER_SIZE in avbtool.
1598 // Logic copied from make:
1599 // https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/Makefile;l=228;drc=a6a0007ef24e16c0b79f439beac4a118416717e6
1600 maxSize -= 69632
1601 }
1602 cmd := builder.Command()
1603 cmd.Textf(`file="%s"; maxsize="%d";`+
1604 `total=$(stat -c "%%s" "$file" | tr -d '\n');`+
1605 `if [ "$total" -gt "$maxsize" ]; then `+
1606 ` echo "error: $file too large ($total > $maxsize)";`+
1607 ` false;`+
1608 `elif [ "$total" -gt $((maxsize - 32768)) ]; then `+
1609 ` echo "WARNING: $file approaching size limit ($total now; limit $maxsize)";`+
1610 `fi`,
1611 image, maxSize)
1612 cmd.Implicit(image)
1613}
Spandan Das71be42d2024-11-20 18:34:16 +00001614
1615// addAutogeneratedRroDeps walks the transitive closure of vendor and product partitions.
1616// It visits apps installed in system and system_ext partitions, and adds the autogenerated
1617// RRO modules to its own deps.
1618func addAutogeneratedRroDeps(ctx android.BottomUpMutatorContext) {
1619 f, ok := ctx.Module().(*filesystem)
1620 if !ok {
1621 return
1622 }
1623 thisPartition := f.PartitionType()
1624 if thisPartition != "vendor" && thisPartition != "product" {
Cole Faust34592c02024-12-13 11:20:24 -08001625 if f.properties.Android_filesystem_deps.System != nil {
1626 ctx.PropertyErrorf("android_filesystem_deps.system", "only vendor or product partitions can use android_filesystem_deps")
1627 }
1628 if f.properties.Android_filesystem_deps.System_ext != nil {
1629 ctx.PropertyErrorf("android_filesystem_deps.system_ext", "only vendor or product partitions can use android_filesystem_deps")
1630 }
Spandan Das71be42d2024-11-20 18:34:16 +00001631 return
1632 }
1633 ctx.WalkDeps(func(child, parent android.Module) bool {
1634 depTag := ctx.OtherModuleDependencyTag(child)
1635 if parent.Name() == f.Name() && depTag != interPartitionDependencyTag {
1636 return false // This is a module listed in deps of vendor/product filesystem
1637 }
1638 if vendorOverlay := java.AutogeneratedRroModuleName(ctx, child.Name(), "vendor"); ctx.OtherModuleExists(vendorOverlay) && thisPartition == "vendor" {
1639 ctx.AddFarVariationDependencies(nil, dependencyTagWithVisibilityEnforcementBypass, vendorOverlay)
1640 }
1641 if productOverlay := java.AutogeneratedRroModuleName(ctx, child.Name(), "product"); ctx.OtherModuleExists(productOverlay) && thisPartition == "product" {
1642 ctx.AddFarVariationDependencies(nil, dependencyTagWithVisibilityEnforcementBypass, productOverlay)
1643 }
1644 return true
1645 })
1646}
Spandan Das6ec1fcf2025-02-11 22:51:51 +00001647
Yu Liu2a815b62025-02-21 20:46:25 +00001648func (f *filesystem) MakeVars(ctx android.MakeVarsModuleContext) []android.ModuleMakeVarsValue {
Spandan Das6ec1fcf2025-02-11 22:51:51 +00001649 if f.Name() == ctx.Config().SoongDefinedSystemImage() {
Yu Liu2a815b62025-02-21 20:46:25 +00001650 return []android.ModuleMakeVarsValue{{"SOONG_DEFINED_SYSTEM_IMAGE_PATH", f.output.String()}}
Spandan Das6ec1fcf2025-02-11 22:51:51 +00001651 }
Yu Liu2a815b62025-02-21 20:46:25 +00001652 return nil
Spandan Das6ec1fcf2025-02-11 22:51:51 +00001653}
Yu Liu0a37d422025-02-13 02:05:00 +00001654
1655func setCommonFilesystemInfo(ctx android.ModuleContext, m Filesystem) {
1656 android.SetProvider(ctx, FilesystemProvider, FilesystemInfo{
1657 Output: m.OutputPath(),
1658 SignedOutputPath: m.SignedOutputPath(),
1659 })
1660}