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 "highlev-plugin-common.h"
30#include "hashtab.h"
31
32/* Event names.  */
33enum plugin_event
34{
35# define DEFEVENT(NAME) NAME,
36# include "plugin.def"
37# undef DEFEVENT
38  PLUGIN_EVENT_FIRST_DYNAMIC
39};
40
41extern const char **plugin_event_name;
42
43struct plugin_argument
44{
45  char *key;    /* key of the argument.  */
46  char *value;  /* value is optional and can be NULL.  */
47};
48
49/* Additional information about the plugin. Used by --help and --version. */
50
51struct plugin_info
52{
53  const char *version;
54  const char *help;
55};
56
57/* Represents the gcc version. Used to avoid using an incompatible plugin. */
58
59struct plugin_gcc_version
60{
61  const char *basever;
62  const char *datestamp;
63  const char *devphase;
64  const char *revision;
65  const char *configuration_arguments;
66};
67
68/* Object that keeps track of the plugin name and its arguments. */
69struct plugin_name_args
70{
71  char *base_name;              /* Short name of the plugin (filename without
72                                   .so suffix). */
73  const char *full_name;        /* Path to the plugin as specified with
74                                   -fplugin=. */
75  int argc;                     /* Number of arguments specified with
76                                   -fplugin-arg-... */
77  struct plugin_argument *argv; /* Array of ARGC key-value pairs. */
78  const char *version;          /* Version string provided by plugin. */
79  const char *help;             /* Help string provided by plugin. */
80};
81
82/* The default version check. Compares every field in VERSION. */
83
84extern bool plugin_default_version_check (struct plugin_gcc_version *,
85					  struct plugin_gcc_version *);
86
87/* Function type for the plugin initialization routine. Each plugin module
88   should define this as an externally-visible function with name
89   "plugin_init."
90
91   PLUGIN_INFO - plugin invocation information.
92   VERSION     - the plugin_gcc_version symbol of GCC.
93
94   Returns 0 if initialization finishes successfully.  */
95
96typedef int (*plugin_init_func) (struct plugin_name_args *plugin_info,
97                                 struct plugin_gcc_version *version);
98
99#ifdef __cplusplus
100extern "C" {
101#endif
102/* Declaration for "plugin_init" function so that it doesn't need to be
103   duplicated in every plugin.  */
104extern int plugin_init (struct plugin_name_args *plugin_info,
105                        struct plugin_gcc_version *version);
106#ifdef __cplusplus
107}
108#endif
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
115typedef 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
128extern int get_event_last (void);
129
130int 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
137extern void register_callback (const char *plugin_name,
138			       int event,
139                               plugin_callback_func callback,
140                               void *user_data);
141
142extern int unregister_callback (const char *plugin_name, int event);
143
144#endif /* GCC_PLUGIN_H */
145