Fix link_flags file produced by bindgen rule

Author: Vinh Tran

bindgen/private/bindgen.bzl

@@ -110,17 +110,21 @@ def _generate_cc_link_build_info(ctx, cc_lib):
         The `BuildInfo` provider.
     """
     compile_data = []
+
+    # rustc_flags are passed directly to rustc while linker_flags are passed
+    # the linker invoked by either rustc or cc_common.link
+    rustc_flags = []
     linker_flags = []
     linker_search_paths = []
 
     for linker_input in cc_lib[CcInfo].linking_context.linker_inputs.to_list():
         for lib in linker_input.libraries:
             if lib.static_library:
-                linker_flags.append("-lstatic={}".format(get_lib_name_default(lib.static_library)))
+                rustc_flags.append("-lstatic={}".format(get_lib_name_default(lib.static_library)))
                 linker_search_paths.append(lib.static_library.dirname)
                 compile_data.append(lib.static_library)
             elif lib.pic_static_library:
-                linker_flags.append("-lstatic={}".format(get_lib_name_default(lib.pic_static_library)))
+                rustc_flags.append("-lstatic={}".format(get_lib_name_default(lib.pic_static_library)))
                 linker_search_paths.append(lib.pic_static_library.dirname)
                 compile_data.append(lib.pic_static_library)
 
@@ -131,9 +135,15 @@ def _generate_cc_link_build_info(ctx, cc_lib):
             cc_lib.label,
         ))
 
-    link_flags = ctx.actions.declare_file("{}.link_flags".format(ctx.label.name))
+    rustc_flags_file = ctx.actions.declare_file("{}.rustc_flags".format(ctx.label.name))
+    ctx.actions.write(
+        output = rustc_flags_file,
+        content = "\n".join(rustc_flags),
+    )
+
+    linker_flags_file = ctx.actions.declare_file("{}.linker_flags".format(ctx.label.name))
     ctx.actions.write(
-        output = link_flags,
+        output = linker_flags_file,
         content = "\n".join(linker_flags),
     )
 
@@ -149,8 +159,8 @@ def _generate_cc_link_build_info(ctx, cc_lib):
     return BuildInfo(
         compile_data = depset(compile_data),
         dep_env = None,
-        flags = None,
-        link_flags = link_flags,
+        flags = rustc_flags_file,
+        linker_flags = linker_flags_file,
         link_search_paths = link_search_paths,
         out_dir = None,
         rustc_env = None,

cargo/private/cargo_build_script.bzl

@@ -299,7 +299,7 @@ def _cargo_build_script_impl(ctx):
             rustc_env = env_out,
             dep_env = dep_env_out,
             flags = flags_out,
-            link_flags = link_flags,
+            linker_flags = link_flags,
             link_search_paths = link_search_paths,
             compile_data = depset([]),
         ),

examples/bindgen/simple/BUILD.bazel

@@ -11,5 +11,6 @@ cc_library(
     name = "simple",
     srcs = ["simple.cc"],
     hdrs = ["simple.h"],
+    linkopts = ["-framework"],
     visibility = ["//bindgen:__pkg__"],
 )

rust/private/providers.bzl

@@ -75,8 +75,8 @@ BuildInfo = provider(
         "compile_data": "Depset[File]: Compile data provided by the build script that was not copied into `out_dir`.",
         "dep_env": "Optinal[File]: extra build script environment varibles to be set to direct dependencies.",
         "flags": "Optional[File]: file containing additional flags to pass to rustc",
-        "link_flags": "Optional[File]: file containing flags to pass to the linker",
-        "link_search_paths": "Optional[File]: file containing search paths to pass to the linker",
+        "linker_flags": "Optional[File]: file containing flags to pass to the linker",
+        "link_search_paths": "Optional[File]: file containing search paths to pass to rustc and linker",
         "out_dir": "Optional[File]: directory containing the result of a build script",
         "rustc_env": "Optional[File]: file containing additional environment variables to set for rustc.",
     },

rust/private/rustc.bzl

@@ -478,9 +478,9 @@ def _process_build_scripts(
             - (File): An optional path to a generated environment file from a `cargo_build_script` target
             - (depset[File]): All direct and transitive build flags from the current build info.
     """
