Subversion Repositories openrisc

/* Support for GCC plugin mechanism.

   Copyright (C) 2009, 2010, 2011 Free Software Foundation, Inc.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 3, or (at your option)

any later version.

GCC is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with GCC; see the file COPYING3.  If not see

<http://www.gnu.org/licenses/>.  */

/* This file contains the support for GCC plugin mechanism based on the

   APIs described in doc/plugin.texi.  */

#include "config.h"

#include "system.h"

#include "coretypes.h"

#include "diagnostic-core.h"

#include "tree.h"

#include "tree-pass.h"

#include "intl.h"

#include "plugin.h"

#include "timevar.h"

#include "ggc.h"

#ifdef ENABLE_PLUGIN

#include "plugin-version.h"

#endif

#define GCC_PLUGIN_STRINGIFY0(X) #X

#define GCC_PLUGIN_STRINGIFY1(X) GCC_PLUGIN_STRINGIFY0 (X)

/* Event names as strings.  Keep in sync with enum plugin_event.  */

static const char *plugin_event_name_init[] =

{

# define DEFEVENT(NAME) GCC_PLUGIN_STRINGIFY1 (NAME),

# include "plugin.def"

# undef DEFEVENT

};

/* A printf format large enough for the largest event above.  */

#define FMT_FOR_PLUGIN_EVENT "%-32s"

const char **plugin_event_name = plugin_event_name_init;

/* A hash table to map event names to the position of the names in the

   plugin_event_name table.  */

static htab_t event_tab;

/* Keep track of the limit of allocated events and space ready for

   allocating events.  */

static int event_last = PLUGIN_EVENT_FIRST_DYNAMIC;

static int event_horizon = PLUGIN_EVENT_FIRST_DYNAMIC;

/* Hash table for the plugin_name_args objects created during command-line

   parsing.  */

static htab_t plugin_name_args_tab = NULL;

/* List node for keeping track of plugin-registered callback.  */

struct callback_info

{

  const char *plugin_name;   /* Name of plugin that registers the callback.  */

  plugin_callback_func func; /* Callback to be called.  */

  void *user_data;           /* plugin-specified data.  */

  struct callback_info *next;

};

/* An array of lists of 'callback_info' objects indexed by the event id.  */

static struct callback_info *plugin_callbacks_init[PLUGIN_EVENT_FIRST_DYNAMIC];

static struct callback_info **plugin_callbacks = plugin_callbacks_init;

/* For invoke_plugin_callbacks(), see plugin.h.  */

bool flag_plugin_added = false;

#ifdef ENABLE_PLUGIN

/* Each plugin should define an initialization function with exactly

   this name.  */

static const char *str_plugin_init_func_name = "plugin_init";

/* Each plugin should define this symbol to assert that it is

   distributed under a GPL-compatible license.  */

static const char *str_license = "plugin_is_GPL_compatible";

#endif

/* Helper function for the hash table that compares the base_name of the

   existing entry (S1) with the given string (S2).  */

static int

htab_str_eq (const void *s1, const void *s2)

{

  const struct plugin_name_args *plugin = (const struct plugin_name_args *) s1;

  return !strcmp (plugin->base_name, (const char *) s2);

}

/* Given a plugin's full-path name FULL_NAME, e.g. /pass/to/NAME.so,

   return NAME.  */

static char *

get_plugin_base_name (const char *full_name)

{

  /* First get the base name part of the full-path name, i.e. NAME.so.  */

  char *base_name = xstrdup (lbasename (full_name));

  /* Then get rid of '.so' part of the name.  */

  strip_off_ending (base_name, strlen (base_name));

  return base_name;

}

/* Create a plugin_name_args object for the given plugin and insert it

   to the hash table. This function is called when

   -fplugin=/path/to/NAME.so or -fplugin=NAME option is processed.  */

void

add_new_plugin (const char* plugin_name)

