Skip to content

Commit 2a28909

Browse files
fmeumcopybara-github
fmeum
authored and
copybara-github
committed
Add RunfilesLibraryInfo
The new provider marks runfiles libraries as such and will be used by both Bazel itself and language rules to emit additional information required for executable targets to find their runfiles in the presence of repository mappings. Work towards #16124 Closes #16125. PiperOrigin-RevId: 470966227 Change-Id: Ie9b4dc69bdd4d8f85485fa04efa347ebbd07b8b5
1 parent a71ebc1 commit 2a28909

File tree

6 files changed

+148
-0
lines changed

6 files changed

+148
-0
lines changed

‎src/main/java/com/google/devtools/build/lib/analysis/BUILD‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,7 @@ java_library(
340340
":rule_configured_object_value",
341341
":rule_definition_environment",
342342
":run_environment_info",
343+
":runfiles_library_info",
343344
":starlark/args",
344345
":starlark/bazel_build_api_globals",
345346
":starlark/function_transition_util",
@@ -1030,6 +1031,16 @@ java_library(
10301031
],
10311032
)
10321033

1034+
java_library(
1035+
name = "runfiles_library_info",
1036+
srcs = ["RunfilesLibraryInfo.java"],
1037+
deps = [
1038+
"//src/main/java/com/google/devtools/build/lib/concurrent",
1039+
"//src/main/java/com/google/devtools/build/lib/packages",
1040+
"//src/main/java/com/google/devtools/build/lib/starlarkbuildapi",
1041+
],
1042+
)
1043+
10331044
java_library(
10341045
name = "rule_definition_environment",
10351046
srcs = ["RuleDefinitionEnvironment.java"],

‎src/main/java/com/google/devtools/build/lib/analysis/RunfilesLibraryInfo.java‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
// Copyright 2022 The Bazel Authors. 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+
15+
package com.google.devtools.build.lib.analysis;
16+
17+
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
18+
import com.google.devtools.build.lib.packages.BuiltinProvider;
19+
import com.google.devtools.build.lib.packages.NativeInfo;
20+
import com.google.devtools.build.lib.starlarkbuildapi.RunfilesLibraryInfoApi;
21+
22+
/**
23+
* Data-less provider that signals to direct dependents that this target is a runfiles library.
24+
*
25+
* <p>Rules that find this provider advertised by a dependency may use this as a signal to generate
26+
* code that helps with runfiles discovery, e.g., by providing a constant containing the name of the
27+
* repository that defines the rule.
28+
*
29+
* <p>Bazel itself uses the presence of this provider on a rule as a sign that it should include the
30+
* repository mapping of the repository containing the rule in the repository mapping manifest of
31+
* executable transitive dependents.
32+
*/
33+
@Immutable
34+
public final class RunfilesLibraryInfo extends NativeInfo implements RunfilesLibraryInfoApi {
35+
36+
public static final RunfilesLibraryInfoProvider PROVIDER = new RunfilesLibraryInfoProvider();
37+
38+
@Override
39+
public RunfilesLibraryInfoProvider getProvider() {
40+
return PROVIDER;
41+
}
42+
43+
/** Provider for {@link RunfilesLibraryInfo}. */
44+
public static class RunfilesLibraryInfoProvider extends BuiltinProvider<RunfilesLibraryInfo>
45+
implements RunfilesLibraryInfoApi.RunfilesLibraryInfoApiProvider {
46+
47+
private RunfilesLibraryInfoProvider() {
48+
super("RunfilesLibraryInfo", RunfilesLibraryInfo.class);
49+
}
50+
51+
@Override
52+
public RunfilesLibraryInfoApi constructor() {
53+
return new RunfilesLibraryInfo();
54+
}
55+
}
56+
}

‎src/main/java/com/google/devtools/build/lib/analysis/starlark/StarlarkModules.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import com.google.devtools.build.lib.analysis.DefaultInfo;
2020
import com.google.devtools.build.lib.analysis.OutputGroupInfo;
2121
import com.google.devtools.build.lib.analysis.RunEnvironmentInfo;
22+
import com.google.devtools.build.lib.analysis.RunfilesLibraryInfo;
2223
import com.google.devtools.build.lib.packages.StarlarkLibrary;
2324
import com.google.devtools.build.lib.packages.StructProvider;
2425
import net.starlark.java.eval.Starlark;
@@ -46,5 +47,6 @@ public static void addPredeclared(ImmutableMap.Builder<String, Object> predeclar
4647
predeclared.put("Actions", ActionsProvider.INSTANCE);
4748
predeclared.put("DefaultInfo", DefaultInfo.PROVIDER);
4849
predeclared.put("RunEnvironmentInfo", RunEnvironmentInfo.PROVIDER);
50+
predeclared.put("RunfilesLibraryInfo", RunfilesLibraryInfo.PROVIDER);
4951
}
5052
}

