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