blob: 02ae5ca20bcd269d95538d5aa666943a383bc909 [file] [log] [blame]
Liz Kammer620dea62021-04-14 17:36:10 -04001// Copyright 2015 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 android
16
17import (
Liz Kammer620dea62021-04-14 17:36:10 -040018 "fmt"
19 "path/filepath"
20 "strings"
21
Chris Parsons953b3562021-09-20 15:14:39 -040022 "android/soong/bazel"
23
Liz Kammer620dea62021-04-14 17:36:10 -040024 "github.com/google/blueprint"
25 "github.com/google/blueprint/pathtools"
26)
27
28// bazel_paths contains methods to:
29// * resolve Soong path and module references into bazel.LabelList
30// * resolve Bazel path references into Soong-compatible paths
31//
32// There is often a similar method for Bazel as there is for Soong path handling and should be used
33// in similar circumstances
34//
Usta Shresthadb46a9b2022-07-11 11:29:56 -040035// Bazel Soong
36// ==============================================================
37// BazelLabelForModuleSrc PathForModuleSrc
38// BazelLabelForModuleSrcExcludes PathForModuleSrcExcludes
39// BazelLabelForModuleDeps n/a
40// tbd PathForSource
41// tbd ExistentPathsForSources
42// PathForBazelOut PathForModuleOut
Liz Kammer620dea62021-04-14 17:36:10 -040043//
44// Use cases:
45// * Module contains a property (often tagged `android:"path"`) that expects paths *relative to the
46// module directory*:
47// * BazelLabelForModuleSrcExcludes, if the module also contains an excludes_<propname> property
48// * BazelLabelForModuleSrc, otherwise
49// * Converting references to other modules to Bazel Labels:
50// BazelLabelForModuleDeps
51// * Converting a path obtained from bazel_handler cquery results:
52// PathForBazelOut
53//
54// NOTE: all Soong globs are expanded within Soong rather than being converted to a Bazel glob
55// syntax. This occurs because Soong does not have a concept of crossing package boundaries,
56// so the glob as computed by Soong may contain paths that cross package-boundaries. These
57// would be unknowingly omitted if the glob were handled by Bazel. By expanding globs within
58// Soong, we support identification and detection (within Bazel) use of paths that cross
59// package boundaries.
60//
61// Path resolution:
62// * filepath/globs: resolves as itself or is converted to an absolute Bazel label (e.g.
63// //path/to/dir:<filepath>) if path exists in a separate package or subpackage.
64// * references to other modules (using the ":name{.tag}" syntax). These resolve as a Bazel label
65// for a target. If the Bazel target is in the local module directory, it will be returned
66// relative to the current package (e.g. ":<target>"). Otherwise, it will be returned as an
67// absolute Bazel label (e.g. "//path/to/dir:<target>"). If the reference to another module
68// cannot be resolved,the function will panic. This is often due to the dependency not being added
69// via an AddDependency* method.
70
Usta Shresthadb46a9b2022-07-11 11:29:56 -040071// BazelConversionContext is a minimal context interface to check if a module should be converted by bp2build,
Jingwen Chen55bc8202021-11-02 06:40:51 +000072// with functions containing information to match against allowlists and denylists.
73// If a module is deemed to be convertible by bp2build, then it should rely on a
74// BazelConversionPathContext for more functions for dep/path features.
75type BazelConversionContext interface {
76 Config() Config
Liz Kammer620dea62021-04-14 17:36:10 -040077
Liz Kammer620dea62021-04-14 17:36:10 -040078 Module() Module
Liz Kammer6eff3232021-08-26 08:37:59 -040079 OtherModuleType(m blueprint.Module) string
Liz Kammer620dea62021-04-14 17:36:10 -040080 OtherModuleName(m blueprint.Module) string
81 OtherModuleDir(m blueprint.Module) string
Sam Delmerico24c56032022-03-28 19:53:03 +000082 ModuleErrorf(format string, args ...interface{})
Jingwen Chen55bc8202021-11-02 06:40:51 +000083}
84
85// A subset of the ModuleContext methods which are sufficient to resolve references to paths/deps in
86// order to form a Bazel-compatible label for conversion.
87type BazelConversionPathContext interface {
88 EarlyModulePathContext
89 BazelConversionContext
90
Liz Kammerc86e0942023-08-11 16:15:12 -040091 ModuleName() string
92 ModuleType() string
Jingwen Chen55bc8202021-11-02 06:40:51 +000093 ModuleErrorf(fmt string, args ...interface{})
94 PropertyErrorf(property, fmt string, args ...interface{})
95 GetDirectDep(name string) (blueprint.Module, blueprint.DependencyTag)
96 ModuleFromName(name string) (blueprint.Module, bool)
Liz Kammer6eff3232021-08-26 08:37:59 -040097 AddUnconvertedBp2buildDep(string)
Liz Kammerdaa09ef2021-12-15 15:35:38 -050098 AddMissingBp2buildDep(dep string)
Liz Kammer620dea62021-04-14 17:36:10 -040099}
100
101// BazelLabelForModuleDeps expects a list of reference to other modules, ("<module>"
102// or ":<module>") and returns a Bazel-compatible label which corresponds to dependencies on the
103// module within the given ctx.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000104func BazelLabelForModuleDeps(ctx BazelConversionPathContext, modules []string) bazel.LabelList {
Chris Parsons953b3562021-09-20 15:14:39 -0400105 return BazelLabelForModuleDepsWithFn(ctx, modules, BazelModuleLabel)
Liz Kammer2d7bbe32021-06-10 18:20:06 -0400106}
107
108// BazelLabelForModuleWholeDepsExcludes expects two lists: modules (containing modules to include in
109// the list), and excludes (modules to exclude from the list). Both of these should contain
110// references to other modules, ("<module>" or ":<module>"). It returns a Bazel-compatible label
111// list which corresponds to dependencies on the module within the given ctx, and the excluded
112// dependencies. Prebuilt dependencies will be appended with _alwayslink so they can be handled as
113// whole static libraries.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000114func BazelLabelForModuleDepsExcludes(ctx BazelConversionPathContext, modules, excludes []string) bazel.LabelList {
Chris Parsons953b3562021-09-20 15:14:39 -0400115 return BazelLabelForModuleDepsExcludesWithFn(ctx, modules, excludes, BazelModuleLabel)
Liz Kammer2d7bbe32021-06-10 18:20:06 -0400116}
117
Chris Parsons953b3562021-09-20 15:14:39 -0400118// BazelLabelForModuleDepsWithFn expects a list of reference to other modules, ("<module>"
119// or ":<module>") and applies moduleToLabelFn to determine and return a Bazel-compatible label
120// which corresponds to dependencies on the module within the given ctx.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000121func BazelLabelForModuleDepsWithFn(ctx BazelConversionPathContext, modules []string,
122 moduleToLabelFn func(BazelConversionPathContext, blueprint.Module) string) bazel.LabelList {
Liz Kammer620dea62021-04-14 17:36:10 -0400123 var labels bazel.LabelList
Chris Parsons51f8c392021-08-03 21:01:05 -0400124 // In some cases, a nil string list is different than an explicitly empty list.
125 if len(modules) == 0 && modules != nil {
126 labels.Includes = []bazel.Label{}
127 return labels
128 }
Cole Faust5c84c622023-08-01 11:07:02 -0700129 modules = FirstUniqueStrings(modules)
Liz Kammer620dea62021-04-14 17:36:10 -0400130 for _, module := range modules {
131 bpText := module
132 if m := SrcIsModule(module); m == "" {
133 module = ":" + module
134 }
135 if m, t := SrcIsModuleWithTag(module); m != "" {
Chris Parsons953b3562021-09-20 15:14:39 -0400136 l := getOtherModuleLabel(ctx, m, t, moduleToLabelFn)
Liz Kammerdaa09ef2021-12-15 15:35:38 -0500137 if l != nil {
138 l.OriginalModuleName = bpText
139 labels.Includes = append(labels.Includes, *l)
140 }
Liz Kammer620dea62021-04-14 17:36:10 -0400141 } else {
142 ctx.ModuleErrorf("%q, is not a module reference", module)
143 }
144 }
145 return labels
146}
147
Chris Parsons953b3562021-09-20 15:14:39 -0400148// BazelLabelForModuleDepsExcludesWithFn expects two lists: modules (containing modules to include in the
149// list), and excludes (modules to exclude from the list). Both of these should contain references
150// to other modules, ("<module>" or ":<module>"). It applies moduleToLabelFn to determine and return a
151// Bazel-compatible label list which corresponds to dependencies on the module within the given ctx, and
152// the excluded dependencies.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000153func BazelLabelForModuleDepsExcludesWithFn(ctx BazelConversionPathContext, modules, excludes []string,
154 moduleToLabelFn func(BazelConversionPathContext, blueprint.Module) string) bazel.LabelList {
Chris Parsons953b3562021-09-20 15:14:39 -0400155 moduleLabels := BazelLabelForModuleDepsWithFn(ctx, RemoveListFromList(modules, excludes), moduleToLabelFn)
Liz Kammer47535c52021-06-02 16:02:22 -0400156 if len(excludes) == 0 {
157 return moduleLabels
158 }
Chris Parsons953b3562021-09-20 15:14:39 -0400159 excludeLabels := BazelLabelForModuleDepsWithFn(ctx, excludes, moduleToLabelFn)
Liz Kammer47535c52021-06-02 16:02:22 -0400160 return bazel.LabelList{
161 Includes: moduleLabels.Includes,
162 Excludes: excludeLabels.Includes,
163 }
164}
165
Jingwen Chen55bc8202021-11-02 06:40:51 +0000166func BazelLabelForModuleSrcSingle(ctx BazelConversionPathContext, path string) bazel.Label {
Liz Kammerdaa09ef2021-12-15 15:35:38 -0500167 if srcs := BazelLabelForModuleSrcExcludes(ctx, []string{path}, []string(nil)).Includes; len(srcs) > 0 {
168 return srcs[0]
169 }
170 return bazel.Label{}
Lukacs T. Berki1353e592021-04-30 15:35:09 +0200171}
172
Jingwen Chen55bc8202021-11-02 06:40:51 +0000173func BazelLabelForModuleDepSingle(ctx BazelConversionPathContext, path string) bazel.Label {
Liz Kammerdaa09ef2021-12-15 15:35:38 -0500174 if srcs := BazelLabelForModuleDepsExcludes(ctx, []string{path}, []string(nil)).Includes; len(srcs) > 0 {
175 return srcs[0]
176 }
177 return bazel.Label{}
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -0400178}
179
Liz Kammer620dea62021-04-14 17:36:10 -0400180// BazelLabelForModuleSrc expects a list of path (relative to local module directory) and module
181// references (":<module>") and returns a bazel.LabelList{} containing the resolved references in
182// paths, relative to the local module, or Bazel-labels (absolute if in a different package or
183// relative if within the same package).
184// Properties must have been annotated with struct tag `android:"path"` so that dependencies modules
Spandan Das950091c2023-07-19 22:26:37 +0000185// will have already been handled by the pathdeps mutator.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000186func BazelLabelForModuleSrc(ctx BazelConversionPathContext, paths []string) bazel.LabelList {
Liz Kammer620dea62021-04-14 17:36:10 -0400187 return BazelLabelForModuleSrcExcludes(ctx, paths, []string(nil))
188}
189
190// BazelLabelForModuleSrc expects lists of path and excludes (relative to local module directory)
191// and module references (":<module>") and returns a bazel.LabelList{} containing the resolved
192// references in paths, minus those in excludes, relative to the local module, or Bazel-labels
193// (absolute if in a different package or relative if within the same package).
194// Properties must have been annotated with struct tag `android:"path"` so that dependencies modules
Spandan Das950091c2023-07-19 22:26:37 +0000195// will have already been handled by the pathdeps mutator.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000196func BazelLabelForModuleSrcExcludes(ctx BazelConversionPathContext, paths, excludes []string) bazel.LabelList {
Liz Kammer620dea62021-04-14 17:36:10 -0400197 excludeLabels := expandSrcsForBazel(ctx, excludes, []string(nil))
198 excluded := make([]string, 0, len(excludeLabels.Includes))
199 for _, e := range excludeLabels.Includes {
200 excluded = append(excluded, e.Label)
201 }
202 labels := expandSrcsForBazel(ctx, paths, excluded)
203 labels.Excludes = excludeLabels.Includes
Spandan Das0a8a2752023-06-21 01:50:33 +0000204 labels = TransformSubpackagePaths(ctx.Config(), ctx.ModuleDir(), labels)
Liz Kammer620dea62021-04-14 17:36:10 -0400205 return labels
206}
207
Jingwen Chen0eeaeb82022-09-21 10:27:42 +0000208// Returns true if a prefix + components[:i] is a package boundary.
209//
210// A package boundary is determined by a BUILD file in the directory. This can happen in 2 cases:
211//
Usta Shresthad5580312022-09-23 16:46:38 -0400212// 1. An Android.bp exists, which bp2build will always convert to a sibling BUILD file.
213// 2. An Android.bp doesn't exist, but a checked-in BUILD/BUILD.bazel file exists, and that file
214// is allowlisted by the bp2build configuration to be merged into the symlink forest workspace.
Jingwen Chen0eeaeb82022-09-21 10:27:42 +0000215func isPackageBoundary(config Config, prefix string, components []string, componentIndex int) bool {
216 prefix = filepath.Join(prefix, filepath.Join(components[:componentIndex+1]...))
217 if exists, _, _ := config.fs.Exists(filepath.Join(prefix, "Android.bp")); exists {
Liz Kammer620dea62021-04-14 17:36:10 -0400218 return true
Jingwen Chen0eeaeb82022-09-21 10:27:42 +0000219 } else if config.Bp2buildPackageConfig.ShouldKeepExistingBuildFileForDir(prefix) {
220 if exists, _, _ := config.fs.Exists(filepath.Join(prefix, "BUILD")); exists {
221 return true
222 } else if exists, _, _ := config.fs.Exists(filepath.Join(prefix, "BUILD.bazel")); exists {
223 return true
224 }
Liz Kammer620dea62021-04-14 17:36:10 -0400225 }
Jingwen Chen0eeaeb82022-09-21 10:27:42 +0000226
227 return false
Liz Kammer620dea62021-04-14 17:36:10 -0400228}
229
230// Transform a path (if necessary) to acknowledge package boundaries
231//
232// e.g. something like
Colin Crossd079e0b2022-08-16 10:27:33 -0700233//
234// async_safe/include/async_safe/CHECK.h
235//
Liz Kammer620dea62021-04-14 17:36:10 -0400236// might become
Colin Crossd079e0b2022-08-16 10:27:33 -0700237//
238// //bionic/libc/async_safe:include/async_safe/CHECK.h
239//
Liz Kammer620dea62021-04-14 17:36:10 -0400240// if the "async_safe" directory is actually a package and not just a directory.
241//
242// In particular, paths that extend into packages are transformed into absolute labels beginning with //.
Spandan Das0a8a2752023-06-21 01:50:33 +0000243func transformSubpackagePath(cfg Config, dir string, path bazel.Label) bazel.Label {
Liz Kammer620dea62021-04-14 17:36:10 -0400244 var newPath bazel.Label
245
Jingwen Chen38e62642021-04-19 05:00:15 +0000246 // Don't transform OriginalModuleName
247 newPath.OriginalModuleName = path.OriginalModuleName
Liz Kammer1e753242023-06-02 19:03:06 -0400248 // if it wasn't a module, store the original path. We may need the original path to replace
249 // references if it is actually in another package
250 if path.OriginalModuleName == "" {
251 newPath.OriginalModuleName = path.Label
252 }
Liz Kammer620dea62021-04-14 17:36:10 -0400253
254 if strings.HasPrefix(path.Label, "//") {
255 // Assume absolute labels are already correct (e.g. //path/to/some/package:foo.h)
256 newPath.Label = path.Label
257 return newPath
258 }
Usta Shresthad5580312022-09-23 16:46:38 -0400259 if strings.HasPrefix(path.Label, "./") {
260 // Drop "./" for consistent handling of paths.
261 // Specifically, to not let "." be considered a package boundary.
262 // Say `inputPath` is `x/Android.bp` and that file has some module
263 // with `srcs=["y/a.c", "z/b.c"]`.
264 // And say the directory tree is:
265 // x
266 // ├── Android.bp
267 // ├── y
268 // │ ├── a.c
269 // │ └── Android.bp
270 // └── z
271 // └── b.c
272 // Then bazel equivalent labels in srcs should be:
273 // //x/y:a.c, x/z/b.c
274 // The above should still be the case if `x/Android.bp` had
275 // srcs=["./y/a.c", "./z/b.c"]
276 // However, if we didn't strip "./", we'd get
277 // //x/./y:a.c, //x/.:z/b.c
278 path.Label = strings.TrimPrefix(path.Label, "./")
279 }
Liz Kammer620dea62021-04-14 17:36:10 -0400280 pathComponents := strings.Split(path.Label, "/")
Usta Shresthad5580312022-09-23 16:46:38 -0400281 newLabel := ""
Jingwen Chen0eeaeb82022-09-21 10:27:42 +0000282 foundPackageBoundary := false
Liz Kammer620dea62021-04-14 17:36:10 -0400283 // Check the deepest subdirectory first and work upwards
284 for i := len(pathComponents) - 1; i >= 0; i-- {
285 pathComponent := pathComponents[i]
286 var sep string
Spandan Das0a8a2752023-06-21 01:50:33 +0000287 if !foundPackageBoundary && isPackageBoundary(cfg, dir, pathComponents, i) {
Liz Kammer620dea62021-04-14 17:36:10 -0400288 sep = ":"
Jingwen Chen0eeaeb82022-09-21 10:27:42 +0000289 foundPackageBoundary = true
Liz Kammer620dea62021-04-14 17:36:10 -0400290 } else {
291 sep = "/"
292 }
293 if newLabel == "" {
294 newLabel = pathComponent
295 } else {
296 newLabel = pathComponent + sep + newLabel
297 }
298 }
Jingwen Chen0eeaeb82022-09-21 10:27:42 +0000299 if foundPackageBoundary {
Liz Kammer620dea62021-04-14 17:36:10 -0400300 // Ensure paths end up looking like //bionic/... instead of //./bionic/...
Spandan Das0a8a2752023-06-21 01:50:33 +0000301 moduleDir := dir
Liz Kammer620dea62021-04-14 17:36:10 -0400302 if strings.HasPrefix(moduleDir, ".") {
303 moduleDir = moduleDir[1:]
304 }
305 // Make the path into an absolute label (e.g. //bionic/libc/foo:bar.h instead of just foo:bar.h)
306 if moduleDir == "" {
307 newLabel = "//" + newLabel
308 } else {
309 newLabel = "//" + moduleDir + "/" + newLabel
310 }
311 }
312 newPath.Label = newLabel
313
314 return newPath
315}
316
317// Transform paths to acknowledge package boundaries
318// See transformSubpackagePath() for more information
Spandan Das0a8a2752023-06-21 01:50:33 +0000319func TransformSubpackagePaths(cfg Config, dir string, paths bazel.LabelList) bazel.LabelList {
Liz Kammer620dea62021-04-14 17:36:10 -0400320 var newPaths bazel.LabelList
321 for _, include := range paths.Includes {
Spandan Das0a8a2752023-06-21 01:50:33 +0000322 newPaths.Includes = append(newPaths.Includes, transformSubpackagePath(cfg, dir, include))
Liz Kammer620dea62021-04-14 17:36:10 -0400323 }
324 for _, exclude := range paths.Excludes {
Spandan Das0a8a2752023-06-21 01:50:33 +0000325 newPaths.Excludes = append(newPaths.Excludes, transformSubpackagePath(cfg, dir, exclude))
Liz Kammer620dea62021-04-14 17:36:10 -0400326 }
327 return newPaths
328}
329
Romain Jobredeaux1282c422021-10-29 10:52:59 -0400330// Converts root-relative Paths to a list of bazel.Label relative to the module in ctx.
331func RootToModuleRelativePaths(ctx BazelConversionPathContext, paths Paths) []bazel.Label {
332 var newPaths []bazel.Label
333 for _, path := range PathsWithModuleSrcSubDir(ctx, paths, "") {
334 s := path.Rel()
335 newPaths = append(newPaths, bazel.Label{Label: s})
336 }
337 return newPaths
338}
339
Liz Kammer620dea62021-04-14 17:36:10 -0400340// expandSrcsForBazel returns bazel.LabelList with paths rooted from the module's local source
341// directory and Bazel target labels, excluding those included in the excludes argument (which
342// should already be expanded to resolve references to Soong-modules). Valid elements of paths
343// include:
Colin Crossd079e0b2022-08-16 10:27:33 -0700344// - filepath, relative to local module directory, resolves as a filepath relative to the local
345// source directory
346// - glob, relative to the local module directory, resolves as filepath(s), relative to the local
347// module directory. Because Soong does not have a concept of crossing package boundaries, the
348// glob as computed by Soong may contain paths that cross package-boundaries that would be
349// unknowingly omitted if the glob were handled by Bazel. To allow identification and detect
350// (within Bazel) use of paths that cross package boundaries, we expand globs within Soong rather
351// than converting Soong glob syntax to Bazel glob syntax. **Invalid for excludes.**
352// - other modules using the ":name{.tag}" syntax. These modules must implement SourceFileProducer
353// or OutputFileProducer. These resolve as a Bazel label for a target. If the Bazel target is in
354// the local module directory, it will be returned relative to the current package (e.g.
355// ":<target>"). Otherwise, it will be returned as an absolute Bazel label (e.g.
356// "//path/to/dir:<target>"). If the reference to another module cannot be resolved,the function
357// will panic.
358//
Liz Kammer620dea62021-04-14 17:36:10 -0400359// Properties passed as the paths or excludes argument must have been annotated with struct tag
360// `android:"path"` so that dependencies on other modules will have already been handled by the
Spandan Das950091c2023-07-19 22:26:37 +0000361// pathdeps mutator.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000362func expandSrcsForBazel(ctx BazelConversionPathContext, paths, expandedExcludes []string) bazel.LabelList {
Liz Kammer620dea62021-04-14 17:36:10 -0400363 if paths == nil {
364 return bazel.LabelList{}
365 }
366 labels := bazel.LabelList{
367 Includes: []bazel.Label{},
368 }
Jingwen Chen4ecc67d2021-04-27 09:47:02 +0000369
370 // expandedExcludes contain module-dir relative paths, but root-relative paths
371 // are needed for GlobFiles later.
372 var rootRelativeExpandedExcludes []string
373 for _, e := range expandedExcludes {
374 rootRelativeExpandedExcludes = append(rootRelativeExpandedExcludes, filepath.Join(ctx.ModuleDir(), e))
375 }
376
Liz Kammer620dea62021-04-14 17:36:10 -0400377 for _, p := range paths {
378 if m, tag := SrcIsModuleWithTag(p); m != "" {
Chris Parsons953b3562021-09-20 15:14:39 -0400379 l := getOtherModuleLabel(ctx, m, tag, BazelModuleLabel)
Liz Kammerdaa09ef2021-12-15 15:35:38 -0500380 if l != nil && !InList(l.Label, expandedExcludes) {
Spandan Dasf62e80a2023-08-17 22:35:04 +0000381 if strings.HasPrefix(m, "//") {
382 // this is a module in a soong namespace
383 // It appears as //<namespace>:<module_name> in srcs, and not ://<namespace>:<module_name>
384 l.OriginalModuleName = m
385 } else {
386 l.OriginalModuleName = fmt.Sprintf(":%s", m)
387 }
Liz Kammerdaa09ef2021-12-15 15:35:38 -0500388 labels.Includes = append(labels.Includes, *l)
Liz Kammer620dea62021-04-14 17:36:10 -0400389 }
390 } else {
391 var expandedPaths []bazel.Label
392 if pathtools.IsGlob(p) {
Jingwen Chen4ecc67d2021-04-27 09:47:02 +0000393 // e.g. turn "math/*.c" in
394 // external/arm-optimized-routines to external/arm-optimized-routines/math/*.c
395 rootRelativeGlobPath := pathForModuleSrc(ctx, p).String()
Romain Jobredeaux1282c422021-10-29 10:52:59 -0400396 expandedPaths = RootToModuleRelativePaths(ctx, GlobFiles(ctx, rootRelativeGlobPath, rootRelativeExpandedExcludes))
Liz Kammer620dea62021-04-14 17:36:10 -0400397 } else {
398 if !InList(p, expandedExcludes) {
399 expandedPaths = append(expandedPaths, bazel.Label{Label: p})
400 }
401 }
402 labels.Includes = append(labels.Includes, expandedPaths...)
403 }
404 }
405 return labels
406}
407
408// getOtherModuleLabel returns a bazel.Label for the given dependency/tag combination for the
409// module. The label will be relative to the current directory if appropriate. The dependency must
410// already be resolved by either deps mutator or path deps mutator.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000411func getOtherModuleLabel(ctx BazelConversionPathContext, dep, tag string,
Liz Kammerdaa09ef2021-12-15 15:35:38 -0500412 labelFromModule func(BazelConversionPathContext, blueprint.Module) string) *bazel.Label {
Chris Parsons5a34ffb2021-07-21 14:34:58 -0400413 m, _ := ctx.ModuleFromName(dep)
Liz Kammerdaa09ef2021-12-15 15:35:38 -0500414 // The module was not found in an Android.bp file, this is often due to:
415 // * a limited manifest
416 // * a required module not being converted from Android.mk
Liz Kammer620dea62021-04-14 17:36:10 -0400417 if m == nil {
Liz Kammerdaa09ef2021-12-15 15:35:38 -0500418 ctx.AddMissingBp2buildDep(dep)
419 return &bazel.Label{
420 Label: ":" + dep + "__BP2BUILD__MISSING__DEP",
421 }
Liz Kammer620dea62021-04-14 17:36:10 -0400422 }
Liz Kammer6eff3232021-08-26 08:37:59 -0400423 if !convertedToBazel(ctx, m) {
424 ctx.AddUnconvertedBp2buildDep(dep)
425 }
Chris Parsons953b3562021-09-20 15:14:39 -0400426 label := BazelModuleLabel(ctx, ctx.Module())
427 otherLabel := labelFromModule(ctx, m)
428
429 // TODO(b/165114590): Convert tag (":name{.tag}") to corresponding Bazel implicit output targets.
430
Liz Kammer620dea62021-04-14 17:36:10 -0400431 if samePackage(label, otherLabel) {
432 otherLabel = bazelShortLabel(otherLabel)
433 }
434
Liz Kammerdaa09ef2021-12-15 15:35:38 -0500435 return &bazel.Label{
Liz Kammer620dea62021-04-14 17:36:10 -0400436 Label: otherLabel,
437 }
438}
439
Jingwen Chen55bc8202021-11-02 06:40:51 +0000440func BazelModuleLabel(ctx BazelConversionPathContext, module blueprint.Module) string {
Liz Kammer620dea62021-04-14 17:36:10 -0400441 // TODO(b/165114590): Convert tag (":name{.tag}") to corresponding Bazel implicit output targets.
Spandan Das64852422023-08-02 21:58:41 +0000442 if !convertedToBazel(ctx, module) || isGoModule(module) {
Liz Kammer620dea62021-04-14 17:36:10 -0400443 return bp2buildModuleLabel(ctx, module)
444 }
Liz Kammer6eff3232021-08-26 08:37:59 -0400445 b, _ := module.(Bazelable)
Liz Kammer620dea62021-04-14 17:36:10 -0400446 return b.GetBazelLabel(ctx, module)
447}
448
449func bazelShortLabel(label string) string {
450 i := strings.Index(label, ":")
Jingwen Chen80b6b642021-11-02 06:23:07 +0000451 if i == -1 {
452 panic(fmt.Errorf("Could not find the ':' character in '%s', expected a fully qualified label.", label))
453 }
Liz Kammer620dea62021-04-14 17:36:10 -0400454 return label[i:]
455}
456
457func bazelPackage(label string) string {
458 i := strings.Index(label, ":")
Jingwen Chen80b6b642021-11-02 06:23:07 +0000459 if i == -1 {
460 panic(fmt.Errorf("Could not find the ':' character in '%s', expected a fully qualified label.", label))
461 }
Liz Kammer620dea62021-04-14 17:36:10 -0400462 return label[0:i]
463}
464
465func samePackage(label1, label2 string) bool {
466 return bazelPackage(label1) == bazelPackage(label2)
467}
468
Jingwen Chen55bc8202021-11-02 06:40:51 +0000469func bp2buildModuleLabel(ctx BazelConversionContext, module blueprint.Module) string {
Liz Kammerc86e0942023-08-11 16:15:12 -0400470 moduleName := moduleNameWithPossibleOverride(ctx, module, ctx.OtherModuleName(module))
471 moduleDir := moduleDirWithPossibleOverride(ctx, module, ctx.OtherModuleDir(module))
Jingwen Chen889f2f22022-12-16 08:16:01 +0000472 if moduleDir == Bp2BuildTopLevel {
473 moduleDir = ""
474 }
Liz Kammer620dea62021-04-14 17:36:10 -0400475 return fmt.Sprintf("//%s:%s", moduleDir, moduleName)
476}
477
478// BazelOutPath is a Bazel output path compatible to be used for mixed builds within Soong/Ninja.
479type BazelOutPath struct {
480 OutputPath
481}
482
Liz Kammer0f3b7d22021-09-28 13:48:21 -0400483// ensure BazelOutPath implements Path
Liz Kammer620dea62021-04-14 17:36:10 -0400484var _ Path = BazelOutPath{}
Liz Kammer0f3b7d22021-09-28 13:48:21 -0400485
486// ensure BazelOutPath implements genPathProvider
487var _ genPathProvider = BazelOutPath{}
488
489// ensure BazelOutPath implements objPathProvider
Liz Kammer620dea62021-04-14 17:36:10 -0400490var _ objPathProvider = BazelOutPath{}
491
Liz Kammer0f3b7d22021-09-28 13:48:21 -0400492func (p BazelOutPath) genPathWithExt(ctx ModuleOutPathContext, subdir, ext string) ModuleGenPath {
493 return PathForModuleGen(ctx, subdir, pathtools.ReplaceExtension(p.path, ext))
494}
495
Liz Kammer620dea62021-04-14 17:36:10 -0400496func (p BazelOutPath) objPathWithExt(ctx ModuleOutPathContext, subdir, ext string) ModuleObjPath {
497 return PathForModuleObj(ctx, subdir, pathtools.ReplaceExtension(p.path, ext))
498}
499
Cole Faust9a06d252022-06-03 16:00:11 -0700500// PathForBazelOutRelative returns a BazelOutPath representing the path under an output directory dedicated to
501// bazel-owned outputs. Calling .Rel() on the result will give the input path as relative to the given
502// relativeRoot.
503func PathForBazelOutRelative(ctx PathContext, relativeRoot string, path string) BazelOutPath {
504 validatedPath, err := validatePath(filepath.Join("execroot", "__main__", path))
Liz Kammer620dea62021-04-14 17:36:10 -0400505 if err != nil {
506 reportPathError(ctx, err)
507 }
Cole Faust0abd4b42023-01-10 10:49:18 -0800508 var relativeRootPath string
509 if pathComponents := strings.SplitN(path, "/", 4); len(pathComponents) >= 3 &&
Cole Faust9a06d252022-06-03 16:00:11 -0700510 pathComponents[0] == "bazel-out" && pathComponents[2] == "bin" {
511 // If the path starts with something like: bazel-out/linux_x86_64-fastbuild-ST-b4ef1c4402f9/bin/
512 // make it relative to that folder. bazel-out/volatile-status.txt is an example
513 // of something that starts with bazel-out but is not relative to the bin folder
514 relativeRootPath = filepath.Join("execroot", "__main__", pathComponents[0], pathComponents[1], pathComponents[2], relativeRoot)
Cole Faust0abd4b42023-01-10 10:49:18 -0800515 } else {
516 relativeRootPath = filepath.Join("execroot", "__main__", relativeRoot)
Cole Faust9a06d252022-06-03 16:00:11 -0700517 }
Liz Kammer620dea62021-04-14 17:36:10 -0400518
Cole Faust9a06d252022-06-03 16:00:11 -0700519 var relPath string
520 if relPath, err = filepath.Rel(relativeRootPath, validatedPath); err != nil || strings.HasPrefix(relPath, "../") {
521 // We failed to make this path relative to execroot/__main__, fall back to a non-relative path
522 // One case where this happens is when path is ../bazel_tools/something
523 relativeRootPath = ""
524 relPath = validatedPath
525 }
526
527 outputPath := OutputPath{
528 basePath{"", ""},
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200529 ctx.Config().soongOutDir,
Cole Faust9a06d252022-06-03 16:00:11 -0700530 ctx.Config().BazelContext.OutputBase(),
531 }
Liz Kammer620dea62021-04-14 17:36:10 -0400532
533 return BazelOutPath{
Cole Faust9a06d252022-06-03 16:00:11 -0700534 // .withRel() appends its argument onto the current path, and only the most
535 // recently appended part is returned by outputPath.rel().
536 // So outputPath.rel() will return relPath.
537 OutputPath: outputPath.withRel(relativeRootPath).withRel(relPath),
Liz Kammer620dea62021-04-14 17:36:10 -0400538 }
539}
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400540
Cole Faust9a06d252022-06-03 16:00:11 -0700541// PathForBazelOut returns a BazelOutPath representing the path under an output directory dedicated to
542// bazel-owned outputs.
543func PathForBazelOut(ctx PathContext, path string) BazelOutPath {
544 return PathForBazelOutRelative(ctx, "", path)
545}
546
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400547// PathsForBazelOut returns a list of paths representing the paths under an output directory
548// dedicated to Bazel-owned outputs.
549func PathsForBazelOut(ctx PathContext, paths []string) Paths {
550 outs := make(Paths, 0, len(paths))
551 for _, p := range paths {
552 outs = append(outs, PathForBazelOut(ctx, p))
553 }
554 return outs
555}
Jingwen Chen6817bbb2022-10-14 09:56:07 +0000556
557// BazelStringOrLabelFromProp splits a Soong module property that can be
558// either a string literal, path (with android:path tag) or a module reference
559// into separate bazel string or label attributes. Bazel treats string and label
560// attributes as distinct types, so this function categorizes a string property
561// into either one of them.
562//
563// e.g. apex.private_key = "foo.pem" can either refer to:
564//
565// 1. "foo.pem" in the current directory -> file target
566// 2. "foo.pem" module -> rule target
567// 3. "foo.pem" file in a different directory, prefixed by a product variable handled
568// in a bazel macro. -> string literal
569//
570// For the first two cases, they are defined using the label attribute. For the third case,
571// it's defined with the string attribute.
572func BazelStringOrLabelFromProp(
573 ctx TopDownMutatorContext,
574 propToDistinguish *string) (bazel.LabelAttribute, bazel.StringAttribute) {
575
576 var labelAttr bazel.LabelAttribute
577 var strAttr bazel.StringAttribute
578
579 if propToDistinguish == nil {
580 // nil pointer
581 return labelAttr, strAttr
582 }
583
584 prop := String(propToDistinguish)
585 if SrcIsModule(prop) != "" {
586 // If it's a module (SrcIsModule will return the module name), set the
587 // resolved label to the label attribute.
588 labelAttr.SetValue(BazelLabelForModuleDepSingle(ctx, prop))
589 } else {
590 // Not a module name. This could be a string literal or a file target in
591 // the current dir. Check if the path exists:
592 path := ExistentPathForSource(ctx, ctx.ModuleDir(), prop)
593
594 if path.Valid() && parentDir(path.String()) == ctx.ModuleDir() {
595 // If it exists and the path is relative to the current dir, resolve the bazel label
596 // for the _file target_ and set it to the label attribute.
597 //
598 // Resolution is necessary because this could be a file in a subpackage.
599 labelAttr.SetValue(BazelLabelForModuleSrcSingle(ctx, prop))
600 } else {
601 // Otherwise, treat it as a string literal and assign to the string attribute.
602 strAttr.Value = propToDistinguish
603 }
604 }
605
606 return labelAttr, strAttr
607}