Add -install_name when linking shared libraries on macOS

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

@@ -303,6 +303,7 @@ public CcToolchainVariables getLinkBuildVariables(
         isUsingLinkerNotArchiver,
         /* binDirectoryPath= */ null,
         convertFromNoneable(outputFile, /* defaultValue= */ null),
+        /* runtimeSolibName= */ null,
         isCreatingSharedLibrary,
         convertFromNoneable(paramFile, /* defaultValue= */ null),
         /* thinltoParamFile= */ null,

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

@@ -770,4 +770,9 @@ public boolean useCppCompileHeaderMnemonic() {
   public boolean generateLlvmLCov() {
     return cppOptions.generateLlvmLcov;
   }
+
+  @Override
+  public boolean macosSetInstallName() {
+    return cppOptions.macosSetInstallName;
+  }
 }

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

@@ -868,6 +868,7 @@ public CppLinkAction build() throws InterruptedException, RuleErrorException {
               getLinkType().linkerOrArchiver().equals(LinkerOrArchiver.LINKER),
               configuration.getBinDirectory(repositoryName).getExecPath(),
               output.getExecPathString(),
+              SolibSymlinkAction.getDynamicLibrarySoname(output.getRootRelativePath(), false),
               linkType.equals(LinkTargetType.DYNAMIC_LIBRARY),
               paramFile != null ? paramFile.getExecPathString() : null,
               thinltoParamFile != null ? thinltoParamFile.getExecPathString() : null,

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

@@ -1045,6 +1045,20 @@ public Label getPropellerOptimizeLabel() {
       help = "If enabled, give distinguishing mnemonic to header processing actions")
   public boolean useCppCompileHeaderMnemonic;
 
+  @Option(
+      name = "incompatible_macos_set_install_name",
+      defaultValue = "false",
+      documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
+      effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS},
+      metadataTags = {
+          OptionMetadataTag.INCOMPATIBLE_CHANGE,
+          OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES
+      },
+      help =
+          "Whether to explicitly set `-install_name` when creating dynamic libraries. "
+              + "See https://github.com/bazelbuild/bazel/issues/12370")
+  public boolean macosSetInstallName;
+
   /** See {@link #targetLibcTopLabel} documentation. * */
   @Override
   public FragmentOptions getNormalized() {
@@ -1133,6 +1147,8 @@ public FragmentOptions getHost() {
     host.hostLinkoptList = hostLinkoptList;
 
     host.experimentalStarlarkCcImport = experimentalStarlarkCcImport;
+
+    host.macosSetInstallName = macosSetInstallName;
 
     return host;
   }

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

@@ -82,7 +82,9 @@ public enum LinkBuildVariables {
   /** Path to the context sensitive fdo instrument. */
   CS_FDO_INSTRUMENT_PATH("cs_fdo_instrument_path"),
   /** Path to the Propeller Optimize linker profile artifact */
-  PROPELLER_OPTIMIZE_LD_PATH("propeller_optimize_ld_path");
+  PROPELLER_OPTIMIZE_LD_PATH("propeller_optimize_ld_path"),
+  /** The name of the runtime solib symlink of the shared library. */
+  RUNTIME_SOLIB_NAME("runtime_solib_name");
 
   private final String variableName;
 
@@ -98,6 +100,7 @@ public static CcToolchainVariables setupVariables(
       boolean isUsingLinkerNotArchiver,
       PathFragment binDirectoryPath,
       String outputFile,
+      String runtimeSolibName,
       boolean isCreatingSharedLibrary,
       String paramFile,
       String thinltoParamFile,
@@ -166,6 +169,10 @@ public static CcToolchainVariables setupVariables(
       buildVariables.addStringVariable(OUTPUT_EXECPATH.getVariableName(), outputFile);
     }
 
+    if (runtimeSolibName != null && !isLtoIndexing) {
+      buildVariables.addStringVariable(RUNTIME_SOLIB_NAME.getVariableName(), runtimeSolibName);
+    }
+
     if (isLtoIndexing) {
       if (thinltoParamFile != null) {
         // This is a lto-indexing action and we want it to populate param file.

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

@@ -77,4 +77,12 @@ public interface CppConfigurationApi<InvalidConfigurationExceptionT extends Exce
               + "    )<br/>"
               + ")</pre>")
   Label customMalloc();
+
+  @StarlarkMethod(
+      name = "do_not_use_macos_set_install_name",
+      structField = true,
+      // Only for migration purposes. Intentionally not documented.
+      documented = false,
+      doc = "Accessor for <code>--incompatible_macos_set_install_name</code>.")
+  boolean macosSetInstallName();
 }

src/test/shell/bazel/cpp_darwin_integration_test.sh

@@ -123,5 +123,42 @@ EOF
   return 0
 }
 
+function test_cc_test_with_explicit_install_name() {
+  mkdir -p cpp
+  cat > cpp/BUILD <<EOF
+cc_library(
+  name = "foo",
+  srcs = ["foo.cc"],
+  hdrs = ["foo.h"],
+)
+cc_test(
+  name = "test",
+  srcs = ["test.cc"],
+  deps = [":foo"],
+)
+EOF
+  cat > cpp/foo.h <<EOF
+  int foo();
+EOF
+  cat > cpp/foo.cc <<EOF
+  int foo() { return 0; }
+EOF
+  cat > cpp/test.cc <<EOF
+  #include "cpp/foo.h"
+  int main() {
+    return foo();
+  }
+EOF
+
+  bazel test --incompatible_macos_set_install_name //cpp:test || \
+      fail "bazel test //cpp:test failed"
+  # Ensure @rpath is correctly set in the binary.
+  ./bazel-bin/cpp/test || \
+      fail "//cpp:test workspace execution failed, expected return 0, got $?"
+  cd bazel-bin
+  ./cpp/test || \
+      fail "//cpp:test execution failed, expected 0, but $?"
+}
+
 run_suite "Tests for Bazel's C++ rules on Darwin"
 

tools/osx/crosstool/cc_toolchain_config.bzl

@@ -6065,6 +6065,28 @@ def _impl(ctx):
         ],
     )
 
+    set_install_name = feature(
+        name = "set_install_name",
+        enabled = ctx.fragments.cpp.do_not_use_macos_set_install_name,
+        flag_sets = [
+            flag_set(
+                actions = [
+                    ACTION_NAMES.cpp_link_dynamic_library,
+                    ACTION_NAMES.cpp_link_nodeps_dynamic_library,
+                ],
+                flag_groups = [
+                    flag_group(
+                        flags = [
+                            "-install_name",
+                            "@rpath/%{runtime_solib_name}",
+                        ],
+                        expand_if_available = "runtime_solib_name",
+                    ),
+                ],
+            ),
+        ],
+    )
+
     if (ctx.attr.cpu == "ios_arm64" or
         ctx.attr.cpu == "ios_arm64e" or
         ctx.attr.cpu == "ios_armv7" or
@@ -6228,6 +6250,7 @@ def _impl(ctx):
             supports_dynamic_linker_feature,
             objcopy_embed_flags_feature,
             dynamic_linking_mode_feature,
+            set_install_name,
         ]
     elif (ctx.attr.cpu == "armeabi-v7a"):
         features = [
@@ -6406,4 +6429,5 @@ cc_toolchain_config = rule(
     },
     provides = [CcToolchainConfigInfo],
     executable = True,
+    fragments = ["cpp"],
 )