{

  struct plugin_name_args *plugin;

  void **slot;

  char *base_name;

  bool name_is_short;

  const char *pc;

  flag_plugin_added = true;

  /* Replace short names by their full path when relevant.  */

  name_is_short  = !IS_ABSOLUTE_PATH (plugin_name);

  for (pc = plugin_name; name_is_short && *pc; pc++)

    if (*pc == '.' || IS_DIR_SEPARATOR (*pc))

      name_is_short = false;

  if (name_is_short)

    {

      base_name = CONST_CAST (char*, plugin_name);

      /* FIXME: the ".so" suffix is currently builtin, since plugins

         only work on ELF host systems like e.g. Linux or Solaris.

         When plugins shall be available on non ELF systems such as

         Windows or MacOS, this code has to be greatly improved.  */

      plugin_name = concat (default_plugin_dir_name (), "/",

                            plugin_name, ".so", NULL);

      if (access (plugin_name, R_OK))

        fatal_error

          ("inaccessible plugin file %s expanded from short plugin name %s: %m",

           plugin_name, base_name);

    }

  else

    base_name = get_plugin_base_name (plugin_name);

  /* If this is the first -fplugin= option we encounter, create

     'plugin_name_args_tab' hash table.  */

  if (!plugin_name_args_tab)

    plugin_name_args_tab = htab_create (10, htab_hash_string, htab_str_eq,

                                        NULL);

  slot = htab_find_slot (plugin_name_args_tab, base_name, INSERT);

  /* If the same plugin (name) has been specified earlier, either emit an

     error or a warning message depending on if they have identical full

     (path) names.  */

  if (*slot)

    {

      plugin = (struct plugin_name_args *) *slot;

      if (strcmp (plugin->full_name, plugin_name))

        error ("plugin %s was specified with different paths:\n%s\n%s",

               plugin->base_name, plugin->full_name, plugin_name);

      return;

    }

  plugin = XCNEW (struct plugin_name_args);

  plugin->base_name = base_name;

  plugin->full_name = plugin_name;

  *slot = plugin;

}

/* Parse the -fplugin-arg-<name>-<key>[=<value>] option and create a

   'plugin_argument' object for the parsed key-value pair. ARG is

   the <name>-<key>[=<value>] part of the option.  */

void

parse_plugin_arg_opt (const char *arg)

{

  size_t len = 0, name_len = 0, key_len = 0, value_len = 0;

  const char *ptr, *name_start = arg, *key_start = NULL, *value_start = NULL;

  char *name, *key, *value;

  void **slot;

  bool name_parsed = false, key_parsed = false;

  /* Iterate over the ARG string and identify the starting character position

     of 'name', 'key', and 'value' and their lengths.  */

  for (ptr = arg; *ptr; ++ptr)

    {

      /* Only the first '-' encountered is considered a separator between

         'name' and 'key'. All the subsequent '-'s are considered part of

         'key'. For example, given -fplugin-arg-foo-bar-primary-key=value,

         the plugin name is 'foo' and the key is 'bar-primary-key'.  */

      if (*ptr == '-' && !name_parsed)

        {

          name_len = len;

          len = 0;

          key_start = ptr + 1;

          name_parsed = true;

          continue;

        }

      else if (*ptr == '=')

        {

          if (key_parsed)

            {

              error ("malformed option -fplugin-arg-%s (multiple '=' signs)",

                     arg);

              return;

            }

          key_len = len;

          len = 0;

          value_start = ptr + 1;

          key_parsed = true;

          continue;

        }

      else

        ++len;

    }

  if (!key_start)

    {

      error ("malformed option -fplugin-arg-%s (missing -<key>[=<value>])",

             arg);

      return;

    }

  /* If the option doesn't contain the 'value' part, LEN is the KEY_LEN.

     Otherwise, it is the VALUE_LEN.  */

  if (!value_start)

    key_len = len;

  else

    value_len = len;

  name = XNEWVEC (char, name_len + 1);

  strncpy (name, name_start, name_len);

  name[name_len] = '\0';

  /* Check if the named plugin has already been specified earlier in the

     command-line.  */

  if (plugin_name_args_tab

      && ((slot = htab_find_slot (plugin_name_args_tab, name, NO_INSERT))

          != NULL))

    {

      struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;

      key = XNEWVEC (char, key_len + 1);

      strncpy (key, key_start, key_len);

      key[key_len] = '\0';

      if (value_start)

        {

          value = XNEWVEC (char, value_len + 1);

          strncpy (value, value_start, value_len);

          value[value_len] = '\0';

        }

      else

        value = NULL;

      /* Create a plugin_argument object for the parsed key-value pair.

         If there are already arguments for this plugin, we will need to

         adjust the argument array size by creating a new array and deleting

         the old one. If the performance ever becomes an issue, we can

         change the code by pre-allocating a larger array first.  */

      if (plugin->argc > 0)

        {

          struct plugin_argument *args = XNEWVEC (struct plugin_argument,

                                                  plugin->argc + 1);

          memcpy (args, plugin->argv,

                  sizeof (struct plugin_argument) * plugin->argc);

          XDELETEVEC (plugin->argv);

          plugin->argv = args;

          ++plugin->argc;

        }

      else

        {

          gcc_assert (plugin->argv == NULL);

          plugin->argv = XNEWVEC (struct plugin_argument, 1);

          plugin->argc = 1;

        }

      plugin->argv[plugin->argc - 1].key = key;

      plugin->argv[plugin->argc - 1].value = value;

    }

  else

    error ("plugin %s should be specified before -fplugin-arg-%s "

           "in the command line", name, arg);

  /* We don't need the plugin's name anymore. Just release it.  */

  XDELETEVEC (name);

}

