C++: Make linking_context libraries_to_link return depset
Triggered by the flag: --incompatible_depset_for_libraries_to_link_getter
GitHub tracking issue: https://github.com/bazelbuild/bazel/issues/8118
RELNOTES:none
PiperOrigin-RevId: 245747705
diff --git a/src/main/java/com/google/devtools/build/lib/packages/StarlarkSemanticsOptions.java b/src/main/java/com/google/devtools/build/lib/packages/StarlarkSemanticsOptions.java
index 96236cb..8b34979 100644
--- a/src/main/java/com/google/devtools/build/lib/packages/StarlarkSemanticsOptions.java
+++ b/src/main/java/com/google/devtools/build/lib/packages/StarlarkSemanticsOptions.java
@@ -605,6 +605,20 @@
+ "only specifiable positionally (and not by keyword).")
public boolean incompatibleRestrictNamedParams;
+ @Option(
+ name = "incompatible_depset_for_libraries_to_link_getter",
+ defaultValue = "false",
+ documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS,
+ effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS},
+ metadataTags = {
+ OptionMetadataTag.INCOMPATIBLE_CHANGE,
+ OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES
+ },
+ help =
+ "When true, Bazel no longer returns a list from linking_context.libraries_to_link but "
+ + "returns a depset instead.")
+ public boolean incompatibleDepsetForLibrariesToLinkGetter;
+
/** Constructs a {@link StarlarkSemantics} object corresponding to this set of option values. */
public StarlarkSemantics toSkylarkSemantics() {
return StarlarkSemantics.builder()
@@ -654,6 +668,7 @@
.incompatibleStringJoinRequiresStrings(incompatibleStringJoinRequiresStrings)
.internalSkylarkFlagTestCanary(internalSkylarkFlagTestCanary)
.incompatibleDoNotSplitLinkingCmdline(incompatibleDoNotSplitLinkingCmdline)
+ .incompatibleDepsetForLibrariesToLinkGetter(incompatibleDepsetForLibrariesToLinkGetter)
.build();
}
}
diff --git a/src/main/java/com/google/devtools/build/lib/rules/cpp/LibraryToLink.java b/src/main/java/com/google/devtools/build/lib/rules/cpp/LibraryToLink.java
index 73315f1..9b868a8 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/cpp/LibraryToLink.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/cpp/LibraryToLink.java
@@ -31,6 +31,7 @@
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.skylarkbuildapi.cpp.CcLinkingContextApi;
import com.google.devtools.build.lib.skylarkbuildapi.cpp.LibraryToLinkApi;
+import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.SkylarkList;
import com.google.devtools.build.lib.syntax.SkylarkNestedSet;
import com.google.devtools.build.lib.util.Fingerprint;
@@ -61,7 +62,7 @@
}
/** Structure of CcLinkingContext. */
- public static class CcLinkingContext implements CcLinkingContextApi<Artifact, LibraryToLink> {
+ public static class CcLinkingContext implements CcLinkingContextApi<Artifact> {
public static final CcLinkingContext EMPTY = builder().build();
/** A list of link options contributed by a single configured target/aspect. */
@@ -289,8 +290,12 @@
}
@Override
- public SkylarkList<LibraryToLink> getSkylarkLibrariesToLink() {
- return SkylarkList.createImmutable(libraries.toList());
+ public Object getSkylarkLibrariesToLink(Environment environment) {
+ if (environment.getSemantics().incompatibleDepsetForLibrariesToLinkGetter()) {
+ return SkylarkNestedSet.of(LibraryToLink.class, libraries);
+ } else {
+ return SkylarkList.createImmutable(libraries.toList());
+ }
}
@Override
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/BazelCcModuleApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/BazelCcModuleApi.java
index 7df8f2a..dac4d87 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/BazelCcModuleApi.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/BazelCcModuleApi.java
@@ -44,7 +44,7 @@
CompilationOutputsT extends CcCompilationOutputsApi<FileT>,
LinkingOutputsT extends CcLinkingOutputsApi<FileT>,
LibraryToLinkT extends LibraryToLinkApi<FileT>,
- LinkingContextT extends CcLinkingContextApi<FileT, LibraryToLinkT>,
+ LinkingContextT extends CcLinkingContextApi<FileT>,
CcToolchainVariablesT extends CcToolchainVariablesApi,
CcToolchainConfigInfoT extends CcToolchainConfigInfoApi>
extends CcModuleApi<
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/CcBootstrap.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/CcBootstrap.java
index 023de9c..18ebafc 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/CcBootstrap.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/CcBootstrap.java
@@ -34,8 +34,7 @@
? extends CcCompilationOutputsApi<? extends FileApi>,
? extends CcLinkingOutputsApi<? extends FileApi>,
? extends LibraryToLinkApi<? extends FileApi>,
- ? extends
- CcLinkingContextApi<? extends FileApi, ? extends LibraryToLinkApi<? extends FileApi>>,
+ ? extends CcLinkingContextApi<? extends FileApi>,
? extends CcToolchainVariablesApi,
? extends CcToolchainConfigInfoApi>
ccModule;
@@ -51,9 +50,7 @@
? extends CcCompilationOutputsApi<? extends FileApi>,
? extends CcLinkingOutputsApi<? extends FileApi>,
? extends LibraryToLinkApi<? extends FileApi>,
- ? extends
- CcLinkingContextApi<
- ? extends FileApi, ? extends LibraryToLinkApi<? extends FileApi>>,
+ ? extends CcLinkingContextApi<? extends FileApi>,
? extends CcToolchainVariablesApi,
? extends CcToolchainConfigInfoApi>
ccModule) {
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/CcLinkingContextApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/CcLinkingContextApi.java
index 318d327..34671f4 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/CcLinkingContextApi.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/cpp/CcLinkingContextApi.java
@@ -18,6 +18,7 @@
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
+import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.SkylarkList;
import com.google.devtools.build.lib.syntax.SkylarkNestedSet;
@@ -28,8 +29,7 @@
doc =
"Immutable store of information needed for C++ linking that is aggregated across "
+ "dependencies.")
-public interface CcLinkingContextApi<
- FileT extends FileApi, LibraryToLinkT extends LibraryToLinkApi<FileT>> {
+public interface CcLinkingContextApi<FileT extends FileApi> {
@SkylarkCallable(
name = "user_link_flags",
doc = "Returns the list of user link flags passed as strings.",
@@ -38,13 +38,16 @@
@SkylarkCallable(
name = "libraries_to_link",
- doc = "Returns the list of <code>LibraryToLink</code>.",
- structField = true)
- SkylarkList<LibraryToLinkT> getSkylarkLibrariesToLink();
+ doc =
+ "Returns the depset of <code>LibraryToLink</code>. May return a list but this is"
+ + "deprecated. See #8118.",
+ structField = true,
+ useEnvironment = true)
+ Object getSkylarkLibrariesToLink(Environment environment);
@SkylarkCallable(
name = "additional_inputs",
- doc = "Returns the list of additional inputs, e.g.: linker scripts.",
+ doc = "Returns the depset of additional inputs, e.g.: linker scripts.",
structField = true)
SkylarkNestedSet getSkylarkNonCodeInputs();
}
diff --git a/src/main/java/com/google/devtools/build/lib/syntax/StarlarkSemantics.java b/src/main/java/com/google/devtools/build/lib/syntax/StarlarkSemantics.java
index 6778ce9..5b1909f 100644
--- a/src/main/java/com/google/devtools/build/lib/syntax/StarlarkSemantics.java
+++ b/src/main/java/com/google/devtools/build/lib/syntax/StarlarkSemantics.java
@@ -200,6 +200,8 @@
public abstract boolean incompatibleDoNotSplitLinkingCmdline();
+ public abstract boolean incompatibleDepsetForLibrariesToLinkGetter();
+
/** Returns a {@link Builder} initialized with the values of this instance. */
public abstract Builder toBuilder();
@@ -256,6 +258,7 @@
.incompatibleStringJoinRequiresStrings(false)
.internalSkylarkFlagTestCanary(false)
.incompatibleDoNotSplitLinkingCmdline(false)
+ .incompatibleDepsetForLibrariesToLinkGetter(false)
.build();
/** Builder for {@link StarlarkSemantics}. All fields are mandatory. */
@@ -346,6 +349,8 @@
public abstract Builder incompatibleDoNotSplitLinkingCmdline(boolean value);
+ public abstract Builder incompatibleDepsetForLibrariesToLinkGetter(boolean value);
+
public abstract StarlarkSemantics build();
}
}
diff --git a/src/main/java/com/google/devtools/build/skydoc/fakebuildapi/cpp/FakeCcModule.java b/src/main/java/com/google/devtools/build/skydoc/fakebuildapi/cpp/FakeCcModule.java
index d3fa42e..276f497 100644
--- a/src/main/java/com/google/devtools/build/skydoc/fakebuildapi/cpp/FakeCcModule.java
+++ b/src/main/java/com/google/devtools/build/skydoc/fakebuildapi/cpp/FakeCcModule.java
@@ -51,7 +51,7 @@
CcCompilationOutputsApi<FileApi>,
CcLinkingOutputsApi<FileApi>,
LibraryToLinkApi<FileApi>,
- CcLinkingContextApi<FileApi, LibraryToLinkApi<FileApi>>,
+ CcLinkingContextApi<FileApi>,
CcToolchainVariablesApi,
CcToolchainConfigInfoApi> {
@@ -199,7 +199,7 @@
CcToolchainProviderApi<FeatureConfigurationApi> skylarkCcToolchainProvider,
CcCompilationOutputsApi<FileApi> compilationOutputs,
SkylarkList<String> userLinkFlags,
- SkylarkList<CcLinkingContextApi<FileApi, LibraryToLinkApi<FileApi>>> ccLinkingContextApis,
+ SkylarkList<CcLinkingContextApi<FileApi>> ccLinkingContextApis,
String name,
String language,
boolean alwayslink,
@@ -221,7 +221,7 @@
CcToolchainProviderApi<FeatureConfigurationApi> skylarkCcToolchainProvider,
CcCompilationOutputsApi<FileApi> compilationOutputs,
SkylarkList<String> userLinkFlags,
- SkylarkList<CcLinkingContextApi<FileApi, LibraryToLinkApi<FileApi>>> linkingContexts,
+ SkylarkList<CcLinkingContextApi<FileApi>> linkingContexts,
String name,
String language,
String outputType,
diff --git a/src/test/java/com/google/devtools/build/lib/packages/SkylarkSemanticsConsistencyTest.java b/src/test/java/com/google/devtools/build/lib/packages/SkylarkSemanticsConsistencyTest.java
index bc9fbb1..5ce9cf7 100644
--- a/src/test/java/com/google/devtools/build/lib/packages/SkylarkSemanticsConsistencyTest.java
+++ b/src/test/java/com/google/devtools/build/lib/packages/SkylarkSemanticsConsistencyTest.java
@@ -133,6 +133,7 @@
"--experimental_platforms_api=" + rand.nextBoolean(),
"--experimental_starlark_config_transitions=" + rand.nextBoolean(),
"--incompatible_bzl_disallow_load_after_statement=" + rand.nextBoolean(),
+ "--incompatible_depset_for_libraries_to_link_getter=" + rand.nextBoolean(),
"--incompatible_depset_is_not_iterable=" + rand.nextBoolean(),
"--incompatible_depset_union=" + rand.nextBoolean(),
"--incompatible_disable_deprecated_attr_params=" + rand.nextBoolean(),
@@ -148,6 +149,7 @@
"--incompatible_disallow_old_style_args_add=" + rand.nextBoolean(),
"--incompatible_disallow_struct_provider_syntax=" + rand.nextBoolean(),
"--incompatible_disallow_rule_execution_platform_constraints_allowed=" + rand.nextBoolean(),
+ "--incompatible_do_not_split_linking_cmdline=" + rand.nextBoolean(),
"--incompatible_expand_directories=" + rand.nextBoolean(),
"--incompatible_new_actions_api=" + rand.nextBoolean(),
"--incompatible_no_attr_license=" + rand.nextBoolean(),
@@ -163,8 +165,7 @@
"--incompatible_restrict_named_params=" + rand.nextBoolean(),
"--incompatible_static_name_resolution_in_build_files=" + rand.nextBoolean(),
"--incompatible_string_join_requires_strings=" + rand.nextBoolean(),
- "--internal_skylark_flag_test_canary=" + rand.nextBoolean(),
- "--incompatible_do_not_split_linking_cmdline=" + rand.nextBoolean());
+ "--internal_skylark_flag_test_canary=" + rand.nextBoolean());
}
/**
@@ -185,6 +186,7 @@
.experimentalPlatformsApi(rand.nextBoolean())
.experimentalStarlarkConfigTransitions(rand.nextBoolean())
.incompatibleBzlDisallowLoadAfterStatement(rand.nextBoolean())
+ .incompatibleDepsetForLibrariesToLinkGetter(rand.nextBoolean())
.incompatibleDepsetIsNotIterable(rand.nextBoolean())
.incompatibleDepsetUnion(rand.nextBoolean())
.incompatibleDisableDeprecatedAttrParams(rand.nextBoolean())
@@ -200,6 +202,7 @@
.incompatibleDisallowOldStyleArgsAdd(rand.nextBoolean())
.incompatibleDisallowStructProviderSyntax(rand.nextBoolean())
.incompatibleDisallowRuleExecutionPlatformConstraintsAllowed(rand.nextBoolean())
+ .incompatibleDoNotSplitLinkingCmdline(rand.nextBoolean())
.incompatibleExpandDirectories(rand.nextBoolean())
.incompatibleNewActionsApi(rand.nextBoolean())
.incompatibleNoAttrLicense(rand.nextBoolean())
@@ -216,7 +219,6 @@
.incompatibleStaticNameResolutionInBuildFiles(rand.nextBoolean())
.incompatibleStringJoinRequiresStrings(rand.nextBoolean())
.internalSkylarkFlagTestCanary(rand.nextBoolean())
- .incompatibleDoNotSplitLinkingCmdline(rand.nextBoolean())
.build();
}
diff --git a/src/test/java/com/google/devtools/build/lib/rules/cpp/SkylarkCcCommonTest.java b/src/test/java/com/google/devtools/build/lib/rules/cpp/SkylarkCcCommonTest.java
index 6004210..5f7385b 100644
--- a/src/test/java/com/google/devtools/build/lib/rules/cpp/SkylarkCcCommonTest.java
+++ b/src/test/java/com/google/devtools/build/lib/rules/cpp/SkylarkCcCommonTest.java
@@ -1142,6 +1142,46 @@
ImmutableList.of("a.so", "liba_Slibdep2.so", "b.so", "e.so", "liba_Slibdep1.so"));
}
+ /** TODO(#8118): This test can go away once flag is flipped. */
+ @Test
+ public void testIncompatibleDepsetForLibrariesToLinkGetter() throws Exception {
+ AnalysisMock.get()
+ .ccSupport()
+ .setupCcToolchainConfig(
+ mockToolsConfig,
+ CcToolchainConfig.builder()
+ .withFeatures(
+ CppRuleClasses.PIC,
+ CppRuleClasses.SUPPORTS_PIC,
+ CppRuleClasses.SUPPORTS_DYNAMIC_LINKER));
+ setSkylarkSemanticsOptions("--incompatible_depset_for_libraries_to_link_getter");
+ setUpCcLinkingContextTest();
+ ConfiguredTarget a = getConfiguredTarget("//a:a");
+ StructImpl info = ((StructImpl) getMyInfoFromTarget(a).getValue("info"));
+
+ @SuppressWarnings("unchecked")
+ SkylarkNestedSet librariesToLink = info.getValue("libraries_to_link", SkylarkNestedSet.class);
+ assertThat(
+ librariesToLink.toCollection(LibraryToLink.class).stream()
+ .filter(x -> x.getStaticLibrary() != null)
+ .map(x -> x.getStaticLibrary().getFilename())
+ .collect(ImmutableList.toImmutableList()))
+ .containsExactly("a.a", "b.a", "c.a", "d.a");
+ assertThat(
+ librariesToLink.toCollection(LibraryToLink.class).stream()
+ .filter(x -> x.getPicStaticLibrary() != null)
+ .map(x -> x.getPicStaticLibrary().getFilename())
+ .collect(ImmutableList.toImmutableList()))
+ .containsExactly("a.pic.a", "libdep2.a", "b.pic.a", "c.pic.a", "e.pic.a", "libdep1.a");
+ assertThat(
+ librariesToLink.toCollection(LibraryToLink.class).stream()
+ .filter(x -> x.getDynamicLibrary() != null)
+ .map(x -> x.getDynamicLibrary().getFilename())
+ .collect(ImmutableList.toImmutableList()))
+ .containsExactly("a.so", "liba_Slibdep2.so", "b.so", "e.so", "liba_Slibdep1.so");
+ }
+
+ @Deprecated
private void doTestCcLinkingContext(
List<String> staticLibraryList,
List<String> picStaticLibraryList,
