blob: fd869174cac746d5fcc53bafe2c90ba0c5d61cb1 [file] [log] [blame]
Ivan Lozanoffee3342019-08-27 12:03:00 -07001// Copyright 2019 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 rust
16
17import (
Colin Cross225a37a2023-01-11 14:17:39 -080018 "android/soong/cc"
Matthew Maurera28404a2023-11-20 23:33:28 +000019 "errors"
Ivan Lozanoffee3342019-08-27 12:03:00 -070020 "fmt"
21 "path/filepath"
Ivan Lozano45a9e312021-07-27 12:29:12 -040022 "strings"
Ivan Lozanoffee3342019-08-27 12:03:00 -070023
Ivan Lozanoad8b18b2019-10-31 19:38:29 -070024 "github.com/google/blueprint/proptools"
25
Ivan Lozanoffee3342019-08-27 12:03:00 -070026 "android/soong/android"
27 "android/soong/rust/config"
28)
29
Ivan Lozanodd055472020-09-28 13:22:45 -040030type RustLinkage int
31
32const (
33 DefaultLinkage RustLinkage = iota
34 RlibLinkage
35 DylibLinkage
36)
37
Matthew Maurer689d6f62023-11-20 17:49:25 +000038type compiler interface {
39 initialize(ctx ModuleContext)
40 compilerFlags(ctx ModuleContext, flags Flags) Flags
41 cfgFlags(ctx ModuleContext, flags Flags) Flags
Jihoon Kang091ffd82024-10-03 01:13:24 +000042 featureFlags(ctx ModuleContext, module *Module, flags Flags) Flags
Matthew Maurer689d6f62023-11-20 17:49:25 +000043 compilerProps() []interface{}
44 compile(ctx ModuleContext, flags Flags, deps PathDeps) buildOutput
45 compilerDeps(ctx DepsContext, deps Deps) Deps
46 crateName() string
Matthew Maurerdb72f7e2023-11-21 00:20:02 +000047 edition() string
Jihoon Kang091ffd82024-10-03 01:13:24 +000048 features(ctx android.ConfigurableEvaluatorContext, module *Module) []string
Matthew Maurer689d6f62023-11-20 17:49:25 +000049 rustdoc(ctx ModuleContext, flags Flags, deps PathDeps) android.OptionalPath
Ivan Lozanoab586472024-05-15 10:59:47 -040050 Thinlto() bool
Matthew Maurer689d6f62023-11-20 17:49:25 +000051
52 // Output directory in which source-generated code from dependencies is
53 // copied. This is equivalent to Cargo's OUT_DIR variable.
Matthew Maurercd416532023-11-20 17:52:01 +000054 cargoOutDir() android.OptionalPath
Matthew Maurer689d6f62023-11-20 17:49:25 +000055
Matthew Maurercd416532023-11-20 17:52:01 +000056 // cargoPkgVersion returns the value of the Cargo_pkg_version property.
57 cargoPkgVersion() string
Matthew Maurer689d6f62023-11-20 17:49:25 +000058
Matthew Maurercd416532023-11-20 17:52:01 +000059 // cargoEnvCompat returns whether Cargo environment variables should be used.
60 cargoEnvCompat() bool
Matthew Maurer689d6f62023-11-20 17:49:25 +000061
62 inData() bool
63 install(ctx ModuleContext)
64 relativeInstallPath() string
65 everInstallable() bool
66
67 nativeCoverage() bool
68
69 Disabled() bool
70 SetDisabled()
71
72 stdLinkage(ctx *depsContext) RustLinkage
73 noStdlibs() bool
74
75 unstrippedOutputFilePath() android.Path
76 strippedOutputFilePath() android.OptionalPath
Matthew Maurerd221d312023-11-20 21:02:40 +000077
Matthew Maurera28404a2023-11-20 23:33:28 +000078 checkedCrateRootPath() (android.Path, error)
Andrew Walbran52533232024-03-19 11:36:04 +000079
80 Aliases() map[string]string
Matthew Maurer689d6f62023-11-20 17:49:25 +000081}
82
Thiébaud Weksteene81c9242020-08-03 10:46:28 +020083func (compiler *baseCompiler) edition() string {
Chih-Hung Hsieh961a30c2019-10-03 09:47:06 -070084 return proptools.StringDefault(compiler.Properties.Edition, config.DefaultEdition)
85}
86
Matthew Maurer99020b02019-10-31 10:44:40 -070087func (compiler *baseCompiler) setNoStdlibs() {
88 compiler.Properties.No_stdlibs = proptools.BoolPtr(true)
89}
90
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +020091func (compiler *baseCompiler) disableLints() {
92 compiler.Properties.Lints = proptools.StringPtr("none")
Stephen Craneda931d42020-08-04 13:02:28 -070093}
94
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -080095func NewBaseCompiler(dir, dir64 string, location installLocation) *baseCompiler {
Ivan Lozanoffee3342019-08-27 12:03:00 -070096 return &baseCompiler{
Chih-Hung Hsieh961a30c2019-10-03 09:47:06 -070097 Properties: BaseCompilerProperties{},
98 dir: dir,
99 dir64: dir64,
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -0800100 location: location,
Ivan Lozanoffee3342019-08-27 12:03:00 -0700101 }
102}
103
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -0800104type installLocation int
105
106const (
107 InstallInSystem installLocation = 0
108 InstallInData = iota
Ivan Lozano43845682020-07-09 21:03:28 -0400109
110 incorrectSourcesError = "srcs can only contain one path for a rust file and source providers prefixed by \":\""
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100111 genSubDir = "out/"
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -0800112)
113
Ivan Lozanoffee3342019-08-27 12:03:00 -0700114type BaseCompilerProperties struct {
Ivan Lozanoe4db0032021-08-11 13:39:33 -0400115 // path to the source file that is the main entry point of the program (e.g. main.rs or lib.rs).
116 // Only a single source file can be defined. Modules which generate source can be included by prefixing
117 // the module name with ":", for example ":libfoo_bindgen"
118 //
119 // If no source file is defined, a single generated source module can be defined to be used as the main source.
Ivan Lozano8a23fa42020-06-16 10:26:57 -0400120 Srcs []string `android:"path,arch_variant"`
121
Sam Delmerico63ca14e2023-09-25 12:13:17 +0000122 // Entry point that is passed to rustc to begin the compilation. E.g. main.rs or lib.rs.
123 // When this property is set,
124 // * sandboxing is enabled for this module, and
125 // * the srcs attribute is interpreted as a list of all source files potentially
126 // used in compilation, including the entrypoint, and
127 // * compile_data can be used to add additional files used in compilation that
128 // not directly used as source files.
129 Crate_root *string `android:"path,arch_variant"`
130
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +0200131 // name of the lint set that should be used to validate this module.
132 //
133 // Possible values are "default" (for using a sensible set of lints
134 // depending on the module's location), "android" (for the strictest
135 // lint set that applies to all Android platform code), "vendor" (for
136 // a relaxed set) and "none" (for ignoring all lint warnings and
137 // errors). The default value is "default".
138 Lints *string
Chih-Hung Hsiehefdd7ac2019-09-26 18:59:27 -0700139
Thiébaud Weksteenc44e7372021-04-07 14:53:06 +0200140 // flags to pass to rustc. To enable configuration options or features, use the "cfgs" or "features" properties.
Liz Kammereda93982021-04-20 10:15:41 -0400141 Flags []string `android:"arch_variant"`
Ivan Lozanoffee3342019-08-27 12:03:00 -0700142
143 // flags to pass to the linker
Liz Kammereda93982021-04-20 10:15:41 -0400144 Ld_flags []string `android:"arch_variant"`
Ivan Lozanoffee3342019-08-27 12:03:00 -0700145
Andrew Walbran52533232024-03-19 11:36:04 +0000146 // Rust crate dependencies to rename. Each entry should be a string of the form "dependencyname:alias".
147 //
148 // "dependencyname" here should be the name of the crate, not the Android module. This is
149 // equivalent to writing `alias = { package = "dependencyname" }` in a `Cargo.toml`.
150 Aliases []string
151
Ivan Lozanoffee3342019-08-27 12:03:00 -0700152 // list of rust rlib crate dependencies
153 Rlibs []string `android:"arch_variant"`
154
Vinh Tran4eeb2a92023-08-14 13:29:30 -0400155 // list of rust automatic crate dependencies.
156 // Rustlibs linkage is rlib for host targets and dylib for device targets.
Jihoon Kang127f95c2024-10-07 22:19:59 +0000157 Rustlibs proptools.Configurable[[]string] `android:"arch_variant"`
Matthew Maurer0f003b12020-06-29 14:34:06 -0700158
Ivan Lozanoffee3342019-08-27 12:03:00 -0700159 // list of rust proc_macro crate dependencies
160 Proc_macros []string `android:"arch_variant"`
161
162 // list of C shared library dependencies
163 Shared_libs []string `android:"arch_variant"`
164
Ivan Lozano63bb7682021-03-23 15:53:44 -0400165 // list of C static library dependencies. These dependencies do not normally propagate to dependents
166 // and may need to be redeclared. See whole_static_libs for bundling static dependencies into a library.
Ivan Lozanoffee3342019-08-27 12:03:00 -0700167 Static_libs []string `android:"arch_variant"`
168
Ivan Lozano63bb7682021-03-23 15:53:44 -0400169 // Similar to static_libs, but will bundle the static library dependency into a library. This is helpful
170 // to avoid having to redeclare the dependency for dependents of this library, but in some cases may also
171 // result in bloat if multiple dependencies all include the same static library whole.
172 //
173 // The common use case for this is when the static library is unlikely to be a dependency of other modules to avoid
174 // having to redeclare the static library dependency for every dependent module.
175 // If you are not sure what to, for rust_library modules most static dependencies should go in static_libraries,
176 // and for rust_ffi modules most static dependencies should go into whole_static_libraries.
177 //
178 // For rust_ffi static variants, these libraries will be included in the resulting static library archive.
179 //
180 // For rust_library rlib variants, these libraries will be bundled into the resulting rlib library. This will
181 // include all of the static libraries symbols in any dylibs or binaries which use this rlib as well.
182 Whole_static_libs []string `android:"arch_variant"`
183
Andrew Walbran797e4be2022-03-07 15:41:53 +0000184 // list of Rust system library dependencies.
185 //
186 // This is usually only needed when `no_stdlibs` is true, in which case it can be used to depend on system crates
187 // like `core` and `alloc`.
188 Stdlibs []string `android:"arch_variant"`
189
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400190 // crate name, required for modules which produce Rust libraries: rust_library, rust_ffi and SourceProvider
191 // modules which create library variants (rust_bindgen). This must be the expected extern crate name used in
192 // source, and is required to conform to an enforced format matching library output files (if the output file is
193 // lib<someName><suffix>, the crate_name property must be <someName>).
Ivan Lozanoffee3342019-08-27 12:03:00 -0700194 Crate_name string `android:"arch_variant"`
195
196 // list of features to enable for this crate
Jihoon Kang091ffd82024-10-03 01:13:24 +0000197 Features proptools.Configurable[[]string] `android:"arch_variant"`
Ivan Lozanoffee3342019-08-27 12:03:00 -0700198
Thiébaud Weksteenc44e7372021-04-07 14:53:06 +0200199 // list of configuration options to enable for this crate. To enable features, use the "features" property.
Cole Faustfdec8722024-05-22 11:38:29 -0700200 Cfgs proptools.Configurable[[]string] `android:"arch_variant"`
Thiébaud Weksteenc44e7372021-04-07 14:53:06 +0200201
Ivan Lozanoffee3342019-08-27 12:03:00 -0700202 // specific rust edition that should be used if the default version is not desired
203 Edition *string `android:"arch_variant"`
204
205 // sets name of the output
206 Stem *string `android:"arch_variant"`
207
208 // append to name of output
209 Suffix *string `android:"arch_variant"`
210
211 // install to a subdirectory of the default install path for the module
212 Relative_install_path *string `android:"arch_variant"`
Matthew Maurer99020b02019-10-31 10:44:40 -0700213
214 // whether to suppress inclusion of standard crates - defaults to false
Ivan Lozanoc5182022023-11-14 10:23:31 -0500215 No_stdlibs *bool `android:"arch_variant"`
Ivan Lozanoea086132020-12-08 14:43:00 -0500216
217 // Change the rustlibs linkage to select rlib linkage by default for device targets.
218 // Also link libstd as an rlib as well on device targets.
219 // Note: This is the default behavior for host targets.
220 //
221 // This is primarily meant for rust_binary and rust_ffi modules where the default
222 // linkage of libstd might need to be overridden in some use cases. This should
223 // generally be avoided with other module types since it may cause collisions at
Martin Geisler46329e92022-09-29 13:12:23 +0000224 // linkage if all dependencies of the root binary module do not link against libstd
Ivan Lozanoea086132020-12-08 14:43:00 -0500225 // the same way.
226 Prefer_rlib *bool `android:"arch_variant"`
Ivan Lozanoa9a1fc02021-08-11 15:13:43 -0400227
228 // Enables emitting certain Cargo environment variables. Only intended to be used for compatibility purposes.
229 // Will set CARGO_CRATE_NAME to the crate_name property's value.
230 // Will set CARGO_BIN_NAME to the output filename value without the extension.
231 Cargo_env_compat *bool
232
233 // If cargo_env_compat is true, sets the CARGO_PKG_VERSION env var to this value.
234 Cargo_pkg_version *string
Ivan Lozanoab586472024-05-15 10:59:47 -0400235
236 // Control whether LTO is used for the final (Rust) linkage. This does not impact
237 // cross-language LTO.
238 Lto struct {
239 // Whether thin LTO should be enabled. By default this is true.
240 // LTO provides such a large code size benefit for Rust, this should always
241 // be enabled for production builds unless there's a clear need to disable it.
242 Thin *bool `android:"arch_variant"`
243 } `android:"arch_variant"`
Ivan Lozanoffee3342019-08-27 12:03:00 -0700244}
245
246type baseCompiler struct {
Joel Galensonfa049382021-01-14 16:03:18 -0800247 Properties BaseCompilerProperties
Ivan Lozanoffee3342019-08-27 12:03:00 -0700248
249 // Install related
250 dir string
251 dir64 string
252 subDir string
253 relative string
Colin Cross70dda7e2019-10-01 22:05:35 -0700254 path android.InstallPath
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -0800255 location installLocation
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500256 sanitize *sanitize
Ivan Lozano8a23fa42020-06-16 10:26:57 -0400257
Joel Galensonfa049382021-01-14 16:03:18 -0800258 distFile android.OptionalPath
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400259
Colin Cross5c1d5fb2023-11-15 12:39:40 -0800260 installDeps android.InstallPaths
261
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400262 // unstripped output file.
263 unstrippedOutputFile android.Path
264
265 // stripped output file.
Thiébaud Weksteenfabaff62020-08-27 13:48:36 +0200266 strippedOutputFile android.OptionalPath
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100267
268 // If a crate has a source-generated dependency, a copy of the source file
269 // will be available in cargoOutDir (equivalent to Cargo OUT_DIR).
Matthew Maurercd416532023-11-20 17:52:01 +0000270 // This is stored internally because it may not be available during
271 // singleton-generation passes like rustdoc/rust_project.json, but should
272 // be stashed during initial generation.
273 cachedCargoOutDir android.ModuleOutPath
Matthew Maurera28404a2023-11-20 23:33:28 +0000274 // Calculated crate root cached internally because ModuleContext is not
275 // available to singleton targets like rustdoc/rust_project.json
276 cachedCrateRootPath android.Path
277 // If cachedCrateRootPath is nil after initialization, this will contain
278 // an explanation of why
279 cachedCrateRootError error
Ivan Lozanoffee3342019-08-27 12:03:00 -0700280}
281
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400282func (compiler *baseCompiler) Disabled() bool {
283 return false
284}
285
Ivan Lozanoab586472024-05-15 10:59:47 -0400286// Thin LTO is enabled by default.
287func (compiler *baseCompiler) Thinlto() bool {
288 return BoolDefault(compiler.Properties.Lto.Thin, true)
289}
290
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400291func (compiler *baseCompiler) SetDisabled() {
292 panic("baseCompiler does not implement SetDisabled()")
293}
294
Ivan Lozano9ef9cb82023-02-14 10:56:14 -0500295func (compiler *baseCompiler) noStdlibs() bool {
296 return Bool(compiler.Properties.No_stdlibs)
297}
298
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400299func (compiler *baseCompiler) coverageOutputZipPath() android.OptionalPath {
300 panic("baseCompiler does not implement coverageOutputZipPath()")
301}
302
Ivan Lozanoea086132020-12-08 14:43:00 -0500303func (compiler *baseCompiler) preferRlib() bool {
304 return Bool(compiler.Properties.Prefer_rlib)
305}
306
Andrew Walbran52533232024-03-19 11:36:04 +0000307func (compiler *baseCompiler) Aliases() map[string]string {
308 aliases := map[string]string{}
309 for _, entry := range compiler.Properties.Aliases {
310 dep, alias, found := strings.Cut(entry, ":")
311 if !found {
312 panic(fmt.Errorf("invalid aliases entry %q missing ':'", entry))
313 }
314 aliases[dep] = alias
315 }
316 return aliases
317}
318
Ivan Lozanodd055472020-09-28 13:22:45 -0400319func (compiler *baseCompiler) stdLinkage(ctx *depsContext) RustLinkage {
Ivan Lozano2b081132020-09-08 12:46:52 -0400320 // For devices, we always link stdlibs in as dylibs by default.
Ivan Lozanoea086132020-12-08 14:43:00 -0500321 if compiler.preferRlib() {
322 return RlibLinkage
323 } else if ctx.Device() {
Ivan Lozanodd055472020-09-28 13:22:45 -0400324 return DylibLinkage
Ivan Lozano2b081132020-09-08 12:46:52 -0400325 } else {
Ivan Lozanodd055472020-09-28 13:22:45 -0400326 return RlibLinkage
Ivan Lozano2b081132020-09-08 12:46:52 -0400327 }
Ivan Lozano042504f2020-08-18 14:31:23 -0400328}
329
Ivan Lozanoffee3342019-08-27 12:03:00 -0700330var _ compiler = (*baseCompiler)(nil)
331
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -0800332func (compiler *baseCompiler) inData() bool {
333 return compiler.location == InstallInData
334}
335
Ivan Lozanoffee3342019-08-27 12:03:00 -0700336func (compiler *baseCompiler) compilerProps() []interface{} {
337 return []interface{}{&compiler.Properties}
338}
339
Ivan Lozano28ed8f42024-05-06 21:46:39 -0400340func cfgsToFlags(cfgs []string) []string {
Cole Faustfdec8722024-05-22 11:38:29 -0700341 flags := make([]string, 0, len(cfgs))
Ivan Lozano28ed8f42024-05-06 21:46:39 -0400342 for _, cfg := range cfgs {
Thiébaud Weksteenc44e7372021-04-07 14:53:06 +0200343 flags = append(flags, "--cfg '"+cfg+"'")
344 }
Ivan Lozano67eada32021-09-23 11:50:33 -0400345
Thiébaud Weksteenc44e7372021-04-07 14:53:06 +0200346 return flags
347}
348
Jihoon Kang091ffd82024-10-03 01:13:24 +0000349func (compiler *baseCompiler) features(ctx android.ConfigurableEvaluatorContext, module *Module) []string {
350 eval := module.ConfigurableEvaluator(ctx)
351 return compiler.Properties.Features.GetOrDefault(eval, nil)
Matthew Maurerdb72f7e2023-11-21 00:20:02 +0000352}
353
Jihoon Kang091ffd82024-10-03 01:13:24 +0000354func (compiler *baseCompiler) featuresToFlags(ctx android.ConfigurableEvaluatorContext, module *Module) []string {
Thiébaud Weksteenc44e7372021-04-07 14:53:06 +0200355 flags := []string{}
Jihoon Kang091ffd82024-10-03 01:13:24 +0000356 for _, feature := range compiler.features(ctx, module) {
Ivan Lozanoffee3342019-08-27 12:03:00 -0700357 flags = append(flags, "--cfg 'feature=\""+feature+"\"'")
358 }
Ivan Lozano67eada32021-09-23 11:50:33 -0400359
360 return flags
361}
362
Jihoon Kang091ffd82024-10-03 01:13:24 +0000363func (compiler *baseCompiler) featureFlags(ctx ModuleContext, module *Module, flags Flags) Flags {
364 flags.RustFlags = append(flags.RustFlags, compiler.featuresToFlags(ctx, module)...)
365 flags.RustdocFlags = append(flags.RustdocFlags, compiler.featuresToFlags(ctx, module)...)
Ivan Lozano67eada32021-09-23 11:50:33 -0400366
367 return flags
368}
369
Ivan Lozano28ed8f42024-05-06 21:46:39 -0400370func CommonDefaultCfgFlags(flags Flags, vendor bool, product bool) Flags {
371 var cfgs []string
372 if vendor || product {
373 cfgs = append(cfgs, "android_vndk")
374 if vendor {
375 cfgs = append(cfgs, "android_vendor")
376 } else if product {
377 cfgs = append(cfgs, "android_product")
Matthew Maurer65a54a82023-02-24 19:19:22 +0000378 }
Ivan Lozano67eada32021-09-23 11:50:33 -0400379 }
380
Ivan Lozano28ed8f42024-05-06 21:46:39 -0400381 flags.RustFlags = append(flags.RustFlags, cfgsToFlags(cfgs)...)
382 flags.RustdocFlags = append(flags.RustdocFlags, cfgsToFlags(cfgs)...)
383 return flags
384}
385
386func (compiler *baseCompiler) cfgFlags(ctx ModuleContext, flags Flags) Flags {
387 flags = CommonDefaultCfgFlags(flags, ctx.RustModule().InVendor(), ctx.RustModule().InProduct())
388
Cole Faustfdec8722024-05-22 11:38:29 -0700389 cfgFlags := cfgsToFlags(compiler.Properties.Cfgs.GetOrDefault(ctx, nil))
390 flags.RustFlags = append(flags.RustFlags, cfgFlags...)
391 flags.RustdocFlags = append(flags.RustdocFlags, cfgFlags...)
Ivan Lozano28ed8f42024-05-06 21:46:39 -0400392
393 return flags
394}
395
396func CommonDefaultFlags(ctx android.ModuleContext, toolchain config.Toolchain, flags Flags) Flags {
397 flags.GlobalRustFlags = append(flags.GlobalRustFlags, config.GlobalRustFlags...)
398 flags.GlobalRustFlags = append(flags.GlobalRustFlags, toolchain.ToolchainRustFlags())
399 flags.GlobalLinkFlags = append(flags.GlobalLinkFlags, toolchain.ToolchainLinkFlags())
400 flags.EmitXrefs = ctx.Config().EmitXrefRules()
401
402 if ctx.Host() && !ctx.Windows() {
403 flags.LinkFlags = append(flags.LinkFlags, cc.RpathFlags(ctx)...)
404 }
405
406 if ctx.Os() == android.Linux {
407 // Add -lc, -lrt, -ldl, -lpthread, -lm and -lgcc_s to glibc builds to match
408 // the default behavior of device builds.
409 flags.LinkFlags = append(flags.LinkFlags, config.LinuxHostGlobalLinkFlags...)
410 } else if ctx.Os() == android.Darwin {
411 // Add -lc, -ldl, -lpthread and -lm to glibc darwin builds to match the default
412 // behavior of device builds.
413 flags.LinkFlags = append(flags.LinkFlags,
414 "-lc",
415 "-ldl",
416 "-lpthread",
417 "-lm",
418 )
419 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700420 return flags
421}
422
423func (compiler *baseCompiler) compilerFlags(ctx ModuleContext, flags Flags) Flags {
424
Ivan Lozano28ed8f42024-05-06 21:46:39 -0400425 flags = CommonDefaultFlags(ctx, ctx.toolchain(), flags)
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +0200426 lintFlags, err := config.RustcLintsForDir(ctx.ModuleDir(), compiler.Properties.Lints)
427 if err != nil {
428 ctx.PropertyErrorf("lints", err.Error())
Chih-Hung Hsiehefdd7ac2019-09-26 18:59:27 -0700429 }
Ivan Lozano45a9e312021-07-27 12:29:12 -0400430
431 // linkage-related flags are disallowed.
432 for _, s := range compiler.Properties.Ld_flags {
433 if strings.HasPrefix(s, "-Wl,-l") || strings.HasPrefix(s, "-Wl,-L") {
434 ctx.PropertyErrorf("ld_flags", "'-Wl,-l' and '-Wl,-L' flags cannot be manually specified")
435 }
436 }
437 for _, s := range compiler.Properties.Flags {
438 if strings.HasPrefix(s, "-l") || strings.HasPrefix(s, "-L") {
439 ctx.PropertyErrorf("flags", "'-l' and '-L' flags cannot be manually specified")
440 }
441 if strings.HasPrefix(s, "--extern") {
442 ctx.PropertyErrorf("flags", "'--extern' flag cannot be manually specified")
443 }
444 if strings.HasPrefix(s, "-Clink-args=") || strings.HasPrefix(s, "-C link-args=") {
445 ctx.PropertyErrorf("flags", "'-C link-args' flag cannot be manually specified")
446 }
447 }
448
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +0200449 flags.RustFlags = append(flags.RustFlags, lintFlags)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700450 flags.RustFlags = append(flags.RustFlags, compiler.Properties.Flags...)
Thiébaud Weksteene81c9242020-08-03 10:46:28 +0200451 flags.RustFlags = append(flags.RustFlags, "--edition="+compiler.edition())
Dan Albert06feee92021-03-19 15:06:02 -0700452 flags.RustdocFlags = append(flags.RustdocFlags, "--edition="+compiler.edition())
Ivan Lozanoffee3342019-08-27 12:03:00 -0700453 flags.LinkFlags = append(flags.LinkFlags, compiler.Properties.Ld_flags...)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700454
Ivan Lozanoffee3342019-08-27 12:03:00 -0700455 return flags
456}
457
Sasha Smundaka76acba2022-04-18 20:12:56 -0700458func (compiler *baseCompiler) compile(ctx ModuleContext, flags Flags, deps PathDeps) buildOutput {
Ivan Lozanoffee3342019-08-27 12:03:00 -0700459 panic(fmt.Errorf("baseCrater doesn't know how to crate things!"))
460}
461
Dan Albert06feee92021-03-19 15:06:02 -0700462func (compiler *baseCompiler) rustdoc(ctx ModuleContext, flags Flags,
463 deps PathDeps) android.OptionalPath {
464
465 return android.OptionalPath{}
466}
467
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100468func (compiler *baseCompiler) initialize(ctx ModuleContext) {
Matthew Maurercd416532023-11-20 17:52:01 +0000469 compiler.cachedCargoOutDir = android.PathForModuleOut(ctx, genSubDir)
Matthew Maurera28404a2023-11-20 23:33:28 +0000470 if compiler.Properties.Crate_root == nil {
471 compiler.cachedCrateRootPath, compiler.cachedCrateRootError = srcPathFromModuleSrcs(ctx, compiler.Properties.Srcs)
472 } else {
473 compiler.cachedCrateRootPath = android.PathForModuleSrc(ctx, *compiler.Properties.Crate_root)
474 compiler.cachedCrateRootError = nil
475 }
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100476}
477
Matthew Maurercd416532023-11-20 17:52:01 +0000478func (compiler *baseCompiler) cargoOutDir() android.OptionalPath {
479 return android.OptionalPathForPath(compiler.cachedCargoOutDir)
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100480}
481
Matthew Maurercd416532023-11-20 17:52:01 +0000482func (compiler *baseCompiler) cargoEnvCompat() bool {
Ivan Lozanoa9a1fc02021-08-11 15:13:43 -0400483 return Bool(compiler.Properties.Cargo_env_compat)
484}
485
Matthew Maurercd416532023-11-20 17:52:01 +0000486func (compiler *baseCompiler) cargoPkgVersion() string {
Ivan Lozanoa9a1fc02021-08-11 15:13:43 -0400487 return String(compiler.Properties.Cargo_pkg_version)
488}
489
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400490func (compiler *baseCompiler) unstrippedOutputFilePath() android.Path {
491 return compiler.unstrippedOutputFile
492}
493
Jiyong Parke54f07e2021-04-07 15:08:04 +0900494func (compiler *baseCompiler) strippedOutputFilePath() android.OptionalPath {
495 return compiler.strippedOutputFile
496}
497
Ivan Lozanoffee3342019-08-27 12:03:00 -0700498func (compiler *baseCompiler) compilerDeps(ctx DepsContext, deps Deps) Deps {
499 deps.Rlibs = append(deps.Rlibs, compiler.Properties.Rlibs...)
Jihoon Kang127f95c2024-10-07 22:19:59 +0000500 deps.Rustlibs = append(deps.Rustlibs, compiler.Properties.Rustlibs.GetOrDefault(ctx, nil)...)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700501 deps.ProcMacros = append(deps.ProcMacros, compiler.Properties.Proc_macros...)
502 deps.StaticLibs = append(deps.StaticLibs, compiler.Properties.Static_libs...)
Ivan Lozano63bb7682021-03-23 15:53:44 -0400503 deps.WholeStaticLibs = append(deps.WholeStaticLibs, compiler.Properties.Whole_static_libs...)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700504 deps.SharedLibs = append(deps.SharedLibs, compiler.Properties.Shared_libs...)
Andrew Walbran797e4be2022-03-07 15:41:53 +0000505 deps.Stdlibs = append(deps.Stdlibs, compiler.Properties.Stdlibs...)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700506
Matthew Maurer99020b02019-10-31 10:44:40 -0700507 if !Bool(compiler.Properties.No_stdlibs) {
508 for _, stdlib := range config.Stdlibs {
Colin Crossa8941ec2022-07-01 11:17:22 -0700509 // If we're building for the build host, use the prebuilt stdlibs, unless the host
510 // is linux_bionic which doesn't have prebuilts.
511 if ctx.Host() && !ctx.Target().HostCross && ctx.Target().Os != android.LinuxBionic {
Ivan Lozanofba2aa22021-11-11 09:29:07 -0500512 stdlib = "prebuilt_" + stdlib
Matthew Maurer99020b02019-10-31 10:44:40 -0700513 }
Ivan Lozano2b081132020-09-08 12:46:52 -0400514 deps.Stdlibs = append(deps.Stdlibs, stdlib)
Matthew Maurer99020b02019-10-31 10:44:40 -0700515 }
516 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700517 return deps
518}
519
Thiébaud Weksteenf1ff54a2021-03-22 14:24:54 +0100520func bionicDeps(ctx DepsContext, deps Deps, static bool) Deps {
Ivan Lozanobf63d002020-10-02 10:03:23 -0400521 bionicLibs := []string{}
522 bionicLibs = append(bionicLibs, "liblog")
523 bionicLibs = append(bionicLibs, "libc")
524 bionicLibs = append(bionicLibs, "libm")
525 bionicLibs = append(bionicLibs, "libdl")
526
527 if static {
528 deps.StaticLibs = append(deps.StaticLibs, bionicLibs...)
529 } else {
530 deps.SharedLibs = append(deps.SharedLibs, bionicLibs...)
531 }
Ivan Lozano8711c5c2021-08-13 13:14:06 -0400532 if ctx.RustModule().StaticExecutable() {
533 deps.StaticLibs = append(deps.StaticLibs, "libunwind")
534 }
Thiébaud Weksteenf1ff54a2021-03-22 14:24:54 +0100535 if libRuntimeBuiltins := config.BuiltinsRuntimeLibrary(ctx.toolchain()); libRuntimeBuiltins != "" {
536 deps.StaticLibs = append(deps.StaticLibs, libRuntimeBuiltins)
537 }
Ivan Lozanof1c84332019-09-20 11:00:37 -0700538 return deps
539}
540
Colin Crosse32f0932022-01-23 20:48:36 -0800541func muslDeps(ctx DepsContext, deps Deps, static bool) Deps {
542 muslLibs := []string{"libc_musl"}
543 if static {
544 deps.StaticLibs = append(deps.StaticLibs, muslLibs...)
545 } else {
546 deps.SharedLibs = append(deps.SharedLibs, muslLibs...)
547 }
548 if libRuntimeBuiltins := config.BuiltinsRuntimeLibrary(ctx.toolchain()); libRuntimeBuiltins != "" {
549 deps.StaticLibs = append(deps.StaticLibs, libRuntimeBuiltins)
550 }
551
552 return deps
553}
554
Ivan Lozanoffee3342019-08-27 12:03:00 -0700555func (compiler *baseCompiler) crateName() string {
556 return compiler.Properties.Crate_name
557}
558
Ivan Lozanod7586b62021-04-01 09:49:36 -0400559func (compiler *baseCompiler) everInstallable() bool {
560 // Most modules are installable, so return true by default.
561 return true
562}
563
Colin Cross70dda7e2019-10-01 22:05:35 -0700564func (compiler *baseCompiler) installDir(ctx ModuleContext) android.InstallPath {
Ivan Lozanoffee3342019-08-27 12:03:00 -0700565 dir := compiler.dir
566 if ctx.toolchain().Is64Bit() && compiler.dir64 != "" {
567 dir = compiler.dir64
568 }
Ivan Lozanod6fdca82020-04-07 12:30:33 -0400569 if ctx.Target().NativeBridge == android.NativeBridgeEnabled {
570 dir = filepath.Join(dir, ctx.Target().NativeBridgeRelativePath)
571 }
572 if !ctx.Host() && ctx.Config().HasMultilibConflict(ctx.Arch().ArchType) {
Ivan Lozanoffee3342019-08-27 12:03:00 -0700573 dir = filepath.Join(dir, ctx.Arch().ArchType.String())
574 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400575
Kiyoung Kimaa394802024-01-08 12:55:45 +0900576 if compiler.location == InstallInData && ctx.RustModule().InVendorOrProduct() {
Matthew Maurer9f59e8d2021-08-19 13:10:05 -0700577 if ctx.RustModule().InProduct() {
578 dir = filepath.Join(dir, "product")
579 } else if ctx.RustModule().InVendor() {
580 dir = filepath.Join(dir, "vendor")
581 } else {
582 ctx.ModuleErrorf("Unknown data+VNDK installation kind")
583 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400584 }
Matthew Maurer9f59e8d2021-08-19 13:10:05 -0700585
Ivan Lozanoffee3342019-08-27 12:03:00 -0700586 return android.PathForModuleInstall(ctx, dir, compiler.subDir,
587 compiler.relativeInstallPath(), compiler.relative)
588}
589
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400590func (compiler *baseCompiler) nativeCoverage() bool {
591 return false
592}
593
Thiébaud Weksteenfabaff62020-08-27 13:48:36 +0200594func (compiler *baseCompiler) install(ctx ModuleContext) {
Jiyong Parke54f07e2021-04-07 15:08:04 +0900595 path := ctx.RustModule().OutputFile()
Colin Cross5c1d5fb2023-11-15 12:39:40 -0800596 compiler.path = ctx.InstallFile(compiler.installDir(ctx), path.Path().Base(), path.Path(), compiler.installDeps...)
597}
598
599func (compiler *baseCompiler) installTestData(ctx ModuleContext, data []android.DataPath) {
600 installedData := ctx.InstallTestData(compiler.installDir(ctx), data)
601 compiler.installDeps = append(compiler.installDeps, installedData...)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700602}
603
Ivan Lozano28ed8f42024-05-06 21:46:39 -0400604func (compiler *baseCompiler) getStem(ctx android.ModuleContext) string {
Ivan Lozanoffee3342019-08-27 12:03:00 -0700605 return compiler.getStemWithoutSuffix(ctx) + String(compiler.Properties.Suffix)
606}
607
Ivan Lozano28ed8f42024-05-06 21:46:39 -0400608func (compiler *baseCompiler) getStemWithoutSuffix(ctx android.BaseModuleContext) string {
Thiébaud Weksteen1f7f70f2020-06-24 11:32:48 +0200609 stem := ctx.ModuleName()
Ivan Lozanoffee3342019-08-27 12:03:00 -0700610 if String(compiler.Properties.Stem) != "" {
611 stem = String(compiler.Properties.Stem)
612 }
613
614 return stem
615}
Ivan Lozanoad8b18b2019-10-31 19:38:29 -0700616
Ivan Lozanoffee3342019-08-27 12:03:00 -0700617func (compiler *baseCompiler) relativeInstallPath() string {
618 return String(compiler.Properties.Relative_install_path)
619}
620
Matthew Maurera28404a2023-11-20 23:33:28 +0000621func (compiler *baseCompiler) checkedCrateRootPath() (android.Path, error) {
622 return compiler.cachedCrateRootPath, compiler.cachedCrateRootError
623}
Seth Moore3afac0b2021-10-13 15:32:18 -0700624
Matthew Maurera28404a2023-11-20 23:33:28 +0000625func crateRootPath(ctx ModuleContext, compiler compiler) android.Path {
626 root, err := compiler.checkedCrateRootPath()
627 if err != nil {
628 ctx.PropertyErrorf("srcs", err.Error())
Matthew Maurerd221d312023-11-20 21:02:40 +0000629 }
Matthew Maurera28404a2023-11-20 23:33:28 +0000630 return root
Matthew Maurerd221d312023-11-20 21:02:40 +0000631}
632
Ivan Lozano43845682020-07-09 21:03:28 -0400633// Returns the Path for the main source file along with Paths for generated source files from modules listed in srcs.
Matthew Maurera28404a2023-11-20 23:33:28 +0000634func srcPathFromModuleSrcs(ctx ModuleContext, srcs []string) (android.Path, error) {
Chih-Hung Hsiehbbd25ae2020-05-15 17:36:30 -0700635 // The srcs can contain strings with prefix ":".
636 // They are dependent modules of this module, with android.SourceDepTag.
637 // They are not the main source file compiled by rustc.
638 numSrcs := 0
639 srcIndex := 0
640 for i, s := range srcs {
641 if android.SrcIsModule(s) == "" {
642 numSrcs++
643 srcIndex = i
644 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700645 }
Ivan Lozanoe4db0032021-08-11 13:39:33 -0400646 if numSrcs > 1 {
Matthew Maurera28404a2023-11-20 23:33:28 +0000647 return nil, errors.New(incorrectSourcesError)
Chih-Hung Hsiehbbd25ae2020-05-15 17:36:30 -0700648 }
Ivan Lozanoe4db0032021-08-11 13:39:33 -0400649
650 // If a main source file is not provided we expect only a single SourceProvider module to be defined
651 // within srcs, with the expectation that the first source it provides is the entry point.
Chih-Hung Hsiehbbd25ae2020-05-15 17:36:30 -0700652 if srcIndex != 0 {
Matthew Maurera28404a2023-11-20 23:33:28 +0000653 return nil, errors.New("main source file must be the first in srcs")
Ivan Lozanoe4db0032021-08-11 13:39:33 -0400654 } else if numSrcs > 1 {
Matthew Maurera28404a2023-11-20 23:33:28 +0000655 return nil, errors.New("only a single generated source module can be defined without a main source file.")
Chih-Hung Hsiehbbd25ae2020-05-15 17:36:30 -0700656 }
Ivan Lozanoe4db0032021-08-11 13:39:33 -0400657
Sam Delmerico63ca14e2023-09-25 12:13:17 +0000658 // TODO: b/297264540 - once all modules are sandboxed, we need to select the proper
659 // entry point file from Srcs rather than taking the first one
Chih-Hung Hsiehbbd25ae2020-05-15 17:36:30 -0700660 paths := android.PathsForModuleSrc(ctx, srcs)
Matthew Maurera28404a2023-11-20 23:33:28 +0000661 if len(paths) == 0 {
662 return nil, errors.New("srcs must not be empty")
663 }
664 return paths[srcIndex], nil
Ivan Lozanoffee3342019-08-27 12:03:00 -0700665}