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  * @summary
  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
  49 typedef enum ir_segment_t {
  50         /** "normal" global data */
  51         IR_SEGMENT_GLOBAL,
  52         /** thread local storage segment */
  53         IR_SEGMENT_THREAD_LOCAL,
  54         /**
  55          * the constructors segment. Contains pointers to functions which are
  56          * executed on module initialization (program start or when a library is
  57          * dynamically loaded)
  58          */
  59         IR_SEGMENT_CONSTRUCTORS,
  60         /** like constructors, but functions are executed on module exit */
  61         IR_SEGMENT_DESTRUCTORS,
  62
  63         IR_SEGMENT_COUNT
  64 } ir_segment_t;
  65
  66 /**
  67  * Datastructure that holds central information about a program
  68  *
  69  * Preliminary documentation ;-)
  70  *
  71  * - main_irg:  The ir graph that is the entry point to the program.
  72  *              (Anything not reachable from here may be optimized away.
  73  *              If we want to translate libraries or the like correctly
  74  *              we must replace this by a list.)
  75  * - irg:       List of all ir graphs in the program.
  76  * - type:      A list containing all types known to the translated program.
  77  *              Some types can have several entries in this list (as a result of
  78  *              using exchange_types()).
  79  * - glob_type: The unique global type that is owner of all global entities.
  80  *
  81  */
  82 typedef struct ir_prog ir_prog;
  83
  84 /**
  85  * A variable from where everything in the ir can be accessed.
  86  * This variable contains the irp, the "immediate representation program".
  87  * This variable should be considered constant. Moreover, one should use get_irp()
  88  * to get access the the irp.
  89  *
  90  * @note
  91  *      Think of the irp as the "handle" of libFirm.
  92  */
  93 extern ir_prog *irp;
  94
  95 /**
  96  * Returns the access points from where everything in the ir can be accessed.
  97  *
  98  * @see irp
  99  */
 100 ir_prog *get_irp(void);
 101
 102 /** Creates a new ir_prog, returns it and sets irp with it.
 103  *  Automatically called by init_firm() through init_irprog. */
 104 ir_prog *new_ir_prog(void);
 105
 106 /** frees all memory used by irp.  Types in type list and irgs in irg
 107  *  list must be freed by hand before. */
 108 void free_ir_prog(void);
 109
 110 /** Sets the file name / executable name or the like. Initially the
 111     ident 'no_name_set'. */
 112 void set_irp_prog_name(ident *name);
 113
 114 /** Returns true if the user ever set a program name */
 115 int irp_prog_name_is_set(void);
 116
 117 /** Gets the file name / executable name or the like.
 118  */
 119 ident *get_irp_prog_ident(void);
 120
 121 /** Gets the file name / executable name or the like.
 122  */
 123 const char *get_irp_prog_name (void);
 124
 125 /** Gets the main routine of the compiled program. */
 126 ir_graph *get_irp_main_irg(void);
 127
 128 /** Sets the main routine of the compiled program. */
 129 void set_irp_main_irg(ir_graph *main_irg);
 130
 131 /** Adds irg to the list of ir graphs in irp. */
 132 void add_irp_irg(ir_graph *irg);
 133
 134 /** Removes irg from the list of irgs and
 135     shrinks the list by one. */
 136 void remove_irp_irg_from_list(ir_graph *irg);
 137 /** Removes irg from the list of irgs, deallocates it and
 138     shrinks the list by one. */
 139 void remove_irp_irg(ir_graph *irg);
 140
 141 /** returns the biggest not used irg index number */
 142 int get_irp_last_idx(void);
 143
 144 /** Returns the number of ir graphs in the irp. */
 145 int get_irp_n_irgs(void);
 146
 147 /** Returns the ir graph at position pos in the irp. */
 148 ir_graph *get_irp_irg(int pos);
 149
 150 /** Sets the ir graph at position pos. */
 151 void set_irp_irg(int pos, ir_graph *irg);
 152
 153 /** Gets the number of graphs _and_ pseudo graphs. */
 154 int get_irp_n_allirgs(void);
 155
 156 /** Returns the ir graph at position pos of all graphs (including
 157  pseudo graphs).  Visits first graphs, then pseudo graphs. */
 158 ir_graph *get_irp_allirg(int pos);
 159
 160 /**
 161  * returns the type containing the entities for a segment
 162  */
 163 ir_type *get_segment_type(ir_segment_t segment);
 164
 165 /**
 166  * Returns the "global" type of the irp.
 167  * Upon creation this is an empty class type.
 168  * This is a convenience function for get_segment_type(IR_SEGMENT_GLOBAL)
 169  */
 170 ir_type *get_glob_type(void);
 171
 172 /**
 173  * Returns the "thread local storage" type of the irp.
 174  * Upon creation this is an empty struct type.
 175  */
 176 ir_type *get_tls_type(void);
 177
 178 /** Adds type to the list of types in irp. */
 179 void add_irp_type(ir_type *typ);
 180
 181 /** Removes type from the list of types, deallocates it and
 182     shrinks the list by one. */
 183 void remove_irp_type(ir_type *typ);
 184
 185 /** Returns the number of all types in the irp. */
 186 int get_irp_n_types(void);
 187
 188 /** Returns the type at position pos in the irp. */
 189 ir_type *get_irp_type(int pos);
 190
 191 /** Overwrites the type at position pos with another type. */
 192 void set_irp_type(int pos, ir_type *typ);
 193
 194 /** Returns the number of all modes in the irp. */
 195 int get_irp_n_modes(void);
 196
 197 /** Returns the mode at position pos in the irp. */
 198 ir_mode *get_irp_mode(int pos);
 199
 200 /** Adds opcode to the list of opcodes in irp. */
 201 void add_irp_opcode(ir_op *opcode);
 202
 203 /** Removes opcode from the list of opcodes, deallocates it and
 204     shrinks the list by one. */
 205 void remove_irp_opcode(ir_op *opcode);
 206
 207 /** Returns the number of all opcodes in the irp. */
 208 int get_irp_n_opcodes(void);
 209
 210 /** Returns the opcode at position pos in the irp. */
 211 ir_op *get_irp_opcode(int pos);
 212
 213 /** Sets the generic function pointer of all opcodes to NULL */
 214 void clear_irp_opcodes_generic_func(void);
 215
 216
 217 /**  Return the graph for global constants.
 218  *
 219  *   Returns an irgraph that only contains constant expressions for
 220  *   constant entities.  Do not use any access function for this
 221  *   graph, do not generate code for this graph.  This graph contains
 222  *   only one block.  The constant expressions may not contain control
 223  *   flow.
 224  *   Walking the graph starting from any node will not reach the block
 225  *   or any controlflow.
 226  *   See also copy_const_code() in entity.h.
 227  */
 228 ir_graph *get_const_code_irg(void);
 229
 230
 231 /** The phase state for the program.
 232  *
 233  *  The phase state of the whole program is
 234  *   building:  if at least one graph is state_building
 235  *              or one type is incomplete.
 236  *   high:      all graphs are in state high or low, all types are constructed.
 237  *   low:       all graphs are in state low, all types are in state layout fixed.
 238  */
 239 irg_phase_state get_irp_phase_state(void);
 240 void            set_irp_phase_state(irg_phase_state s);
 241
 242 irg_outs_state get_irp_ip_outs_state(void);
 243 void           set_irp_ip_outs_inconsistent(void);
 244
 245
 246 irg_callee_info_state get_irp_callee_info_state(void);
 247 void                  set_irp_callee_info_state(irg_callee_info_state s);
 248
 249 /** Returns a new, unique exception region number. */
 250 ir_exc_region_t get_irp_next_region_nr(void);
 251
 252 /** Returns a new, unique label number. */
 253 ir_label_t get_irp_next_label_nr(void);
 254
 255 /** Add a new global asm include. */
 256 void add_irp_asm(ident *asm_string);
 257
 258 /** Return the number of global asm includes. */
 259 int get_irp_n_asms(void);
 260
 261 /** Return the global asm include at position pos. */
 262 ident *get_irp_asm(int pos);
 263
 264 #endif