1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
// Copyright 2017 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package build
import (
"bufio"
"fmt"
"path/filepath"
"runtime"
"sort"
"strings"
"android/soong/ui/metrics"
"android/soong/ui/status"
)
// Checks for files in the out directory that have a rule that depends on them but no rule to
// create them. This catches a common set of build failures where a rule to generate a file is
// deleted (either by deleting a module in an Android.mk file, or by modifying the build system
// incorrectly). These failures are often not caught by a local incremental build because the
// previously built files are still present in the output directory.
func testForDanglingRules(ctx Context, config Config) {
// Many modules are disabled on mac. Checking for dangling rules would cause lots of build
// breakages, and presubmit wouldn't catch them, so just disable the check.
if runtime.GOOS != "linux" {
return
}
ctx.BeginTrace(metrics.TestRun, "test for dangling rules")
defer ctx.EndTrace()
ts := ctx.Status.StartTool()
action := &status.Action{
Description: "Test for dangling rules",
}
ts.StartAction(action)
// Get a list of leaf nodes in the dependency graph from ninja
executable := config.PrebuiltBuildTool("ninja")
common_args := []string{}
common_args = append(common_args, config.NinjaArgs()...)
common_args = append(common_args, "-f", config.CombinedNinjaFile())
args := append(common_args, "-t", "targets", "rule")
cmd := Command(ctx, config, "ninja", executable, args...)
stdout, err := cmd.StdoutPipe()
if err != nil {
ctx.Fatal(err)
}
cmd.StartOrFatal()
outDir := config.OutDir()
bootstrapDir := filepath.Join(outDir, "soong", ".bootstrap")
miniBootstrapDir := filepath.Join(outDir, "soong", ".minibootstrap")
modulePathsDir := filepath.Join(outDir, ".module_paths")
variablesFilePath := filepath.Join(outDir, "soong", "soong.variables")
danglingRules := make(map[string]bool)
scanner := bufio.NewScanner(stdout)
for scanner.Scan() {
line := scanner.Text()
if !strings.HasPrefix(line, outDir) {
// Leaf node is not in the out directory.
continue
}
if strings.HasPrefix(line, bootstrapDir) ||
strings.HasPrefix(line, miniBootstrapDir) ||
strings.HasPrefix(line, modulePathsDir) ||
line == variablesFilePath {
// Leaf node is in one of Soong's bootstrap directories, which do not have
// full build rules in the primary build.ninja file.
continue
}
danglingRules[line] = true
}
cmd.WaitOrFatal()
var danglingRulesList []string
for rule := range danglingRules {
danglingRulesList = append(danglingRulesList, rule)
}
sort.Strings(danglingRulesList)
if len(danglingRulesList) > 0 {
sb := &strings.Builder{}
title := "Dependencies in out found with no rule to create them:"
fmt.Fprintln(sb, title)
report_lines := 1
for i, dep := range danglingRulesList {
if report_lines > 20 {
fmt.Fprintf(sb, " ... and %d more\n", len(danglingRulesList)-i)
break
}
// It's helpful to see the reverse dependencies. ninja -t query is the
// best tool we got for that. Its output starts with the dependency
// itself.
query_cmd := Command(ctx, config, "ninja", executable,
append(common_args, "-t", "query", dep)...)
query_stdout, err := query_cmd.StdoutPipe()
if err != nil {
ctx.Fatal(err)
}
query_cmd.StartOrFatal()
scanner := bufio.NewScanner(query_stdout)
for scanner.Scan() {
report_lines++
fmt.Fprintln(sb, " ", scanner.Text())
}
query_cmd.WaitOrFatal()
}
ts.FinishAction(status.ActionResult{
Action: action,
Error: fmt.Errorf(title),
Output: sb.String(),
})
ctx.Fatal("stopping")
}
ts.FinishAction(status.ActionResult{Action: action})
}
|
