platform_build_soong/ui/build/rbe.go

118 lines
3.7 KiB
Go

// Copyright 2019 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 (
"fmt"
"math/rand"
"os"
"path/filepath"
"time"
"android/soong/ui/metrics"
)
const (
rbeLeastNProcs = 2500
rbeLeastNFiles = 16000
// prebuilt RBE binaries
bootstrapCmd = "bootstrap"
// RBE metrics proto buffer file
rbeMetricsPBFilename = "rbe_metrics.pb"
)
func rbeCommand(ctx Context, config Config, rbeCmd string) string {
var cmdPath string
if rbeDir, ok := config.Environment().Get("RBE_DIR"); ok {
cmdPath = filepath.Join(rbeDir, rbeCmd)
} else if home, ok := config.Environment().Get("HOME"); ok {
cmdPath = filepath.Join(home, "rbe", rbeCmd)
} else {
ctx.Fatalf("rbe command path not found")
}
if _, err := os.Stat(cmdPath); err != nil && os.IsNotExist(err) {
ctx.Fatalf("rbe command %q not found", rbeCmd)
}
return cmdPath
}
func getRBEVars(ctx Context, tmpDir string) map[string]string {
rand.Seed(time.Now().UnixNano())
return map[string]string{"RBE_server_address": fmt.Sprintf("unix://%v/reproxy_%v.sock", tmpDir, rand.Intn(1000))}
}
func startRBE(ctx Context, config Config) {
ctx.BeginTrace(metrics.RunSetupTool, "rbe_bootstrap")
defer ctx.EndTrace()
if u := ulimitOrFatal(ctx, config, "-u"); u < rbeLeastNProcs {
ctx.Fatalf("max user processes is insufficient: %d; want >= %d.\n", u, rbeLeastNProcs)
}
if n := ulimitOrFatal(ctx, config, "-n"); n < rbeLeastNFiles {
ctx.Fatalf("max open files is insufficient: %d; want >= %d.\n", n, rbeLeastNFiles)
}
cmd := Command(ctx, config, "startRBE bootstrap", rbeCommand(ctx, config, bootstrapCmd))
if output, err := cmd.CombinedOutput(); err != nil {
ctx.Fatalf("rbe bootstrap failed with: %v\n%s\n", err, output)
}
}
func stopRBE(ctx Context, config Config) {
cmd := Command(ctx, config, "stopRBE bootstrap", rbeCommand(ctx, config, bootstrapCmd), "-shutdown")
if output, err := cmd.CombinedOutput(); err != nil {
ctx.Fatalf("rbe bootstrap with shutdown failed with: %v\n%s\n", err, output)
}
}
// DumpRBEMetrics creates a metrics protobuf file containing RBE related metrics.
// The protobuf file is created if RBE is enabled and the proxy service has
// started. The proxy service is shutdown in order to dump the RBE metrics to the
// protobuf file.
func DumpRBEMetrics(ctx Context, config Config, filename string) {
ctx.BeginTrace(metrics.RunShutdownTool, "dump_rbe_metrics")
defer ctx.EndTrace()
// Remove the previous metrics file in case there is a failure or RBE has been
// disable for this run.
os.Remove(filename)
// If RBE is not enabled then there are no metrics to generate.
// If RBE does not require to start, the RBE proxy maybe started
// manually for debugging purpose and can generate the metrics
// afterwards.
if !config.StartRBE() {
return
}
outputDir := config.RBEStatsOutputDir()
if outputDir == "" {
ctx.Fatal("RBE output dir variable not defined. Aborting metrics dumping.")
}
metricsFile := filepath.Join(outputDir, rbeMetricsPBFilename)
// Stop the proxy first in order to generate the RBE metrics protobuf file.
stopRBE(ctx, config)
if _, err := copyFile(metricsFile, filename); err != nil {
ctx.Fatalf("failed to copy %q to %q: %v\n", metricsFile, filename, err)
}
}