/* Register additional plugin information. NAME is the name passed to

   plugin_init. INFO is the information that should be registered. */

static void

register_plugin_info (const char* name, struct plugin_info *info)

{

  void **slot = htab_find_slot (plugin_name_args_tab, name, NO_INSERT);

  struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;

  plugin->version = info->version;

  plugin->help = info->help;

}

/* Helper function for the event hash table that compares the name of an

   existing entry (E1) with the given string (S2).  */

static int

htab_event_eq (const void *e1, const void *s2)

{

  const char *s1= *(const char * const *) e1;

  return !strcmp (s1, (const char *) s2);

}

/* Look up the event id for NAME.  If the name is not found, return -1

   if INSERT is NO_INSERT.  */

int

get_named_event_id (const char *name, enum insert_option insert)

{

  void **slot;

  if (!event_tab)

    {

      int i;

      event_tab = htab_create (150, htab_hash_string, htab_event_eq, NULL);

      for (i = 0; i < event_last; i++)

        {

          slot = htab_find_slot (event_tab, plugin_event_name[i], INSERT);

          gcc_assert (*slot == HTAB_EMPTY_ENTRY);

          *slot = &plugin_event_name[i];

        }

    }

  slot = htab_find_slot (event_tab, name, insert);

  if (slot == NULL)

    return -1;

  if (*slot != HTAB_EMPTY_ENTRY)

    return (const char **) *slot - &plugin_event_name[0];

  if (event_last >= event_horizon)

    {

      event_horizon = event_last * 2;

      if (plugin_event_name == plugin_event_name_init)

        {

          plugin_event_name = XNEWVEC (const char *, event_horizon);

          memcpy (plugin_event_name, plugin_event_name_init,

                  sizeof plugin_event_name_init);

          plugin_callbacks = XNEWVEC (struct callback_info *, event_horizon);

          memcpy (plugin_callbacks, plugin_callbacks_init,

                  sizeof plugin_callbacks_init);

        }

      else

        {

          plugin_event_name

            = XRESIZEVEC (const char *, plugin_event_name, event_horizon);

          plugin_callbacks = XRESIZEVEC (struct callback_info *,

                                         plugin_callbacks, event_horizon);

        }

      /* All the pointers in the hash table will need to be updated.  */

      htab_delete (event_tab);

      event_tab = NULL;

    }

  else

    *slot = &plugin_event_name[event_last];

  plugin_event_name[event_last] = name;

  return event_last++;

}

/* Called from the plugin's initialization code. Register a single callback.

   This function can be called multiple times.

   PLUGIN_NAME - display name for this plugin

   EVENT       - which event the callback is for

   CALLBACK    - the callback to be called at the event

   USER_DATA   - plugin-provided data   */

void

register_callback (const char *plugin_name,

                   int event,

                   plugin_callback_func callback,

                   void *user_data)

{

  switch (event)

    {

      case PLUGIN_PASS_MANAGER_SETUP:

        gcc_assert (!callback);

        register_pass ((struct register_pass_info *) user_data);

        break;

      case PLUGIN_INFO:

        gcc_assert (!callback);

        register_plugin_info (plugin_name, (struct plugin_info *) user_data);

        break;

      case PLUGIN_REGISTER_GGC_ROOTS:

        gcc_assert (!callback);

        ggc_register_root_tab ((const struct ggc_root_tab*) user_data);

        break;

      case PLUGIN_REGISTER_GGC_CACHES:

        gcc_assert (!callback);

        ggc_register_cache_tab ((const struct ggc_cache_tab*) user_data);

        break;

      case PLUGIN_EVENT_FIRST_DYNAMIC:

      default:

        if (event < PLUGIN_EVENT_FIRST_DYNAMIC || event >= event_last)

          {

            error ("unknown callback event registered by plugin %s",

                   plugin_name);

            return;

          }

      /* Fall through.  */

      case PLUGIN_FINISH_TYPE:

      case PLUGIN_FINISH_DECL:

      case PLUGIN_START_UNIT:

      case PLUGIN_FINISH_UNIT:

      case PLUGIN_PRE_GENERICIZE:

      case PLUGIN_GGC_START:

      case PLUGIN_GGC_MARKING:

      case PLUGIN_GGC_END:

      case PLUGIN_ATTRIBUTES:

      case PLUGIN_PRAGMAS:

      case PLUGIN_FINISH:

      case PLUGIN_ALL_PASSES_START:

      case PLUGIN_ALL_PASSES_END:

      case PLUGIN_ALL_IPA_PASSES_START:

      case PLUGIN_ALL_IPA_PASSES_END:

      case PLUGIN_OVERRIDE_GATE:

      case PLUGIN_PASS_EXECUTION:

      case PLUGIN_EARLY_GIMPLE_PASSES_START:

      case PLUGIN_EARLY_GIMPLE_PASSES_END:

      case PLUGIN_NEW_PASS:

        {

          struct callback_info *new_callback;

          if (!callback)

            {

              error ("plugin %s registered a null callback function "

                     "for event %s", plugin_name, plugin_event_name[event]);

              return;

            }

          new_callback = XNEW (struct callback_info);

          new_callback->plugin_name = plugin_name;

          new_callback->func = callback;

          new_callback->user_data = user_data;

          new_callback->next = plugin_callbacks[event];

          plugin_callbacks[event] = new_callback;

        }

        break;

    }

}

