builder.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426
  1. // 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. package rust
  15. import (
  16. "path/filepath"
  17. "strings"
  18. "github.com/google/blueprint"
  19. "android/soong/android"
  20. "android/soong/rust/config"
  21. )
  22. var (
  23. _ = pctx.SourcePathVariable("rustcCmd", "${config.RustBin}/rustc")
  24. rustc = pctx.AndroidStaticRule("rustc",
  25. blueprint.RuleParams{
  26. Command: "$envVars $rustcCmd " +
  27. "-C linker=${config.RustLinker} " +
  28. "-C link-args=\"${crtBegin} ${config.RustLinkerArgs} ${linkFlags} ${crtEnd}\" " +
  29. "--emit link -o $out --emit dep-info=$out.d.raw $in ${libFlags} $rustcFlags" +
  30. " && grep \"^$out:\" $out.d.raw > $out.d",
  31. CommandDeps: []string{"$rustcCmd"},
  32. // Rustc deps-info writes out make compatible dep files: https://github.com/rust-lang/rust/issues/7633
  33. // Rustc emits unneeded dependency lines for the .d and input .rs files.
  34. // Those extra lines cause ninja warning:
  35. // "warning: depfile has multiple output paths"
  36. // For ninja, we keep/grep only the dependency rule for the rust $out file.
  37. Deps: blueprint.DepsGCC,
  38. Depfile: "$out.d",
  39. },
  40. "rustcFlags", "linkFlags", "libFlags", "crtBegin", "crtEnd", "envVars")
  41. _ = pctx.SourcePathVariable("rustdocCmd", "${config.RustBin}/rustdoc")
  42. rustdoc = pctx.AndroidStaticRule("rustdoc",
  43. blueprint.RuleParams{
  44. Command: "$envVars $rustdocCmd $rustdocFlags $in -o $outDir && " +
  45. "touch $out",
  46. CommandDeps: []string{"$rustdocCmd"},
  47. },
  48. "rustdocFlags", "outDir", "envVars")
  49. _ = pctx.SourcePathVariable("clippyCmd", "${config.RustBin}/clippy-driver")
  50. clippyDriver = pctx.AndroidStaticRule("clippy",
  51. blueprint.RuleParams{
  52. Command: "$envVars $clippyCmd " +
  53. // Because clippy-driver uses rustc as backend, we need to have some output even during the linting.
  54. // Use the metadata output as it has the smallest footprint.
  55. "--emit metadata -o $out --emit dep-info=$out.d.raw $in ${libFlags} " +
  56. "$rustcFlags $clippyFlags" +
  57. " && grep \"^$out:\" $out.d.raw > $out.d",
  58. CommandDeps: []string{"$clippyCmd"},
  59. Deps: blueprint.DepsGCC,
  60. Depfile: "$out.d",
  61. },
  62. "rustcFlags", "libFlags", "clippyFlags", "envVars")
  63. zip = pctx.AndroidStaticRule("zip",
  64. blueprint.RuleParams{
  65. Command: "cat $out.rsp | tr ' ' '\\n' | tr -d \\' | sort -u > ${out}.tmp && ${SoongZipCmd} -o ${out} -C $$OUT_DIR -l ${out}.tmp",
  66. CommandDeps: []string{"${SoongZipCmd}"},
  67. Rspfile: "$out.rsp",
  68. RspfileContent: "$in",
  69. })
  70. cp = pctx.AndroidStaticRule("cp",
  71. blueprint.RuleParams{
  72. Command: "cp `cat $outDir.rsp` $outDir",
  73. Rspfile: "${outDir}.rsp",
  74. RspfileContent: "$in",
  75. },
  76. "outDir")
  77. // Cross-referencing:
  78. _ = pctx.SourcePathVariable("rustExtractor",
  79. "prebuilts/build-tools/${config.HostPrebuiltTag}/bin/rust_extractor")
  80. _ = pctx.VariableFunc("kytheCorpus",
  81. func(ctx android.PackageVarContext) string { return ctx.Config().XrefCorpusName() })
  82. _ = pctx.VariableFunc("kytheCuEncoding",
  83. func(ctx android.PackageVarContext) string { return ctx.Config().XrefCuEncoding() })
  84. _ = pctx.SourcePathVariable("kytheVnames", "build/soong/vnames.json")
  85. kytheExtract = pctx.AndroidStaticRule("kythe",
  86. blueprint.RuleParams{
  87. Command: `KYTHE_CORPUS=${kytheCorpus} ` +
  88. `KYTHE_OUTPUT_FILE=$out ` +
  89. `KYTHE_VNAMES=$kytheVnames ` +
  90. `KYTHE_KZIP_ENCODING=${kytheCuEncoding} ` +
  91. `KYTHE_CANONICALIZE_VNAME_PATHS=prefer-relative ` +
  92. `$rustExtractor $envVars ` +
  93. `$rustcCmd ` +
  94. `-C linker=${config.RustLinker} ` +
  95. `-C link-args="${crtBegin} ${config.RustLinkerArgs} ${linkFlags} ${crtEnd}" ` +
  96. `$in ${libFlags} $rustcFlags`,
  97. CommandDeps: []string{"$rustExtractor", "$kytheVnames"},
  98. Rspfile: "${out}.rsp",
  99. RspfileContent: "$in",
  100. },
  101. "rustcFlags", "linkFlags", "libFlags", "crtBegin", "crtEnd", "envVars")
  102. )
  103. type buildOutput struct {
  104. outputFile android.Path
  105. kytheFile android.Path
  106. }
  107. func init() {
  108. pctx.HostBinToolVariable("SoongZipCmd", "soong_zip")
  109. }
  110. func TransformSrcToBinary(ctx ModuleContext, mainSrc android.Path, deps PathDeps, flags Flags,
  111. outputFile android.WritablePath) buildOutput {
  112. flags.GlobalRustFlags = append(flags.GlobalRustFlags, "-C lto=thin")
  113. return transformSrctoCrate(ctx, mainSrc, deps, flags, outputFile, "bin")
  114. }
  115. func TransformSrctoRlib(ctx ModuleContext, mainSrc android.Path, deps PathDeps, flags Flags,
  116. outputFile android.WritablePath) buildOutput {
  117. return transformSrctoCrate(ctx, mainSrc, deps, flags, outputFile, "rlib")
  118. }
  119. func TransformSrctoDylib(ctx ModuleContext, mainSrc android.Path, deps PathDeps, flags Flags,
  120. outputFile android.WritablePath) buildOutput {
  121. return transformSrctoCrate(ctx, mainSrc, deps, flags, outputFile, "dylib")
  122. }
  123. func TransformSrctoStatic(ctx ModuleContext, mainSrc android.Path, deps PathDeps, flags Flags,
  124. outputFile android.WritablePath) buildOutput {
  125. flags.GlobalRustFlags = append(flags.GlobalRustFlags, "-C lto=thin")
  126. return transformSrctoCrate(ctx, mainSrc, deps, flags, outputFile, "staticlib")
  127. }
  128. func TransformSrctoShared(ctx ModuleContext, mainSrc android.Path, deps PathDeps, flags Flags,
  129. outputFile android.WritablePath) buildOutput {
  130. flags.GlobalRustFlags = append(flags.GlobalRustFlags, "-C lto=thin")
  131. return transformSrctoCrate(ctx, mainSrc, deps, flags, outputFile, "cdylib")
  132. }
  133. func TransformSrctoProcMacro(ctx ModuleContext, mainSrc android.Path, deps PathDeps,
  134. flags Flags, outputFile android.WritablePath) buildOutput {
  135. return transformSrctoCrate(ctx, mainSrc, deps, flags, outputFile, "proc-macro")
  136. }
  137. func rustLibsToPaths(libs RustLibraries) android.Paths {
  138. var paths android.Paths
  139. for _, lib := range libs {
  140. paths = append(paths, lib.Path)
  141. }
  142. return paths
  143. }
  144. func makeLibFlags(deps PathDeps) []string {
  145. var libFlags []string
  146. // Collect library/crate flags
  147. for _, lib := range deps.RLibs {
  148. libFlags = append(libFlags, "--extern "+lib.CrateName+"="+lib.Path.String())
  149. }
  150. for _, lib := range deps.DyLibs {
  151. libFlags = append(libFlags, "--extern "+lib.CrateName+"="+lib.Path.String())
  152. }
  153. for _, proc_macro := range deps.ProcMacros {
  154. libFlags = append(libFlags, "--extern "+proc_macro.CrateName+"="+proc_macro.Path.String())
  155. }
  156. for _, path := range deps.linkDirs {
  157. libFlags = append(libFlags, "-L "+path)
  158. }
  159. return libFlags
  160. }
  161. func rustEnvVars(ctx ModuleContext, deps PathDeps) []string {
  162. var envVars []string
  163. // libstd requires a specific environment variable to be set. This is
  164. // not officially documented and may be removed in the future. See
  165. // https://github.com/rust-lang/rust/blob/master/library/std/src/env.rs#L866.
  166. if ctx.RustModule().CrateName() == "std" {
  167. envVars = append(envVars, "STD_ENV_ARCH="+config.StdEnvArch[ctx.RustModule().Arch().ArchType])
  168. }
  169. if len(deps.SrcDeps) > 0 {
  170. moduleGenDir := ctx.RustModule().compiler.CargoOutDir()
  171. // We must calculate an absolute path for OUT_DIR since Rust's include! macro (which normally consumes this)
  172. // assumes that paths are relative to the source file.
  173. var outDirPrefix string
  174. if !filepath.IsAbs(moduleGenDir.String()) {
  175. // If OUT_DIR is not absolute, we use $$PWD to generate an absolute path (os.Getwd() returns '/')
  176. outDirPrefix = "$$PWD/"
  177. } else {
  178. // If OUT_DIR is absolute, then moduleGenDir will be an absolute path, so we don't need to set this to anything.
  179. outDirPrefix = ""
  180. }
  181. envVars = append(envVars, "OUT_DIR="+filepath.Join(outDirPrefix, moduleGenDir.String()))
  182. }
  183. return envVars
  184. }
  185. func transformSrctoCrate(ctx ModuleContext, main android.Path, deps PathDeps, flags Flags,
  186. outputFile android.WritablePath, crateType string) buildOutput {
  187. var inputs android.Paths
  188. var implicits android.Paths
  189. var output buildOutput
  190. var rustcFlags, linkFlags []string
  191. var implicitOutputs android.WritablePaths
  192. output.outputFile = outputFile
  193. crateName := ctx.RustModule().CrateName()
  194. targetTriple := ctx.toolchain().RustTriple()
  195. envVars := rustEnvVars(ctx, deps)
  196. inputs = append(inputs, main)
  197. // Collect rustc flags
  198. rustcFlags = append(rustcFlags, flags.GlobalRustFlags...)
  199. rustcFlags = append(rustcFlags, flags.RustFlags...)
  200. rustcFlags = append(rustcFlags, "--crate-type="+crateType)
  201. if crateName != "" {
  202. rustcFlags = append(rustcFlags, "--crate-name="+crateName)
  203. }
  204. if targetTriple != "" {
  205. rustcFlags = append(rustcFlags, "--target="+targetTriple)
  206. linkFlags = append(linkFlags, "-target "+targetTriple)
  207. }
  208. // Suppress an implicit sysroot
  209. rustcFlags = append(rustcFlags, "--sysroot=/dev/null")
  210. // Enable incremental compilation if requested by user
  211. if ctx.Config().IsEnvTrue("SOONG_RUSTC_INCREMENTAL") {
  212. incrementalPath := android.PathForOutput(ctx, "rustc").String()
  213. rustcFlags = append(rustcFlags, "-C incremental="+incrementalPath)
  214. }
  215. // Collect linker flags
  216. linkFlags = append(linkFlags, flags.GlobalLinkFlags...)
  217. linkFlags = append(linkFlags, flags.LinkFlags...)
  218. // Check if this module needs to use the bootstrap linker
  219. if ctx.RustModule().Bootstrap() && !ctx.RustModule().InRecovery() && !ctx.RustModule().InRamdisk() && !ctx.RustModule().InVendorRamdisk() {
  220. dynamicLinker := "-Wl,-dynamic-linker,/system/bin/bootstrap/linker"
  221. if ctx.toolchain().Is64Bit() {
  222. dynamicLinker += "64"
  223. }
  224. linkFlags = append(linkFlags, dynamicLinker)
  225. }
  226. libFlags := makeLibFlags(deps)
  227. // Collect dependencies
  228. implicits = append(implicits, rustLibsToPaths(deps.RLibs)...)
  229. implicits = append(implicits, rustLibsToPaths(deps.DyLibs)...)
  230. implicits = append(implicits, rustLibsToPaths(deps.ProcMacros)...)
  231. implicits = append(implicits, deps.StaticLibs...)
  232. implicits = append(implicits, deps.SharedLibDeps...)
  233. implicits = append(implicits, deps.srcProviderFiles...)
  234. implicits = append(implicits, deps.AfdoProfiles...)
  235. implicits = append(implicits, deps.CrtBegin...)
  236. implicits = append(implicits, deps.CrtEnd...)
  237. if len(deps.SrcDeps) > 0 {
  238. moduleGenDir := ctx.RustModule().compiler.CargoOutDir()
  239. var outputs android.WritablePaths
  240. for _, genSrc := range deps.SrcDeps {
  241. if android.SuffixInList(outputs.Strings(), genSubDir+genSrc.Base()) {
  242. ctx.PropertyErrorf("srcs",
  243. "multiple source providers generate the same filename output: "+genSrc.Base())
  244. }
  245. outputs = append(outputs, android.PathForModuleOut(ctx, genSubDir+genSrc.Base()))
  246. }
  247. ctx.Build(pctx, android.BuildParams{
  248. Rule: cp,
  249. Description: "cp " + moduleGenDir.Path().Rel(),
  250. Outputs: outputs,
  251. Inputs: deps.SrcDeps,
  252. Args: map[string]string{
  253. "outDir": moduleGenDir.String(),
  254. },
  255. })
  256. implicits = append(implicits, outputs.Paths()...)
  257. }
  258. envVars = append(envVars, "ANDROID_RUST_VERSION="+config.GetRustVersion(ctx))
  259. if ctx.RustModule().compiler.CargoEnvCompat() {
  260. if _, ok := ctx.RustModule().compiler.(*binaryDecorator); ok {
  261. envVars = append(envVars, "CARGO_BIN_NAME="+strings.TrimSuffix(outputFile.Base(), outputFile.Ext()))
  262. }
  263. envVars = append(envVars, "CARGO_CRATE_NAME="+ctx.RustModule().CrateName())
  264. pkgVersion := ctx.RustModule().compiler.CargoPkgVersion()
  265. if pkgVersion != "" {
  266. envVars = append(envVars, "CARGO_PKG_VERSION="+pkgVersion)
  267. }
  268. }
  269. if flags.Clippy {
  270. clippyFile := android.PathForModuleOut(ctx, outputFile.Base()+".clippy")
  271. ctx.Build(pctx, android.BuildParams{
  272. Rule: clippyDriver,
  273. Description: "clippy " + main.Rel(),
  274. Output: clippyFile,
  275. ImplicitOutputs: nil,
  276. Inputs: inputs,
  277. Implicits: implicits,
  278. Args: map[string]string{
  279. "rustcFlags": strings.Join(rustcFlags, " "),
  280. "libFlags": strings.Join(libFlags, " "),
  281. "clippyFlags": strings.Join(flags.ClippyFlags, " "),
  282. "envVars": strings.Join(envVars, " "),
  283. },
  284. })
  285. // Declare the clippy build as an implicit dependency of the original crate.
  286. implicits = append(implicits, clippyFile)
  287. }
  288. ctx.Build(pctx, android.BuildParams{
  289. Rule: rustc,
  290. Description: "rustc " + main.Rel(),
  291. Output: outputFile,
  292. ImplicitOutputs: implicitOutputs,
  293. Inputs: inputs,
  294. Implicits: implicits,
  295. Args: map[string]string{
  296. "rustcFlags": strings.Join(rustcFlags, " "),
  297. "linkFlags": strings.Join(linkFlags, " "),
  298. "libFlags": strings.Join(libFlags, " "),
  299. "crtBegin": strings.Join(deps.CrtBegin.Strings(), " "),
  300. "crtEnd": strings.Join(deps.CrtEnd.Strings(), " "),
  301. "envVars": strings.Join(envVars, " "),
  302. },
  303. })
  304. if flags.EmitXrefs {
  305. kytheFile := android.PathForModuleOut(ctx, outputFile.Base()+".kzip")
  306. ctx.Build(pctx, android.BuildParams{
  307. Rule: kytheExtract,
  308. Description: "Xref Rust extractor " + main.Rel(),
  309. Output: kytheFile,
  310. Inputs: inputs,
  311. Implicits: implicits,
  312. Args: map[string]string{
  313. "rustcFlags": strings.Join(rustcFlags, " "),
  314. "linkFlags": strings.Join(linkFlags, " "),
  315. "libFlags": strings.Join(libFlags, " "),
  316. "crtBegin": strings.Join(deps.CrtBegin.Strings(), " "),
  317. "crtEnd": strings.Join(deps.CrtEnd.Strings(), " "),
  318. "envVars": strings.Join(envVars, " "),
  319. },
  320. })
  321. output.kytheFile = kytheFile
  322. }
  323. return output
  324. }
  325. func Rustdoc(ctx ModuleContext, main android.Path, deps PathDeps,
  326. flags Flags) android.ModuleOutPath {
  327. rustdocFlags := append([]string{}, flags.RustdocFlags...)
  328. rustdocFlags = append(rustdocFlags, "--sysroot=/dev/null")
  329. // Build an index for all our crates. -Z unstable options is required to use
  330. // this flag.
  331. rustdocFlags = append(rustdocFlags, "-Z", "unstable-options", "--enable-index-page")
  332. targetTriple := ctx.toolchain().RustTriple()
  333. // Collect rustc flags
  334. if targetTriple != "" {
  335. rustdocFlags = append(rustdocFlags, "--target="+targetTriple)
  336. }
  337. crateName := ctx.RustModule().CrateName()
  338. rustdocFlags = append(rustdocFlags, "--crate-name "+crateName)
  339. rustdocFlags = append(rustdocFlags, makeLibFlags(deps)...)
  340. docTimestampFile := android.PathForModuleOut(ctx, "rustdoc.timestamp")
  341. // Silence warnings about renamed lints for third-party crates
  342. modulePath := android.PathForModuleSrc(ctx).String()
  343. if android.IsThirdPartyPath(modulePath) {
  344. rustdocFlags = append(rustdocFlags, " -A renamed_and_removed_lints")
  345. }
  346. // Yes, the same out directory is used simultaneously by all rustdoc builds.
  347. // This is what cargo does. The docs for individual crates get generated to
  348. // a subdirectory named for the crate, and rustdoc synchronizes writes to
  349. // shared pieces like the index and search data itself.
  350. // https://github.com/rust-lang/rust/blob/master/src/librustdoc/html/render/write_shared.rs#L144-L146
  351. docDir := android.PathForOutput(ctx, "rustdoc")
  352. ctx.Build(pctx, android.BuildParams{
  353. Rule: rustdoc,
  354. Description: "rustdoc " + main.Rel(),
  355. Output: docTimestampFile,
  356. Input: main,
  357. Implicit: ctx.RustModule().UnstrippedOutputFile(),
  358. Args: map[string]string{
  359. "rustdocFlags": strings.Join(rustdocFlags, " "),
  360. "outDir": docDir.String(),
  361. "envVars": strings.Join(rustEnvVars(ctx, deps), " "),
  362. },
  363. })
  364. return docTimestampFile
  365. }