gcc/gcc-plugin.h

   1 /* Public header file for plugins to include.
   2    Copyright (C) 2009, 2010 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 #ifndef GCC_PLUGIN_H
  21 #define GCC_PLUGIN_H
  22
  23 #ifndef IN_GCC
  24 #define IN_GCC
  25 #endif
  26
  27 #include "config.h"
  28 #include "system.h"
  29 #include "highlev-plugin-common.h"
  30 #include "hashtab.h"
  31
  32 /* Event names.  */
  33 enum plugin_event
  34 {
  35 # define DEFEVENT(NAME) NAME,
  36 # include "plugin.def"
  37 # undef DEFEVENT
  38   PLUGIN_EVENT_FIRST_DYNAMIC
  39 };
  40
  41 /* All globals declared here have C linkage to reduce link compatibility
  42    issues with implementation language choice and mangling.  */
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 extern const char **plugin_event_name;
  48
  49 struct plugin_argument
  50 {
  51   char *key;    /* key of the argument.  */
  52   char *value;  /* value is optional and can be NULL.  */
  53 };
  54
  55 /* Additional information about the plugin. Used by --help and --version. */
  56
  57 struct plugin_info
  58 {
  59   const char *version;
  60   const char *help;
  61 };
  62
  63 /* Represents the gcc version. Used to avoid using an incompatible plugin. */
  64
  65 struct plugin_gcc_version
  66 {
  67   const char *basever;
  68   const char *datestamp;
  69   const char *devphase;
  70   const char *revision;
  71   const char *configuration_arguments;
  72 };
  73
  74 /* Object that keeps track of the plugin name and its arguments. */
  75 struct plugin_name_args
  76 {
  77   char *base_name;              /* Short name of the plugin (filename without
  78                                    .so suffix). */
  79   const char *full_name;        /* Path to the plugin as specified with
  80                                    -fplugin=. */
  81   int argc;                     /* Number of arguments specified with
  82                                    -fplugin-arg-... */
  83   struct plugin_argument *argv; /* Array of ARGC key-value pairs. */
  84   const char *version;          /* Version string provided by plugin. */
  85   const char *help;             /* Help string provided by plugin. */
  86 };
  87
  88 /* The default version check. Compares every field in VERSION. */
  89
  90 extern bool plugin_default_version_check (struct plugin_gcc_version *,
  91                                           struct plugin_gcc_version *);
  92
  93 /* Function type for the plugin initialization routine. Each plugin module
  94    should define this as an externally-visible function with name
  95    "plugin_init."
  96
  97    PLUGIN_INFO - plugin invocation information.
  98    VERSION     - the plugin_gcc_version symbol of GCC.
  99
 100    Returns 0 if initialization finishes successfully.  */
 101
 102 typedef int (*plugin_init_func) (struct plugin_name_args *plugin_info,
 103                                  struct plugin_gcc_version *version);
 104
 105 /* Declaration for "plugin_init" function so that it doesn't need to be
 106    duplicated in every plugin.  */
 107 extern int plugin_init (struct plugin_name_args *plugin_info,
 108                         struct plugin_gcc_version *version);
 109
 110 /* Function type for a plugin callback routine.
 111
 112    GCC_DATA  - event-specific data provided by GCC
 113    USER_DATA - plugin-specific data provided by the plugin  */
 114
 115 typedef void (*plugin_callback_func) (void *gcc_data, void *user_data);
 116
 117 /* Called from the plugin's initialization code. Register a single callback.
 118    This function can be called multiple times.
 119
 120    PLUGIN_NAME - display name for this plugin
 121    EVENT       - which event the callback is for
 122    CALLBACK    - the callback to be called at the event
 123    USER_DATA   - plugin-provided data.
 124 */
 125
 126 /* Number of event ids / names registered so far.  */
 127
 128 extern int get_event_last (void);
 129
 130 int get_named_event_id (const char *name, enum insert_option insert);
 131
 132 /* This is also called without a callback routine for the
 133    PLUGIN_PASS_MANAGER_SETUP, PLUGIN_INFO, PLUGIN_REGISTER_GGC_ROOTS and
 134    PLUGIN_REGISTER_GGC_CACHES pseudo-events, with a specific user_data.
 135   */
 136
 137 extern void register_callback (const char *plugin_name,
 138                                int event,
 139                                plugin_callback_func callback,
 140                                void *user_data);
 141
 142 extern int unregister_callback (const char *plugin_name, int event);
 143
 144
 145 /* Retrieve the plugin directory name, as returned by the
 146    -fprint-file-name=plugin argument to the gcc program, which is the
 147    -iplugindir program argument to cc1.  */
 148 extern const char* default_plugin_dir_name (void);
 149
 150 #ifdef __cplusplus
 151 }
 152 #endif
 153
 154 /* In case the C++ compiler does name mangling for globals, declare
 155    plugin_is_GPL_compatible extern "C" so that a later definition
 156    in a plugin file will have this linkage.  */
 157 #ifdef __cplusplus
 158 extern "C" {
 159 #endif
 160 extern int plugin_is_GPL_compatible;
 161 #ifdef __cplusplus
 162 }
 163 #endif
 164
 165 #endif /* GCC_PLUGIN_H */