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