‎src/main/java/com/google/devtools/build/lib/starlarkbuildapi/RunfilesLibraryInfoApi.java‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// Copyright 2022 The Bazel Authors. 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+
15+
package com.google.devtools.build.lib.starlarkbuildapi;
16+
17+
import com.google.devtools.build.docgen.annot.DocCategory;
18+
import com.google.devtools.build.docgen.annot.StarlarkConstructor;
19+
import com.google.devtools.build.lib.starlarkbuildapi.core.ProviderApi;
20+
import com.google.devtools.build.lib.starlarkbuildapi.core.StructApi;
21+
import net.starlark.java.annot.StarlarkBuiltin;
22+
import net.starlark.java.annot.StarlarkMethod;
23+
24+
/** Interface for runfiles library info. */
25+
@StarlarkBuiltin(
26+
name = "RunfilesLibraryInfo",
27+
category = DocCategory.PROVIDER,
28+
doc =
29+
"Signals to direct dependents as well as Bazel itself that this target is a runfiles"
30+
+ " library. For example, rules for compiled languages may choose to generate and"
31+
+ " compile additional code that gives access to the name of the repository defining"
32+
+ " the current target if they find this provider advertised by a direct"
33+
+ " dependency.<p>This provider carries no data.")
34+
public interface RunfilesLibraryInfoApi extends StructApi {
35+
36+
/** Interface for runfiles library info provider. */
37+
@StarlarkBuiltin(name = "Provider", category = DocCategory.PROVIDER, documented = false)
38+
interface RunfilesLibraryInfoApiProvider extends ProviderApi {
39+
40+
@StarlarkMethod(
41+
name = "RunfilesLibraryInfo",
42+
doc = "The <code>RunfilesLibraryInfo</code> constructor.",
43+
selfCall = true)
44+
@StarlarkConstructor
45+
RunfilesLibraryInfoApi constructor();
46+
}
47+
}

‎src/test/java/com/google/devtools/build/lib/starlark/BUILD‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ java_test(
4646
"//src/main/java/com/google/devtools/build/lib/analysis:file_provider",
4747
"//src/main/java/com/google/devtools/build/lib/analysis:resolved_toolchain_context",
4848
"//src/main/java/com/google/devtools/build/lib/analysis:run_environment_info",
49+
"//src/main/java/com/google/devtools/build/lib/analysis:runfiles_library_info",
4950
"//src/main/java/com/google/devtools/build/lib/analysis:starlark/args",
5051
"//src/main/java/com/google/devtools/build/lib/analysis:starlark/starlark_exec_group_collection",
5152
"//src/main/java/com/google/devtools/build/lib/analysis:test/analysis_test_result_info",

‎src/test/java/com/google/devtools/build/lib/starlark/StarlarkIntegrationTest.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import com.google.devtools.build.lib.analysis.FilesToRunProvider;
3131
import com.google.devtools.build.lib.analysis.OutputGroupInfo;
3232
import com.google.devtools.build.lib.analysis.RunEnvironmentInfo;
33+
import com.google.devtools.build.lib.analysis.RunfilesLibraryInfo;
3334
import com.google.devtools.build.lib.analysis.RunfilesProvider;
3435
import com.google.devtools.build.lib.analysis.config.StarlarkDefinedConfigTransition;
3536
import com.google.devtools.build.lib.analysis.configuredtargets.FileConfiguredTarget;
@@ -3652,4 +3653,34 @@ public void nonExecutableStarlarkRuleReturningTestEnvironmentProducesAWarning()
36523653
+ " non-test target has no effect",
36533654
ImmutableSet.of(EventKind.WARNING));
36543655
}
3656+
3657+
@Test
3658+
public void runfilesLibraryInfoCanBeReturnedAndQueried() throws Exception {
3659+
scratch.file(
3660+
"examples/rules.bzl",
3661+
"def my_runfiles_library_impl(ctx):",
3662+
" return [RunfilesLibraryInfo()]",
3663+
"my_runfiles_library = rule(implementation = my_runfiles_library_impl)",
3664+
"def language_rule_impl(ctx):",
3665+
" if RunfilesLibraryInfo not in ctx.attr.dep:",
3666+
" fail('dep does not advertise RunfilesLibraryInfo')",
3667+
"language_rule = rule(",
3668+
" implementation = language_rule_impl,",
3669+
" attrs = {'dep': attr.label()},",
3670+
")");
3671+
scratch.file(
3672+
"examples/BUILD",
3673+
"load(':rules.bzl', 'language_rule', 'my_runfiles_library')",
3674+
"my_runfiles_library(name = 'runfiles_library')",
3675+
"language_rule(",
3676+
" name = 'target',",
3677+
" dep = ':runfiles_library',",
3678+
")");
3679+
3680+
ConfiguredTarget runfilesLibrary = getConfiguredTarget("//examples:runfiles_library");
3681+
assertThat(runfilesLibrary.get(RunfilesLibraryInfo.PROVIDER)).isNotNull();
3682+
3683+
// Succeeds only if targets can be queried for the presence of RunfilesLibraryInfo in Starlark.
3684+
getConfiguredTarget("//examples:target");
3685+
}
36553686
}

0 commit comments

Comments
 (0)