Start wiring up build settings for crosstool dSYM bundles into the rules themselves.

Cherry-pick: f1ed76b

Author: nglevin

apple/BUILD

@@ -56,6 +56,7 @@ bzl_library(
         "//apple/internal:rule_attrs",
         "//apple/internal:rule_factory",
         "//apple/internal:transition_support",
+        "//apple/internal/toolchains:apple_toolchains",
         "@build_bazel_apple_support//lib:apple_support",
     ],
 )

apple/apple_binary.bzl

@@ -18,6 +18,11 @@ load(
     "@build_bazel_apple_support//lib:apple_support.bzl",
     "apple_support",
 )
+load(
+    "//apple/internal:apple_toolchains.bzl",
+    "AppleXPlatToolsToolchainInfo",
+    "apple_toolchain_utils",
+)
 load(
     "//apple/internal:linking_support.bzl",
     "linking_support",
@@ -67,6 +72,7 @@ visionOS binaries require a visionOS SDK provided by Xcode 15.1 beta or later.
 Resolved Xcode is version {xcode_version}.
 """.format(xcode_version = str(xcode_version_config.xcode_version())))
 
+    apple_xplat_toolchain_info = ctx.attr._xplat_toolchain[AppleXPlatToolsToolchainInfo]
     binary_type = ctx.attr.binary_type
     bundle_loader = ctx.attr.bundle_loader
     cc_toolchain_forwarder = ctx.split_attr._cc_toolchain_forwarder
@@ -97,6 +103,7 @@ Resolved Xcode is version {xcode_version}.
     link_result = linking_support.register_binary_linking_action(
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         bundle_loader = bundle_loader,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         extra_linkopts = extra_linkopts,
@@ -152,6 +159,7 @@ implementation of `apple_binary` in Bazel core so that it can be removed.
     implementation = _apple_binary_impl,
     attrs = [
         apple_support.platform_constraint_attrs(),
+        apple_toolchain_utils.shared_attrs(),
         rule_attrs.binary_linking_attrs(
             deps_cfg = transition_support.apple_platform_split_transition,
             is_test_supporting_rule = False,

apple/internal/ios_rules.bzl

@@ -248,6 +248,7 @@ def _ios_application_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         extra_linkopts = extra_linkopts,
@@ -627,6 +628,7 @@ def _ios_app_clip_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         platform_prerequisites = platform_prerequisites,
@@ -950,6 +952,7 @@ def _ios_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -1227,6 +1230,7 @@ def _ios_extension_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         extra_linkopts = extra_linkopts,
@@ -1545,6 +1549,7 @@ def _ios_dynamic_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -2181,6 +2186,7 @@ def _ios_imessage_extension_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         extra_linkopts = extra_linkopts,

apple/internal/linking_support.bzl

@@ -144,6 +144,7 @@ def _link_multi_arch_binary(
         *,
         ctx,
         avoid_deps = [],
+        build_settings,
         cc_toolchains,
         extra_linkopts = [],
         extra_link_inputs = [],
@@ -167,6 +168,7 @@ def _link_multi_arch_binary(
             dependencies that will be found at runtime in another image, such as the
             bundle loader or any dynamic libraries/frameworks that will be loaded by
             this binary.
+        build_settings: A struct with build settings info from AppleXplatToolsToolchainInfo.
         cc_toolchains: Dictionary of CcToolchainInfo and ApplePlatformInfo providers under a split
             transition to relay target platform information for related deps.
         extra_linkopts: A list of strings: Extra linkopts to add to the linking action.
@@ -282,21 +284,42 @@ def _link_multi_arch_binary(
         additional_outputs = []
         extensions = {}
 
-        dsym_binary = None
+        dsym_output = None
         if ctx.fragments.cpp.apple_generate_dsym:
-            if ctx.fragments.cpp.objc_should_strip_binary:
-                suffix = "_bin_unstripped.dwarf"
+            dsym_variants = build_settings.dsym_variant_flag
+            if dsym_variants == "bundle":
+                # TODO(b/391401130): Remove this once dsymutil generated bundle dSYM output is
+                # supported.
+                fail("dsymutil bundle dSYM output is not yet supported by the Apple BUILD Rules.")
+            elif dsym_variants != "flat":
+                fail("""
+Internal Error: Found unsupported dsym_variant_flag: {dsym_variants}.
+
+Please report this as a bug to the Apple BUILD Rules team.
+                """.format(
+                    dsym_variants = dsym_variants,
+                ))
             else:
-                suffix = "_bin.dwarf"
-            dsym_binary = intermediates.file(
-                actions = ctx.actions,
-                target_name = ctx.label.name,
-                output_discriminator = split_transition_key,
-                file_name = ctx.label.name + suffix,
-            )
-            extensions["dsym_path"] = dsym_binary.path  # dsym symbol file
-            additional_outputs.append(dsym_binary)
-            legacy_debug_outputs.setdefault(platform_info.target_arch, {})["dsym_binary"] = dsym_binary
+                if ctx.fragments.cpp.objc_should_strip_binary:
+                    suffix = "_bin_unstripped"
+                else:
+                    suffix = "_bin"
+                dsym_output = intermediates.file(
+                    actions = ctx.actions,
+                    target_name = ctx.label.name,
+                    output_discriminator = split_transition_key,
+                    file_name = "{}.dwarf".format(ctx.label.name + suffix),
+                )
+
+                # TODO(b/391401130): Remove this once all users are migrated to the downstream
+                # provider AppleDsymBundleInfo.
+                legacy_debug_outputs.setdefault(
+                    platform_info.target_arch,
+                    {},
+                )["dsym_binary"] = dsym_output
+
+            extensions["dsym_path"] = dsym_output.path  # dsym symbol file
+            additional_outputs.append(dsym_output)
 
         linkmap = None
         if ctx.fragments.cpp.objc_generate_linkmap:
@@ -329,7 +352,7 @@ def _link_multi_arch_binary(
             "platform": platform_info.target_os,
             "architecture": platform_info.target_arch,
             "environment": platform_info.target_environment,
-            "dsym_binary": dsym_binary,
+            "dsym_binary": dsym_output,
             "linkmap": linkmap,
         }
 
@@ -419,6 +442,7 @@ def _register_binary_linking_action(
         ctx,
         *,
         avoid_deps = [],
+        build_settings,
         bundle_loader = None,
         cc_toolchains,
         entitlements = None,
@@ -439,6 +463,7 @@ def _register_binary_linking_action(
         ctx: The rule context.
         avoid_deps: A list of `Target`s representing dependencies of the binary but whose
             symbols should not be linked into it.
+        build_settings: A struct with build settings info from AppleXplatToolsToolchainInfo.
         bundle_loader: For Mach-O bundles, the `Target` whose binary will load this bundle.
             This target must propagate the `AppleExecutableBinaryInfo` provider.
             This simplifies the process of passing the bundle loader to all the arguments
@@ -550,6 +575,7 @@ def _register_binary_linking_action(
     linking_outputs = _link_multi_arch_binary(
         ctx = ctx,
         avoid_deps = all_avoid_deps,
+        build_settings = build_settings,
         cc_toolchains = cc_toolchains,
         extra_linkopts = linkopts,
         extra_link_inputs = link_inputs,

apple/internal/macos_rules.bzl

@@ -241,6 +241,7 @@ def _macos_application_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         platform_prerequisites = platform_prerequisites,
@@ -546,6 +547,7 @@ def _macos_bundle_impl(ctx):
     link_result = linking_support.register_binary_linking_action(
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         bundle_loader = ctx.attr.bundle_loader,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -800,6 +802,7 @@ def _macos_extension_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         extra_linkopts = extra_linkopts,
@@ -1068,6 +1071,7 @@ def _macos_quick_look_plugin_impl(ctx):
 
     link_result = linking_support.register_binary_linking_action(
         ctx,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         cc_toolchains = cc_toolchain_forwarder,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -1322,6 +1326,7 @@ def _macos_kernel_extension_impl(ctx):
 
     link_result = linking_support.register_binary_linking_action(
         ctx,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         cc_toolchains = cc_toolchain_forwarder,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -1565,6 +1570,7 @@ def _macos_spotlight_importer_impl(ctx):
 
     link_result = linking_support.register_binary_linking_action(
         ctx,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         cc_toolchains = cc_toolchain_forwarder,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -1806,6 +1812,7 @@ def _macos_xpc_service_impl(ctx):
 
     link_result = linking_support.register_binary_linking_action(
         ctx,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         cc_toolchains = cc_toolchain_forwarder,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -2022,6 +2029,7 @@ def _macos_command_line_application_impl(ctx):
 
     link_result = linking_support.register_binary_linking_action(
         ctx,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         cc_toolchains = cc_toolchain_forwarder,
         # Command-line applications do not have entitlements.
         entitlements = None,
@@ -2164,6 +2172,7 @@ def _macos_dylib_impl(ctx):
 
     link_result = linking_support.register_binary_linking_action(
         ctx,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         cc_toolchains = cc_toolchain_forwarder,
         # Dynamic libraries do not have entitlements.
         entitlements = None,
@@ -2856,6 +2865,7 @@ def _macos_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -3139,6 +3149,7 @@ def _macos_dynamic_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,

apple/internal/testing/apple_test_bundle_support.bzl

@@ -392,6 +392,7 @@ def _apple_test_bundle_impl(*, ctx, product_type):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = getattr(ctx.attr, "frameworks", []),
+        build_settings = apple_xplat_toolchain_info.build_settings,
         bundle_loader = bundle_loader,
         # Unit/UI tests do not use entitlements.
         entitlements = None,

apple/internal/tvos_rules.bzl

@@ -225,6 +225,7 @@ def _tvos_application_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         platform_prerequisites = platform_prerequisites,
@@ -561,6 +562,7 @@ def _tvos_dynamic_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -848,6 +850,7 @@ def _tvos_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -1133,6 +1136,7 @@ def _tvos_extension_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         extra_linkopts = extra_linkopts,

apple/internal/visionos_rules.bzl

@@ -233,6 +233,7 @@ Resolved Xcode is version {xcode_version}.
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         platform_prerequisites = platform_prerequisites,
@@ -565,6 +566,7 @@ def _visionos_dynamic_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -853,6 +855,7 @@ def _visionos_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -1125,6 +1128,7 @@ def _visionos_extension_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         extra_linkopts = [

apple/internal/watchos_rules.bzl

@@ -226,6 +226,7 @@ def _watchos_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -506,6 +507,7 @@ def _watchos_dynamic_framework_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         # Frameworks do not have entitlements.
         entitlements = None,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
@@ -1127,6 +1129,7 @@ def _watchos_extension_impl(ctx):
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         extra_linkopts = extra_linkopts,
@@ -1597,6 +1600,7 @@ delegate is referenced in the single-target `watchos_application`'s `deps`.
         ctx,
         cc_toolchains = cc_toolchain_forwarder,
         avoid_deps = ctx.attr.frameworks,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         entitlements = entitlements.linking,
         exported_symbols_lists = ctx.files.exported_symbols_lists,
         extra_linkopts = [],

apple/internal/xcframework_rules.bzl

@@ -590,6 +590,7 @@ def _apple_xcframework_impl(ctx):
 
     link_result = linking_support.register_binary_linking_action(
         ctx,
+        build_settings = apple_xplat_toolchain_info.build_settings,
         cc_toolchains = cc_toolchain_forwarder,
         # Frameworks do not have entitlements.
         entitlements = None,