/* Remove a callback for EVENT which has been registered with for a plugin

   PLUGIN_NAME.  Return PLUGEVT_SUCCESS if a matching callback was

   found & removed, PLUGEVT_NO_CALLBACK if the event does not have a matching

   callback, and PLUGEVT_NO_SUCH_EVENT if EVENT is invalid.  */

int

unregister_callback (const char *plugin_name, int event)

{

  struct callback_info *callback, **cbp;

  if (event >= event_last)

    return PLUGEVT_NO_SUCH_EVENT;

  for (cbp = &plugin_callbacks[event]; (callback = *cbp); cbp = &callback->next)

    if (strcmp (callback->plugin_name, plugin_name) == 0)

      {

        *cbp = callback->next;

        return PLUGEVT_SUCCESS;

      }

  return PLUGEVT_NO_CALLBACK;

}

/* Invoke all plugin callbacks registered with the specified event,

   called from invoke_plugin_callbacks().  */

int

invoke_plugin_callbacks_full (int event, void *gcc_data)

{

  int retval = PLUGEVT_SUCCESS;

  timevar_push (TV_PLUGIN_RUN);

  switch (event)

    {

      case PLUGIN_EVENT_FIRST_DYNAMIC:

      default:

        gcc_assert (event >= PLUGIN_EVENT_FIRST_DYNAMIC);

        gcc_assert (event < event_last);

      /* Fall through.  */

      case PLUGIN_FINISH_TYPE:

      case PLUGIN_FINISH_DECL:

      case PLUGIN_START_UNIT:

      case PLUGIN_FINISH_UNIT:

      case PLUGIN_PRE_GENERICIZE:

      case PLUGIN_ATTRIBUTES:

      case PLUGIN_PRAGMAS:

      case PLUGIN_FINISH:

      case PLUGIN_GGC_START:

      case PLUGIN_GGC_MARKING:

      case PLUGIN_GGC_END:

      case PLUGIN_ALL_PASSES_START:

      case PLUGIN_ALL_PASSES_END:

      case PLUGIN_ALL_IPA_PASSES_START:

      case PLUGIN_ALL_IPA_PASSES_END:

      case PLUGIN_OVERRIDE_GATE:

      case PLUGIN_PASS_EXECUTION:

      case PLUGIN_EARLY_GIMPLE_PASSES_START:

      case PLUGIN_EARLY_GIMPLE_PASSES_END:

      case PLUGIN_NEW_PASS:

        {

          /* Iterate over every callback registered with this event and

             call it.  */

          struct callback_info *callback = plugin_callbacks[event];

          if (!callback)

            retval = PLUGEVT_NO_CALLBACK;

          for ( ; callback; callback = callback->next)

            (*callback->func) (gcc_data, callback->user_data);

        }

        break;

      case PLUGIN_PASS_MANAGER_SETUP:

      case PLUGIN_REGISTER_GGC_ROOTS:

      case PLUGIN_REGISTER_GGC_CACHES:

        gcc_assert (false);

    }

  timevar_pop (TV_PLUGIN_RUN);

  return retval;

}

#ifdef ENABLE_PLUGIN

/* We need a union to cast dlsym return value to a function pointer

   as ISO C forbids assignment between function pointer and 'void *'.

   Use explicit union instead of __extension__(<union_cast>) for

   portability.  */

#define PTR_UNION_TYPE(TOTYPE) union { void *_q; TOTYPE _nq; }

#define PTR_UNION_AS_VOID_PTR(NAME) (NAME._q)

