Add experimental cc_static_library rule

RELNOTES: The new `cc_static_library` rule produces a static library that bundles given targets and all their transitive dependencies. It has to be enabled via `--experimental_cc_static_library`.

Implements https://docs.google.com/document/d/1jN0LUmp6_-rV9_f-Chx-Cs6t_5iOm3fziOklzBGjGIg/edit

Fixes bazelbuild#1920

Closes bazelbuild#16954.

PiperOrigin-RevId: 661382285
Change-Id: I972afd1a38d50ab4e48d9b3c189f1662b0096bbf

src/main/java/com/google/devtools/build/lib/bazel/rules/CcRules.java

@@ -31,6 +31,7 @@
 import com.google.devtools.build.lib.rules.cpp.CcLibcTopAlias;
 import com.google.devtools.build.lib.rules.cpp.CcNativeLibraryInfo;
 import com.google.devtools.build.lib.rules.cpp.CcSharedLibraryRule;
+import com.google.devtools.build.lib.rules.cpp.CcStaticLibraryRule;
 import com.google.devtools.build.lib.rules.cpp.CcToolchainAliasRule;
 import com.google.devtools.build.lib.rules.cpp.CcToolchainConfigInfo;
 import com.google.devtools.build.lib.rules.cpp.CcToolchainRule;
