blob: c583a494364542701dc6311631cab8ce16d0dab7 [file] [log] [blame]
Colin Cross3f40fa42015-01-30 17:27:36 -08001// Copyright 2015 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
15package main
16
17import (
18 "flag"
19 "fmt"
Lukacs T. Berkif0b3b942021-03-23 11:46:47 +010020 "io/ioutil"
Colin Cross3f40fa42015-01-30 17:27:36 -080021 "os"
22 "path/filepath"
Jingwen Cheneb76c432021-01-28 08:22:12 -050023 "strings"
Lukacs T. Berkic99c9472021-03-24 10:50:06 +010024 "time"
Colin Cross3f40fa42015-01-30 17:27:36 -080025
Dan Willemsen66213a62021-09-21 17:50:30 -070026 "android/soong/android"
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020027 "android/soong/bp2build"
Lukacs T. Berki7690c092021-02-26 14:27:36 +010028 "android/soong/shared"
Chris Parsons715b08f2022-03-22 19:23:40 -040029 "android/soong/ui/metrics/bp2build_metrics_proto"
Lukacs T. Berkie571dc32021-08-25 14:14:13 +020030
Colin Cross70b40592015-03-23 12:57:34 -070031 "github.com/google/blueprint/bootstrap"
Lukacs T. Berkid518e1a2021-04-14 13:49:50 +020032 "github.com/google/blueprint/deptools"
Chris Parsons715b08f2022-03-22 19:23:40 -040033 "github.com/google/blueprint/metrics"
Dan Willemsen66213a62021-09-21 17:50:30 -070034 androidProtobuf "google.golang.org/protobuf/android"
Colin Cross3f40fa42015-01-30 17:27:36 -080035)
36
Colin Crosse87040b2017-12-11 15:52:26 -080037var (
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020038 topDir string
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +020039 outDir string
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +020040 soongOutDir string
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020041 availableEnvFile string
42 usedEnvFile string
43
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +020044 runGoTests bool
45
Lukacs T. Berki809d2ed2021-08-18 10:55:32 +020046 globFile string
47 globListDir string
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020048 delveListen string
49 delvePath string
50
Lukacs T. Berkie571dc32021-08-25 14:14:13 +020051 moduleGraphFile string
kgui67007242022-01-25 13:50:25 +080052 moduleActionsFile string
Jingwen Chen50f93d22020-11-05 07:42:11 -050053 docFile string
54 bazelQueryViewDir string
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020055 bp2buildMarker string
Lukacs T. Berkif9008072021-08-16 15:24:48 +020056
57 cmdlineArgs bootstrap.Args
Colin Crosse87040b2017-12-11 15:52:26 -080058)
59
60func init() {
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020061 // Flags that make sense in every mode
Lukacs T. Berki7690c092021-02-26 14:27:36 +010062 flag.StringVar(&topDir, "top", "", "Top directory of the Android source tree")
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +020063 flag.StringVar(&soongOutDir, "soong_out", "", "Soong output directory (usually $TOP/out/soong)")
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020064 flag.StringVar(&availableEnvFile, "available_env", "", "File containing available environment variables")
65 flag.StringVar(&usedEnvFile, "used_env", "", "File containing used environment variables")
Lukacs T. Berkib078ade2021-08-31 10:42:08 +020066 flag.StringVar(&globFile, "globFile", "build-globs.ninja", "the Ninja file of globs to output")
67 flag.StringVar(&globListDir, "globListDir", "", "the directory containing the glob list files")
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +020068 flag.StringVar(&outDir, "out", "", "the ninja builddir directory")
Lukacs T. Berkib078ade2021-08-31 10:42:08 +020069 flag.StringVar(&cmdlineArgs.ModuleListFile, "l", "", "file that lists filepaths to parse")
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020070
71 // Debug flags
Lukacs T. Berki7d613bf2021-03-02 10:09:41 +010072 flag.StringVar(&delveListen, "delve_listen", "", "Delve port to listen on for debugging")
73 flag.StringVar(&delvePath, "delve_path", "", "Path to Delve. Only used if --delve_listen is set")
Lukacs T. Berkib078ade2021-08-31 10:42:08 +020074 flag.StringVar(&cmdlineArgs.Cpuprofile, "cpuprofile", "", "write cpu profile to file")
75 flag.StringVar(&cmdlineArgs.TraceFile, "trace", "", "write trace to file")
76 flag.StringVar(&cmdlineArgs.Memprofile, "memprofile", "", "write memory profile to file")
77 flag.BoolVar(&cmdlineArgs.NoGC, "nogc", false, "turn off GC for debugging")
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020078
79 // Flags representing various modes soong_build can run in
Lukacs T. Berkie571dc32021-08-25 14:14:13 +020080 flag.StringVar(&moduleGraphFile, "module_graph_file", "", "JSON module graph file to output")
kgui67007242022-01-25 13:50:25 +080081 flag.StringVar(&moduleActionsFile, "module_actions_file", "", "JSON file to output inputs/outputs of actions of modules")
Colin Crosse87040b2017-12-11 15:52:26 -080082 flag.StringVar(&docFile, "soong_docs", "", "build documentation file to output")
Lukacs T. Berki47a9d0c2021-03-08 16:34:09 +010083 flag.StringVar(&bazelQueryViewDir, "bazel_queryview_dir", "", "path to the bazel queryview directory relative to --top")
Lukacs T. Berkif8e24282021-04-14 10:31:00 +020084 flag.StringVar(&bp2buildMarker, "bp2build_marker", "", "If set, run bp2build, touch the specified marker file then exit")
Lukacs T. Berkif9008072021-08-16 15:24:48 +020085 flag.StringVar(&cmdlineArgs.OutFile, "o", "build.ninja", "the Ninja file to output")
Lukacs T. Berkib078ade2021-08-31 10:42:08 +020086 flag.BoolVar(&cmdlineArgs.EmptyNinjaFile, "empty-ninja-file", false, "write out a 0-byte ninja file")
87
88 // Flags that probably shouldn't be flags of soong_build but we haven't found
89 // the time to remove them yet
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +020090 flag.BoolVar(&runGoTests, "t", false, "build and run go tests during bootstrap")
Dan Willemsen66213a62021-09-21 17:50:30 -070091
92 // Disable deterministic randomization in the protobuf package, so incremental
93 // builds with unrelated Soong changes don't trigger large rebuilds (since we
94 // write out text protos in command lines, and command line changes trigger
95 // rebuilds).
96 androidProtobuf.DisableRand()
Colin Crosse87040b2017-12-11 15:52:26 -080097}
98
Jeff Gaston088e29e2017-11-29 16:47:17 -080099func newNameResolver(config android.Config) *android.NameResolver {
100 namespacePathsToExport := make(map[string]bool)
101
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700102 for _, namespaceName := range config.ExportedNamespaces() {
Jeff Gaston088e29e2017-11-29 16:47:17 -0800103 namespacePathsToExport[namespaceName] = true
104 }
105
106 namespacePathsToExport["."] = true // always export the root namespace
107
108 exportFilter := func(namespace *android.Namespace) bool {
109 return namespacePathsToExport[namespace.Path]
110 }
111
112 return android.NewNameResolver(exportFilter)
113}
114
Lukacs T. Berkiffc9e8d2021-09-07 17:54:38 +0200115func newContext(configuration android.Config) *android.Context {
Colin Crossae8600b2020-10-29 17:09:13 -0700116 ctx := android.NewContext(configuration)
Jingwen Chendaa54bc2020-12-14 02:58:54 -0500117 ctx.Register()
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400118 ctx.SetNameInterface(newNameResolver(configuration))
119 ctx.SetAllowMissingDependencies(configuration.AllowMissingDependencies())
120 return ctx
121}
122
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +0200123func newConfig(availableEnv map[string]string) android.Config {
124 configuration, err := android.NewConfig(cmdlineArgs.ModuleListFile, runGoTests, outDir, soongOutDir, availableEnv)
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400125 if err != nil {
126 fmt.Fprintf(os.Stderr, "%s", err)
127 os.Exit(1)
128 }
129 return configuration
130}
131
Chris Parsonsf874e462022-05-10 13:50:12 -0400132// Bazel-enabled mode. Attaches a mutator to queue Bazel requests, adds a
133// BeforePrepareBuildActionsHook to invoke Bazel, and then uses Bazel metadata
134// for modules that should be handled by Bazel.
135func runMixedModeBuild(configuration android.Config, ctx *android.Context, extraNinjaDeps []string) {
136 ctx.EventHandler.Begin("mixed_build")
137 defer ctx.EventHandler.End("mixed_build")
Lukacs T. Berkid518e1a2021-04-14 13:49:50 +0200138
Chris Parsonsf874e462022-05-10 13:50:12 -0400139 bazelHook := func() error {
140 ctx.EventHandler.Begin("bazel")
141 defer ctx.EventHandler.End("bazel")
Yu Liu8d82ac52022-05-17 15:13:28 -0700142 return configuration.BazelContext.InvokeBazel(configuration)
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200143 }
Chris Parsonsf874e462022-05-10 13:50:12 -0400144 ctx.SetBeforePrepareBuildActionsHook(bazelHook)
Chris Parsons715b08f2022-03-22 19:23:40 -0400145
Chris Parsonsf874e462022-05-10 13:50:12 -0400146 ninjaDeps := bootstrap.RunBlueprint(cmdlineArgs, bootstrap.DoEverything, ctx.Context, configuration)
Chris Parsons027881c2022-05-24 15:38:38 -0400147 ninjaDeps = append(ninjaDeps, extraNinjaDeps...)
Lukacs T. Berki809d2ed2021-08-18 10:55:32 +0200148
Chris Parsonsf874e462022-05-10 13:50:12 -0400149 globListFiles := writeBuildGlobsNinjaFile(ctx, configuration.SoongOutDir(), configuration)
Lukacs T. Berki809d2ed2021-08-18 10:55:32 +0200150 ninjaDeps = append(ninjaDeps, globListFiles...)
151
Chris Parsonsf874e462022-05-10 13:50:12 -0400152 writeDepFile(cmdlineArgs.OutFile, *ctx.EventHandler, ninjaDeps)
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200153}
154
155// Run the code-generation phase to convert BazelTargetModules to BUILD files.
Lukacs T. Berki3a821692021-09-06 17:08:02 +0200156func runQueryView(queryviewDir, queryviewMarker string, configuration android.Config, ctx *android.Context) {
Chris Parsons715b08f2022-03-22 19:23:40 -0400157 ctx.EventHandler.Begin("queryview")
158 defer ctx.EventHandler.End("queryview")
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200159 codegenContext := bp2build.NewCodegenContext(configuration, *ctx, bp2build.QueryView)
Lukacs T. Berki3a821692021-09-06 17:08:02 +0200160 absoluteQueryViewDir := shared.JoinPath(topDir, queryviewDir)
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200161 if err := createBazelQueryView(codegenContext, absoluteQueryViewDir); err != nil {
162 fmt.Fprintf(os.Stderr, "%s", err)
163 os.Exit(1)
164 }
Lukacs T. Berki3a821692021-09-06 17:08:02 +0200165
166 touch(shared.JoinPath(topDir, queryviewMarker))
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200167}
168
Dan Willemsenccf36aa2022-04-20 23:11:43 -0700169func writeMetrics(configuration android.Config, eventHandler metrics.EventHandler, metricsDir string) {
Chris Parsons715b08f2022-03-22 19:23:40 -0400170 if len(metricsDir) < 1 {
171 fmt.Fprintf(os.Stderr, "\nMissing required env var for generating soong metrics: LOG_DIR\n")
172 os.Exit(1)
173 }
174 metricsFile := filepath.Join(metricsDir, "soong_build_metrics.pb")
175 err := android.WriteMetrics(configuration, eventHandler, metricsFile)
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200176 if err != nil {
177 fmt.Fprintf(os.Stderr, "error writing soong_build metrics %s: %s", metricsFile, err)
178 os.Exit(1)
179 }
180}
181
kgui67007242022-01-25 13:50:25 +0800182func writeJsonModuleGraphAndActions(ctx *android.Context, graphPath string, actionsPath string) {
183 graphFile, graphErr := os.Create(shared.JoinPath(topDir, graphPath))
184 actionsFile, actionsErr := os.Create(shared.JoinPath(topDir, actionsPath))
185 if graphErr != nil || actionsErr != nil {
186 fmt.Fprintf(os.Stderr, "Graph err: %s, actions err: %s", graphErr, actionsErr)
Lukacs T. Berki97bb9f12021-04-01 18:28:45 +0200187 os.Exit(1)
188 }
189
kgui67007242022-01-25 13:50:25 +0800190 defer graphFile.Close()
191 defer actionsFile.Close()
192 ctx.Context.PrintJSONGraphAndActions(graphFile, actionsFile)
Lukacs T. Berki97bb9f12021-04-01 18:28:45 +0200193}
194
Chris Parsons715b08f2022-03-22 19:23:40 -0400195func writeBuildGlobsNinjaFile(ctx *android.Context, buildDir string, config interface{}) []string {
196 ctx.EventHandler.Begin("globs_ninja_file")
197 defer ctx.EventHandler.End("globs_ninja_file")
198
Lukacs T. Berki809d2ed2021-08-18 10:55:32 +0200199 globDir := bootstrap.GlobDirectory(buildDir, globListDir)
200 bootstrap.WriteBuildGlobsNinjaFile(&bootstrap.GlobSingleton{
Chris Parsons715b08f2022-03-22 19:23:40 -0400201 GlobLister: ctx.Globs,
Lukacs T. Berki809d2ed2021-08-18 10:55:32 +0200202 GlobFile: globFile,
203 GlobDir: globDir,
Chris Parsons715b08f2022-03-22 19:23:40 -0400204 SrcDir: ctx.SrcDir(),
Lukacs T. Berki809d2ed2021-08-18 10:55:32 +0200205 }, config)
206 return bootstrap.GlobFileListFiles(globDir)
207}
208
Chris Parsons715b08f2022-03-22 19:23:40 -0400209func writeDepFile(outputFile string, eventHandler metrics.EventHandler, ninjaDeps []string) {
210 eventHandler.Begin("ninja_deps")
211 defer eventHandler.End("ninja_deps")
Lukacs T. Berkie571dc32021-08-25 14:14:13 +0200212 depFile := shared.JoinPath(topDir, outputFile+".d")
213 err := deptools.WriteDepFile(depFile, outputFile, ninjaDeps)
214 if err != nil {
215 fmt.Fprintf(os.Stderr, "Error writing depfile '%s': %s\n", depFile, err)
216 os.Exit(1)
217 }
218}
219
Jingwen Chen4fabaf52021-05-25 02:40:29 +0000220// doChosenActivity runs Soong for a specific activity, like bp2build, queryview
221// or the actual Soong build for the build.ninja file. Returns the top level
222// output file of the specific activity.
Dan Willemsenccf36aa2022-04-20 23:11:43 -0700223func doChosenActivity(configuration android.Config, extraNinjaDeps []string, logDir string) string {
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200224 mixedModeBuild := configuration.BazelContext.BazelEnabled()
Lukacs T. Berkic6012f32021-09-06 18:31:46 +0200225 generateBazelWorkspace := bp2buildMarker != ""
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200226 generateQueryView := bazelQueryViewDir != ""
Lukacs T. Berkic6012f32021-09-06 18:31:46 +0200227 generateModuleGraphFile := moduleGraphFile != ""
228 generateDocFile := docFile != ""
Lukacs T. Berki97bb9f12021-04-01 18:28:45 +0200229
Lukacs T. Berkic6012f32021-09-06 18:31:46 +0200230 if generateBazelWorkspace {
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200231 // Run the alternate pipeline of bp2build mutators and singleton to convert
232 // Blueprint to BUILD files before everything else.
233 runBp2Build(configuration, extraNinjaDeps)
Jingwen Chen4fabaf52021-05-25 02:40:29 +0000234 return bp2buildMarker
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200235 }
236
Lukacs T. Berkieb0454b2021-10-26 13:32:59 +0200237 blueprintArgs := cmdlineArgs
238
Lukacs T. Berkiffc9e8d2021-09-07 17:54:38 +0200239 ctx := newContext(configuration)
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200240 if mixedModeBuild {
241 runMixedModeBuild(configuration, ctx, extraNinjaDeps)
242 } else {
Chris Parsons715b08f2022-03-22 19:23:40 -0400243 var stopBefore bootstrap.StopBefore
244 if generateModuleGraphFile {
245 stopBefore = bootstrap.StopBeforeWriteNinja
246 } else if generateQueryView {
247 stopBefore = bootstrap.StopBeforePrepareBuildActions
248 } else if generateDocFile {
249 stopBefore = bootstrap.StopBeforePrepareBuildActions
250 } else {
251 stopBefore = bootstrap.DoEverything
252 }
253
Lukacs T. Berkiffc9e8d2021-09-07 17:54:38 +0200254 ninjaDeps := bootstrap.RunBlueprint(blueprintArgs, stopBefore, ctx.Context, configuration)
Lukacs T. Berki6124c9b2021-04-15 15:06:40 +0200255 ninjaDeps = append(ninjaDeps, extraNinjaDeps...)
Lukacs T. Berki809d2ed2021-08-18 10:55:32 +0200256
Chris Parsons715b08f2022-03-22 19:23:40 -0400257 globListFiles := writeBuildGlobsNinjaFile(ctx, configuration.SoongOutDir(), configuration)
Lukacs T. Berki809d2ed2021-08-18 10:55:32 +0200258 ninjaDeps = append(ninjaDeps, globListFiles...)
259
Lukacs T. Berkie571dc32021-08-25 14:14:13 +0200260 // Convert the Soong module graph into Bazel BUILD files.
261 if generateQueryView {
Lukacs T. Berki3a821692021-09-06 17:08:02 +0200262 queryviewMarkerFile := bazelQueryViewDir + ".marker"
263 runQueryView(bazelQueryViewDir, queryviewMarkerFile, configuration, ctx)
Chris Parsons715b08f2022-03-22 19:23:40 -0400264 writeDepFile(queryviewMarkerFile, *ctx.EventHandler, ninjaDeps)
Lukacs T. Berki3a821692021-09-06 17:08:02 +0200265 return queryviewMarkerFile
Lukacs T. Berkic6012f32021-09-06 18:31:46 +0200266 } else if generateModuleGraphFile {
kgui67007242022-01-25 13:50:25 +0800267 writeJsonModuleGraphAndActions(ctx, moduleGraphFile, moduleActionsFile)
Chris Parsons715b08f2022-03-22 19:23:40 -0400268 writeDepFile(moduleGraphFile, *ctx.EventHandler, ninjaDeps)
Lukacs T. Berkie571dc32021-08-25 14:14:13 +0200269 return moduleGraphFile
Lukacs T. Berkic6012f32021-09-06 18:31:46 +0200270 } else if generateDocFile {
271 // TODO: we could make writeDocs() return the list of documentation files
272 // written and add them to the .d file. Then soong_docs would be re-run
273 // whenever one is deleted.
274 if err := writeDocs(ctx, shared.JoinPath(topDir, docFile)); err != nil {
275 fmt.Fprintf(os.Stderr, "error building Soong documentation: %s\n", err)
276 os.Exit(1)
277 }
Chris Parsons715b08f2022-03-22 19:23:40 -0400278 writeDepFile(docFile, *ctx.EventHandler, ninjaDeps)
Lukacs T. Berkic6012f32021-09-06 18:31:46 +0200279 return docFile
Lukacs T. Berkie571dc32021-08-25 14:14:13 +0200280 } else {
281 // The actual output (build.ninja) was written in the RunBlueprint() call
282 // above
Chris Parsons715b08f2022-03-22 19:23:40 -0400283 writeDepFile(cmdlineArgs.OutFile, *ctx.EventHandler, ninjaDeps)
Lukacs T. Berkid518e1a2021-04-14 13:49:50 +0200284 }
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200285 }
286
Dan Willemsenccf36aa2022-04-20 23:11:43 -0700287 writeMetrics(configuration, *ctx.EventHandler, logDir)
Lukacs T. Berkif9008072021-08-16 15:24:48 +0200288 return cmdlineArgs.OutFile
Lukacs T. Berkif8e24282021-04-14 10:31:00 +0200289}
290
291// soong_ui dumps the available environment variables to
292// soong.environment.available . Then soong_build itself is run with an empty
293// environment so that the only way environment variables can be accessed is
294// using Config, which tracks access to them.
295
296// At the end of the build, a file called soong.environment.used is written
297// containing the current value of all used environment variables. The next
298// time soong_ui is run, it checks whether any environment variables that was
299// used had changed and if so, it deletes soong.environment.used to cause a
300// rebuild.
301//
302// The dependency of build.ninja on soong.environment.used is declared in
303// build.ninja.d
304func parseAvailableEnv() map[string]string {
305 if availableEnvFile == "" {
306 fmt.Fprintf(os.Stderr, "--available_env not set\n")
307 os.Exit(1)
308 }
309
310 result, err := shared.EnvFromFile(shared.JoinPath(topDir, availableEnvFile))
311 if err != nil {
312 fmt.Fprintf(os.Stderr, "error reading available environment file '%s': %s\n", availableEnvFile, err)
313 os.Exit(1)
314 }
315
316 return result
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200317}
318
Colin Cross3f40fa42015-01-30 17:27:36 -0800319func main() {
320 flag.Parse()
321
Lukacs T. Berki7d613bf2021-03-02 10:09:41 +0100322 shared.ReexecWithDelveMaybe(delveListen, delvePath)
Lukacs T. Berki7690c092021-02-26 14:27:36 +0100323 android.InitSandbox(topDir)
Lukacs T. Berki7690c092021-02-26 14:27:36 +0100324
Lukacs T. Berkif8e24282021-04-14 10:31:00 +0200325 availableEnv := parseAvailableEnv()
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200326
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +0200327 configuration := newConfig(availableEnv)
Lukacs T. Berkif0b3b942021-03-23 11:46:47 +0100328 extraNinjaDeps := []string{
329 configuration.ProductVariablesFileName,
Lukacs T. Berkid518e1a2021-04-14 13:49:50 +0200330 usedEnvFile,
Lukacs T. Berkif0b3b942021-03-23 11:46:47 +0100331 }
Colin Crossaa812d12019-06-19 13:33:24 -0700332
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100333 if configuration.Getenv("ALLOW_MISSING_DEPENDENCIES") == "true" {
334 configuration.SetAllowMissingDependencies()
335 }
336
Lukacs T. Berki7d613bf2021-03-02 10:09:41 +0100337 if shared.IsDebugging() {
Colin Crossaa812d12019-06-19 13:33:24 -0700338 // Add a non-existent file to the dependencies so that soong_build will rerun when the debugger is
339 // enabled even if it completed successfully.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200340 extraNinjaDeps = append(extraNinjaDeps, filepath.Join(configuration.SoongOutDir(), "always_rerun_for_delve"))
Colin Crossaa812d12019-06-19 13:33:24 -0700341 }
Jingwen Chendaa54bc2020-12-14 02:58:54 -0500342
Dan Willemsenccf36aa2022-04-20 23:11:43 -0700343 // Bypass configuration.Getenv, as LOG_DIR does not need to be dependency tracked. By definition, it will
344 // change between every CI build, so tracking it would require re-running Soong for every build.
345 logDir := availableEnv["LOG_DIR"]
346
347 finalOutputFile := doChosenActivity(configuration, extraNinjaDeps, logDir)
Chris Parsons715b08f2022-03-22 19:23:40 -0400348
Lukacs T. Berkif8e24282021-04-14 10:31:00 +0200349 writeUsedEnvironmentFile(configuration, finalOutputFile)
Lukacs T. Berkif0b3b942021-03-23 11:46:47 +0100350}
351
Lukacs T. Berkif8e24282021-04-14 10:31:00 +0200352func writeUsedEnvironmentFile(configuration android.Config, finalOutputFile string) {
353 if usedEnvFile == "" {
354 return
355 }
356
357 path := shared.JoinPath(topDir, usedEnvFile)
Lukacs T. Berkif0b3b942021-03-23 11:46:47 +0100358 data, err := shared.EnvFileContents(configuration.EnvDeps())
359 if err != nil {
Lukacs T. Berkif8e24282021-04-14 10:31:00 +0200360 fmt.Fprintf(os.Stderr, "error writing used environment file '%s': %s\n", usedEnvFile, err)
Lukacs T. Berkif0b3b942021-03-23 11:46:47 +0100361 os.Exit(1)
362 }
363
364 err = ioutil.WriteFile(path, data, 0666)
365 if err != nil {
Lukacs T. Berkif8e24282021-04-14 10:31:00 +0200366 fmt.Fprintf(os.Stderr, "error writing used environment file '%s': %s\n", usedEnvFile, err)
Lukacs T. Berkic99c9472021-03-24 10:50:06 +0100367 os.Exit(1)
368 }
369
Lukacs T. Berkif8e24282021-04-14 10:31:00 +0200370 // Touch the output file so that it's not older than the file we just
Lukacs T. Berkic99c9472021-03-24 10:50:06 +0100371 // wrote. We can't write the environment file earlier because one an access
372 // new environment variables while writing it.
Lukacs T. Berkif8e24282021-04-14 10:31:00 +0200373 touch(shared.JoinPath(topDir, finalOutputFile))
Colin Cross3f40fa42015-01-30 17:27:36 -0800374}
Jingwen Chen5ba7e472020-07-15 10:06:41 +0000375
Lukacs T. Berkif8e24282021-04-14 10:31:00 +0200376func touch(path string) {
377 f, err := os.OpenFile(path, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0666)
378 if err != nil {
379 fmt.Fprintf(os.Stderr, "Error touching '%s': %s\n", path, err)
380 os.Exit(1)
381 }
382
383 err = f.Close()
384 if err != nil {
385 fmt.Fprintf(os.Stderr, "Error touching '%s': %s\n", path, err)
386 os.Exit(1)
387 }
388
389 currentTime := time.Now().Local()
390 err = os.Chtimes(path, currentTime, currentTime)
391 if err != nil {
392 fmt.Fprintf(os.Stderr, "error touching '%s': %s\n", path, err)
393 os.Exit(1)
394 }
395}
396
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400397// Find BUILD files in the srcDir which...
398//
399// - are not on the allow list (android/bazel.go#ShouldKeepExistingBuildFileForDir())
400//
401// - won't be overwritten by corresponding bp2build generated files
402//
403// And return their paths so they can be left out of the Bazel workspace dir (i.e. ignored)
Liz Kammer1aefc9d2021-10-18 16:59:00 -0400404func getPathsToIgnoredBuildFiles(topDir string, generatedRoot string, srcDirBazelFiles []string, verbose bool) []string {
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400405 paths := make([]string, 0)
406
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400407 for _, srcDirBazelFileRelativePath := range srcDirBazelFiles {
408 srcDirBazelFileFullPath := shared.JoinPath(topDir, srcDirBazelFileRelativePath)
409 fileInfo, err := os.Stat(srcDirBazelFileFullPath)
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400410 if err != nil {
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400411 // Warn about error, but continue trying to check files
412 fmt.Fprintf(os.Stderr, "WARNING: Error accessing path '%s', err: %s\n", srcDirBazelFileFullPath, err)
413 continue
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400414 }
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400415 if fileInfo.IsDir() {
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400416 // Don't ignore entire directories
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400417 continue
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400418 }
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400419 if !(fileInfo.Name() == "BUILD" || fileInfo.Name() == "BUILD.bazel") {
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400420 // Don't ignore this file - it is not a build file
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400421 continue
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400422 }
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400423 srcDirBazelFileDir := filepath.Dir(srcDirBazelFileRelativePath)
424 if android.ShouldKeepExistingBuildFileForDir(srcDirBazelFileDir) {
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400425 // Don't ignore this existing build file
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400426 continue
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400427 }
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400428 correspondingBp2BuildFile := shared.JoinPath(topDir, generatedRoot, srcDirBazelFileRelativePath)
429 if _, err := os.Stat(correspondingBp2BuildFile); err == nil {
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400430 // If bp2build generated an alternate BUILD file, don't exclude this workspace path
431 // BUILD file clash resolution happens later in the symlink forest creation
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400432 continue
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400433 }
Liz Kammer1aefc9d2021-10-18 16:59:00 -0400434 if verbose {
435 fmt.Fprintf(os.Stderr, "Ignoring existing BUILD file: %s\n", srcDirBazelFileRelativePath)
436 }
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400437 paths = append(paths, srcDirBazelFileRelativePath)
438 }
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400439
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400440 return paths
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400441}
442
443// Returns temporary symlink forest excludes necessary for bazel build //external/... (and bazel build //frameworks/...) to work
444func getTemporaryExcludes() []string {
445 excludes := make([]string, 0)
446
447 // FIXME: 'autotest_lib' is a symlink back to external/autotest, and this causes an infinite symlink expansion error for Bazel
448 excludes = append(excludes, "external/autotest/venv/autotest_lib")
Jingwen Chenc0c50212022-06-07 10:07:22 +0000449 excludes = append(excludes, "external/autotest/autotest_lib")
450 excludes = append(excludes, "external/autotest/client/autotest_lib/client")
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400451
452 // FIXME: The external/google-fruit/extras/bazel_root/third_party/fruit dir is poison
453 // It contains several symlinks back to real source dirs, and those source dirs contain BUILD files we want to ignore
454 excludes = append(excludes, "external/google-fruit/extras/bazel_root/third_party/fruit")
455
456 // FIXME: 'frameworks/compile/slang' has a filegroup error due to an escaping issue
457 excludes = append(excludes, "frameworks/compile/slang")
458
459 return excludes
460}
461
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400462// Read the bazel.list file that the Soong Finder already dumped earlier (hopefully)
463// It contains the locations of BUILD files, BUILD.bazel files, etc. in the source dir
464func getExistingBazelRelatedFiles(topDir string) ([]string, error) {
Lukacs T. Berkif9008072021-08-16 15:24:48 +0200465 bazelFinderFile := filepath.Join(filepath.Dir(cmdlineArgs.ModuleListFile), "bazel.list")
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400466 if !filepath.IsAbs(bazelFinderFile) {
467 // Assume this was a relative path under topDir
468 bazelFinderFile = filepath.Join(topDir, bazelFinderFile)
469 }
470 data, err := ioutil.ReadFile(bazelFinderFile)
471 if err != nil {
472 return nil, err
473 }
474 files := strings.Split(strings.TrimSpace(string(data)), "\n")
475 return files, nil
476}
477
Jingwen Chendaa54bc2020-12-14 02:58:54 -0500478// Run Soong in the bp2build mode. This creates a standalone context that registers
479// an alternate pipeline of mutators and singletons specifically for generating
480// Bazel BUILD files instead of Ninja files.
Lukacs T. Berki6790ebc2021-04-01 17:55:58 +0200481func runBp2Build(configuration android.Config, extraNinjaDeps []string) {
Chris Parsons715b08f2022-03-22 19:23:40 -0400482 eventHandler := metrics.EventHandler{}
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400483 var metrics bp2build.CodegenMetrics
484 eventHandler.Do("bp2build", func() {
Chris Parsons715b08f2022-03-22 19:23:40 -0400485
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400486 // Register an alternate set of singletons and mutators for bazel
487 // conversion for Bazel conversion.
488 bp2buildCtx := android.NewContext(configuration)
Jingwen Cheneb76c432021-01-28 08:22:12 -0500489
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400490 // Soong internals like LoadHooks behave differently when running as
491 // bp2build. This is the bit to differentiate between Soong-as-Soong and
492 // Soong-as-bp2build.
493 bp2buildCtx.SetRunningAsBp2build()
Jingwen Chena47f28d2021-11-02 16:43:57 +0000494
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400495 // Propagate "allow misssing dependencies" bit. This is normally set in
496 // newContext(), but we create bp2buildCtx without calling that method.
497 bp2buildCtx.SetAllowMissingDependencies(configuration.AllowMissingDependencies())
498 bp2buildCtx.SetNameInterface(newNameResolver(configuration))
499 bp2buildCtx.RegisterForBazelConversion()
Jingwen Cheneb76c432021-01-28 08:22:12 -0500500
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400501 // The bp2build process is a purely functional process that only depends on
502 // Android.bp files. It must not depend on the values of per-build product
503 // configurations or variables, since those will generate different BUILD
504 // files based on how the user has configured their tree.
505 bp2buildCtx.SetModuleListFile(cmdlineArgs.ModuleListFile)
506 modulePaths, err := bp2buildCtx.ListModulePaths(".")
507 if err != nil {
508 panic(err)
509 }
Jingwen Chen7dcc4fc2021-02-05 01:28:44 -0500510
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400511 extraNinjaDeps = append(extraNinjaDeps, modulePaths...)
Lukacs T. Berkif0b3b942021-03-23 11:46:47 +0100512
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400513 // Run the loading and analysis pipeline to prepare the graph of regular
514 // Modules parsed from Android.bp files, and the BazelTargetModules mapped
515 // from the regular Modules.
516 blueprintArgs := cmdlineArgs
517 ninjaDeps := bootstrap.RunBlueprint(blueprintArgs, bootstrap.StopBeforePrepareBuildActions, bp2buildCtx.Context, configuration)
518 ninjaDeps = append(ninjaDeps, extraNinjaDeps...)
Lukacs T. Berkid518e1a2021-04-14 13:49:50 +0200519
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400520 globListFiles := writeBuildGlobsNinjaFile(bp2buildCtx, configuration.SoongOutDir(), configuration)
521 ninjaDeps = append(ninjaDeps, globListFiles...)
Lukacs T. Berkid518e1a2021-04-14 13:49:50 +0200522
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400523 // Run the code-generation phase to convert BazelTargetModules to BUILD files
524 // and print conversion metrics to the user.
525 codegenContext := bp2build.NewCodegenContext(configuration, *bp2buildCtx, bp2build.Bp2Build)
526 metrics = bp2build.Codegen(codegenContext)
Lukacs T. Berkib353cca2021-04-16 13:47:36 +0200527
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400528 generatedRoot := shared.JoinPath(configuration.SoongOutDir(), "bp2build")
529 workspaceRoot := shared.JoinPath(configuration.SoongOutDir(), "workspace")
Lukacs T. Berkib353cca2021-04-16 13:47:36 +0200530
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400531 excludes := []string{
532 "bazel-bin",
533 "bazel-genfiles",
534 "bazel-out",
535 "bazel-testlogs",
536 "bazel-" + filepath.Base(topDir),
537 }
Lukacs T. Berkib353cca2021-04-16 13:47:36 +0200538
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400539 if outDir[0] != '/' {
540 excludes = append(excludes, outDir)
541 }
Lukacs T. Berkib353cca2021-04-16 13:47:36 +0200542
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400543 existingBazelRelatedFiles, err := getExistingBazelRelatedFiles(topDir)
544 if err != nil {
545 fmt.Fprintf(os.Stderr, "Error determining existing Bazel-related files: %s\n", err)
546 os.Exit(1)
547 }
Rupert Shuttleworthe03bb612021-05-20 19:34:50 -0400548
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400549 pathsToIgnoredBuildFiles := getPathsToIgnoredBuildFiles(topDir, generatedRoot, existingBazelRelatedFiles, configuration.IsEnvTrue("BP2BUILD_VERBOSE"))
550 excludes = append(excludes, pathsToIgnoredBuildFiles...)
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400551
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400552 excludes = append(excludes, getTemporaryExcludes()...)
Rupert Shuttleworth00960792021-05-12 21:20:13 -0400553
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400554 symlinkForestDeps := bp2build.PlantSymlinkForest(
Sasha Smundak0fd93e02022-05-19 19:34:31 -0700555 configuration, topDir, workspaceRoot, generatedRoot, ".", excludes)
Lukacs T. Berkib353cca2021-04-16 13:47:36 +0200556
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400557 ninjaDeps = append(ninjaDeps, codegenContext.AdditionalNinjaDeps()...)
558 ninjaDeps = append(ninjaDeps, symlinkForestDeps...)
Chris Parsons715b08f2022-03-22 19:23:40 -0400559
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400560 writeDepFile(bp2buildMarker, eventHandler, ninjaDeps)
Chris Parsons715b08f2022-03-22 19:23:40 -0400561
Usta Shrestha5c6b9482022-05-26 12:22:17 -0400562 // Create an empty bp2build marker file.
563 touch(shared.JoinPath(topDir, bp2buildMarker))
564 })
Chris Parsons715b08f2022-03-22 19:23:40 -0400565
Lukacs T. Berkib353cca2021-04-16 13:47:36 +0200566 // Only report metrics when in bp2build mode. The metrics aren't relevant
567 // for queryview, since that's a total repo-wide conversion and there's a
568 // 1:1 mapping for each module.
Sasha Smundak0fd93e02022-05-19 19:34:31 -0700569 if configuration.IsEnvTrue("BP2BUILD_VERBOSE") {
570 metrics.Print()
571 }
Chris Parsons715b08f2022-03-22 19:23:40 -0400572 writeBp2BuildMetrics(&metrics, configuration, eventHandler)
Jingwen Chendaa54bc2020-12-14 02:58:54 -0500573}
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -0500574
575// Write Bp2Build metrics into $LOG_DIR
Chris Parsons715b08f2022-03-22 19:23:40 -0400576func writeBp2BuildMetrics(codegenMetrics *bp2build.CodegenMetrics,
577 configuration android.Config, eventHandler metrics.EventHandler) {
578 for _, event := range eventHandler.CompletedEvents() {
579 codegenMetrics.Events = append(codegenMetrics.Events,
580 &bp2build_metrics_proto.Event{
581 Name: event.Id,
582 StartTime: uint64(event.Start.UnixNano()),
583 RealTime: event.RuntimeNanoseconds(),
584 })
585 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -0500586 metricsDir := configuration.Getenv("LOG_DIR")
587 if len(metricsDir) < 1 {
588 fmt.Fprintf(os.Stderr, "\nMissing required env var for generating bp2build metrics: LOG_DIR\n")
589 os.Exit(1)
590 }
Chris Parsons715b08f2022-03-22 19:23:40 -0400591 codegenMetrics.Write(metricsDir)
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -0500592}