gcc/plugin.c

   1 /* Support for GCC plugin mechanism.
   2    Copyright (C) 2009-2014 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 3, or (at your option)
   9 any later version.
  10
  11 GCC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 /* This file contains the support for GCC plugin mechanism based on the
  21    APIs described in doc/plugin.texi.  */
  22
  23 #include "config.h"
  24 #include "system.h"
  25 #include "coretypes.h"
  26 #include "hash-table.h"
  27 #include "diagnostic-core.h"
  28 #include "tree.h"
  29 #include "tree-pass.h"
  30 #include "intl.h"
  31 #include "plugin.h"
  32 #include "ggc.h"
  33
  34 #ifdef ENABLE_PLUGIN
  35 #include "plugin-version.h"
  36 #endif
  37
  38 #define GCC_PLUGIN_STRINGIFY0(X) #X
  39 #define GCC_PLUGIN_STRINGIFY1(X) GCC_PLUGIN_STRINGIFY0 (X)
  40
  41 /* Event names as strings.  Keep in sync with enum plugin_event.  */
  42 static const char *plugin_event_name_init[] =
  43 {
  44 # define DEFEVENT(NAME) GCC_PLUGIN_STRINGIFY1 (NAME),
  45 # include "plugin.def"
  46 # undef DEFEVENT
  47 };
  48
  49 /* A printf format large enough for the largest event above.  */
  50 #define FMT_FOR_PLUGIN_EVENT "%-32s"
  51
  52 const char **plugin_event_name = plugin_event_name_init;
  53
  54 /* Event hashtable helpers.  */
  55
  56 struct event_hasher : typed_noop_remove <const char *>
  57 {
  58   typedef const char *value_type;
  59   typedef const char *compare_type;
  60   static inline hashval_t hash (const value_type *);
  61   static inline bool equal (const value_type *, const compare_type *);
  62 };
  63
  64 /* Helper function for the event hash table that hashes the entry V.  */
  65
  66 inline hashval_t
  67 event_hasher::hash (const value_type *v)
  68 {
  69   return htab_hash_string (*v);
  70 }
  71
  72 /* Helper function for the event hash table that compares the name of an
  73    existing entry (S1) with the given string (S2).  */
  74
  75 inline bool
  76 event_hasher::equal (const value_type *s1, const compare_type *s2)
  77 {
  78   return !strcmp (*s1, *s2);
  79 }
  80
  81 /* A hash table to map event names to the position of the names in the
  82    plugin_event_name table.  */
  83 static hash_table<event_hasher> *event_tab;
  84
  85 /* Keep track of the limit of allocated events and space ready for
  86    allocating events.  */
  87 static int event_last = PLUGIN_EVENT_FIRST_DYNAMIC;
  88 static int event_horizon = PLUGIN_EVENT_FIRST_DYNAMIC;
  89
  90 /* Hash table for the plugin_name_args objects created during command-line
  91    parsing.  */
  92 static htab_t plugin_name_args_tab = NULL;
  93
  94 /* List node for keeping track of plugin-registered callback.  */
  95 struct callback_info
  96 {
  97   const char *plugin_name;   /* Name of plugin that registers the callback.  */
  98   plugin_callback_func func; /* Callback to be called.  */
  99   void *user_data;           /* plugin-specified data.  */
 100   struct callback_info *next;
 101 };
 102
 103 /* An array of lists of 'callback_info' objects indexed by the event id.  */
 104 static struct callback_info *plugin_callbacks_init[PLUGIN_EVENT_FIRST_DYNAMIC];
 105 static struct callback_info **plugin_callbacks = plugin_callbacks_init;
 106
 107 /* For invoke_plugin_callbacks(), see plugin.h.  */
 108 bool flag_plugin_added = false;
 109
 110 #ifdef ENABLE_PLUGIN
 111 /* Each plugin should define an initialization function with exactly
 112    this name.  */
 113 static const char *str_plugin_init_func_name = "plugin_init";
 114
 115 /* Each plugin should define this symbol to assert that it is
 116    distributed under a GPL-compatible license.  */
 117 static const char *str_license = "plugin_is_GPL_compatible";
 118 #endif
 119
 120 /* Helper function for the hash table that compares the base_name of the
 121    existing entry (S1) with the given string (S2).  */
 122
 123 static int
 124 htab_str_eq (const void *s1, const void *s2)
 125 {
 126   const struct plugin_name_args *plugin = (const struct plugin_name_args *) s1;
 127   return !strcmp (plugin->base_name, (const char *) s2);
 128 }
 129
 130
 131 /* Given a plugin's full-path name FULL_NAME, e.g. /pass/to/NAME.so,
 132    return NAME.  */
 133
 134 static char *
 135 get_plugin_base_name (const char *full_name)
 136 {
 137   /* First get the base name part of the full-path name, i.e. NAME.so.  */
 138   char *base_name = xstrdup (lbasename (full_name));
 139
 140   /* Then get rid of '.so' part of the name.  */
 141   strip_off_ending (base_name, strlen (base_name));
 142
 143   return base_name;
 144 }
 145
 146
 147 /* Create a plugin_name_args object for the given plugin and insert it
 148    to the hash table. This function is called when
 149    -fplugin=/path/to/NAME.so or -fplugin=NAME option is processed.  */
 150
 151 void
 152 add_new_plugin (const char* plugin_name)
 153 {
 154   struct plugin_name_args *plugin;
 155   void **slot;
 156   char *base_name;
 157   bool name_is_short;
 158   const char *pc;
 159
 160   flag_plugin_added = true;
 161
 162   /* Replace short names by their full path when relevant.  */
 163   name_is_short  = !IS_ABSOLUTE_PATH (plugin_name);
 164   for (pc = plugin_name; name_is_short && *pc; pc++)
 165     if (*pc == '.' || IS_DIR_SEPARATOR (*pc))
 166       name_is_short = false;
 167
 168   if (name_is_short)
 169     {
 170       base_name = CONST_CAST (char*, plugin_name);
 171       /* FIXME: the ".so" suffix is currently builtin, since plugins
 172          only work on ELF host systems like e.g. Linux or Solaris.
 173          When plugins shall be available on non ELF systems such as
 174          Windows or MacOS, this code has to be greatly improved.  */
 175       plugin_name = concat (default_plugin_dir_name (), "/",
 176                             plugin_name, ".so", NULL);
 177       if (access (plugin_name, R_OK))
 178         fatal_error
 179           ("inaccessible plugin file %s expanded from short plugin name %s: %m",
 180            plugin_name, base_name);
 181     }
 182   else
 183     base_name = get_plugin_base_name (plugin_name);
 184
 185   /* If this is the first -fplugin= option we encounter, create
 186      'plugin_name_args_tab' hash table.  */
 187   if (!plugin_name_args_tab)
 188     plugin_name_args_tab = htab_create (10, htab_hash_string, htab_str_eq,
 189                                         NULL);
 190
 191   slot = htab_find_slot (plugin_name_args_tab, base_name, INSERT);
 192
 193   /* If the same plugin (name) has been specified earlier, either emit an
 194      error or a warning message depending on if they have identical full
 195      (path) names.  */
 196   if (*slot)
 197     {
 198       plugin = (struct plugin_name_args *) *slot;
 199       if (strcmp (plugin->full_name, plugin_name))
 200         error ("plugin %s was specified with different paths:\n%s\n%s",
 201                plugin->base_name, plugin->full_name, plugin_name);
 202       return;
 203     }
 204
 205   plugin = XCNEW (struct plugin_name_args);
 206   plugin->base_name = base_name;
 207   plugin->full_name = plugin_name;
 208
 209   *slot = plugin;
 210 }
 211
 212
 213 /* Parse the -fplugin-arg-<name>-<key>[=<value>] option and create a
 214    'plugin_argument' object for the parsed key-value pair. ARG is
 215    the <name>-<key>[=<value>] part of the option.  */
 216
 217 void
 218 parse_plugin_arg_opt (const char *arg)
 219 {
 220   size_t len = 0, name_len = 0, key_len = 0, value_len = 0;
 221   const char *ptr, *name_start = arg, *key_start = NULL, *value_start = NULL;
 222   char *name, *key, *value;
 223   void **slot;
 224   bool name_parsed = false, key_parsed = false;
 225
 226   /* Iterate over the ARG string and identify the starting character position
 227      of 'name', 'key', and 'value' and their lengths.  */
 228   for (ptr = arg; *ptr; ++ptr)
 229     {
 230       /* Only the first '-' encountered is considered a separator between
 231          'name' and 'key'. All the subsequent '-'s are considered part of
 232          'key'. For example, given -fplugin-arg-foo-bar-primary-key=value,
 233          the plugin name is 'foo' and the key is 'bar-primary-key'.  */
 234       if (*ptr == '-' && !name_parsed)
 235         {
 236           name_len = len;
 237           len = 0;
 238           key_start = ptr + 1;
 239           name_parsed = true;
 240           continue;
 241         }
 242       else if (*ptr == '=')
 243         {
 244           if (!key_parsed)
 245             {
 246               key_len = len;
 247               len = 0;
 248               value_start = ptr + 1;
 249               key_parsed = true;
 250             }
 251           continue;
 252         }
 253       else
 254         ++len;
 255     }
 256
 257   if (!key_start)
 258     {
 259       error ("malformed option -fplugin-arg-%s (missing -<key>[=<value>])",
 260              arg);
 261       return;
 262     }
 263
 264   /* If the option doesn't contain the 'value' part, LEN is the KEY_LEN.
 265      Otherwise, it is the VALUE_LEN.  */
 266   if (!value_start)
 267     key_len = len;
 268   else
 269     value_len = len;
 270
 271   name = XNEWVEC (char, name_len + 1);
 272   strncpy (name, name_start, name_len);
 273   name[name_len] = '\0';
 274
 275   /* Check if the named plugin has already been specified earlier in the
 276      command-line.  */
 277   if (plugin_name_args_tab
 278       && ((slot = htab_find_slot (plugin_name_args_tab, name, NO_INSERT))
 279           != NULL))
 280     {
 281       struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;
 282
 283       key = XNEWVEC (char, key_len + 1);
 284       strncpy (key, key_start, key_len);
 285       key[key_len] = '\0';
 286       if (value_start)
 287         {
 288           value = XNEWVEC (char, value_len + 1);
 289           strncpy (value, value_start, value_len);
 290           value[value_len] = '\0';
 291         }
 292       else
 293         value = NULL;
 294
 295       /* Create a plugin_argument object for the parsed key-value pair.
 296          If there are already arguments for this plugin, we will need to
 297          adjust the argument array size by creating a new array and deleting
 298          the old one. If the performance ever becomes an issue, we can
 299          change the code by pre-allocating a larger array first.  */
 300       if (plugin->argc > 0)
 301         {
 302           struct plugin_argument *args = XNEWVEC (struct plugin_argument,
 303                                                   plugin->argc + 1);
 304           memcpy (args, plugin->argv,
 305                   sizeof (struct plugin_argument) * plugin->argc);
 306           XDELETEVEC (plugin->argv);
 307           plugin->argv = args;
 308           ++plugin->argc;
 309         }
 310       else
 311         {
 312           gcc_assert (plugin->argv == NULL);
 313           plugin->argv = XNEWVEC (struct plugin_argument, 1);
 314           plugin->argc = 1;
 315         }
 316
 317       plugin->argv[plugin->argc - 1].key = key;
 318       plugin->argv[plugin->argc - 1].value = value;
 319     }
 320   else
 321     error ("plugin %s should be specified before -fplugin-arg-%s "
 322            "in the command line", name, arg);
 323
 324   /* We don't need the plugin's name anymore. Just release it.  */
 325   XDELETEVEC (name);
 326 }
 327
 328 /* Register additional plugin information. NAME is the name passed to
 329    plugin_init. INFO is the information that should be registered. */
 330
 331 static void
 332 register_plugin_info (const char* name, struct plugin_info *info)
 333 {
 334   void **slot = htab_find_slot (plugin_name_args_tab, name, NO_INSERT);
 335   struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;
 336   plugin->version = info->version;
 337   plugin->help = info->help;
 338 }
 339
 340 /* Look up the event id for NAME.  If the name is not found, return -1
 341    if INSERT is NO_INSERT.  */
 342
 343 int
 344 get_named_event_id (const char *name, enum insert_option insert)
 345 {
 346   const char ***slot;
 347
 348   if (!event_tab)
 349     {
 350       int i;
 351
 352       event_tab = new hash_table<event_hasher> (150);
 353       for (i = 0; i < event_last; i++)
 354         {
 355           slot = event_tab->find_slot (&plugin_event_name[i], INSERT);
 356           gcc_assert (*slot == HTAB_EMPTY_ENTRY);
 357           *slot = &plugin_event_name[i];
 358         }
 359     }
 360   slot = event_tab->find_slot (&name, insert);
 361   if (slot == NULL)
 362     return -1;
 363   if (*slot != HTAB_EMPTY_ENTRY)
 364     return *slot - &plugin_event_name[0];
 365
 366   if (event_last >= event_horizon)
 367     {
 368       event_horizon = event_last * 2;
 369       if (plugin_event_name == plugin_event_name_init)
 370         {
 371           plugin_event_name = XNEWVEC (const char *, event_horizon);
 372           memcpy (plugin_event_name, plugin_event_name_init,
 373                   sizeof plugin_event_name_init);
 374           plugin_callbacks = XNEWVEC (struct callback_info *, event_horizon);
 375           memcpy (plugin_callbacks, plugin_callbacks_init,
 376                   sizeof plugin_callbacks_init);
 377         }
 378       else
 379         {
 380           plugin_event_name
 381             = XRESIZEVEC (const char *, plugin_event_name, event_horizon);
 382           plugin_callbacks = XRESIZEVEC (struct callback_info *,
 383                                          plugin_callbacks, event_horizon);
 384         }
 385       /* All the pointers in the hash table will need to be updated.  */
 386       delete event_tab;
 387       event_tab = NULL;
 388     }
 389   else
 390     *slot = &plugin_event_name[event_last];
 391   plugin_event_name[event_last] = name;
 392   return event_last++;
 393 }
 394
 395 /* Called from the plugin's initialization code. Register a single callback.
 396    This function can be called multiple times.
 397
 398    PLUGIN_NAME - display name for this plugin
 399    EVENT       - which event the callback is for
 400    CALLBACK    - the callback to be called at the event
 401    USER_DATA   - plugin-provided data   */
 402
 403 void
 404 register_callback (const char *plugin_name,
 405                    int event,
 406                    plugin_callback_func callback,
 407                    void *user_data)
 408 {
 409   switch (event)
 410     {
 411       case PLUGIN_PASS_MANAGER_SETUP:
 412         gcc_assert (!callback);
 413         register_pass ((struct register_pass_info *) user_data);
 414         break;
 415       case PLUGIN_INFO:
 416         gcc_assert (!callback);
 417         register_plugin_info (plugin_name, (struct plugin_info *) user_data);
 418         break;
 419       case PLUGIN_REGISTER_GGC_ROOTS:
 420         gcc_assert (!callback);
 421         ggc_register_root_tab ((const struct ggc_root_tab*) user_data);
 422         break;
 423       case PLUGIN_EVENT_FIRST_DYNAMIC:
 424       default:
 425         if (event < PLUGIN_EVENT_FIRST_DYNAMIC || event >= event_last)
 426           {
 427             error ("unknown callback event registered by plugin %s",
 428                    plugin_name);
 429             return;
 430           }
 431       /* Fall through.  */
 432       case PLUGIN_FINISH_TYPE:
 433       case PLUGIN_FINISH_DECL:
 434       case PLUGIN_START_UNIT:
 435       case PLUGIN_FINISH_UNIT:
 436       case PLUGIN_PRE_GENERICIZE:
 437       case PLUGIN_GGC_START:
 438       case PLUGIN_GGC_MARKING:
 439       case PLUGIN_GGC_END:
 440       case PLUGIN_ATTRIBUTES:
 441       case PLUGIN_PRAGMAS:
 442       case PLUGIN_FINISH:
 443       case PLUGIN_ALL_PASSES_START:
 444       case PLUGIN_ALL_PASSES_END:
 445       case PLUGIN_ALL_IPA_PASSES_START:
 446       case PLUGIN_ALL_IPA_PASSES_END:
 447       case PLUGIN_OVERRIDE_GATE:
 448       case PLUGIN_PASS_EXECUTION:
 449       case PLUGIN_EARLY_GIMPLE_PASSES_START:
 450       case PLUGIN_EARLY_GIMPLE_PASSES_END:
 451       case PLUGIN_NEW_PASS:
 452       case PLUGIN_INCLUDE_FILE:
 453         {
 454           struct callback_info *new_callback;
 455           if (!callback)
 456             {
 457               error ("plugin %s registered a null callback function "
 458                      "for event %s", plugin_name, plugin_event_name[event]);
 459               return;
 460             }
 461           new_callback = XNEW (struct callback_info);
 462           new_callback->plugin_name = plugin_name;
 463           new_callback->func = callback;
 464           new_callback->user_data = user_data;
 465           new_callback->next = plugin_callbacks[event];
 466           plugin_callbacks[event] = new_callback;
 467         }
 468         break;
 469     }
 470 }
 471
 472 /* Remove a callback for EVENT which has been registered with for a plugin
 473    PLUGIN_NAME.  Return PLUGEVT_SUCCESS if a matching callback was
 474    found & removed, PLUGEVT_NO_CALLBACK if the event does not have a matching
 475    callback, and PLUGEVT_NO_SUCH_EVENT if EVENT is invalid.  */
 476 int
 477 unregister_callback (const char *plugin_name, int event)
 478 {
 479   struct callback_info *callback, **cbp;
 480
 481   if (event >= event_last)
 482     return PLUGEVT_NO_SUCH_EVENT;
 483
 484   for (cbp = &plugin_callbacks[event]; (callback = *cbp); cbp = &callback->next)
 485     if (strcmp (callback->plugin_name, plugin_name) == 0)
 486       {
 487         *cbp = callback->next;
 488         return PLUGEVT_SUCCESS;
 489       }
 490   return PLUGEVT_NO_CALLBACK;
 491 }
 492
 493 /* Invoke all plugin callbacks registered with the specified event,
 494    called from invoke_plugin_callbacks().  */
 495
 496 int
 497 invoke_plugin_callbacks_full (int event, void *gcc_data)
 498 {
 499   int retval = PLUGEVT_SUCCESS;
 500
 501   timevar_push (TV_PLUGIN_RUN);
 502
 503   switch (event)
 504     {
 505       case PLUGIN_EVENT_FIRST_DYNAMIC:
 506       default:
 507         gcc_assert (event >= PLUGIN_EVENT_FIRST_DYNAMIC);
 508         gcc_assert (event < event_last);
 509       /* Fall through.  */
 510       case PLUGIN_FINISH_TYPE:
 511       case PLUGIN_FINISH_DECL:
 512       case PLUGIN_START_UNIT:
 513       case PLUGIN_FINISH_UNIT:
 514       case PLUGIN_PRE_GENERICIZE:
 515       case PLUGIN_ATTRIBUTES:
 516       case PLUGIN_PRAGMAS:
 517       case PLUGIN_FINISH:
 518       case PLUGIN_GGC_START:
 519       case PLUGIN_GGC_MARKING:
 520       case PLUGIN_GGC_END:
 521       case PLUGIN_ALL_PASSES_START:
 522       case PLUGIN_ALL_PASSES_END:
 523       case PLUGIN_ALL_IPA_PASSES_START:
 524       case PLUGIN_ALL_IPA_PASSES_END:
 525       case PLUGIN_OVERRIDE_GATE:
 526       case PLUGIN_PASS_EXECUTION:
 527       case PLUGIN_EARLY_GIMPLE_PASSES_START:
 528       case PLUGIN_EARLY_GIMPLE_PASSES_END:
 529       case PLUGIN_NEW_PASS:
 530       case PLUGIN_INCLUDE_FILE:
 531         {
 532           /* Iterate over every callback registered with this event and
 533              call it.  */
 534           struct callback_info *callback = plugin_callbacks[event];
 535
 536           if (!callback)
 537             retval = PLUGEVT_NO_CALLBACK;
 538           for ( ; callback; callback = callback->next)
 539             (*callback->func) (gcc_data, callback->user_data);
 540         }
 541         break;
 542
 543       case PLUGIN_PASS_MANAGER_SETUP:
 544       case PLUGIN_REGISTER_GGC_ROOTS:
 545         gcc_assert (false);
 546     }
 547
 548   timevar_pop (TV_PLUGIN_RUN);
 549   return retval;
 550 }
 551
 552 #ifdef ENABLE_PLUGIN
 553 /* We need a union to cast dlsym return value to a function pointer
 554    as ISO C forbids assignment between function pointer and 'void *'.
 555    Use explicit union instead of __extension__(<union_cast>) for
 556    portability.  */
 557 #define PTR_UNION_TYPE(TOTYPE) union { void *_q; TOTYPE _nq; }
 558 #define PTR_UNION_AS_VOID_PTR(NAME) (NAME._q)
 559 #define PTR_UNION_AS_CAST_PTR(NAME) (NAME._nq)
 560
 561 /* Try to initialize PLUGIN. Return true if successful. */
 562
 563 static bool
 564 try_init_one_plugin (struct plugin_name_args *plugin)
 565 {
 566   void *dl_handle;
 567   plugin_init_func plugin_init;
 568   const char *err;
 569   PTR_UNION_TYPE (plugin_init_func) plugin_init_union;
 570
 571   /* We use RTLD_NOW to accelerate binding and detect any mismatch
 572      between the API expected by the plugin and the GCC API; we use
 573      RTLD_GLOBAL which is useful to plugins which themselves call
 574      dlopen.  */
 575   dl_handle = dlopen (plugin->full_name, RTLD_NOW | RTLD_GLOBAL);
 576   if (!dl_handle)
 577     {
 578       error ("cannot load plugin %s\n%s", plugin->full_name, dlerror ());
 579       return false;
 580     }
 581
 582   /* Clear any existing error.  */
 583   dlerror ();
 584
 585   /* Check the plugin license.  */
 586   if (dlsym (dl_handle, str_license) == NULL)
 587     fatal_error ("plugin %s is not licensed under a GPL-compatible license\n"
 588                  "%s", plugin->full_name, dlerror ());
 589
 590   PTR_UNION_AS_VOID_PTR (plugin_init_union) =
 591       dlsym (dl_handle, str_plugin_init_func_name);
 592   plugin_init = PTR_UNION_AS_CAST_PTR (plugin_init_union);
 593
 594   if ((err = dlerror ()) != NULL)
 595     {
 596       error ("cannot find %s in plugin %s\n%s", str_plugin_init_func_name,
 597              plugin->full_name, err);
 598       return false;
 599     }
 600
 601   /* Call the plugin-provided initialization routine with the arguments.  */
 602   if ((*plugin_init) (plugin, &gcc_version))
 603     {
 604       error ("fail to initialize plugin %s", plugin->full_name);
 605       return false;
 606     }
 607
 608   return true;
 609 }
 610
 611
 612 /* Routine to dlopen and initialize one plugin. This function is passed to
 613    (and called by) the hash table traverse routine. Return 1 for the
 614    htab_traverse to continue scan, 0 to stop.
 615
 616    SLOT - slot of the hash table element
 617    INFO - auxiliary pointer handed to hash table traverse routine
 618           (unused in this function)  */
 619
 620 static int
 621 init_one_plugin (void **slot, void * ARG_UNUSED (info))
 622 {
 623   struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;
 624   bool ok = try_init_one_plugin (plugin);
 625   if (!ok)
 626     {
 627       htab_remove_elt (plugin_name_args_tab, plugin->base_name);
 628       XDELETE (plugin);
 629     }
 630   return 1;
 631 }
 632
 633 #endif  /* ENABLE_PLUGIN  */
 634
 635 /* Main plugin initialization function.  Called from compile_file() in
 636    toplev.c.  */
 637
 638 void
 639 initialize_plugins (void)
 640 {
 641   /* If no plugin was specified in the command-line, simply return.  */
 642   if (!plugin_name_args_tab)
 643     return;
 644
 645   timevar_push (TV_PLUGIN_INIT);
 646
 647 #ifdef ENABLE_PLUGIN
 648   /* Traverse and initialize each plugin specified in the command-line.  */
 649   htab_traverse_noresize (plugin_name_args_tab, init_one_plugin, NULL);
 650 #endif
 651
 652   timevar_pop (TV_PLUGIN_INIT);
 653 }
 654
 655 /* Release memory used by one plugin. */
 656
 657 static int
 658 finalize_one_plugin (void **slot, void * ARG_UNUSED (info))
 659 {
 660   struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;
 661   XDELETE (plugin);
 662   return 1;
 663 }
 664
 665 /* Free memory allocated by the plugin system. */
 666
 667 void
 668 finalize_plugins (void)
 669 {
 670   if (!plugin_name_args_tab)
 671     return;
 672
 673   /* We can now delete the plugin_name_args object as it will no longer
 674      be used. Note that base_name and argv fields (both of which were also
 675      dynamically allocated) are not freed as they could still be used by
 676      the plugin code.  */
 677
 678   htab_traverse_noresize (plugin_name_args_tab, finalize_one_plugin, NULL);
 679
 680   /* PLUGIN_NAME_ARGS_TAB is no longer needed, just delete it.  */
 681   htab_delete (plugin_name_args_tab);
 682   plugin_name_args_tab = NULL;
 683 }
 684
 685 /* Used to pass options to htab_traverse callbacks. */
 686
 687 struct print_options
 688 {
 689   FILE *file;
 690   const char *indent;
 691 };
 692
 693 /* Print the version of one plugin. */
 694
 695 static int
 696 print_version_one_plugin (void **slot, void *data)
 697 {
 698   struct print_options *opt = (struct print_options *) data;
 699   struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;
 700   const char *version = plugin->version ? plugin->version : "Unknown version.";
 701
 702   fprintf (opt->file, " %s%s: %s\n", opt->indent, plugin->base_name, version);
 703   return 1;
 704 }
 705
 706 /* Print the version of each plugin. */
 707
 708 void
 709 print_plugins_versions (FILE *file, const char *indent)
 710 {
 711   struct print_options opt;
 712   opt.file = file;
 713   opt.indent = indent;
 714   if (!plugin_name_args_tab || htab_elements (plugin_name_args_tab) == 0)
 715     return;
 716
 717   fprintf (file, "%sVersions of loaded plugins:\n", indent);
 718   htab_traverse_noresize (plugin_name_args_tab, print_version_one_plugin, &opt);
 719 }
 720
 721 /* Print help for one plugin. SLOT is the hash table slot. DATA is the
 722    argument to htab_traverse_noresize. */
 723
 724 static int
 725 print_help_one_plugin (void **slot, void *data)
 726 {
 727   struct print_options *opt = (struct print_options *) data;
 728   struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;
 729   const char *help = plugin->help ? plugin->help : "No help available .";
 730
 731   char *dup = xstrdup (help);
 732   char *p, *nl;
 733   fprintf (opt->file, " %s%s:\n", opt->indent, plugin->base_name);
 734
 735   for (p = nl = dup; nl; p = nl)
 736     {
 737       nl = strchr (nl, '\n');
 738       if (nl)
 739         {
 740           *nl = '\0';
 741           nl++;
 742         }
 743       fprintf (opt->file, "   %s %s\n", opt->indent, p);
 744     }
 745
 746   free (dup);
 747   return 1;
 748 }
 749
 750 /* Print help for each plugin. The output goes to FILE and every line starts
 751    with INDENT. */
 752
 753 void
 754 print_plugins_help (FILE *file, const char *indent)
 755 {
 756   struct print_options opt;
 757   opt.file = file;
 758   opt.indent = indent;
 759   if (!plugin_name_args_tab || htab_elements (plugin_name_args_tab) == 0)
 760     return;
 761
 762   fprintf (file, "%sHelp for the loaded plugins:\n", indent);
 763   htab_traverse_noresize (plugin_name_args_tab, print_help_one_plugin, &opt);
 764 }
 765
 766
 767 /* Return true if plugins have been loaded.  */
 768
 769 bool
 770 plugins_active_p (void)
 771 {
 772   int event;
 773
 774   for (event = PLUGIN_PASS_MANAGER_SETUP; event < event_last; event++)
 775     if (plugin_callbacks[event])
 776       return true;
 777
 778   return false;
 779 }
 780
 781
 782 /* Dump to FILE the names and associated events for all the active
 783    plugins.  */
 784
 785 DEBUG_FUNCTION void
 786 dump_active_plugins (FILE *file)
 787 {
 788   int event;
 789
 790   if (!plugins_active_p ())
 791     return;
 792
 793   fprintf (file, FMT_FOR_PLUGIN_EVENT " | %s\n", _("Event"), _("Plugins"));
 794   for (event = PLUGIN_PASS_MANAGER_SETUP; event < event_last; event++)
 795     if (plugin_callbacks[event])
 796       {
 797         struct callback_info *ci;
 798
 799         fprintf (file, FMT_FOR_PLUGIN_EVENT " |", plugin_event_name[event]);
 800
 801         for (ci = plugin_callbacks[event]; ci; ci = ci->next)
 802           fprintf (file, " %s", ci->plugin_name);
 803
 804         putc ('\n', file);
 805       }
 806 }
 807
 808
 809 /* Dump active plugins to stderr.  */
 810
 811 DEBUG_FUNCTION void
 812 debug_active_plugins (void)
 813 {
 814   dump_active_plugins (stderr);
 815 }
 816
 817 /* Give a warning if plugins are present, before an ICE message asking
 818    to submit a bug report.  */
 819
 820 void
 821 warn_if_plugins (void)
 822 {
 823   if (plugins_active_p ())
 824     {
 825       fnotice (stderr, "*** WARNING *** there are active plugins, do not report"
 826                " this as a bug unless you can reproduce it without enabling"
 827                " any plugins.\n");
 828       dump_active_plugins (stderr);
 829     }
 830
 831 }
 832
 833 /* Likewise, as a callback from the diagnostics code.  */
 834
 835 void
 836 plugins_internal_error_function (diagnostic_context *context ATTRIBUTE_UNUSED,
 837                                  const char *msgid ATTRIBUTE_UNUSED,
 838                                  va_list *ap ATTRIBUTE_UNUSED)
 839 {
 840   warn_if_plugins ();
 841 }
 842
 843 /* The default version check. Compares every field in VERSION. */
 844
 845 bool
 846 plugin_default_version_check (struct plugin_gcc_version *gcc_version,
 847                               struct plugin_gcc_version *plugin_version)
 848 {
 849   if (!gcc_version || !plugin_version)
 850     return false;
 851
 852   if (strcmp (gcc_version->basever, plugin_version->basever))
 853     return false;
 854   if (strcmp (gcc_version->datestamp, plugin_version->datestamp))
 855     return false;
 856   if (strcmp (gcc_version->devphase, plugin_version->devphase))
 857     return false;
 858   if (strcmp (gcc_version->revision, plugin_version->revision))
 859     return false;
 860   if (strcmp (gcc_version->configuration_arguments,
 861               plugin_version->configuration_arguments))
 862     return false;
 863   return true;
 864 }
 865
 866
 867 /* Return the current value of event_last, so that plugins which provide
 868    additional functionality for events for the benefit of high-level plugins
 869    know how many valid entries plugin_event_name holds.  */
 870
 871 int
 872 get_event_last (void)
 873 {
 874   return event_last;
 875 }
 876
 877
 878 /* Retrieve the default plugin directory.  The gcc driver should have passed
 879    it as -iplugindir <dir> to the cc1 program, and it is queriable through the
 880    -print-file-name=plugin option to gcc.  */
 881 const char*
 882 default_plugin_dir_name (void)
 883 {
 884   if (!plugindir_string)
 885     fatal_error ("-iplugindir <dir> option not passed from the gcc driver");
 886   return plugindir_string;
 887 }