gcc/jit/jit-common.h

   1 /* Core of implementation of libgccjit.so
   2    Copyright (C) 2013-2015 Free Software Foundation, Inc.
   3    Contributed by David Malcolm <dmalcolm@redhat.com>.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it
   8 under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 3, or (at your option)
  10 any later version.
  11
  12 GCC is distributed in the hope that it will be useful, but
  13 WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef JIT_COMMON_H
  22 #define JIT_COMMON_H
  23
  24 #include "libgccjit.h"
  25
  26 #include "hash-set.h"
  27 #include "input.h"
  28 #include "vec.h"
  29 #include "double-int.h"
  30 #include "alias.h"
  31 #include "flags.h"
  32 #include "symtab.h"
  33 #include "inchash.h"
  34 #include "tree.h"
  35 #include "tree-iterator.h"
  36
  37 #ifdef GCC_VERSION
  38 #if GCC_VERSION >= 4001
  39 #define GNU_PRINTF(M, N) __attribute__ ((format (gnu_printf, (M), (N))))
  40 #else
  41 #define GNU_PRINTF(M, N)
  42 #endif
  43 #endif
  44
  45 const int NUM_GCC_JIT_TYPES = GCC_JIT_TYPE_COMPLEX_LONG_DOUBLE + 1;
  46
  47 /* This comment is included by the docs.
  48
  49    In order to allow jit objects to be usable outside of a compile
  50    whilst working with the existing structure of GCC's code the
  51    C API is implemented in terms of a gcc::jit::recording::context,
  52    which records the calls made to it.
  53
  54    When a gcc_jit_context is compiled, the recording context creates a
  55    playback context.  The playback context invokes the bulk of the GCC
  56    code, and within the "frontend" parsing hook, plays back the recorded
  57    API calls, creating GCC tree objects.
  58
  59    So there are two parallel families of classes: those relating to
  60    recording, and those relating to playback:
  61
  62    * Visibility: recording objects are exposed back to client code,
  63      whereas playback objects are internal to the library.
  64
  65    * Lifetime: recording objects have a lifetime equal to that of the
  66      recording context that created them, whereas playback objects only
  67      exist within the frontend hook.
  68
  69    * Memory allocation: recording objects are allocated by the recording
  70      context, and automatically freed by it when the context is released,
  71      whereas playback objects are allocated within the GC heap, and
  72      garbage-collected; they can own GC-references.
  73
  74    * Integration with rest of GCC: recording objects are unrelated to the
  75      rest of GCC, whereas playback objects are wrappers around "tree"
  76      instances.  Hence you can't ask a recording rvalue or lvalue what its
  77      type is, whereas you can for a playback rvalue of lvalue (since it
  78      can work with the underlying GCC tree nodes).
  79
  80    * Instancing: There can be multiple recording contexts "alive" at once
  81      (albeit it only one compiling at once), whereas there can only be one
  82      playback context alive at one time (since it interacts with the GC).
  83
  84    Ultimately if GCC could support multiple GC heaps and contexts, and
  85    finer-grained initialization, then this recording vs playback
  86    distinction could be eliminated.
  87
  88    During a playback, we associate objects from the recording with
  89    their counterparts during this playback.  For simplicity, we store this
  90    within the recording objects, as ``void *m_playback_obj``, casting it to
  91    the appropriate playback object subclass.  For these casts to make
  92    sense, the two class hierarchies need to have the same structure.
  93
  94    Note that the playback objects that ``m_playback_obj`` points to are
  95    GC-allocated, but the recording objects don't own references:
  96    these associations only exist within a part of the code where
  97    the GC doesn't collect, and are set back to NULL before the GC can
  98    run.
  99
 100    End of comment for inclusion in the docs.  */
 101
 102 namespace gcc {
 103
 104 namespace jit {
 105
 106 class result;
 107 class dump;
 108 class logger;
 109 class builtins_manager; // declared within jit-builtins.h
 110 class tempdir;
 111
 112 namespace recording {
 113
 114   /* Recording types.  */
 115
 116   /* Indentation indicates inheritance: */
 117   class context;
 118   class memento;
 119     class string;
 120     class location;
 121     class type;
 122       class function_type;
 123       class compound_type;
 124         class struct_;
 125         class union_;
 126     class field;
 127     class fields;
 128     class function;
 129     class block;
 130     class rvalue;
 131       class lvalue;
 132         class local;
 133         class global;
 134         class param;
 135     class statement;
 136
 137   /* End of recording types. */
 138 }
 139
 140 namespace playback {
 141   /* Playback types.  */
 142
 143   /* Indentation indicates inheritance: */
 144   class context;
 145   class wrapper;
 146     class type;
 147       class compound_type;
 148     class field;
 149     class function;
 150     class block;
 151     class rvalue;
 152       class lvalue;
 153         class param;
 154     class source_file;
 155     class source_line;
 156     class location;
 157
 158   /* End of playback types. */
 159 }
 160
 161 typedef playback::context replayer;
 162
 163 class dump
 164 {
 165 public:
 166   dump (recording::context &ctxt,
 167         const char *filename,
 168         bool update_locations);
 169   ~dump ();
 170
 171   recording::context &get_context () { return m_ctxt; }
 172
 173   void write (const char *fmt, ...)
 174     GNU_PRINTF(2, 3);
 175
 176   bool update_locations () const { return m_update_locations; }
 177
 178   recording::location *
 179   make_location () const;
 180
 181 private:
 182   recording::context &m_ctxt;
 183   const char *m_filename;
 184   bool m_update_locations;
 185   int m_line;
 186   int m_column;
 187   FILE *m_file;
 188 };
 189
 190 } // namespace gcc::jit
 191
 192 } // namespace gcc
 193
 194 #endif /* JIT_COMMON_H */