#define PTR_UNION_AS_CAST_PTR(NAME) (NAME._nq)

/* Try to initialize PLUGIN. Return true if successful. */

static bool

try_init_one_plugin (struct plugin_name_args *plugin)

{

  void *dl_handle;

  plugin_init_func plugin_init;

  const char *err;

  PTR_UNION_TYPE (plugin_init_func) plugin_init_union;

  /* We use RTLD_NOW to accelerate binding and detect any mismatch

     between the API expected by the plugin and the GCC API; we use

     RTLD_GLOBAL which is useful to plugins which themselves call

     dlopen.  */

  dl_handle = dlopen (plugin->full_name, RTLD_NOW | RTLD_GLOBAL);

  if (!dl_handle)

    {

      error ("cannot load plugin %s\n%s", plugin->full_name, dlerror ());

      return false;

    }

  /* Clear any existing error.  */

  dlerror ();

  /* Check the plugin license.  */

  if (dlsym (dl_handle, str_license) == NULL)

    fatal_error ("plugin %s is not licensed under a GPL-compatible license\n"

                 "%s", plugin->full_name, dlerror ());

  PTR_UNION_AS_VOID_PTR (plugin_init_union) =

      dlsym (dl_handle, str_plugin_init_func_name);

  plugin_init = PTR_UNION_AS_CAST_PTR (plugin_init_union);

  if ((err = dlerror ()) != NULL)

    {

      error ("cannot find %s in plugin %s\n%s", str_plugin_init_func_name,

             plugin->full_name, err);

      return false;

    }

  /* Call the plugin-provided initialization routine with the arguments.  */

  if ((*plugin_init) (plugin, &gcc_version))

    {

      error ("fail to initialize plugin %s", plugin->full_name);

      return false;

    }

  return true;

}

/* Routine to dlopen and initialize one plugin. This function is passed to

   (and called by) the hash table traverse routine. Return 1 for the

   htab_traverse to continue scan, 0 to stop.

   SLOT - slot of the hash table element

   INFO - auxiliary pointer handed to hash table traverse routine

          (unused in this function)  */

static int

init_one_plugin (void **slot, void * ARG_UNUSED (info))

{

  struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;

  bool ok = try_init_one_plugin (plugin);

  if (!ok)

    {

      htab_remove_elt (plugin_name_args_tab, plugin->base_name);

      XDELETE (plugin);

    }

  return 1;

}

#endif  /* ENABLE_PLUGIN  */

/* Main plugin initialization function.  Called from compile_file() in

   toplev.c.  */

void

initialize_plugins (void)

{

  /* If no plugin was specified in the command-line, simply return.  */

  if (!plugin_name_args_tab)

    return;

  timevar_push (TV_PLUGIN_INIT);

#ifdef ENABLE_PLUGIN

  /* Traverse and initialize each plugin specified in the command-line.  */

  htab_traverse_noresize (plugin_name_args_tab, init_one_plugin, NULL);

#endif

  timevar_pop (TV_PLUGIN_INIT);

}

/* Release memory used by one plugin. */

static int

finalize_one_plugin (void **slot, void * ARG_UNUSED (info))

{

  struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;

  XDELETE (plugin);

  return 1;

}

/* Free memory allocated by the plugin system. */

void

finalize_plugins (void)

{

  if (!plugin_name_args_tab)

    return;

  /* We can now delete the plugin_name_args object as it will no longer

     be used. Note that base_name and argv fields (both of which were also

     dynamically allocated) are not freed as they could still be used by

     the plugin code.  */

  htab_traverse_noresize (plugin_name_args_tab, finalize_one_plugin, NULL);

  /* PLUGIN_NAME_ARGS_TAB is no longer needed, just delete it.  */

  htab_delete (plugin_name_args_tab);

  plugin_name_args_tab = NULL;

}

/* Used to pass options to htab_traverse callbacks. */

struct print_options

{

  FILE *file;

  const char *indent;

};

/* Print the version of one plugin. */

static int

print_version_one_plugin (void **slot, void *data)

{

  struct print_options *opt = (struct print_options *) data;

  struct plugin_name_args *plugin = (struct plugin_name_args *) *slot;

  const char *version = plugin->version ? plugin->version : "Unknown version.";

  fprintf (opt->file, " %s%s: %s\n", opt->indent, plugin->base_name, version);

  return 1;

}

/* Print the version of each plugin. */

void

print_plugins_versions (FILE *file, const char *indent)

{

  struct print_options opt;

  opt.file = file;

  opt.indent = indent;

  if (!plugin_name_args_tab || htab_elements (plugin_name_args_tab) == 0)

    return;