paths.go 2.0 KB

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