blob: af60e0d7694c525b06dc0129a737212cf048f3a3 [file] [log] [blame]
Colin Cross37193492017-11-16 17:55:00 -08001// Copyright 2017 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 build
16
17import (
18 "bufio"
Dan Willemsend2e231a2018-08-02 12:06:24 -070019 "fmt"
Colin Cross37193492017-11-16 17:55:00 -080020 "path/filepath"
Liz Kammer2af5ea82022-11-11 14:21:03 -050021 "regexp"
Colin Cross37193492017-11-16 17:55:00 -080022 "runtime"
Colin Cross63b4e0f2018-06-26 23:48:52 -070023 "sort"
Colin Cross37193492017-11-16 17:55:00 -080024 "strings"
Liz Kammer2af5ea82022-11-11 14:21:03 -050025 "sync"
Dan Willemsend2e231a2018-08-02 12:06:24 -070026
Nan Zhang17f27672018-12-12 16:01:49 -080027 "android/soong/ui/metrics"
Dan Willemsend2e231a2018-08-02 12:06:24 -070028 "android/soong/ui/status"
Colin Cross37193492017-11-16 17:55:00 -080029)
30
Liz Kammer2af5ea82022-11-11 14:21:03 -050031var (
32 // bazel output paths are in __main__/bazel-out/<config-specific-path>/bin
33 bazelOutputPathRegexOnce sync.Once
34 bazelOutputPathRegexp *regexp.Regexp
35)
36
37func bazelOutputPathPattern(config Config) *regexp.Regexp {
38 bazelOutputPathRegexOnce.Do(func() {
39 // Bazel output files are in <Bazel output base>/execroot/__main__/bazel-out/<config>/bin
40 bazelOutRoot := filepath.Join(regexp.QuoteMeta(config.bazelOutputBase()), "execroot", "__main__", "bazel-out")
41 bazelOutputPathRegexp = regexp.MustCompile(bazelOutRoot + "/[^/]+/bin")
42 })
43 return bazelOutputPathRegexp
44}
45
46func ignoreBazelPath(config Config, path string) bool {
47 bazelRoot := filepath.Join(config.bazelOutputBase(), "execroot")
48 // Don't check bazel output regexp unless it is Bazel path
49 if strings.HasPrefix(path, bazelRoot) {
50 bazelOutputRegexp := bazelOutputPathPattern(config)
51 // if the file is a bazel path that is _not_ a Bazel generated file output, we rely on Bazel to
52 // ensure the paths to exist. If it _is_ a Bazel output path, we expect that it should be built
53 // by Ninja.
54 return !bazelOutputRegexp.MatchString(path)
55 }
56 return false
57}
58
Colin Cross37193492017-11-16 17:55:00 -080059// Checks for files in the out directory that have a rule that depends on them but no rule to
60// create them. This catches a common set of build failures where a rule to generate a file is
61// deleted (either by deleting a module in an Android.mk file, or by modifying the build system
62// incorrectly). These failures are often not caught by a local incremental build because the
63// previously built files are still present in the output directory.
64func testForDanglingRules(ctx Context, config Config) {
65 // Many modules are disabled on mac. Checking for dangling rules would cause lots of build
66 // breakages, and presubmit wouldn't catch them, so just disable the check.
67 if runtime.GOOS != "linux" {
68 return
69 }
70
Nan Zhang17f27672018-12-12 16:01:49 -080071 ctx.BeginTrace(metrics.TestRun, "test for dangling rules")
Colin Cross37193492017-11-16 17:55:00 -080072 defer ctx.EndTrace()
73
Dan Willemsend2e231a2018-08-02 12:06:24 -070074 ts := ctx.Status.StartTool()
75 action := &status.Action{
76 Description: "Test for dangling rules",
77 }
78 ts.StartAction(action)
79
Colin Cross37193492017-11-16 17:55:00 -080080 // Get a list of leaf nodes in the dependency graph from ninja
81 executable := config.PrebuiltBuildTool("ninja")
82
Jaewoong Jung18aefc12020-12-21 09:11:10 -080083 commonArgs := []string{}
Jaewoong Jung18aefc12020-12-21 09:11:10 -080084 commonArgs = append(commonArgs, "-f", config.CombinedNinjaFile())
85 args := append(commonArgs, "-t", "targets", "rule")
Colin Cross37193492017-11-16 17:55:00 -080086
87 cmd := Command(ctx, config, "ninja", executable, args...)
88 stdout, err := cmd.StdoutPipe()
89 if err != nil {
90 ctx.Fatal(err)
91 }
92
93 cmd.StartOrFatal()
94
95 outDir := config.OutDir()
Chris Parsons8f232a22020-06-23 17:37:05 -040096 modulePathsDir := filepath.Join(outDir, ".module_paths")
97 variablesFilePath := filepath.Join(outDir, "soong", "soong.variables")
Rupert Shuttleworth0bc9a9a2020-12-08 13:28:38 +000098
Jingwen Chenebb0b572020-11-02 00:24:57 -050099 // dexpreopt.config is an input to the soong_docs action, which runs the
100 // soong_build primary builder. However, this file is created from $(shell)
101 // invocation at Kati parse time, so it's not an explicit output of any
102 // Ninja action, but it is present during the build itself and can be
103 // treated as an source file.
104 dexpreoptConfigFilePath := filepath.Join(outDir, "soong", "dexpreopt.config")
Colin Cross37193492017-11-16 17:55:00 -0800105
Cole Faust39ec9272023-10-04 17:00:22 -0700106 // These files are written by soong_ui at the beginning of every build.
107 // Ninja considers them "source files"
Rupert Shuttleworth0bc9a9a2020-12-08 13:28:38 +0000108 buildDatetimeFilePath := filepath.Join(outDir, "build_date.txt")
Cole Faust39ec9272023-10-04 17:00:22 -0700109 cleanPartitionsFilePath := filepath.Join(outDir, "partitions_were_clean_at_start_of_build.txt")
Rupert Shuttleworth0bc9a9a2020-12-08 13:28:38 +0000110
Lukacs T. Berki5a67da72021-11-10 12:32:22 +0100111 // bpglob is built explicitly using Microfactory
112 bpglob := filepath.Join(config.SoongOutDir(), "bpglob")
113
Colin Cross63b4e0f2018-06-26 23:48:52 -0700114 danglingRules := make(map[string]bool)
Colin Cross37193492017-11-16 17:55:00 -0800115
116 scanner := bufio.NewScanner(stdout)
117 for scanner.Scan() {
118 line := scanner.Text()
119 if !strings.HasPrefix(line, outDir) {
120 // Leaf node is not in the out directory.
121 continue
122 }
Lukacs T. Berki90b43342021-11-02 14:42:04 +0100123 if strings.HasPrefix(line, modulePathsDir) ||
Jingwen Chenebb0b572020-11-02 00:24:57 -0500124 line == variablesFilePath ||
Rupert Shuttleworth0bc9a9a2020-12-08 13:28:38 +0000125 line == dexpreoptConfigFilePath ||
Lukacs T. Berki5a67da72021-11-10 12:32:22 +0100126 line == buildDatetimeFilePath ||
Cole Faust39ec9272023-10-04 17:00:22 -0700127 line == cleanPartitionsFilePath ||
Lukacs T. Berki5a67da72021-11-10 12:32:22 +0100128 line == bpglob {
Colin Cross37193492017-11-16 17:55:00 -0800129 // Leaf node is in one of Soong's bootstrap directories, which do not have
130 // full build rules in the primary build.ninja file.
131 continue
132 }
Liz Kammer2af5ea82022-11-11 14:21:03 -0500133
134 if ignoreBazelPath(config, line) {
135 continue
136 }
Colin Cross63b4e0f2018-06-26 23:48:52 -0700137 danglingRules[line] = true
Colin Cross37193492017-11-16 17:55:00 -0800138 }
139
140 cmd.WaitOrFatal()
141
Colin Cross63b4e0f2018-06-26 23:48:52 -0700142 var danglingRulesList []string
143 for rule := range danglingRules {
144 danglingRulesList = append(danglingRulesList, rule)
145 }
146 sort.Strings(danglingRulesList)
147
148 if len(danglingRulesList) > 0 {
Dan Willemsend2e231a2018-08-02 12:06:24 -0700149 sb := &strings.Builder{}
150 title := "Dependencies in out found with no rule to create them:"
151 fmt.Fprintln(sb, title)
Martin Stjernholm946fb672020-04-15 23:23:34 +0100152
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800153 reportLines := 1
Martin Stjernholm946fb672020-04-15 23:23:34 +0100154 for i, dep := range danglingRulesList {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800155 if reportLines > 20 {
Martin Stjernholm946fb672020-04-15 23:23:34 +0100156 fmt.Fprintf(sb, " ... and %d more\n", len(danglingRulesList)-i)
157 break
158 }
159 // It's helpful to see the reverse dependencies. ninja -t query is the
160 // best tool we got for that. Its output starts with the dependency
161 // itself.
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800162 queryCmd := Command(ctx, config, "ninja", executable,
163 append(commonArgs, "-t", "query", dep)...)
164 queryStdout, err := queryCmd.StdoutPipe()
Martin Stjernholm946fb672020-04-15 23:23:34 +0100165 if err != nil {
166 ctx.Fatal(err)
167 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800168 queryCmd.StartOrFatal()
169 scanner := bufio.NewScanner(queryStdout)
Martin Stjernholm946fb672020-04-15 23:23:34 +0100170 for scanner.Scan() {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800171 reportLines++
Martin Stjernholm946fb672020-04-15 23:23:34 +0100172 fmt.Fprintln(sb, " ", scanner.Text())
173 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800174 queryCmd.WaitOrFatal()
Colin Cross37193492017-11-16 17:55:00 -0800175 }
Martin Stjernholm946fb672020-04-15 23:23:34 +0100176
Dan Willemsend2e231a2018-08-02 12:06:24 -0700177 ts.FinishAction(status.ActionResult{
178 Action: action,
179 Error: fmt.Errorf(title),
180 Output: sb.String(),
181 })
Colin Cross63b4e0f2018-06-26 23:48:52 -0700182 ctx.Fatal("stopping")
Colin Cross37193492017-11-16 17:55:00 -0800183 }
Dan Willemsend2e231a2018-08-02 12:06:24 -0700184 ts.FinishAction(status.ActionResult{Action: action})
Colin Cross37193492017-11-16 17:55:00 -0800185}