blob: 62c86580acecf9739c5df887d3421bfeb8f69abb [file] [log] [blame]
Jihoon Kangf2c53982024-10-09 17:32:52 +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 filesystem
16
17import (
Jihoon Kang0a6315b2025-01-30 01:14:49 +000018 "fmt"
Spandan Das258c08f2025-01-08 23:30:45 +000019 "strings"
Cole Faustb55a41c2025-01-09 16:53:58 -080020 "sync/atomic"
Spandan Das258c08f2025-01-08 23:30:45 +000021
Jihoon Kangf2c53982024-10-09 17:32:52 +000022 "android/soong/android"
23
24 "github.com/google/blueprint"
25 "github.com/google/blueprint/proptools"
26)
27
28type PartitionNameProperties struct {
Cole Faust2bdc5e52025-01-10 10:29:36 -080029 // Name of the super partition filesystem module
30 Super_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000031 // Name of the boot partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000032 Boot_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000033 // Name of the vendor boot partition filesystem module
34 Vendor_boot_partition_name *string
35 // Name of the init boot partition filesystem module
36 Init_boot_partition_name *string
37 // Name of the system partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000038 System_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000039 // Name of the system_ext partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000040 System_ext_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000041 // Name of the product partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000042 Product_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000043 // Name of the vendor partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000044 Vendor_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000045 // Name of the odm partition filesystem module
Spandan Dasc5717162024-11-01 18:33:57 +000046 Odm_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000047 // Name of the recovery partition filesystem module
48 Recovery_partition_name *string
Cole Faust3552eb62024-11-06 18:07:26 -080049 // The vbmeta partition and its "chained" partitions
50 Vbmeta_partitions []string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000051 // Name of the userdata partition filesystem module
mrziwang23ba8762024-11-07 16:21:53 -080052 Userdata_partition_name *string
Spandan Dasa0394002025-01-07 18:38:34 +000053 // Name of the system_dlkm partition filesystem module
54 System_dlkm_partition_name *string
55 // Name of the vendor_dlkm partition filesystem module
56 Vendor_dlkm_partition_name *string
57 // Name of the odm_dlkm partition filesystem module
58 Odm_dlkm_partition_name *string
Jihoon Kangf2c53982024-10-09 17:32:52 +000059}
60
Jihoon Kang3be17162025-01-09 20:51:54 +000061type DeviceProperties struct {
62 // Path to the prebuilt bootloader that would be copied to PRODUCT_OUT
63 Bootloader *string `android:"path"`
Spandan Dase51ff952025-01-09 18:11:59 +000064 // Path to android-info.txt file containing board specific info.
65 Android_info *string `android:"path"`
Cole Faust11fda332025-01-14 16:47:19 -080066 // If this is the "main" android_device target for the build, i.e. the one that gets built
67 // when running a plain `m` command. Currently, this is the autogenerated android_device module
68 // in soong-only builds, but in the future when we check in android_device modules, the main
69 // one will be determined based on the lunch product. TODO: Figure out how to make this
70 // blueprint:"mutated" and still set it from filesystem_creator
71 Main_device *bool
Spandan Das29d44882025-01-15 21:12:36 +000072
Spandan Das00948072025-02-12 19:36:03 +000073 Ab_ota_updater *bool
74 Ab_ota_partitions []string
75 Ab_ota_keys []string
76 Ab_ota_postinstall_config []string
Jihoon Kang3be17162025-01-09 20:51:54 +000077}
78
Jihoon Kangf2c53982024-10-09 17:32:52 +000079type androidDevice struct {
80 android.ModuleBase
81
82 partitionProps PartitionNameProperties
Jihoon Kang3be17162025-01-09 20:51:54 +000083
84 deviceProps DeviceProperties
Cole Fausta472a6f2025-02-10 16:10:04 -080085
86 allImagesZip android.Path
Jihoon Kangf2c53982024-10-09 17:32:52 +000087}
88
89func AndroidDeviceFactory() android.Module {
90 module := &androidDevice{}
Jihoon Kang3be17162025-01-09 20:51:54 +000091 module.AddProperties(&module.partitionProps, &module.deviceProps)
Cole Faust341d5f12025-01-07 15:32:38 -080092 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibFirst)
Jihoon Kangf2c53982024-10-09 17:32:52 +000093 return module
94}
95
Cole Faust11fda332025-01-14 16:47:19 -080096var numMainAndroidDevicesOnceKey android.OnceKey = android.NewOnceKey("num_auto_generated_anroid_devices")
Cole Faustb55a41c2025-01-09 16:53:58 -080097
Jihoon Kangf2c53982024-10-09 17:32:52 +000098type partitionDepTagType struct {
99 blueprint.BaseDependencyTag
100}
101
Cole Faust2bdc5e52025-01-10 10:29:36 -0800102type superPartitionDepTagType struct {
103 blueprint.BaseDependencyTag
104}
Spandan Das29d44882025-01-15 21:12:36 +0000105type targetFilesMetadataDepTagType struct {
106 blueprint.BaseDependencyTag
107}
Cole Faust2bdc5e52025-01-10 10:29:36 -0800108
109var superPartitionDepTag superPartitionDepTagType
Jihoon Kangf2c53982024-10-09 17:32:52 +0000110var filesystemDepTag partitionDepTagType
Spandan Das29d44882025-01-15 21:12:36 +0000111var targetFilesMetadataDepTag targetFilesMetadataDepTagType
Jihoon Kangf2c53982024-10-09 17:32:52 +0000112
113func (a *androidDevice) DepsMutator(ctx android.BottomUpMutatorContext) {
114 addDependencyIfDefined := func(dep *string) {
115 if dep != nil {
Cole Faust341d5f12025-01-07 15:32:38 -0800116 ctx.AddDependency(ctx.Module(), filesystemDepTag, proptools.String(dep))
Jihoon Kangf2c53982024-10-09 17:32:52 +0000117 }
118 }
119
Cole Faust2bdc5e52025-01-10 10:29:36 -0800120 if a.partitionProps.Super_partition_name != nil {
121 ctx.AddDependency(ctx.Module(), superPartitionDepTag, *a.partitionProps.Super_partition_name)
122 }
Jihoon Kangf2c53982024-10-09 17:32:52 +0000123 addDependencyIfDefined(a.partitionProps.Boot_partition_name)
Jihoon Kang9e087002025-01-08 19:12:23 +0000124 addDependencyIfDefined(a.partitionProps.Init_boot_partition_name)
Spandan Dasef200ac2025-01-08 01:42:45 +0000125 addDependencyIfDefined(a.partitionProps.Vendor_boot_partition_name)
Jihoon Kangf2c53982024-10-09 17:32:52 +0000126 addDependencyIfDefined(a.partitionProps.System_partition_name)
127 addDependencyIfDefined(a.partitionProps.System_ext_partition_name)
128 addDependencyIfDefined(a.partitionProps.Product_partition_name)
129 addDependencyIfDefined(a.partitionProps.Vendor_partition_name)
Spandan Dasc5717162024-11-01 18:33:57 +0000130 addDependencyIfDefined(a.partitionProps.Odm_partition_name)
mrziwang23ba8762024-11-07 16:21:53 -0800131 addDependencyIfDefined(a.partitionProps.Userdata_partition_name)
Spandan Dasa0394002025-01-07 18:38:34 +0000132 addDependencyIfDefined(a.partitionProps.System_dlkm_partition_name)
133 addDependencyIfDefined(a.partitionProps.Vendor_dlkm_partition_name)
134 addDependencyIfDefined(a.partitionProps.Odm_dlkm_partition_name)
Spandan Dasef200ac2025-01-08 01:42:45 +0000135 addDependencyIfDefined(a.partitionProps.Recovery_partition_name)
Cole Faust3552eb62024-11-06 18:07:26 -0800136 for _, vbmetaPartition := range a.partitionProps.Vbmeta_partitions {
137 ctx.AddDependency(ctx.Module(), filesystemDepTag, vbmetaPartition)
138 }
Spandan Das29d44882025-01-15 21:12:36 +0000139 a.addDepsForTargetFilesMetadata(ctx)
140}
141
142func (a *androidDevice) addDepsForTargetFilesMetadata(ctx android.BottomUpMutatorContext) {
143 ctx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), targetFilesMetadataDepTag, "liblz4") // host variant
Jihoon Kangf2c53982024-10-09 17:32:52 +0000144}
145
Cole Faust11fda332025-01-14 16:47:19 -0800146func (a *androidDevice) GenerateAndroidBuildActions(ctx android.ModuleContext) {
147 if proptools.Bool(a.deviceProps.Main_device) {
148 numMainAndroidDevices := ctx.Config().Once(numMainAndroidDevicesOnceKey, func() interface{} {
149 return &atomic.Int32{}
150 }).(*atomic.Int32)
151 total := numMainAndroidDevices.Add(1)
152 if total > 1 {
153 // There should only be 1 main android_device module. That one will be
154 // made the default thing to build in soong-only builds.
155 ctx.ModuleErrorf("There cannot be more than 1 main android_device module")
156 }
Jihoon Kang3be17162025-01-09 20:51:54 +0000157 }
158
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000159 a.buildTargetFilesZip(ctx)
mrziwang2fd33a72025-01-08 12:22:08 -0800160 var deps []android.Path
Cole Faust2bdc5e52025-01-10 10:29:36 -0800161 if proptools.String(a.partitionProps.Super_partition_name) != "" {
Cole Faust19eb09d2025-01-14 13:27:00 -0800162 superImage := ctx.GetDirectDepProxyWithTag(*a.partitionProps.Super_partition_name, superPartitionDepTag)
Cole Faust2bdc5e52025-01-10 10:29:36 -0800163 if info, ok := android.OtherModuleProvider(ctx, superImage, SuperImageProvider); ok {
164 assertUnset := func(prop *string, propName string) {
165 if prop != nil && *prop != "" {
166 ctx.PropertyErrorf(propName, "Cannot be set because it's already part of the super image")
167 }
168 }
169 for _, subPartitionType := range android.SortedKeys(info.SubImageInfo) {
170 switch subPartitionType {
171 case "system":
172 assertUnset(a.partitionProps.System_partition_name, "system_partition_name")
173 case "system_ext":
174 assertUnset(a.partitionProps.System_ext_partition_name, "system_ext_partition_name")
175 case "system_dlkm":
176 assertUnset(a.partitionProps.System_dlkm_partition_name, "system_dlkm_partition_name")
177 case "system_other":
178 // TODO
179 case "product":
180 assertUnset(a.partitionProps.Product_partition_name, "product_partition_name")
181 case "vendor":
182 assertUnset(a.partitionProps.Vendor_partition_name, "vendor_partition_name")
183 case "vendor_dlkm":
184 assertUnset(a.partitionProps.Vendor_dlkm_partition_name, "vendor_dlkm_partition_name")
185 case "odm":
186 assertUnset(a.partitionProps.Odm_partition_name, "odm_partition_name")
187 case "odm_dlkm":
188 assertUnset(a.partitionProps.Odm_dlkm_partition_name, "odm_dlkm_partition_name")
189 default:
190 ctx.ModuleErrorf("Unsupported sub-partition of super partition: %q", subPartitionType)
191 }
192 }
193
194 deps = append(deps, info.SuperImage)
195 } else {
196 ctx.ModuleErrorf("Expected super image dep to provide SuperImageProvider")
197 }
198 }
Cole Faust19eb09d2025-01-14 13:27:00 -0800199 ctx.VisitDirectDepsProxyWithTag(filesystemDepTag, func(m android.ModuleProxy) {
mrziwang2fd33a72025-01-08 12:22:08 -0800200 imageOutput, ok := android.OtherModuleProvider(ctx, m, android.OutputFilesProvider)
201 if !ok {
202 ctx.ModuleErrorf("Partition module %s doesn't set OutputfilesProvider", m.Name())
203 }
204 if len(imageOutput.DefaultOutputFiles) != 1 {
205 ctx.ModuleErrorf("Partition module %s should provide exact 1 output file", m.Name())
206 }
207 deps = append(deps, imageOutput.DefaultOutputFiles[0])
208 })
Jihoon Kang3be17162025-01-09 20:51:54 +0000209
Cole Fausta472a6f2025-02-10 16:10:04 -0800210 allImagesZip := android.PathForModuleOut(ctx, "all_images.zip")
211 allImagesZipBuilder := android.NewRuleBuilder(pctx, ctx)
212 cmd := allImagesZipBuilder.Command().BuiltTool("soong_zip").Flag("--sort_entries")
213 for _, dep := range deps {
214 cmd.FlagWithArg("-e ", dep.Base())
215 cmd.FlagWithInput("-f ", dep)
216 }
217 cmd.FlagWithOutput("-o ", allImagesZip)
218 allImagesZipBuilder.Build("soong_all_images_zip", "all_images.zip")
219 a.allImagesZip = allImagesZip
220
Cole Faustb55a41c2025-01-09 16:53:58 -0800221 allImagesStamp := android.PathForModuleOut(ctx, "all_images_stamp")
Cole Faust11fda332025-01-14 16:47:19 -0800222 var validations android.Paths
223 if !ctx.Config().KatiEnabled() && proptools.Bool(a.deviceProps.Main_device) {
Cole Faustb55a41c2025-01-09 16:53:58 -0800224 // In soong-only builds, build this module by default.
225 // This is the analogue to this make code:
226 // https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/main.mk;l=1396;drc=6595459cdd8164a6008335f6372c9f97b9094060
227 ctx.Phony("droidcore-unbundled", allImagesStamp)
Cole Faust11fda332025-01-14 16:47:19 -0800228
Cole Faust19fbb072025-01-30 18:19:29 -0800229 deps = append(deps, a.copyFilesToProductOutForSoongOnly(ctx))
Cole Faustb55a41c2025-01-09 16:53:58 -0800230 }
Cole Faust11fda332025-01-14 16:47:19 -0800231
232 ctx.Build(pctx, android.BuildParams{
233 Rule: android.Touch,
234 Output: allImagesStamp,
235 Implicits: deps,
236 Validations: validations,
237 })
238
239 // Checkbuilding it causes soong to make a phony, so you can say `m <module name>`
240 ctx.CheckbuildFile(allImagesStamp)
Jihoon Kang0a6315b2025-01-30 01:14:49 +0000241
242 a.setVbmetaPhonyTargets(ctx)
Jihoon Kangf67b7de2025-02-12 01:01:09 +0000243
244 a.distFiles(ctx)
245}
246
247func (a *androidDevice) distFiles(ctx android.ModuleContext) {
248 if !ctx.Config().KatiEnabled() {
249 if proptools.Bool(a.deviceProps.Main_device) {
250 fsInfoMap := a.getFsInfos(ctx)
251 for _, partition := range android.SortedKeys(fsInfoMap) {
252 fsInfo := fsInfoMap[partition]
253 if fsInfo.InstalledFiles.Json != nil {
254 ctx.DistForGoal("droidcore-unbundled", fsInfo.InstalledFiles.Json)
255 }
256 if fsInfo.InstalledFiles.Txt != nil {
257 ctx.DistForGoal("droidcore-unbundled", fsInfo.InstalledFiles.Txt)
258 }
259 }
260 }
261 }
262
Cole Faust44080412024-12-20 14:17:07 -0800263}
Jihoon Kangf2c53982024-10-09 17:32:52 +0000264
Cole Fausta472a6f2025-02-10 16:10:04 -0800265func (a *androidDevice) MakeVars(ctx android.MakeVarsModuleContext) {
266 if proptools.Bool(a.deviceProps.Main_device) {
267 ctx.StrictRaw("SOONG_ONLY_ALL_IMAGES_ZIP", a.allImagesZip.String())
268 }
269}
270
Spandan Dasef775742025-01-13 22:17:40 +0000271// Helper structs for target_files.zip creation
Spandan Dasef200ac2025-01-08 01:42:45 +0000272type targetFilesZipCopy struct {
273 srcModule *string
274 destSubdir string
275}
276
Spandan Dasef775742025-01-13 22:17:40 +0000277type targetFilesystemZipCopy struct {
278 fsInfo FilesystemInfo
279 destSubdir string
280}
281
Cole Faust44080412024-12-20 14:17:07 -0800282func (a *androidDevice) buildTargetFilesZip(ctx android.ModuleContext) {
283 targetFilesDir := android.PathForModuleOut(ctx, "target_files_dir")
284 targetFilesZip := android.PathForModuleOut(ctx, "target_files.zip")
285
286 builder := android.NewRuleBuilder(pctx, ctx)
287 builder.Command().Textf("rm -rf %s", targetFilesDir.String())
288 builder.Command().Textf("mkdir -p %s", targetFilesDir.String())
Spandan Dasef200ac2025-01-08 01:42:45 +0000289 toCopy := []targetFilesZipCopy{
290 targetFilesZipCopy{a.partitionProps.System_partition_name, "SYSTEM"},
291 targetFilesZipCopy{a.partitionProps.System_ext_partition_name, "SYSTEM_EXT"},
292 targetFilesZipCopy{a.partitionProps.Product_partition_name, "PRODUCT"},
293 targetFilesZipCopy{a.partitionProps.Vendor_partition_name, "VENDOR"},
294 targetFilesZipCopy{a.partitionProps.Odm_partition_name, "ODM"},
295 targetFilesZipCopy{a.partitionProps.System_dlkm_partition_name, "SYSTEM_DLKM"},
296 targetFilesZipCopy{a.partitionProps.Vendor_dlkm_partition_name, "VENDOR_DLKM"},
297 targetFilesZipCopy{a.partitionProps.Odm_dlkm_partition_name, "ODM_DLKM"},
298 targetFilesZipCopy{a.partitionProps.Init_boot_partition_name, "BOOT/RAMDISK"},
299 targetFilesZipCopy{a.partitionProps.Init_boot_partition_name, "INIT_BOOT/RAMDISK"},
300 targetFilesZipCopy{a.partitionProps.Vendor_boot_partition_name, "VENDOR_BOOT/RAMDISK"},
Spandan Das25649f52025-01-07 18:09:22 +0000301 }
Spandan Dasef200ac2025-01-08 01:42:45 +0000302 // TODO: Handle cases where recovery files are copied to BOOT/ or RECOVERY/
303 // https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/Makefile;l=6211-6219?q=core%2FMakefile&ss=android%2Fplatform%2Fsuperproject%2Fmain
304 if ctx.DeviceConfig().BoardMoveRecoveryResourcesToVendorBoot() {
305 toCopy = append(toCopy, targetFilesZipCopy{a.partitionProps.Recovery_partition_name, "VENDOR_BOOT/RAMDISK"})
306 }
307
Spandan Dasef775742025-01-13 22:17:40 +0000308 filesystemsToCopy := []targetFilesystemZipCopy{}
Spandan Dasef200ac2025-01-08 01:42:45 +0000309 for _, zipCopy := range toCopy {
310 if zipCopy.srcModule == nil {
Spandan Das25649f52025-01-07 18:09:22 +0000311 continue
312 }
Spandan Dasef775742025-01-13 22:17:40 +0000313 filesystemsToCopy = append(
314 filesystemsToCopy,
315 targetFilesystemZipCopy{a.getFilesystemInfo(ctx, *zipCopy.srcModule), zipCopy.destSubdir},
316 )
317 }
318 // Get additional filesystems from super_partition dependency
319 if a.partitionProps.Super_partition_name != nil {
Cole Faust19eb09d2025-01-14 13:27:00 -0800320 superPartition := ctx.GetDirectDepProxyWithTag(*a.partitionProps.Super_partition_name, superPartitionDepTag)
Spandan Dasef775742025-01-13 22:17:40 +0000321 if info, ok := android.OtherModuleProvider(ctx, superPartition, SuperImageProvider); ok {
322 for _, partition := range android.SortedStringKeys(info.SubImageInfo) {
323 filesystemsToCopy = append(
324 filesystemsToCopy,
325 targetFilesystemZipCopy{info.SubImageInfo[partition], strings.ToUpper(partition)},
326 )
327 }
328 } else {
329 ctx.ModuleErrorf("Super partition %s does set SuperImageProvider\n", superPartition.Name())
330 }
331 }
332
333 for _, toCopy := range filesystemsToCopy {
334 rootDirString := toCopy.fsInfo.RootDir.String()
335 if toCopy.destSubdir == "SYSTEM" {
Spandan Dasef200ac2025-01-08 01:42:45 +0000336 rootDirString = rootDirString + "/system"
337 }
Spandan Dasef775742025-01-13 22:17:40 +0000338 builder.Command().Textf("mkdir -p %s/%s", targetFilesDir.String(), toCopy.destSubdir)
Cole Faust44080412024-12-20 14:17:07 -0800339 builder.Command().
340 BuiltTool("acp").
Spandan Dasef775742025-01-13 22:17:40 +0000341 Textf("-rd %s/. %s/%s", rootDirString, targetFilesDir, toCopy.destSubdir).
342 Implicit(toCopy.fsInfo.Output) // so that the staging dir is built
Spandan Dasef200ac2025-01-08 01:42:45 +0000343
Spandan Dasef775742025-01-13 22:17:40 +0000344 if toCopy.destSubdir == "SYSTEM" {
Spandan Das3ec6d062025-01-09 19:37:47 +0000345 // Create the ROOT partition in target_files.zip
Spandan Dasef775742025-01-13 22:17:40 +0000346 builder.Command().Textf("rsync --links --exclude=system/* %s/ -r %s/ROOT", toCopy.fsInfo.RootDir, targetFilesDir.String())
Spandan Das3ec6d062025-01-09 19:37:47 +0000347 }
Cole Faust44080412024-12-20 14:17:07 -0800348 }
Spandan Das9b17df22025-01-08 23:30:45 +0000349 // Copy cmdline, kernel etc. files of boot images
Spandan Das258c08f2025-01-08 23:30:45 +0000350 if a.partitionProps.Vendor_boot_partition_name != nil {
Cole Faust19eb09d2025-01-14 13:27:00 -0800351 bootImg := ctx.GetDirectDepProxyWithTag(proptools.String(a.partitionProps.Vendor_boot_partition_name), filesystemDepTag)
Spandan Das258c08f2025-01-08 23:30:45 +0000352 bootImgInfo, _ := android.OtherModuleProvider(ctx, bootImg, BootimgInfoProvider)
Spandan Das9b17df22025-01-08 23:30:45 +0000353 builder.Command().Textf("echo %s > %s/VENDOR_BOOT/cmdline", proptools.ShellEscape(strings.Join(bootImgInfo.Cmdline, " ")), targetFilesDir)
354 builder.Command().Textf("echo %s > %s/VENDOR_BOOT/vendor_cmdline", proptools.ShellEscape(strings.Join(bootImgInfo.Cmdline, " ")), targetFilesDir)
355 if bootImgInfo.Dtb != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000356 builder.Command().Textf("cp ").Input(bootImgInfo.Dtb).Textf(" %s/VENDOR_BOOT/dtb", targetFilesDir)
Spandan Das9b17df22025-01-08 23:30:45 +0000357 }
Spandan Das23511372025-01-08 23:30:45 +0000358 if bootImgInfo.Bootconfig != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000359 builder.Command().Textf("cp ").Input(bootImgInfo.Bootconfig).Textf(" %s/VENDOR_BOOT/vendor_bootconfig", targetFilesDir)
Spandan Das23511372025-01-08 23:30:45 +0000360 }
Spandan Das258c08f2025-01-08 23:30:45 +0000361 }
362 if a.partitionProps.Boot_partition_name != nil {
Cole Faust19eb09d2025-01-14 13:27:00 -0800363 bootImg := ctx.GetDirectDepProxyWithTag(proptools.String(a.partitionProps.Boot_partition_name), filesystemDepTag)
Spandan Das258c08f2025-01-08 23:30:45 +0000364 bootImgInfo, _ := android.OtherModuleProvider(ctx, bootImg, BootimgInfoProvider)
Spandan Das9b17df22025-01-08 23:30:45 +0000365 builder.Command().Textf("echo %s > %s/BOOT/cmdline", proptools.ShellEscape(strings.Join(bootImgInfo.Cmdline, " ")), targetFilesDir)
366 if bootImgInfo.Dtb != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000367 builder.Command().Textf("cp ").Input(bootImgInfo.Dtb).Textf(" %s/BOOT/dtb", targetFilesDir)
Spandan Das9b17df22025-01-08 23:30:45 +0000368 }
369 if bootImgInfo.Kernel != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000370 builder.Command().Textf("cp ").Input(bootImgInfo.Kernel).Textf(" %s/BOOT/kernel", targetFilesDir)
Spandan Das9b17df22025-01-08 23:30:45 +0000371 // Even though kernel is not used to build vendor_boot, copy the kernel to VENDOR_BOOT to match the behavior of make packaging.
Spandan Dasfed3d042025-01-13 21:38:47 +0000372 builder.Command().Textf("cp ").Input(bootImgInfo.Kernel).Textf(" %s/VENDOR_BOOT/kernel", targetFilesDir)
Spandan Das9b17df22025-01-08 23:30:45 +0000373 }
Spandan Das23511372025-01-08 23:30:45 +0000374 if bootImgInfo.Bootconfig != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000375 builder.Command().Textf("cp ").Input(bootImgInfo.Bootconfig).Textf(" %s/BOOT/bootconfig", targetFilesDir)
Spandan Das23511372025-01-08 23:30:45 +0000376 }
Spandan Das258c08f2025-01-08 23:30:45 +0000377 }
378
Spandan Dase51ff952025-01-09 18:11:59 +0000379 if a.deviceProps.Android_info != nil {
380 builder.Command().Textf("mkdir -p %s/OTA", targetFilesDir)
Cole Faust11fda332025-01-14 16:47:19 -0800381 builder.Command().Textf("cp ").Input(android.PathForModuleSrc(ctx, *a.deviceProps.Android_info)).Textf(" %s/OTA/android-info.txt", targetFilesDir)
Spandan Dase51ff952025-01-09 18:11:59 +0000382 }
383
Spandan Das0036fa32025-01-10 23:40:45 +0000384 a.copyImagesToTargetZip(ctx, builder, targetFilesDir)
Spandan Das29d44882025-01-15 21:12:36 +0000385 a.copyMetadataToTargetZip(ctx, builder, targetFilesDir)
Spandan Das0036fa32025-01-10 23:40:45 +0000386
Cole Faust44080412024-12-20 14:17:07 -0800387 builder.Command().
388 BuiltTool("soong_zip").
389 Text("-d").
390 FlagWithOutput("-o ", targetFilesZip).
391 FlagWithArg("-C ", targetFilesDir.String()).
392 FlagWithArg("-D ", targetFilesDir.String()).
393 Text("-sha256")
394 builder.Build("target_files_"+ctx.ModuleName(), "Build target_files.zip")
395}
396
Spandan Das0036fa32025-01-10 23:40:45 +0000397func (a *androidDevice) copyImagesToTargetZip(ctx android.ModuleContext, builder *android.RuleBuilder, targetFilesDir android.WritablePath) {
398 // Create an IMAGES/ subdirectory
399 builder.Command().Textf("mkdir -p %s/IMAGES", targetFilesDir.String())
400 if a.deviceProps.Bootloader != nil {
401 builder.Command().Textf("cp ").Input(android.PathForModuleSrc(ctx, proptools.String(a.deviceProps.Bootloader))).Textf(" %s/IMAGES/bootloader", targetFilesDir.String())
402 }
403 // Copy the filesystem ,boot and vbmeta img files to IMAGES/
404 ctx.VisitDirectDepsProxyWithTag(filesystemDepTag, func(child android.ModuleProxy) {
Spandan Dasa9db76d2025-01-14 01:34:43 +0000405 if strings.Contains(child.Name(), "recovery") {
406 return // skip recovery.img to match the make packaging behavior
407 }
Spandan Dasef775742025-01-13 22:17:40 +0000408 if info, ok := android.OtherModuleProvider(ctx, child, BootimgInfoProvider); ok {
409 // Check Boot img first so that the boot.img is copied and not its dep ramdisk.img
Spandan Das0036fa32025-01-10 23:40:45 +0000410 builder.Command().Textf("cp ").Input(info.Output).Textf(" %s/IMAGES/", targetFilesDir.String())
Spandan Dasef775742025-01-13 22:17:40 +0000411 } else if info, ok := android.OtherModuleProvider(ctx, child, FilesystemProvider); ok {
Spandan Das0036fa32025-01-10 23:40:45 +0000412 builder.Command().Textf("cp ").Input(info.Output).Textf(" %s/IMAGES/", targetFilesDir.String())
413 } else if info, ok := android.OtherModuleProvider(ctx, child, vbmetaPartitionProvider); ok {
414 builder.Command().Textf("cp ").Input(info.Output).Textf(" %s/IMAGES/", targetFilesDir.String())
415 } else {
416 ctx.ModuleErrorf("Module %s does not provide an .img file output for target_files.zip", child.Name())
417 }
418 })
Spandan Dasef775742025-01-13 22:17:40 +0000419
420 if a.partitionProps.Super_partition_name != nil {
Cole Faust19eb09d2025-01-14 13:27:00 -0800421 superPartition := ctx.GetDirectDepProxyWithTag(*a.partitionProps.Super_partition_name, superPartitionDepTag)
Spandan Dasef775742025-01-13 22:17:40 +0000422 if info, ok := android.OtherModuleProvider(ctx, superPartition, SuperImageProvider); ok {
Cole Faust19eb09d2025-01-14 13:27:00 -0800423 for _, partition := range android.SortedKeys(info.SubImageInfo) {
Spandan Das7a42d1c2025-02-12 01:32:21 +0000424 if info.SubImageInfo[partition].OutputHermetic != nil {
425 builder.Command().Textf("cp ").Input(info.SubImageInfo[partition].OutputHermetic).Textf(" %s/IMAGES/", targetFilesDir.String())
426 }
427 if info.SubImageInfo[partition].MapFile != nil {
428 builder.Command().Textf("cp ").Input(info.SubImageInfo[partition].MapFile).Textf(" %s/IMAGES/", targetFilesDir.String())
429 }
Spandan Dasef775742025-01-13 22:17:40 +0000430 }
431 } else {
432 ctx.ModuleErrorf("Super partition %s does set SuperImageProvider\n", superPartition.Name())
433 }
434 }
Spandan Das0036fa32025-01-10 23:40:45 +0000435}
436
Spandan Das29d44882025-01-15 21:12:36 +0000437func (a *androidDevice) copyMetadataToTargetZip(ctx android.ModuleContext, builder *android.RuleBuilder, targetFilesDir android.WritablePath) {
438 // Create a META/ subdirectory
439 builder.Command().Textf("mkdir -p %s/META", targetFilesDir.String())
440 if proptools.Bool(a.deviceProps.Ab_ota_updater) {
441 ctx.VisitDirectDepsProxyWithTag(targetFilesMetadataDepTag, func(child android.ModuleProxy) {
442 info, _ := android.OtherModuleProvider(ctx, child, android.OutputFilesProvider)
443 builder.Command().Textf("cp").Inputs(info.DefaultOutputFiles).Textf(" %s/META/", targetFilesDir.String())
444 })
Spandan Dasb5f40cf2025-02-12 19:36:03 +0000445 builder.Command().Textf("cp").Input(android.PathForSource(ctx, "external/zucchini/version_info.h")).Textf(" %s/META/zucchini_config.txt", targetFilesDir.String())
446 builder.Command().Textf("cp").Input(android.PathForSource(ctx, "system/update_engine/update_engine.conf")).Textf(" %s/META/update_engine_config.txt", targetFilesDir.String())
447 if a.getFsInfos(ctx)["system"].ErofsCompressHints != nil {
448 builder.Command().Textf("cp").Input(a.getFsInfos(ctx)["system"].ErofsCompressHints).Textf(" %s/META/erofs_default_compress_hints.txt", targetFilesDir.String())
449 }
450 // ab_partitions.txt
451 abPartitionsSorted := android.SortedUniqueStrings(a.deviceProps.Ab_ota_partitions)
452 abPartitionsSortedString := proptools.ShellEscape(strings.Join(abPartitionsSorted, "\\n"))
453 builder.Command().Textf("echo -e").Flag(abPartitionsSortedString).Textf(" > %s/META/ab_partitions.txt", targetFilesDir.String())
Spandan Das35b78742025-02-12 19:36:03 +0000454 // otakeys.txt
455 abOtaKeysSorted := android.SortedUniqueStrings(a.deviceProps.Ab_ota_keys)
456 abOtaKeysSortedString := proptools.ShellEscape(strings.Join(abOtaKeysSorted, "\\n"))
457 builder.Command().Textf("echo -e").Flag(abOtaKeysSortedString).Textf(" > %s/META/otakeys.txt", targetFilesDir.String())
Spandan Das00948072025-02-12 19:36:03 +0000458 // postinstall_config.txt
459 abOtaPostInstallConfigString := proptools.ShellEscape(strings.Join(a.deviceProps.Ab_ota_postinstall_config, "\\n"))
460 builder.Command().Textf("echo -e").Flag(abOtaPostInstallConfigString).Textf(" > %s/META/postinstall_config.txt", targetFilesDir.String())
Spandan Dasf12ff9b2025-02-12 22:27:43 +0000461 // selinuxfc
462 if a.getFsInfos(ctx)["system"].SelinuxFc != nil {
463 builder.Command().Textf("cp").Input(a.getFsInfos(ctx)["system"].SelinuxFc).Textf(" %s/META/file_contexts.bin", targetFilesDir.String())
464 }
Spandan Dasd71af182025-02-12 18:03:29 +0000465 }
Spandan Das29d44882025-01-15 21:12:36 +0000466}
467
Cole Faust44080412024-12-20 14:17:07 -0800468func (a *androidDevice) getFilesystemInfo(ctx android.ModuleContext, depName string) FilesystemInfo {
Cole Faust19eb09d2025-01-14 13:27:00 -0800469 fsMod := ctx.GetDirectDepProxyWithTag(depName, filesystemDepTag)
Cole Faust44080412024-12-20 14:17:07 -0800470 fsInfo, ok := android.OtherModuleProvider(ctx, fsMod, FilesystemProvider)
471 if !ok {
472 ctx.ModuleErrorf("Expected dependency %s to be a filesystem", depName)
473 }
474 return fsInfo
Jihoon Kangf2c53982024-10-09 17:32:52 +0000475}
Jihoon Kang0a6315b2025-01-30 01:14:49 +0000476
477func (a *androidDevice) setVbmetaPhonyTargets(ctx android.ModuleContext) {
478 if !proptools.Bool(a.deviceProps.Main_device) {
479 return
480 }
481
482 if !ctx.Config().KatiEnabled() {
483 for _, vbmetaPartitionName := range a.partitionProps.Vbmeta_partitions {
484 img := ctx.GetDirectDepProxyWithTag(vbmetaPartitionName, filesystemDepTag)
485 if provider, ok := android.OtherModuleProvider(ctx, img, vbmetaPartitionProvider); ok {
486 // make generates `vbmetasystemimage` phony target instead of `vbmeta_systemimage` phony target.
487 partitionName := strings.ReplaceAll(provider.Name, "_", "")
488 ctx.Phony(fmt.Sprintf("%simage", partitionName), provider.Output)
489 }
490 }
491 }
492}