Implement LDPT_REGISTER_CLAIM_FILE_HOOK_V2 linker plugin hook [PR109128]

This is one part of the fix for PR109128, along with a corresponding
binutils's linker change.  Without this patch, what happens in the
linker, when an unused object in a .a file has offload data, is that
elf_link_is_defined_archive_symbol calls bfd_link_plugin_object_p,
which ends up calling the plugin's claim_file_handler, which then
records the object as one with offload data. That is, the linker never
decides to use the object in the first place, but use of this _p
interface (called as part of trying to decide whether to use the
object) results in the plugin deciding to use its offload data (and a
consequent mismatch in the offload data present at runtime).

The new hook allows the linker plugin to distinguish calls to
claim_file_handler that know the object is being used by the linker
(from ldmain.c:add_archive_element), from calls that don't know it's
being used by the linker (from elf_link_is_defined_archive_symbol); in
the latter case, the plugin should avoid recording the object as one
with offload data.

	PR middle-end/109128

	include/
	* plugin-api.h (ld_plugin_claim_file_handler_v2)
	(ld_plugin_register_claim_file_v2)
	(LDPT_REGISTER_CLAIM_FILE_HOOK_V2): New.
	(struct ld_plugin_tv): Add tv_register_claim_file_v2.

	lto-plugin/
	* lto-plugin.c (register_claim_file_v2): New.
	(claim_file_handler_v2): New.
	(claim_file_handler): Wrap claim_file_handler_v2.
	(onload): Handle LDPT_REGISTER_CLAIM_FILE_HOOK_V2.

(cherry picked from commit c49d51fa8134f6c7e6c7cf6e4e3007c4fea617c5)

diff --git a/include/plugin-api.h b/include/plugin-api.h
index 4e12c0320d6f6f5d688d317561d2a224a6e2c29c..85ee70e4e2976dae4a3f778d70f5fae779229806 100644 (file)
--- a/include/plugin-api.h
+++ b/include/plugin-api.h
@@ -260,6 +260,13 @@ enum ld_plugin_status
 (*ld_plugin_claim_file_handler) (
   const struct ld_plugin_input_file *file, int *claimed);
 
+/* The plugin library's "claim file" handler, version 2.  */
+
+typedef
+enum ld_plugin_status
+(*ld_plugin_claim_file_handler_v2) (
+  const struct ld_plugin_input_file *file, int *claimed, int known_used);
+
 /* The plugin library's "all symbols read" handler.  */
 
 typedef
@@ -278,6 +285,13 @@ typedef
 enum ld_plugin_status
 (*ld_plugin_register_claim_file) (ld_plugin_claim_file_handler handler);
 
+/* The linker's interface for registering the "claim file" handler,
+   version 2.  */
+
+typedef
+enum ld_plugin_status
+(*ld_plugin_register_claim_file_v2) (ld_plugin_claim_file_handler_v2 handler);
+
 /* The linker's interface for registering the "all symbols read" handler.  */
 
 typedef
@@ -520,7 +534,8 @@ enum ld_plugin_tag
   LDPT_GET_INPUT_SECTION_SIZE = 30,
   LDPT_REGISTER_NEW_INPUT_HOOK = 31,
   LDPT_GET_WRAP_SYMBOLS = 32,
-  LDPT_ADD_SYMBOLS_V2 = 33
+  LDPT_ADD_SYMBOLS_V2 = 33,
+  LDPT_REGISTER_CLAIM_FILE_HOOK_V2 = 35,
 };
 
 /* The plugin transfer vector.  */
@@ -533,6 +548,7 @@ struct ld_plugin_tv
     int tv_val;
     const char *tv_string;
     ld_plugin_register_claim_file tv_register_claim_file;
+    ld_plugin_register_claim_file_v2 tv_register_claim_file_v2;
     ld_plugin_register_all_symbols_read tv_register_all_symbols_read;
     ld_plugin_register_cleanup tv_register_cleanup;
     ld_plugin_add_symbols tv_add_symbols;

diff --git a/lto-plugin/lto-plugin.c b/lto-plugin/lto-plugin.c
index 33d49571d0e2b21234603a6a2765e695e3e012de..1192ea8e6da5be4003a24d683de0543f05d1ed29 100644 (file)
--- a/lto-plugin/lto-plugin.c
+++ b/lto-plugin/lto-plugin.c
@@ -158,6 +158,7 @@ enum symbol_style
 
 static char *arguments_file_name;
 static ld_plugin_register_claim_file register_claim_file;
+static ld_plugin_register_claim_file_v2 register_claim_file_v2;
 static ld_plugin_register_all_symbols_read register_all_symbols_read;
 static ld_plugin_get_symbols get_symbols, get_symbols_v2;
 static ld_plugin_register_cleanup register_cleanup;
@@ -1147,10 +1148,15 @@ process_offload_section (void *data, const char *name, off_t offset, off_t len)
 }
 
 /* Callback used by a linker to check if the plugin will claim FILE. Writes
-   the result in CLAIMED. */
+   the result in CLAIMED.  If KNOWN_USED, the object is known by the linker
+   to be used, or an older API version is in use that does not provide that
+   information; otherwise, the linker is only determining whether this is
+   a plugin object and it should not be registered as having offload data if
+   not claimed by the plugin.  */
 
 static enum ld_plugin_status
-claim_file_handler (const struct ld_plugin_input_file *file, int *claimed)
+claim_file_handler_v2 (const struct ld_plugin_input_file *file, int *claimed,
+                      int known_used)
 {
   enum ld_plugin_status status;
   struct plugin_objfile obj;
@@ -1260,7 +1266,7 @@ claim_file_handler (const struct ld_plugin_input_file *file, int *claimed)
   if (*claimed && obj.offload == 0 && offload_files_last_lto == NULL)
     offload_files_last_lto = offload_files_last;
 
-  if (obj.offload == 1)
+  if (obj.offload && (known_used || obj.found > 0))
     {
       /* Add file to the list.  The order must be exactly the same as the final
         order after recompilation and linking, otherwise host and target tables
@@ -1321,6 +1327,15 @@ claim_file_handler (const struct ld_plugin_input_file *file, int *claimed)
   return LDPS_OK;
 }
 
+/* Callback used by a linker to check if the plugin will claim FILE. Writes
+   the result in CLAIMED. */
+
+static enum ld_plugin_status
+claim_file_handler (const struct ld_plugin_input_file *file, int *claimed)
+{
+  return claim_file_handler_v2 (file, claimed, true);
+}
+
 /* Parse the plugin options. */
 
 static void
@@ -1400,6 +1415,9 @@ onload (struct ld_plugin_tv *tv)
        case LDPT_REGISTER_CLAIM_FILE_HOOK:
          register_claim_file = p->tv_u.tv_register_claim_file;
          break;
+       case LDPT_REGISTER_CLAIM_FILE_HOOK_V2:
+         register_claim_file_v2 = p->tv_u.tv_register_claim_file_v2;
+         break;
        case LDPT_ADD_SYMBOLS_V2:
          add_symbols_v2 = p->tv_u.tv_add_symbols;
          break;
@@ -1450,6 +1468,13 @@ onload (struct ld_plugin_tv *tv)
   check (status == LDPS_OK, LDPL_FATAL,
         "could not register the claim_file callback");
 
+  if (register_claim_file_v2)
+    {
+      status = register_claim_file_v2 (claim_file_handler_v2);
+      check (status == LDPS_OK, LDPL_FATAL,
+            "could not register the claim_file_v2 callback");
+    }
+
   if (register_cleanup)
     {
       status = register_cleanup (cleanup_handler);