1 /* Public header file for plugins to include. 2 Copyright (C) 2009 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 30 /* Event names. Keep in sync with plugin_event_name[]. */ 31 enum plugin_event 32 { 33 PLUGIN_PASS_MANAGER_SETUP, /* To hook into pass manager. */ 34 PLUGIN_FINISH_TYPE, /* After finishing parsing a type. */ 35 PLUGIN_FINISH_UNIT, /* Useful for summary processing. */ 36 PLUGIN_CXX_CP_PRE_GENERICIZE, /* Allows to see low level AST in C++ FE. */ 37 PLUGIN_FINISH, /* Called before GCC exits. */ 38 PLUGIN_INFO, /* Information about the plugin. */ 39 PLUGIN_GGC_START, /* Called at start of GCC Garbage Collection. */ 40 PLUGIN_GGC_MARKING, /* Extend the GGC marking. */ 41 PLUGIN_GGC_END, /* Called at end of GGC. */ 42 PLUGIN_REGISTER_GGC_ROOTS, /* Register an extra GGC root table. */ 43 PLUGIN_ATTRIBUTES, /* Called during attribute registration. */ 44 PLUGIN_START_UNIT, /* Called before processing a translation unit. */ 45 PLUGIN_EVENT_LAST /* Dummy event used for indexing callback 46 array. */ 47 }; 48 49 extern const char *plugin_event_name[]; 50 51 struct plugin_argument 52 { 53 char *key; /* key of the argument. */ 54 char *value; /* value is optional and can be NULL. */ 55 }; 56 57 enum pass_positioning_ops 58 { 59 PASS_POS_INSERT_AFTER, /* Insert after the reference pass. */ 60 PASS_POS_INSERT_BEFORE, /* Insert before the reference pass. */ 61 PASS_POS_REPLACE /* Replace the reference pass. */ 62 }; 63 64 struct plugin_pass 65 { 66 struct opt_pass *pass; /* New pass provided by the plugin. */ 67 const char *reference_pass_name; /* Name of the reference pass for hooking 68 up the new pass. */ 69 int ref_pass_instance_number; /* Insert the pass at the specified 70 instance number of the reference pass. 71 Do it for every instance if it is 0. */ 72 enum pass_positioning_ops pos_op; /* how to insert the new pass. */ 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 /* This is also called without a callback routine for the 147 PLUGIN_PASS_MANAGER_SETUP, PLUGIN_INFO, PLUGIN_REGISTER_GGC_ROOTS 148 pseudo-events, with a specific user_data. 149 */ 150 151 extern void register_callback (const char *plugin_name, 152 enum plugin_event event, 153 plugin_callback_func callback, 154 void *user_data); 155 156 #endif /* GCC_PLUGIN_H */ 157