@@ -90,6 +91,7 @@ public void init(ConfiguredRuleClassProvider.Builder builder) {
     builder.addRuleDefinition(new BazelCppRuleClasses.CcBinaryBaseRule());
     builder.addRuleDefinition(new BazelCcBinaryRule());
     builder.addRuleDefinition(new CcSharedLibraryRule());
+    builder.addRuleDefinition(new CcStaticLibraryRule());
     builder.addRuleDefinition(new BazelCcTestRule());
     builder.addRuleDefinition(new BazelCppRuleClasses.CcLibraryBaseRule());
     builder.addRuleDefinition(new BazelCcLibraryRule());

src/main/java/com/google/devtools/build/lib/packages/semantics/BuildLanguageOptions.java

@@ -283,6 +283,19 @@ public final class BuildLanguageOptions extends OptionsBase {
               + "cc_shared_library will be available")
   public boolean experimentalCcSharedLibrary;
 
+  @Option(
+      name = "experimental_cc_static_library",
+      defaultValue = "false",
+      documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS,
+      effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS, OptionEffectTag.LOADING_AND_ANALYSIS},
+      metadataTags = {
+        OptionMetadataTag.EXPERIMENTAL,
+      },
+      help =
+          "If set to true, rule attributes and Starlark API methods needed for the rule "
+              + "cc_static_library will be available")
+  public boolean experimentalCcStaticLibrary;
+
   @Option(
       name = "incompatible_require_linker_input_cc_api",
       defaultValue = "true",
@@ -779,6 +792,7 @@ public StarlarkSemantics toStarlarkSemantics() {
             .setBool(EXPERIMENTAL_GOOGLE_LEGACY_API, experimentalGoogleLegacyApi)
             .setBool(EXPERIMENTAL_PLATFORMS_API, experimentalPlatformsApi)
             .setBool(EXPERIMENTAL_CC_SHARED_LIBRARY, experimentalCcSharedLibrary)
+            .setBool(EXPERIMENTAL_CC_STATIC_LIBRARY, experimentalCcStaticLibrary)
             .setBool(EXPERIMENTAL_REPO_REMOTE_EXEC, experimentalRepoRemoteExec)
             .setBool(EXPERIMENTAL_DISABLE_EXTERNAL_PACKAGE, experimentalDisableExternalPackage)
             .setBool(EXPERIMENTAL_SIBLING_REPOSITORY_LAYOUT, experimentalSiblingRepositoryLayout)
@@ -874,6 +888,7 @@ public StarlarkSemantics toStarlarkSemantics() {
   public static final String EXPERIMENTAL_BZL_VISIBILITY = "+experimental_bzl_visibility";
   public static final String CHECK_BZL_VISIBILITY = "+check_bzl_visibility";
   public static final String EXPERIMENTAL_CC_SHARED_LIBRARY = "-experimental_cc_shared_library";
+  public static final String EXPERIMENTAL_CC_STATIC_LIBRARY = "-experimental_cc_static_library";
   public static final String EXPERIMENTAL_DISABLE_EXTERNAL_PACKAGE =
       "-experimental_disable_external_package";
   public static final String EXPERIMENTAL_ENABLE_ANDROID_MIGRATION_APIS =

src/main/java/com/google/devtools/build/lib/rules/cpp/CcModule.java

@@ -1113,6 +1113,12 @@ public boolean checkExperimentalCcSharedLibrary(StarlarkThread thread) throws Ev
     return thread.getSemantics().getBool(BuildLanguageOptions.EXPERIMENTAL_CC_SHARED_LIBRARY);
   }
 
+  @Override
+  public boolean checkExperimentalCcStaticLibrary(StarlarkThread thread) throws EvalException {
+    isCalledFromStarlarkCcCommon(thread);
+    return thread.getSemantics().getBool(BuildLanguageOptions.EXPERIMENTAL_CC_STATIC_LIBRARY);
+  }
+
   @Override
   public boolean getIncompatibleDisableObjcLibraryTransition(StarlarkThread thread)
       throws EvalException {

src/main/java/com/google/devtools/build/lib/rules/cpp/CcStaticLibraryRule.java

@@ -0,0 +1,103 @@
+// Copyright 2014 The Bazel Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package com.google.devtools.build.lib.rules.cpp;
+
+import static com.google.devtools.build.lib.packages.Attribute.attr;
+import static com.google.devtools.build.lib.packages.BuildType.LABEL_LIST;
+import static com.google.devtools.build.lib.packages.Type.STRING_LIST;
+
+import com.google.devtools.build.lib.analysis.BaseRuleClasses;
+import com.google.devtools.build.lib.analysis.RuleDefinition;
+import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
+import com.google.devtools.build.lib.packages.RuleClass;
+import com.google.devtools.build.lib.packages.StarlarkProviderIdentifier;
+import com.google.devtools.build.lib.util.FileTypeSet;
+
+/** A dummy rule for <code>cc_static_library</code> rule. */
+public final class CcStaticLibraryRule implements RuleDefinition {
+
+  @Override
+  public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment env) {
+    return builder
+        /*<!-- #BLAZE_RULE(cc_static_library).ATTRIBUTE(deps) -->
+        The list of targets to combine into a static library, including all their transitive
+        dependencies.
+
+        <p>Dependencies that do not provide any object files are not included in the static
+        library, but their labels are collected in the file provided by the
+        <code>linkdeps</code> output group.</p>
+        <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/
+        .add(
+            attr("deps", LABEL_LIST)
+                .skipAnalysisTimeFileTypeCheck()
+                .allowedFileTypes(FileTypeSet.NO_FILE)
+                .mandatoryProviders(StarlarkProviderIdentifier.forKey(CcInfo.PROVIDER.getKey())))
+        .add(
+            attr("tags", STRING_LIST)
+                .orderIndependent()
+                .taggable()
+                .nonconfigurable("low-level attribute, used in TargetUtils without configurations"))
+        .build();
+  }
+
+  @Override
+  public Metadata getMetadata() {
+    return Metadata.builder()
+        .name("cc_static_library")
+        .factoryClass(BaseRuleClasses.EmptyRuleConfiguredTargetFactory.class)
+        .build();
+  }
+}
+/*<!-- #BLAZE_RULE (NAME = cc_static_library, TYPE = LIBRARY, FAMILY = C / C++) -->
+Produces a static library from a list of targets and their transitive dependencies.
+
+<p>The resulting static library contains the object files of the targets listed in
+<code>deps</code> as well as their transitive dependencies, with preference given to
+<code>PIC</code> objects.</p>
+
+<h4 id="cc_static_library_output_groups">Output groups</h4>
+
+<h5><code>linkdeps</code></h5>
+<p>A text file containing the labels of those transitive dependencies of targets listed in
+<code>deps</code> that did not contribute any object files to the static library, but do
+provide at least one static, dynamic or interface library. The resulting static library
+may require these libraries to be available at link time.</p>
+
+<h5><code>linkopts</code></h5>
+<p>A text file containing the user-provided <code>linkopts</code> of all transitive
+dependencies of targets listed in <code>deps</code>.
+
+<h4 id="cc_static_library_symbol_check">Duplicate symbols</h4>
+<p>By default, the <code>cc_static_library</code> rule checks that the resulting static
+library does not contain any duplicate symbols. If it does, the build fails with an error
+message that lists the duplicate symbols and the object files containing them.</p>
+
+<p>This check can be disabled per target or per package by setting
+<code>features = ["-symbol_check"]</code> or globally via
+<code>--features=-symbol_check</code>.</p>
+
+<h5 id="cc_static_library_symbol_check_toolchain">Toolchain support for <code>symbol_check</code></h5>
+<p>The auto-configured C++ toolchains shipped with Bazel support the
+<code>symbol_check</code> feature on all platforms. Custom toolchains can add support for
+it in one of two ways:</p>
+<ul>
+  <li>Implementing the <code>ACTION_NAMES.validate_static_library</code> action and
+  enabling it with the <code>symbol_check</code> feature. The tool set in the action is
+  invoked with two arguments, the static library to check for duplicate symbols and the
+  path of a file that must be created if the check passes.</li>
+  <li>Having the <code>symbol_check</code> feature add archiver flags that cause the
+  action creating the static library to fail on duplicate symbols.</li>
+</ul>
+
+<!-- #END_BLAZE_RULE -->*/

src/main/java/com/google/devtools/build/lib/starlarkbuildapi/cpp/CcModuleApi.java

@@ -1417,6 +1417,13 @@ LinkerInputT createLinkerInput(
       documented = false)
   boolean checkExperimentalCcSharedLibrary(StarlarkThread thread) throws EvalException;
 
+  @StarlarkMethod(
+      name = "check_experimental_cc_static_library",
+      doc = "DO NOT USE. This is to guard use of cc_static_library.",
+      useStarlarkThread = true,
+      documented = false)
+  boolean checkExperimentalCcStaticLibrary(StarlarkThread thread) throws EvalException;
+
   @StarlarkMethod(
       name = "incompatible_disable_objc_library_transition",
       useStarlarkThread = true,

src/main/starlark/builtins_bzl/common/cc/action_names.bzl

@@ -95,6 +95,8 @@ CLIF_MATCH_ACTION_NAME = "clif-match"
 # A string constant for the obj copy actions.
 OBJ_COPY_ACTION_NAME = "objcopy_embed_data"
 
+VALIDATE_STATIC_LIBRARY = "validate-static-library"
+
 ACTION_NAMES = struct(
     c_compile = C_COMPILE_ACTION_NAME,
     cpp_compile = CPP_COMPILE_ACTION_NAME,
@@ -122,4 +124,5 @@ ACTION_NAMES = struct(
     objcpp_compile = OBJCPP_COMPILE_ACTION_NAME,
     clif_match = CLIF_MATCH_ACTION_NAME,
     objcopy_embed_data = OBJ_COPY_ACTION_NAME,
+    validate_static_library = VALIDATE_STATIC_LIBRARY,
 )

src/main/starlark/builtins_bzl/common/cc/cc_common.bzl

@@ -623,6 +623,10 @@ def _check_experimental_cc_shared_library():
     cc_common_internal.check_private_api(allowlist = _PRIVATE_STARLARKIFICATION_ALLOWLIST)
     return cc_common_internal.check_experimental_cc_shared_library()
 
+def _check_experimental_cc_static_library():
+    cc_common_internal.check_private_api(allowlist = _PRIVATE_STARLARKIFICATION_ALLOWLIST)
+    return cc_common_internal.check_experimental_cc_static_library()
+
 def _incompatible_disable_objc_library_transition():
     cc_common_internal.check_private_api(allowlist = _PRIVATE_STARLARKIFICATION_ALLOWLIST)
     return cc_common_internal.incompatible_disable_objc_library_transition()
@@ -902,6 +906,7 @@ cc_common = struct(
     merge_compilation_contexts = _merge_compilation_contexts,
     merge_linking_contexts = _merge_linking_contexts,
     check_experimental_cc_shared_library = _check_experimental_cc_shared_library,
+    check_experimental_cc_static_library = _check_experimental_cc_static_library,
     create_module_map = _create_module_map,
     create_debug_context = _create_debug_context,
     merge_debug_context = _merge_debug_context,