• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1// 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	"fmt"
19	"os"
20	"path/filepath"
21	"strconv"
22	"strings"
23	"time"
24
25	"android/soong/ui/metrics"
26	"android/soong/ui/status"
27)
28
29func runNinja(ctx Context, config Config) {
30	ctx.BeginTrace(metrics.PrimaryNinja, "ninja")
31	defer ctx.EndTrace()
32
33	fifo := filepath.Join(config.OutDir(), ".ninja_fifo")
34	nr := status.NewNinjaReader(ctx, ctx.Status.StartTool(), fifo)
35	defer nr.Close()
36
37	executable := config.PrebuiltBuildTool("ninja")
38	args := []string{
39		"-d", "keepdepfile",
40		"--frontend_file", fifo,
41	}
42
43	args = append(args, config.NinjaArgs()...)
44
45	var parallel int
46	if config.UseGoma() {
47		parallel = config.RemoteParallel()
48	} else {
49		parallel = config.Parallel()
50	}
51	args = append(args, "-j", strconv.Itoa(parallel))
52	if config.keepGoing != 1 {
53		args = append(args, "-k", strconv.Itoa(config.keepGoing))
54	}
55
56	args = append(args, "-f", config.CombinedNinjaFile())
57
58	args = append(args,
59		"-w", "dupbuild=err",
60		"-w", "missingdepfile=err")
61
62	cmd := Command(ctx, config, "ninja", executable, args...)
63	cmd.Sandbox = ninjaSandbox
64	if config.HasKatiSuffix() {
65		cmd.Environment.AppendFromKati(config.KatiEnvFile())
66	}
67
68	cmd.Environment.Set("DIST_DIR", config.DistDir())
69
70	// Allow both NINJA_ARGS and NINJA_EXTRA_ARGS, since both have been
71	// used in the past to specify extra ninja arguments.
72	if extra, ok := cmd.Environment.Get("NINJA_ARGS"); ok {
73		cmd.Args = append(cmd.Args, strings.Fields(extra)...)
74	}
75	if extra, ok := cmd.Environment.Get("NINJA_EXTRA_ARGS"); ok {
76		cmd.Args = append(cmd.Args, strings.Fields(extra)...)
77	}
78
79	logPath := filepath.Join(config.OutDir(), ".ninja_log")
80	ninjaHeartbeatDuration := time.Minute * 5
81	if overrideText, ok := cmd.Environment.Get("NINJA_HEARTBEAT_INTERVAL"); ok {
82		// For example, "1m"
83		overrideDuration, err := time.ParseDuration(overrideText)
84		if err == nil && overrideDuration.Seconds() > 0 {
85			ninjaHeartbeatDuration = overrideDuration
86		}
87	}
88	// Poll the ninja log for updates; if it isn't updated enough, then we want to show some diagnostics
89	done := make(chan struct{})
90	defer close(done)
91	ticker := time.NewTicker(ninjaHeartbeatDuration)
92	defer ticker.Stop()
93	checker := &statusChecker{}
94	go func() {
95		for {
96			select {
97			case <-ticker.C:
98				checker.check(ctx, config, logPath)
99			case <-done:
100				return
101			}
102		}
103	}()
104
105	ctx.Status.Status("Starting ninja...")
106	cmd.RunAndPrintOrFatal()
107}
108
109type statusChecker struct {
110	prevTime time.Time
111}
112
113func (c *statusChecker) check(ctx Context, config Config, pathToCheck string) {
114	info, err := os.Stat(pathToCheck)
115	var newTime time.Time
116	if err == nil {
117		newTime = info.ModTime()
118	}
119	if newTime == c.prevTime {
120		// ninja may be stuck
121		dumpStucknessDiagnostics(ctx, config, pathToCheck, newTime)
122	}
123	c.prevTime = newTime
124}
125
126// dumpStucknessDiagnostics gets called when it is suspected that Ninja is stuck and we want to output some diagnostics
127func dumpStucknessDiagnostics(ctx Context, config Config, statusPath string, lastUpdated time.Time) {
128
129	ctx.Verbosef("ninja may be stuck; last update to %v was %v. dumping process tree...", statusPath, lastUpdated)
130
131	// The "pstree" command doesn't exist on Mac, but "pstree" on Linux gives more convenient output than "ps"
132	// So, we try pstree first, and ps second
133	pstreeCommandText := fmt.Sprintf("pstree -pal %v", os.Getpid())
134	psCommandText := "ps -ef"
135	commandText := pstreeCommandText + " || " + psCommandText
136
137	cmd := Command(ctx, config, "dump process tree", "bash", "-c", commandText)
138	output := cmd.CombinedOutputOrFatal()
139	ctx.Verbose(string(output))
140
141	ctx.Verbosef("done\n")
142}
143