-    extra_inputs, out_dir, build_env_file, build_flags_files = _create_extra_input_args(build_info, dep_info)
+    extra_inputs, out_dir, build_env_file, flags_files, linker_flags_files = _create_extra_input_args(build_info, dep_info)
     compile_inputs = depset(transitive = [extra_inputs, compile_inputs])
-    return compile_inputs, out_dir, build_env_file, build_flags_files
+    return compile_inputs, out_dir, build_env_file, flags_files, linker_flags_files
 
 def _symlink_for_ambiguous_lib(actions, toolchain, crate_info, lib):
     """Constructs a disambiguating symlink for a library dependency.
@@ -764,12 +764,11 @@ def collect_inputs(
     # For backwards compatibility, we also check the value of the `rustc_env_files` attribute when
     # `crate_info.rustc_env_files` is not populated.
     build_env_files = crate_info.rustc_env_files if crate_info.rustc_env_files else getattr(files, "rustc_env_files", [])
-    compile_inputs, out_dir, build_env_file, build_flags_files = _process_build_scripts(build_info, dep_info, compile_inputs)
+    compile_inputs, out_dir, build_env_file, flags_files, link_flag_files = _process_build_scripts(build_info, dep_info, compile_inputs)
     if build_env_file:
         build_env_files = [f for f in build_env_files] + [build_env_file]
     compile_inputs = depset(build_env_files, transitive = [compile_inputs])
-
-    return compile_inputs, out_dir, build_env_files, build_flags_files, linkstamp_outs, ambiguous_libs
+    return compile_inputs, out_dir, build_env_files, flags_files, link_flag_files, linkstamp_outs, ambiguous_libs
 
 def construct_arguments(
         ctx,
@@ -787,7 +786,8 @@ def construct_arguments(
         rust_flags,
         out_dir,
         build_env_files,
-        build_flags_files,
+        flags_files,
+        linker_flags_files,
         emit = ["dep-info", "link"],
         force_all_deps_direct = False,
         rustdoc = False,
@@ -852,7 +852,7 @@ def construct_arguments(
     for build_env_file in build_env_files:
         process_wrapper_flags.add("--env-file", build_env_file)
 
-    process_wrapper_flags.add_all(build_flags_files, before_each = "--arg-file")
+    process_wrapper_flags.add_all(flags_files, before_each = "--arg-file")
 
     # Certain rust build processes expect to find files from the environment
     # variable `$CARGO_MANIFEST_DIR`. Examples of this include pest, tera,
@@ -1011,6 +1011,8 @@ def construct_arguments(
             env.update(link_env)
             rustc_flags.add(ld, format = "--codegen=linker=%s")
             rustc_flags.add_joined("--codegen", link_args, join_with = " ", format_joined = "link-args=%s")
+            # TODO pass linkopts (now in linker_flags_files) from cc deps to linker
+            # This can be done by propagating linkopts from cc deps to downstream via CcInfo
 
         _add_native_link_flags(rustc_flags, dep_info, linkstamp_outs, ambiguous_libs, crate_info.type, toolchain, cc_toolchain, feature_configuration, compilation_mode)
 
@@ -1156,7 +1158,7 @@ def rustc_compile_action(
     # Determine if the build is currently running with --stamp
     stamp = is_stamping_enabled(attr)
 
-    compile_inputs, out_dir, build_env_files, build_flags_files, linkstamp_outs, ambiguous_libs = collect_inputs(
+    compile_inputs, out_dir, build_env_files, flags_files, flags_files, linkstamp_outs, ambiguous_libs = collect_inputs(
         ctx = ctx,
         file = ctx.file,
         files = ctx.files,
@@ -1202,7 +1204,8 @@ def rustc_compile_action(
         rust_flags = rust_flags,
         out_dir = out_dir,
         build_env_files = build_env_files,
-        build_flags_files = build_flags_files,
+        flags_files = flags_files,
+        linker_flags_files = linker_flags_files,
         force_all_deps_direct = force_all_deps_direct,
         stamp = stamp,
         use_json_output = bool(build_metadata) or bool(rustc_output) or bool(rustc_rmeta_output),
@@ -1227,8 +1230,8 @@ def rustc_compile_action(
             output_hash = output_hash,
             rust_flags = rust_flags,
             out_dir = out_dir,
-            build_env_files = build_env_files,
-            build_flags_files = build_flags_files,
+            flags_files = flags_files,
+            link_flag_files = linker_flags_files,
             force_all_deps_direct = force_all_deps_direct,
             stamp = stamp,
             use_json_output = True,
@@ -1318,8 +1321,8 @@ def rustc_compile_action(
             )
     elif hasattr(ctx.executable, "_bootstrap_process_wrapper"):
         # Run without process_wrapper
-        if build_env_files or build_flags_files or stamp or build_metadata:
-            fail("build_env_files, build_flags_files, stamp, build_metadata are not supported when building without process_wrapper")
+        if build_env_files or flags_files or linker_flags_files or stamp or build_metadata:
+            fail("build_env_files, flags_files, linker_flags_files, stamp, build_metadata are not supported when building without process_wrapper")
         ctx.actions.run(
             executable = ctx.executable._bootstrap_process_wrapper,
             inputs = compile_inputs,
@@ -1650,7 +1653,8 @@ def _create_extra_input_args(build_info, dep_info):
             - (depset[File]): A list of all build info `OUT_DIR` File objects
             - (str): The `OUT_DIR` of the current build info
             - (File): An optional generated environment file from a `cargo_build_script` target
-            - (depset[File]): All direct and transitive build flag files from the current build info.
+            - (depset[File]): All direct and transitive build flag files for compiling from the current build info.
+            - (depset[File]): All direct and transitive build flag files for linking from the current build info.
     """
     input_files = []
     input_depsets = []
