gcc/gcc-plugin.h

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