gcc/highlev-plugin-internal.h

   1 /* Compiler-side interface for high-level plugins in GCC.
   2    Copyright (C) 2009 Free Software Foundation, Inc.
   3
   4    Contributed by Inria.
   5
   6    Authors: Grigori Fursin <grigori.fursin@inria.fr>, Cupertino Miranda
   7    <cupertinomiranda@gmail.com>, Zbigniew Chamski <zbigniew.chamski@gmail.com>.
   8
   9 This file is part of GCC.
  10
  11 GCC is free software; you can redistribute it and/or modify it under
  12 the terms of the GNU General Public License as published by the Free
  13 Software Foundation; either version 3, or (at your option) any later
  14 version.
  15
  16 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  17 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19 for more details.
  20
  21 You should have received a copy of the GNU General Public License
  22 along with GCC; see the file COPYING3.  If not see
  23 <http://www.gnu.org/licenses/>.  */
  24
  25 #ifndef HIGHLEV_PLUGIN_INTERNAL
  26 #define HIGHLEV_PLUGIN_INTERNAL
  27
  28 /* Callback type for high-level argument-less event callbacks */
  29 typedef void (*event_callback_t) (void);
  30
  31 /* Manipulation of events and event handlers */
  32 extern void register_plugin_event (const char *name, event_callback_t func);
  33 extern void unregister_plugin_event (const char *name);
  34 extern const char **list_plugin_events (void);
  35 extern int call_plugin_event (const char *event_name);
  36
  37 /* return codes for call_plugin_event */
  38 #define PLUGEVT_SUCCESS         0
  39 #define PLUGEVT_NO_EVENTS       1
  40 #define PLUGEVT_NO_SUCH_EVENT   2
  41 #define PLUGEVT_NO_CALLBACK     3
  42
  43 /* Datatype of event parameter structure.  */
  44 typedef enum
  45 {
  46   EP_SILENT, /* Used to pass infomation between ICI and plugin,
  47                 parameter of this type will not be recorded.
  48                 The data type is int.  */
  49   EP_VOID,
  50   EP_CHAR,
  51   EP_UNSIGNED_CHAR,
  52   EP_INT,
  53   EP_UNSIGNED,
  54   EP_LONG,
  55   EP_UNSIGNED_LONG
  56 } event_parameter_type;
  57
  58 /* Manipulation of event parameters (callback arguments) */
  59 extern void register_event_parameter (const char *name, void *param,
  60                                       event_parameter_type type);
  61 extern void unregister_event_parameter (const char *name);
  62 extern const char **list_event_parameters (void);
  63 extern void *get_event_parameter (const char *name);
  64
  65 /* ICI-specific, environment-based plugin loading */
  66 extern void load_ici_plugin (void);
  67
  68 /* Info needed by adaptation.  */
  69 typedef struct {
  70   int numofclonefun;
  71   char **clone_function_list;
  72   char **function_filename_list;
  73   int *clones;
  74   char **clone_extension;
  75   char **adaptation_function;
  76   char **clone_option;
  77   char *external_libraries;
  78 } cloneinfo ;
  79
  80 typedef struct {
  81   int numofinstrfun;
  82   char **instrument_function_list;
  83   char **function_filename_list;
  84   char **timer1;
  85   char **timer2;
  86   char *cloned;
  87 } instrinfo ;
  88
  89 #endif /* HIGHLEV_PLUGIN_INTERNAL_H*/