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 shared 16 17// This file exists to share path-related logic between both soong_ui and soong 18 19import ( 20 "path/filepath" 21 22 "android/soong/bazel" 23) 24 25// A SharedPaths represents a list of paths that are shared between 26// soong_ui and soong. 27type SharedPaths interface { 28 // BazelMetricsDir returns the path where a set of bazel profile 29 // files are stored for later processed by the metrics pipeline. 30 BazelMetricsDir() string 31} 32 33// Joins the path strings in the argument list, taking absolute paths into 34// account. That is, if one of the strings is an absolute path, the ones before 35// are ignored. 36func JoinPath(base string, rest ...string) string { 37 result := base 38 for _, next := range rest { 39 if filepath.IsAbs(next) { 40 result = next 41 } else { 42 result = filepath.Join(result, next) 43 } 44 } 45 return result 46} 47 48// Given the out directory, returns the root of the temp directory (to be cleared at the start of each execution of Soong) 49func TempDirForOutDir(outDir string) (tempPath string) { 50 return filepath.Join(outDir, ".temp") 51} 52 53// BazelMetricsFilename returns the bazel profile filename based 54// on the action name. This is to help to store a set of bazel 55// profiles since bazel may execute multiple times during a single 56// build. 57func BazelMetricsFilename(s SharedPaths, actionName bazel.RunName) string { 58 return filepath.Join(s.BazelMetricsDir(), actionName.String()+"_bazel_profile.gz") 59} 60