@@ -1659,25 +1663,33 @@ def _create_extra_input_args(build_info, dep_info):
     # to create the final command line
     out_dir = None
     build_env_file = None
-    build_flags_files = []
+
+    # We need to make a distinction for flags files here to decide whether to
+    # pass them to rustc based on the output crate type
+    # linker_flags_files are not needed for bin, dylib, and cdylib crate types
+    # because a linker is not invoked to produce such crates
+    flags_files = []
+    link_flag_files = []
 
     if build_info:
         if build_info.out_dir:
             out_dir = build_info.out_dir.path
             input_files.append(build_info.out_dir)
         build_env_file = build_info.rustc_env
         if build_info.flags:
-            build_flags_files.append(build_info.flags)
-        if build_info.link_flags:
-            build_flags_files.append(build_info.link_flags)
-            input_files.append(build_info.link_flags)
+            flags_files.append(build_info.flags)
+        if build_info.linker_flags:
+            link_flag_files.append(build_info.linker_flags)
+            input_files.append(build_info.linker_flags)
         input_depsets.append(build_info.compile_data)
 
     return (
+        # TODO: Split input_files into compile_input_files and link_input_files
         depset(input_files, transitive = [dep_info.link_search_path_files] + input_depsets),
         out_dir,
         build_env_file,
-        depset(build_flags_files, transitive = [dep_info.link_search_path_files]),
+        depset(flags_files, transitive = [dep_info.link_search_path_files]),
+        depset(link_flag_files, transitive = [dep_info.link_search_path_files]),
     )
 
 def _compute_rpaths(toolchain, output_dir, dep_info, use_pic):