blob: 025ba27aadd6c0e7ca2ae7a9342bb7397a7c8053 [file] [log] [blame]
Jiyong Parkc678ad32018-04-10 13:07:10 +09001// Copyright 2016 Google Inc. All rights reserved.
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
Jaewoong Jung4b79e982020-06-01 10:45:49 -070015package etc
Jiyong Parkc678ad32018-04-10 13:07:10 +090016
Yo Chiang803c40d2020-11-16 20:32:51 +080017// This file implements module types that install prebuilt artifacts.
18//
19// There exist two classes of prebuilt modules in the Android tree. The first class are the ones
20// based on `android.Prebuilt`, such as `cc_prebuilt_library` and `java_import`. This kind of
21// modules may exist both as prebuilts and source at the same time, though only one would be
22// installed and the other would be marked disabled. The `prebuilt_postdeps` mutator would select
23// the actual modules to be installed. More details in android/prebuilt.go.
24//
25// The second class is described in this file. Unlike `android.Prebuilt` based module types,
26// `prebuilt_etc` exist only as prebuilts and cannot have a same-named source module counterpart.
27// This makes the logic of `prebuilt_etc` to be much simpler as they don't need to go through the
28// various `prebuilt_*` mutators.
Jaewoong Jung4b79e982020-06-01 10:45:49 -070029
Yo Chiang803c40d2020-11-16 20:32:51 +080030import (
Jiyong Park76a42f52021-02-16 06:50:37 +090031 "fmt"
Kiyoung Kimae11c232021-07-19 11:38:04 +090032 "path/filepath"
Inseob Kim27408bf2021-04-06 21:00:17 +090033 "strings"
Jiyong Park76a42f52021-02-16 06:50:37 +090034
Jaewoong Jung4b79e982020-06-01 10:45:49 -070035 "github.com/google/blueprint/proptools"
36
37 "android/soong/android"
38)
39
40var pctx = android.NewPackageContext("android/soong/etc")
Jiyong Parkc678ad32018-04-10 13:07:10 +090041
Jaewoong Jungc3fcdb42019-02-13 05:50:33 -080042// TODO(jungw): Now that it handles more than the ones in etc/, consider renaming this file.
Jiyong Parkc678ad32018-04-10 13:07:10 +090043
44func init() {
Jaewoong Jung4b79e982020-06-01 10:45:49 -070045 pctx.Import("android/soong/android")
Jooyung Han0703fd82020-08-26 22:11:53 +090046 RegisterPrebuiltEtcBuildComponents(android.InitRegistrationContext)
47}
Jaewoong Jung4b79e982020-06-01 10:45:49 -070048
Jooyung Han0703fd82020-08-26 22:11:53 +090049func RegisterPrebuiltEtcBuildComponents(ctx android.RegistrationContext) {
50 ctx.RegisterModuleType("prebuilt_etc", PrebuiltEtcFactory)
51 ctx.RegisterModuleType("prebuilt_etc_host", PrebuiltEtcHostFactory)
Miguel32b02802022-12-01 18:38:26 +000052 ctx.RegisterModuleType("prebuilt_etc_cacerts", PrebuiltEtcCaCertsFactory)
Inseob Kim27408bf2021-04-06 21:00:17 +090053 ctx.RegisterModuleType("prebuilt_root", PrebuiltRootFactory)
Liz Kammere9ecddc2022-01-04 17:27:52 -050054 ctx.RegisterModuleType("prebuilt_root_host", PrebuiltRootHostFactory)
Jooyung Han0703fd82020-08-26 22:11:53 +090055 ctx.RegisterModuleType("prebuilt_usr_share", PrebuiltUserShareFactory)
56 ctx.RegisterModuleType("prebuilt_usr_share_host", PrebuiltUserShareHostFactory)
yangbill63c5e192024-03-27 09:02:12 +000057 ctx.RegisterModuleType("prebuilt_usr_hyphendata", PrebuiltUserHyphenDataFactory)
yangbill85527e62024-04-30 08:24:50 +000058 ctx.RegisterModuleType("prebuilt_usr_keylayout", PrebuiltUserKeyLayoutFactory)
59 ctx.RegisterModuleType("prebuilt_usr_keychars", PrebuiltUserKeyCharsFactory)
60 ctx.RegisterModuleType("prebuilt_usr_idc", PrebuiltUserIdcFactory)
Jooyung Han0703fd82020-08-26 22:11:53 +090061 ctx.RegisterModuleType("prebuilt_font", PrebuiltFontFactory)
62 ctx.RegisterModuleType("prebuilt_firmware", PrebuiltFirmwareFactory)
63 ctx.RegisterModuleType("prebuilt_dsp", PrebuiltDSPFactory)
Colin Cross83ebf232021-04-09 09:41:23 -070064 ctx.RegisterModuleType("prebuilt_rfsa", PrebuiltRFSAFactory)
Colin Crossf17e2b52023-10-30 15:17:25 -070065 ctx.RegisterModuleType("prebuilt_renderscript_bitcode", PrebuiltRenderScriptBitcodeFactory)
Inseob Kim1e27a142021-05-06 11:46:11 +000066
67 ctx.RegisterModuleType("prebuilt_defaults", defaultsFactory)
Rupert Shuttleworth378fc1b2021-07-28 08:03:16 -040068
Jiyong Parkc678ad32018-04-10 13:07:10 +090069}
70
Paul Duffin1172fed2021-03-08 11:28:18 +000071var PrepareForTestWithPrebuiltEtc = android.FixtureRegisterWithContext(RegisterPrebuiltEtcBuildComponents)
72
Jiyong Parkc678ad32018-04-10 13:07:10 +090073type prebuiltEtcProperties struct {
Yo Chiang803c40d2020-11-16 20:32:51 +080074 // Source file of this prebuilt. Can reference a genrule type module with the ":module" syntax.
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +110075 // Mutually exclusive with srcs.
Colin Cross27b922f2019-03-04 22:35:41 -080076 Src *string `android:"path,arch_variant"`
Jiyong Parkc678ad32018-04-10 13:07:10 +090077
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +110078 // Source files of this prebuilt. Can reference a genrule type module with the ":module" syntax.
79 // Mutually exclusive with src. When used, filename_from_src is set to true.
80 Srcs []string `android:"path,arch_variant"`
81
Yo Chiangf0e19fe2020-11-18 15:28:42 +080082 // Optional name for the installed file. If unspecified, name of the module is used as the file
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +110083 // name. Only available when using a single source (src).
Jiyong Park139a2e62018-10-26 21:49:39 +090084 Filename *string `android:"arch_variant"`
85
Yo Chiangf0e19fe2020-11-18 15:28:42 +080086 // When set to true, and filename property is not set, the name for the installed file
Jiyong Park1a7cf082018-11-13 11:59:12 +090087 // is the same as the file name of the source file.
88 Filename_from_src *bool `android:"arch_variant"`
89
Yifan Hong1b3348d2020-01-21 15:53:22 -080090 // Make this module available when building for ramdisk.
Yifan Hong39143a92020-10-26 12:43:12 -070091 // On device without a dedicated recovery partition, the module is only
92 // available after switching root into
93 // /first_stage_ramdisk. To expose the module before switching root, install
94 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -080095 Ramdisk_available *bool
96
Yifan Hong60e0cfb2020-10-21 15:17:56 -070097 // Make this module available when building for vendor ramdisk.
Yifan Hong39143a92020-10-26 12:43:12 -070098 // On device without a dedicated recovery partition, the module is only
99 // available after switching root into
100 // /first_stage_ramdisk. To expose the module before switching root, install
101 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700102 Vendor_ramdisk_available *bool
103
Inseob Kim08758f02021-04-08 21:13:22 +0900104 // Make this module available when building for debug ramdisk.
105 Debug_ramdisk_available *bool
106
Tao Bao0ba5c942018-08-14 22:20:22 -0700107 // Make this module available when building for recovery.
108 Recovery_available *bool
109
Jiyong Parkad9ce042018-10-31 22:49:57 +0900110 // Whether this module is directly installable to one of the partitions. Default: true.
111 Installable *bool
Yo Chiang3d64d492020-05-27 17:56:39 +0800112
113 // Install symlinks to the installed file.
114 Symlinks []string `android:"arch_variant"`
Jiyong Parkc678ad32018-04-10 13:07:10 +0900115}
116
Inseob Kim27408bf2021-04-06 21:00:17 +0900117type prebuiltSubdirProperties struct {
118 // Optional subdirectory under which this file is installed into, cannot be specified with
119 // relative_install_path, prefer relative_install_path.
120 Sub_dir *string `android:"arch_variant"`
121
122 // Optional subdirectory under which this file is installed into, cannot be specified with
123 // sub_dir.
124 Relative_install_path *string `android:"arch_variant"`
125}
126
Jooyung Han39edb6c2019-11-06 16:53:07 +0900127type PrebuiltEtcModule interface {
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700128 android.Module
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800129
130 // Returns the base install directory, such as "etc", "usr/share".
Jooyung Han0703fd82020-08-26 22:11:53 +0900131 BaseDir() string
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800132
133 // Returns the sub install directory relative to BaseDir().
Jooyung Han39edb6c2019-11-06 16:53:07 +0900134 SubDir() string
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800135
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100136 // Returns an android.OutputPath to the intermediate file, which is the renamed prebuilt source
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800137 // file.
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100138 OutputFiles(tag string) (android.Paths, error)
Jooyung Han39edb6c2019-11-06 16:53:07 +0900139}
140
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900141type PrebuiltEtc struct {
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700142 android.ModuleBase
Inseob Kim1e27a142021-05-06 11:46:11 +0000143 android.DefaultableModuleBase
Jiyong Parkc678ad32018-04-10 13:07:10 +0900144
Inseob Kim27408bf2021-04-06 21:00:17 +0900145 properties prebuiltEtcProperties
146 subdirProperties prebuiltSubdirProperties
Jiyong Parkc678ad32018-04-10 13:07:10 +0900147
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100148 sourceFilePaths android.Paths
149 outputFilePaths android.OutputPaths
Jaewoong Jungc3fcdb42019-02-13 05:50:33 -0800150 // The base install location, e.g. "etc" for prebuilt_etc, "usr/share" for prebuilt_usr_share.
Colin Cross2f634572023-11-13 12:12:06 -0800151 installDirBase string
152 installDirBase64 string
153 installAvoidMultilibConflict bool
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800154 // The base install location when soc_specific property is set to true, e.g. "firmware" for
155 // prebuilt_firmware.
Patrice Arruda057a8b12019-06-03 15:29:27 -0700156 socInstallDirBase string
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700157 installDirPath android.InstallPath
158 additionalDependencies *android.Paths
Colin Crossf17e2b52023-10-30 15:17:25 -0700159
160 makeClass string
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000161
162 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
163 mergedAconfigFiles map[string]android.Paths
Jiyong Parkc678ad32018-04-10 13:07:10 +0900164}
165
Inseob Kim1e27a142021-05-06 11:46:11 +0000166type Defaults struct {
167 android.ModuleBase
168 android.DefaultsModuleBase
169}
170
Yifan Hong1b3348d2020-01-21 15:53:22 -0800171func (p *PrebuiltEtc) inRamdisk() bool {
172 return p.ModuleBase.InRamdisk() || p.ModuleBase.InstallInRamdisk()
173}
174
175func (p *PrebuiltEtc) onlyInRamdisk() bool {
176 return p.ModuleBase.InstallInRamdisk()
177}
178
179func (p *PrebuiltEtc) InstallInRamdisk() bool {
180 return p.inRamdisk()
181}
182
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700183func (p *PrebuiltEtc) inVendorRamdisk() bool {
184 return p.ModuleBase.InVendorRamdisk() || p.ModuleBase.InstallInVendorRamdisk()
185}
186
187func (p *PrebuiltEtc) onlyInVendorRamdisk() bool {
188 return p.ModuleBase.InstallInVendorRamdisk()
189}
190
191func (p *PrebuiltEtc) InstallInVendorRamdisk() bool {
192 return p.inVendorRamdisk()
193}
194
Inseob Kim08758f02021-04-08 21:13:22 +0900195func (p *PrebuiltEtc) inDebugRamdisk() bool {
196 return p.ModuleBase.InDebugRamdisk() || p.ModuleBase.InstallInDebugRamdisk()
197}
198
199func (p *PrebuiltEtc) onlyInDebugRamdisk() bool {
200 return p.ModuleBase.InstallInDebugRamdisk()
201}
202
203func (p *PrebuiltEtc) InstallInDebugRamdisk() bool {
204 return p.inDebugRamdisk()
205}
206
Kiyoung Kimae11c232021-07-19 11:38:04 +0900207func (p *PrebuiltEtc) InRecovery() bool {
Colin Cross7228ecd2019-11-18 16:00:16 -0800208 return p.ModuleBase.InRecovery() || p.ModuleBase.InstallInRecovery()
Tao Bao0ba5c942018-08-14 22:20:22 -0700209}
210
211func (p *PrebuiltEtc) onlyInRecovery() bool {
212 return p.ModuleBase.InstallInRecovery()
213}
214
215func (p *PrebuiltEtc) InstallInRecovery() bool {
Kiyoung Kimae11c232021-07-19 11:38:04 +0900216 return p.InRecovery()
Tao Bao0ba5c942018-08-14 22:20:22 -0700217}
218
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700219var _ android.ImageInterface = (*PrebuiltEtc)(nil)
Colin Cross7228ecd2019-11-18 16:00:16 -0800220
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700221func (p *PrebuiltEtc) ImageMutatorBegin(ctx android.BaseModuleContext) {}
Colin Cross7228ecd2019-11-18 16:00:16 -0800222
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700223func (p *PrebuiltEtc) CoreVariantNeeded(ctx android.BaseModuleContext) bool {
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700224 return !p.ModuleBase.InstallInRecovery() && !p.ModuleBase.InstallInRamdisk() &&
Inseob Kim08758f02021-04-08 21:13:22 +0900225 !p.ModuleBase.InstallInVendorRamdisk() && !p.ModuleBase.InstallInDebugRamdisk()
Yifan Hong1b3348d2020-01-21 15:53:22 -0800226}
227
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700228func (p *PrebuiltEtc) RamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
229 return proptools.Bool(p.properties.Ramdisk_available) || p.ModuleBase.InstallInRamdisk()
Colin Cross7228ecd2019-11-18 16:00:16 -0800230}
231
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700232func (p *PrebuiltEtc) VendorRamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
233 return proptools.Bool(p.properties.Vendor_ramdisk_available) || p.ModuleBase.InstallInVendorRamdisk()
234}
235
Inseob Kim08758f02021-04-08 21:13:22 +0900236func (p *PrebuiltEtc) DebugRamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
237 return proptools.Bool(p.properties.Debug_ramdisk_available) || p.ModuleBase.InstallInDebugRamdisk()
238}
239
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700240func (p *PrebuiltEtc) RecoveryVariantNeeded(ctx android.BaseModuleContext) bool {
241 return proptools.Bool(p.properties.Recovery_available) || p.ModuleBase.InstallInRecovery()
Colin Cross7228ecd2019-11-18 16:00:16 -0800242}
243
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700244func (p *PrebuiltEtc) ExtraImageVariations(ctx android.BaseModuleContext) []string {
Colin Cross7228ecd2019-11-18 16:00:16 -0800245 return nil
246}
247
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700248func (p *PrebuiltEtc) SetImageVariation(ctx android.BaseModuleContext, variation string, module android.Module) {
Colin Cross7228ecd2019-11-18 16:00:16 -0800249}
250
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700251func (p *PrebuiltEtc) SourceFilePath(ctx android.ModuleContext) android.Path {
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100252 if len(p.properties.Srcs) > 0 {
253 panic(fmt.Errorf("SourceFilePath not available on multi-source prebuilt %q", p.Name()))
254 }
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800255 return android.PathForModuleSrc(ctx, proptools.String(p.properties.Src))
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900256}
257
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700258func (p *PrebuiltEtc) InstallDirPath() android.InstallPath {
Jooyung Hana0171822019-07-22 15:48:36 +0900259 return p.installDirPath
260}
261
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900262// This allows other derivative modules (e.g. prebuilt_etc_xml) to perform
263// additional steps (like validating the src) before the file is installed.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700264func (p *PrebuiltEtc) SetAdditionalDependencies(paths android.Paths) {
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900265 p.additionalDependencies = &paths
266}
267
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700268func (p *PrebuiltEtc) OutputFile() android.OutputPath {
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100269 if len(p.properties.Srcs) > 0 {
270 panic(fmt.Errorf("OutputFile not available on multi-source prebuilt %q", p.Name()))
271 }
272 return p.outputFilePaths[0]
Jiyong Parkc43e0ac2018-10-04 20:27:15 +0900273}
274
Jiyong Park76a42f52021-02-16 06:50:37 +0900275var _ android.OutputFileProducer = (*PrebuiltEtc)(nil)
276
277func (p *PrebuiltEtc) OutputFiles(tag string) (android.Paths, error) {
278 switch tag {
279 case "":
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100280 return p.outputFilePaths.Paths(), nil
Jiyong Park76a42f52021-02-16 06:50:37 +0900281 default:
282 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
283 }
284}
285
Jiyong Parkc43e0ac2018-10-04 20:27:15 +0900286func (p *PrebuiltEtc) SubDir() string {
Inseob Kim27408bf2021-04-06 21:00:17 +0900287 if subDir := proptools.String(p.subdirProperties.Sub_dir); subDir != "" {
Liz Kammer0449a632020-06-26 10:12:36 -0700288 return subDir
289 }
Inseob Kim27408bf2021-04-06 21:00:17 +0900290 return proptools.String(p.subdirProperties.Relative_install_path)
Jiyong Parkc43e0ac2018-10-04 20:27:15 +0900291}
292
Jooyung Han0703fd82020-08-26 22:11:53 +0900293func (p *PrebuiltEtc) BaseDir() string {
Jooyung Han8e5685d2020-09-21 11:02:57 +0900294 return p.installDirBase
Jooyung Han0703fd82020-08-26 22:11:53 +0900295}
296
Jiyong Parkad9ce042018-10-31 22:49:57 +0900297func (p *PrebuiltEtc) Installable() bool {
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800298 return p.properties.Installable == nil || proptools.Bool(p.properties.Installable)
Jiyong Parkad9ce042018-10-31 22:49:57 +0900299}
300
Kiyoung Kimae11c232021-07-19 11:38:04 +0900301func (p *PrebuiltEtc) InVendor() bool {
302 return p.ModuleBase.InstallInVendor()
303}
304
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100305func (p *PrebuiltEtc) installBaseDir(ctx android.ModuleContext) string {
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800306 // If soc install dir was specified and SOC specific is set, set the installDirPath to the
307 // specified socInstallDirBase.
Jooyung Han8e5685d2020-09-21 11:02:57 +0900308 installBaseDir := p.installDirBase
Colin Crossf17e2b52023-10-30 15:17:25 -0700309 if p.Target().Arch.ArchType.Multilib == "lib64" && p.installDirBase64 != "" {
310 installBaseDir = p.installDirBase64
311 }
Jooyung Han8e5685d2020-09-21 11:02:57 +0900312 if p.SocSpecific() && p.socInstallDirBase != "" {
313 installBaseDir = p.socInstallDirBase
314 }
Colin Cross2f634572023-11-13 12:12:06 -0800315 if p.installAvoidMultilibConflict && !ctx.Host() && ctx.Config().HasMultilibConflict(ctx.Arch().ArchType) {
316 installBaseDir = filepath.Join(installBaseDir, ctx.Arch().ArchType.String())
317 }
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100318 return installBaseDir
319}
Colin Cross2f634572023-11-13 12:12:06 -0800320
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100321func (p *PrebuiltEtc) GenerateAndroidBuildActions(ctx android.ModuleContext) {
322 var installs []installProperties
Jiyong Parkc43e0ac2018-10-04 20:27:15 +0900323
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100324 if p.properties.Src != nil && len(p.properties.Srcs) > 0 {
325 ctx.PropertyErrorf("src", "src is set. Cannot set srcs")
Spandan Das756d3402023-06-05 22:49:50 +0000326 }
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100327
328 // Check that `sub_dir` and `relative_install_path` are not set at the same time.
329 if p.subdirProperties.Sub_dir != nil && p.subdirProperties.Relative_install_path != nil {
330 ctx.PropertyErrorf("sub_dir", "relative_install_path is set. Cannot set sub_dir")
331 }
332 p.installDirPath = android.PathForModuleInstall(ctx, p.installBaseDir(ctx), p.SubDir())
333
334 filename := proptools.String(p.properties.Filename)
335 filenameFromSrc := proptools.Bool(p.properties.Filename_from_src)
336 if p.properties.Src != nil {
337 p.sourceFilePaths = android.PathsForModuleSrc(ctx, []string{proptools.String(p.properties.Src)})
338 // If the source was not found, set a fake source path to
339 // support AllowMissingDependencies executions.
340 if len(p.sourceFilePaths) == 0 {
341 p.sourceFilePaths = android.Paths{android.PathForModuleSrc(ctx)}
342 }
343
344 // Determine the output file basename.
345 // If Filename is set, use the name specified by the property.
346 // If Filename_from_src is set, use the source file name.
347 // Otherwise use the module name.
348 if filename != "" {
349 if filenameFromSrc {
350 ctx.PropertyErrorf("filename_from_src", "filename is set. filename_from_src can't be true")
351 return
352 }
353 } else if filenameFromSrc {
354 filename = p.sourceFilePaths[0].Base()
355 } else {
356 filename = ctx.ModuleName()
357 }
358 if strings.Contains(filename, "/") {
359 ctx.PropertyErrorf("filename", "filename cannot contain separator '/'")
360 return
361 }
362 p.outputFilePaths = android.OutputPaths{android.PathForModuleOut(ctx, filename).OutputPath}
363
364 ip := installProperties{
365 filename: filename,
366 sourceFilePath: p.sourceFilePaths[0],
367 outputFilePath: p.outputFilePaths[0],
368 installDirPath: p.installDirPath,
369 symlinks: p.properties.Symlinks,
370 }
371 installs = append(installs, ip)
372 } else if len(p.properties.Srcs) > 0 {
373 if filename != "" {
374 ctx.PropertyErrorf("filename", "filename cannot be set when using srcs")
375 }
376 if len(p.properties.Symlinks) > 0 {
377 ctx.PropertyErrorf("symlinks", "symlinks cannot be set when using srcs")
378 }
379 if p.properties.Filename_from_src != nil {
380 ctx.PropertyErrorf("filename_from_src", "filename_from_src is implicitly set to true when using srcs")
381 }
382 p.sourceFilePaths = android.PathsForModuleSrc(ctx, p.properties.Srcs)
383 for _, src := range p.sourceFilePaths {
384 filename := src.Base()
385 output := android.PathForModuleOut(ctx, filename).OutputPath
386 ip := installProperties{
387 filename: filename,
388 sourceFilePath: src,
389 outputFilePath: output,
390 installDirPath: p.installDirPath,
391 }
392 p.outputFilePaths = append(p.outputFilePaths, output)
393 installs = append(installs, ip)
394 }
395 } else if ctx.Config().AllowMissingDependencies() {
396 // If no srcs was set and AllowMissingDependencies is enabled then
397 // mark the module as missing dependencies and set a fake source path
398 // and file name.
399 ctx.AddMissingDependencies([]string{"MISSING_PREBUILT_SRC_FILE"})
400 p.sourceFilePaths = android.Paths{android.PathForModuleSrc(ctx)}
401 if filename == "" {
402 filename = ctx.ModuleName()
403 }
404 p.outputFilePaths = android.OutputPaths{android.PathForModuleOut(ctx, filename).OutputPath}
405 ip := installProperties{
406 filename: filename,
407 sourceFilePath: p.sourceFilePaths[0],
408 outputFilePath: p.outputFilePaths[0],
409 installDirPath: p.installDirPath,
410 }
411 installs = append(installs, ip)
412 } else {
413 ctx.PropertyErrorf("src", "missing prebuilt source file")
414 return
415 }
416
417 // Call InstallFile even when uninstallable to make the module included in the package.
418 if !p.Installable() {
419 p.SkipInstall()
420 }
421 for _, ip := range installs {
422 ip.addInstallRules(ctx)
423 }
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000424 android.CollectDependencyAconfigFiles(ctx, &p.mergedAconfigFiles)
Spandan Das756d3402023-06-05 22:49:50 +0000425}
Jiyong Parkf9f68052020-09-29 20:15:08 +0900426
Spandan Das756d3402023-06-05 22:49:50 +0000427type installProperties struct {
Spandan Das756d3402023-06-05 22:49:50 +0000428 filename string
429 sourceFilePath android.Path
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100430 outputFilePath android.OutputPath
431 installDirPath android.InstallPath
Spandan Das756d3402023-06-05 22:49:50 +0000432 symlinks []string
433}
434
435// utility function to add install rules to the build graph.
436// Reduces code duplication between Soong and Mixed build analysis
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100437func (ip *installProperties) addInstallRules(ctx android.ModuleContext) {
Spandan Das756d3402023-06-05 22:49:50 +0000438 // Copy the file from src to a location in out/ with the correct `filename`
439 // This ensures that outputFilePath has the correct name for others to
440 // use, as the source file may have a different name.
Spandan Das756d3402023-06-05 22:49:50 +0000441 ctx.Build(pctx, android.BuildParams{
442 Rule: android.Cp,
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100443 Output: ip.outputFilePath,
Spandan Das756d3402023-06-05 22:49:50 +0000444 Input: ip.sourceFilePath,
445 })
446
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100447 installPath := ctx.InstallFile(ip.installDirPath, ip.filename, ip.outputFilePath)
Spandan Das756d3402023-06-05 22:49:50 +0000448 for _, sl := range ip.symlinks {
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100449 ctx.InstallSymlink(ip.installDirPath, sl, installPath)
Jiyong Parkf9f68052020-09-29 20:15:08 +0900450 }
Jiyong Parkc678ad32018-04-10 13:07:10 +0900451}
452
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700453func (p *PrebuiltEtc) AndroidMkEntries() []android.AndroidMkEntries {
Jaewoong Jung9aa3ab12019-04-03 15:47:29 -0700454 nameSuffix := ""
Yifan Hong1b3348d2020-01-21 15:53:22 -0800455 if p.inRamdisk() && !p.onlyInRamdisk() {
456 nameSuffix = ".ramdisk"
457 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700458 if p.inVendorRamdisk() && !p.onlyInVendorRamdisk() {
459 nameSuffix = ".vendor_ramdisk"
460 }
Inseob Kim08758f02021-04-08 21:13:22 +0900461 if p.inDebugRamdisk() && !p.onlyInDebugRamdisk() {
462 nameSuffix = ".debug_ramdisk"
463 }
Kiyoung Kimae11c232021-07-19 11:38:04 +0900464 if p.InRecovery() && !p.onlyInRecovery() {
Jaewoong Jung9aa3ab12019-04-03 15:47:29 -0700465 nameSuffix = ".recovery"
466 }
Colin Crossf17e2b52023-10-30 15:17:25 -0700467
468 class := p.makeClass
469 if class == "" {
470 class = "ETC"
471 }
472
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100473 return []android.AndroidMkEntries{{
Colin Crossf17e2b52023-10-30 15:17:25 -0700474 Class: class,
Jaewoong Jung9aa3ab12019-04-03 15:47:29 -0700475 SubName: nameSuffix,
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100476 OutputFile: android.OptionalPathForPath(p.outputFilePaths[0]),
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700477 ExtraEntries: []android.AndroidMkExtraEntriesFunc{
Colin Crossaa255532020-07-03 13:18:24 -0700478 func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700479 entries.SetString("LOCAL_MODULE_TAGS", "optional")
Colin Crossc68db4b2021-11-11 18:59:15 -0800480 entries.SetString("LOCAL_MODULE_PATH", p.installDirPath.String())
Thiébaud Weksteen00e8b312024-03-18 14:06:00 +1100481 entries.SetString("LOCAL_INSTALLED_MODULE_STEM", p.outputFilePaths[0].Base())
Yo Chiang3d64d492020-05-27 17:56:39 +0800482 if len(p.properties.Symlinks) > 0 {
483 entries.AddStrings("LOCAL_MODULE_SYMLINKS", p.properties.Symlinks...)
484 }
Yo Chiang803c40d2020-11-16 20:32:51 +0800485 entries.SetBoolIfTrue("LOCAL_UNINSTALLABLE_MODULE", !p.Installable())
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700486 if p.additionalDependencies != nil {
Yo Chiang803c40d2020-11-16 20:32:51 +0800487 entries.AddStrings("LOCAL_ADDITIONAL_DEPENDENCIES", p.additionalDependencies.Strings()...)
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900488 }
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000489 android.SetAconfigFileMkEntries(p.AndroidModuleBase(), entries, p.mergedAconfigFiles)
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700490 },
Jiyong Parkc678ad32018-04-10 13:07:10 +0900491 },
Jiyong Park0b0e1b92019-12-03 13:24:29 +0900492 }}
Jiyong Parkc678ad32018-04-10 13:07:10 +0900493}
494
LaMont Jonesafe7baf2024-01-09 22:47:39 +0000495func (p *PrebuiltEtc) AndroidModuleBase() *android.ModuleBase {
496 return &p.ModuleBase
497}
498
Jooyung Hana0171822019-07-22 15:48:36 +0900499func InitPrebuiltEtcModule(p *PrebuiltEtc, dirBase string) {
500 p.installDirBase = dirBase
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900501 p.AddProperties(&p.properties)
Inseob Kim27408bf2021-04-06 21:00:17 +0900502 p.AddProperties(&p.subdirProperties)
503}
504
505func InitPrebuiltRootModule(p *PrebuiltEtc) {
506 p.installDirBase = "."
507 p.AddProperties(&p.properties)
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900508}
Jiyong Parkc678ad32018-04-10 13:07:10 +0900509
Patrice Arruda9e14b962019-03-11 15:58:50 -0700510// prebuilt_etc is for a prebuilt artifact that is installed in
511// <partition>/etc/<sub_dir> directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700512func PrebuiltEtcFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900513 module := &PrebuiltEtc{}
514 InitPrebuiltEtcModule(module, "etc")
Jiyong Park5a8d1be2018-04-25 22:57:34 +0900515 // This module is device-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700516 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Inseob Kim1e27a142021-05-06 11:46:11 +0000517 android.InitDefaultableModule(module)
518 return module
519}
520
521func defaultsFactory() android.Module {
522 return DefaultsFactory()
523}
524
525func DefaultsFactory(props ...interface{}) android.Module {
526 module := &Defaults{}
527
528 module.AddProperties(props...)
529 module.AddProperties(
530 &prebuiltEtcProperties{},
531 &prebuiltSubdirProperties{},
532 )
533
534 android.InitDefaultsModule(module)
535
Jiyong Parkc678ad32018-04-10 13:07:10 +0900536 return module
537}
Tao Bao0ba5c942018-08-14 22:20:22 -0700538
Patrice Arruda9e14b962019-03-11 15:58:50 -0700539// prebuilt_etc_host is for a host prebuilt artifact that is installed in
540// $(HOST_OUT)/etc/<sub_dir> directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700541func PrebuiltEtcHostFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900542 module := &PrebuiltEtc{}
543 InitPrebuiltEtcModule(module, "etc")
Jaewoong Jung24788182019-02-04 14:34:10 -0800544 // This module is host-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700545 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommon)
Martin Stjernholmdc6525e2021-10-14 00:42:59 +0100546 android.InitDefaultableModule(module)
Jaewoong Jung24788182019-02-04 14:34:10 -0800547 return module
548}
549
Miguel32b02802022-12-01 18:38:26 +0000550// prebuilt_etc_host is for a host prebuilt artifact that is installed in
551// <partition>/etc/<sub_dir> directory.
552func PrebuiltEtcCaCertsFactory() android.Module {
553 module := &PrebuiltEtc{}
554 InitPrebuiltEtcModule(module, "cacerts")
555 // This module is device-only
556 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Miguel32b02802022-12-01 18:38:26 +0000557 return module
558}
559
Inseob Kim27408bf2021-04-06 21:00:17 +0900560// prebuilt_root is for a prebuilt artifact that is installed in
561// <partition>/ directory. Can't have any sub directories.
562func PrebuiltRootFactory() android.Module {
563 module := &PrebuiltEtc{}
564 InitPrebuiltRootModule(module)
565 // This module is device-only
566 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Martin Stjernholmdc6525e2021-10-14 00:42:59 +0100567 android.InitDefaultableModule(module)
Inseob Kim27408bf2021-04-06 21:00:17 +0900568 return module
569}
570
Liz Kammere9ecddc2022-01-04 17:27:52 -0500571// prebuilt_root_host is for a host prebuilt artifact that is installed in $(HOST_OUT)/<sub_dir>
572// directory.
573func PrebuiltRootHostFactory() android.Module {
574 module := &PrebuiltEtc{}
575 InitPrebuiltEtcModule(module, ".")
576 // This module is host-only
577 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommon)
578 android.InitDefaultableModule(module)
579 return module
580}
581
Patrice Arruda9e14b962019-03-11 15:58:50 -0700582// prebuilt_usr_share is for a prebuilt artifact that is installed in
583// <partition>/usr/share/<sub_dir> directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700584func PrebuiltUserShareFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900585 module := &PrebuiltEtc{}
586 InitPrebuiltEtcModule(module, "usr/share")
Jaewoong Jungc3fcdb42019-02-13 05:50:33 -0800587 // This module is device-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700588 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Martin Stjernholmdc6525e2021-10-14 00:42:59 +0100589 android.InitDefaultableModule(module)
Jaewoong Jungc3fcdb42019-02-13 05:50:33 -0800590 return module
591}
592
Patrice Arruda9e14b962019-03-11 15:58:50 -0700593// prebuild_usr_share_host is for a host prebuilt artifact that is installed in
594// $(HOST_OUT)/usr/share/<sub_dir> directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700595func PrebuiltUserShareHostFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900596 module := &PrebuiltEtc{}
597 InitPrebuiltEtcModule(module, "usr/share")
Patrice Arruda300cef92019-02-22 15:47:57 -0800598 // This module is host-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700599 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommon)
Martin Stjernholmdc6525e2021-10-14 00:42:59 +0100600 android.InitDefaultableModule(module)
Patrice Arruda300cef92019-02-22 15:47:57 -0800601 return module
602}
603
yangbill63c5e192024-03-27 09:02:12 +0000604// prebuilt_usr_hyphendata is for a prebuilt artifact that is installed in
605// <partition>/usr/hyphen-data/<sub_dir> directory.
606func PrebuiltUserHyphenDataFactory() android.Module {
607 module := &PrebuiltEtc{}
608 InitPrebuiltEtcModule(module, "usr/hyphen-data")
609 // This module is device-only
610 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
611 android.InitDefaultableModule(module)
612 return module
613}
614
yangbill85527e62024-04-30 08:24:50 +0000615// prebuilt_usr_keylayout is for a prebuilt artifact that is installed in
616// <partition>/usr/keylayout/<sub_dir> directory.
617func PrebuiltUserKeyLayoutFactory() android.Module {
618 module := &PrebuiltEtc{}
619 InitPrebuiltEtcModule(module, "usr/keylayout")
620 // This module is device-only
621 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
622 android.InitDefaultableModule(module)
623 return module
624}
625
626// prebuilt_usr_keychars is for a prebuilt artifact that is installed in
627// <partition>/usr/keychars/<sub_dir> directory.
628func PrebuiltUserKeyCharsFactory() android.Module {
629 module := &PrebuiltEtc{}
630 InitPrebuiltEtcModule(module, "usr/keychars")
631 // This module is device-only
632 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
633 android.InitDefaultableModule(module)
634 return module
635}
636
637// prebuilt_usr_idc is for a prebuilt artifact that is installed in
638// <partition>/usr/idc/<sub_dir> directory.
639func PrebuiltUserIdcFactory() android.Module {
640 module := &PrebuiltEtc{}
641 InitPrebuiltEtcModule(module, "usr/idc")
642 // This module is device-only
643 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
644 android.InitDefaultableModule(module)
645 return module
646}
647
Patrice Arruda61583eb2019-05-14 08:20:45 -0700648// prebuilt_font installs a font in <partition>/fonts directory.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700649func PrebuiltFontFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900650 module := &PrebuiltEtc{}
651 InitPrebuiltEtcModule(module, "fonts")
Patrice Arruda61583eb2019-05-14 08:20:45 -0700652 // This module is device-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700653 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Martin Stjernholmdc6525e2021-10-14 00:42:59 +0100654 android.InitDefaultableModule(module)
Patrice Arruda61583eb2019-05-14 08:20:45 -0700655 return module
656}
Patrice Arruda057a8b12019-06-03 15:29:27 -0700657
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800658// prebuilt_firmware installs a firmware file to <partition>/etc/firmware directory for system
659// image.
660// If soc_specific property is set to true, the firmware file is installed to the
661// vendor <partition>/firmware directory for vendor image.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700662func PrebuiltFirmwareFactory() android.Module {
Jooyung Hana0171822019-07-22 15:48:36 +0900663 module := &PrebuiltEtc{}
664 module.socInstallDirBase = "firmware"
665 InitPrebuiltEtcModule(module, "etc/firmware")
Patrice Arruda057a8b12019-06-03 15:29:27 -0700666 // This module is device-only
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700667 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Martin Stjernholmdc6525e2021-10-14 00:42:59 +0100668 android.InitDefaultableModule(module)
Patrice Arruda057a8b12019-06-03 15:29:27 -0700669 return module
670}
Patrice Arruda0f688002020-06-08 21:40:25 +0000671
672// prebuilt_dsp installs a DSP related file to <partition>/etc/dsp directory for system image.
Yo Chiangf0e19fe2020-11-18 15:28:42 +0800673// If soc_specific property is set to true, the DSP related file is installed to the
674// vendor <partition>/dsp directory for vendor image.
Patrice Arruda0f688002020-06-08 21:40:25 +0000675func PrebuiltDSPFactory() android.Module {
676 module := &PrebuiltEtc{}
677 module.socInstallDirBase = "dsp"
678 InitPrebuiltEtcModule(module, "etc/dsp")
679 // This module is device-only
680 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Martin Stjernholmdc6525e2021-10-14 00:42:59 +0100681 android.InitDefaultableModule(module)
Patrice Arruda0f688002020-06-08 21:40:25 +0000682 return module
683}
Colin Cross83ebf232021-04-09 09:41:23 -0700684
Colin Crossf17e2b52023-10-30 15:17:25 -0700685// prebuilt_renderscript_bitcode installs a *.bc file into /system/lib or /system/lib64.
686func PrebuiltRenderScriptBitcodeFactory() android.Module {
687 module := &PrebuiltEtc{}
688 module.makeClass = "RENDERSCRIPT_BITCODE"
689 module.installDirBase64 = "lib64"
Colin Cross2f634572023-11-13 12:12:06 -0800690 module.installAvoidMultilibConflict = true
Colin Crossf17e2b52023-10-30 15:17:25 -0700691 InitPrebuiltEtcModule(module, "lib")
692 // This module is device-only
693 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibBoth)
694 android.InitDefaultableModule(module)
695 return module
696}
697
Colin Cross83ebf232021-04-09 09:41:23 -0700698// prebuilt_rfsa installs a firmware file that will be available through Qualcomm's RFSA
699// to the <partition>/lib/rfsa directory.
700func PrebuiltRFSAFactory() android.Module {
701 module := &PrebuiltEtc{}
702 // Ideally these would go in /vendor/dsp, but the /vendor/lib/rfsa paths are hardcoded in too
703 // many places outside of the application processor. They could be moved to /vendor/dsp once
704 // that is cleaned up.
705 InitPrebuiltEtcModule(module, "lib/rfsa")
706 // This module is device-only
707 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
Martin Stjernholmdc6525e2021-10-14 00:42:59 +0100708 android.InitDefaultableModule(module)
Colin Cross83ebf232021-04-09 09:41:23 -0700709 return module
710}