nsz Git - libfirm/blob - include/libfirm/irprog.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   Entry point to the representation of a whole program.
  23  * @author  Goetz Lindenmaier
  24  * @date    2000
  25  * @version $Id$
  26  * @brief
  27  *  Intermediate Representation (IR) of a program.
  28  *
  29  *  This file defines a construct that keeps all information about a
  30  *  program:
  31  *   - A reference point to the method to be executed on program start.
  32  *   - A list of all procedures.
  33  *   - A list of all types.
  34  *   - A global type that contains all global variables and procedures that do
  35  *     not belong to a class.  This type represents the data segment of the
  36  *     program.  It is not the base class of
  37  *     all classes in a class hierarchy (as, e.g., "object" in java).
  38  *   - A degenerated graph that contains constant expressions.
  39  *   - interprocedural outs state.
  40  *   - a flag indicating validity of the interprocedural representation.
  41  *   - the output file name
  42  */
  43 #ifndef FIRM_IR_IRPROG_H
  44 #define FIRM_IR_IRPROG_H
  45
  46 #include "firm_types.h"
  47 #include "irgraph.h"
  48 #include "begin.h"
  49
  50 typedef enum ir_segment_t {
  51         IR_SEGMENT_FIRST,
  52         /** "normal" global data */
  53         IR_SEGMENT_GLOBAL = IR_SEGMENT_FIRST,
  54         /** thread local storage segment */
  55         IR_SEGMENT_THREAD_LOCAL,
  56         /**
  57          * the constructors segment. Contains pointers to functions which are
  58          * executed on module initialization (program start or when a library is
  59          * dynamically loaded)
  60          */
  61         IR_SEGMENT_CONSTRUCTORS,
  62         /** like constructors, but functions are executed on module exit */
  63         IR_SEGMENT_DESTRUCTORS,
  64
  65         IR_SEGMENT_LAST = IR_SEGMENT_DESTRUCTORS
  66 } ir_segment_t;
  67
  68 /**
  69  * A variable pointing to the current irp (program or module).
  70  * This variable should be considered constant. Moreover, one should use get_irp()
  71  * to get access the the irp.
  72  *
  73  * @note
  74  *      Think of the irp as the "handle" of a program.
  75  */
  76 FIRM_API ir_prog *irp;
  77
  78 #ifndef NDEBUG
  79 FIRM_API void irp_reserve_resources(ir_prog *irp, ir_resources_t resources);
  80 FIRM_API void irp_free_resources(ir_prog *irp, ir_resources_t resources);
  81 FIRM_API ir_resources_t irp_resources_reserved(const ir_prog *irp);
  82 #else
  83 #define irp_reserve_resources(irp, resources)
  84 #define irp_free_resources(irp, resources)
  85 #define irp_resources_reserved(irp)   0
  86 #endif
  87
  88 /**
  89  * Returns the current irp from where everything in the current module
  90  * can be accessed.
  91  *
  92  * @see irp
  93  */
  94 FIRM_API ir_prog *get_irp(void);
  95
  96 /**
  97  * Set current irp
  98  */
  99 FIRM_API void set_irp(ir_prog *irp);
 100
 101 /**
 102  * Creates a new ir_prog (a module or compilation unit).
 103  * Note: This does not set irp to the newly created ir_prog
 104  *
 105  * @param name  the name of this irp (module)
 106  */
 107 FIRM_API ir_prog *new_ir_prog(const char *name);
 108
 109 /** frees all memory used by irp.  Types in type list and irgs in irg
 110  *  list must be freed by hand before. */
 111 FIRM_API void free_ir_prog(void);
 112
 113 /** Sets the file name / executable name or the like. Initially the
 114     ident 'no_name_set'. */
 115 FIRM_API void set_irp_prog_name(ident *name);
 116
 117 /** Returns true if the user ever set a program name */
 118 FIRM_API int irp_prog_name_is_set(void);
 119
 120 /** Gets the name of the current irp. */
 121 FIRM_API ident *get_irp_ident(void);
 122
 123 /** Gets the name of the current irp. */
 124 FIRM_API const char *get_irp_name(void);
 125
 126 /** Gets the main routine of the compiled program. */
 127 FIRM_API ir_graph *get_irp_main_irg(void);
 128
 129 /** Sets the main routine of the compiled program. */
 130 FIRM_API void set_irp_main_irg(ir_graph *main_irg);
 131
 132 /** Adds irg to the list of ir graphs in the current irp. */
 133 FIRM_API void add_irp_irg(ir_graph *irg);
 134
 135 /** Removes irg from the list of irgs and
 136     shrinks the list by one. */
 137 FIRM_API void remove_irp_irg_from_list(ir_graph *irg);
 138 /** Removes irg from the list of irgs, deallocates it and
 139     shrinks the list by one. */
 140 FIRM_API void remove_irp_irg(ir_graph *irg);
 141
 142 /** returns the biggest not used irg index number */
 143 FIRM_API int get_irp_last_idx(void);
 144
 145 /** Returns the number of ir graphs in the irp. */
 146 FIRM_API int get_irp_n_irgs(void);
 147
 148 /** Returns the ir graph at position pos in the irp. */
 149 FIRM_API ir_graph *get_irp_irg(int pos);
 150
 151 /** Sets the ir graph at position pos. */
 152 FIRM_API void set_irp_irg(int pos, ir_graph *irg);
 153
 154 /**
 155  * Returns the type containing the entities for a segment.
 156  *
 157  * @param segment  the segment
 158  */
 159 FIRM_API ir_type *get_segment_type(ir_segment_t segment);
 160
 161 /**
 162  * @brief Changes a segment segment type for the program.
 163  * (use with care)
 164  */
 165 FIRM_API void set_segment_type(ir_segment_t segment, ir_type *new_type);
 166
 167 /**
 168  * Returns the "global" type of the irp.
 169  * Upon creation this is an empty class type.
 170  * This is a convenience function for get_segment_type(IR_SEGMENT_GLOBAL)
 171  */
 172 FIRM_API ir_type *get_glob_type(void);
 173
 174 /**
 175  * Returns the "thread local storage" type of the irp.
 176  * Upon creation this is an empty struct type.
 177  * This is a convenience function for get_segment_type(IR_SEGMENT_THREAD_LOCAL)
 178  */
 179 FIRM_API ir_type *get_tls_type(void);
 180
 181 /** Adds type to the list of types in irp. */
 182 FIRM_API void add_irp_type(ir_type *typ);
 183
 184 /** Removes type from the list of types, deallocates it and
 185     shrinks the list by one. */
 186 FIRM_API void remove_irp_type(ir_type *typ);
 187
 188 /**
 189  * Returns the number of all types in the irp.
 190  * @deprecated
 191  */
 192 FIRM_API int get_irp_n_types(void);
 193
 194 /**
 195  * Returns the type at position pos in the irp.
 196  * @deprecated
 197  */
 198 FIRM_API ir_type *get_irp_type(int pos);
 199
 200 /**
 201  * Overwrites the type at position pos with another type.
 202  * @deprecated
 203  */
 204 FIRM_API void set_irp_type(int pos, ir_type *typ);
 205
 206 /** Returns the number of all modes in the irp. */
 207 FIRM_API int get_irp_n_modes(void);
 208
 209 /** Returns the mode at position pos in the irp. */
 210 FIRM_API ir_mode *get_irp_mode(int pos);
 211
 212 /** Adds opcode to the list of opcodes in irp. */
 213 FIRM_API void add_irp_opcode(ir_op *opcode);
 214
 215 /** Removes opcode from the list of opcodes, deallocates it and
 216     shrinks the list by one. */
 217 FIRM_API void remove_irp_opcode(ir_op *opcode);
 218
 219 /** Returns the number of all opcodes in the irp. */
 220 FIRM_API int get_irp_n_opcodes(void);
 221
 222 /** Returns the opcode at position pos in the irp. */
 223 FIRM_API ir_op *get_irp_opcode(int pos);
 224
 225 /** Sets the generic function pointer of all opcodes to NULL */
 226 FIRM_API void clear_irp_opcodes_generic_func(void);
 227
 228
 229 /**  Return the graph for global constants of the current irp.
 230  *
 231  *   Returns an irgraph that only contains constant expressions for
 232  *   constant entities.  Do not use any access function for this
 233  *   graph, do not generate code for this graph.  This graph contains
 234  *   only one block.  The constant expressions may not contain control
 235  *   flow.
 236  *   Walking the graph starting from any node will not reach the block
 237  *   or any controlflow.
 238  *   See also copy_const_code() in entity.h.
 239  */
 240 FIRM_API ir_graph *get_const_code_irg(void);
 241
 242
 243 /** The phase state for the program.
 244  *
 245  *  The phase state of the whole program is
 246  *   building:  if at least one graph is state_building
 247  *              or one type is incomplete.
 248  *   high:      all graphs are in state high or low, all types are constructed.
 249  *   low:       all graphs are in state low, all types are in state layout fixed.
 250  */
 251 FIRM_API irg_phase_state get_irp_phase_state(void);
 252 FIRM_API void            set_irp_phase_state(irg_phase_state s);
 253
 254 FIRM_API irg_outs_state get_irp_ip_outs_state(void);
 255 FIRM_API void           set_irp_ip_outs_inconsistent(void);
 256
 257 /**
 258  * Creates an ir_prog pass for set_irp_phase_state().
 259  *
 260  * @param name   the name of this pass or NULL
 261  * @param state  the state to set
 262  *
 263  * @return  the newly created ir_prog pass
 264  */
 265 FIRM_API ir_prog_pass_t *set_irp_phase_state_pass(const char *name,
 266                                                   irg_phase_state state);
 267
 268 FIRM_API irg_callee_info_state get_irp_callee_info_state(void);
 269 FIRM_API void                  set_irp_callee_info_state(irg_callee_info_state s);
 270
 271 /** Returns a new, unique exception region number. */
 272 FIRM_API ir_exc_region_t get_irp_next_region_nr(void);
 273
 274 /** Returns a new, unique label number. */
 275 FIRM_API ir_label_t get_irp_next_label_nr(void);
 276
 277 /** Add a new global asm include. */
 278 FIRM_API void add_irp_asm(ident *asm_string);
 279
 280 /** Return the number of global asm includes. */
 281 FIRM_API int get_irp_n_asms(void);
 282
 283 /** Return the global asm include at position pos. */
 284 FIRM_API ident *get_irp_asm(int pos);
 285
 286 #include "end.h"
 287
 288 #endif