3 * File name: ir/ir/irprog.h
4 * Purpose: Entry point to the representation of a whole program.
5 * Author: Goetz Lindenmaier
9 * Copyright: (c) 2000-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * ir representation of a program.
18 * @author Goetz Lindenmaier
20 * This file defines a construct that keeps all information about a
22 * - A reference point to the method to be executed on program start.
23 * - A list of all procedures.
24 * - A list of all types.
25 * - A global type that contais all global variables and procedures that do
26 * not belong to a class. This type represents the data segment of the
27 * program. It is not the base class of
28 * all classes in a class hierarchy (as, e.g., "object" in java).
29 * - A degenerated graph that contains constant expressions.
30 * - interprocedural outs state.
31 * - a flag indicating validity of the interprocedural representation.
32 * - the output file name
43 * Datastructure that holds central information about a program
45 * Preliminary documentation ;-)
47 * - main_irg: The ir graph that is the entry point to the program.
48 * (Anything not reachable from here may be optimized away.
49 * If we want to translate libraries or the like correctly
50 * we must replace this by a list.)
51 * - irg: List of all ir graphs in the program.
52 * - type: A list containing all types known to the translated program.
53 * Some types can have several entries in this list (as a result of
54 * using exchange_types()).
55 * - glob_type: The unique global type that is owner of all global entities.
58 typedef struct ir_prog ir_prog;
61 * A variable from where everything in the ir can be accessed.
62 * This variable contains the irp, the "immediate representation program".
63 * This variable should be considered constant. Moreover, one should use get_irp()
64 * to get access the the irp.
67 * Think of the irp as the "handle" of libFirm.
72 * Returns the access points from where everything in the ir can be accessed.
76 ir_prog *get_irp(void);
78 /** initializes ir_prog. Calls the constructor for an ir_prog. */
79 void init_irprog(void);
81 /** Creates a new ir_prog, returns it and sets irp with it.
82 * Automatically called by init_firm() through init_irprog. */
83 ir_prog *new_ir_prog (void);
85 /** frees all memory used by irp. Types in type list and irgs in irg
86 * list must be freed by hand before. */
87 void free_ir_prog(void);
89 /** Sets the file name / executable name or the like. Initially NULL. */
90 void set_irp_prog_name (ident *name);
92 /** Gets the file name / executable name or the like. Returns NULL if
95 ident *get_irp_prog_ident(void);
97 /** Gets the file name / executable name or the like. Returns NULL if
100 const char *get_irp_prog_name (void);
102 /** Gets the main routine of the compiled program. */
103 ir_graph *get_irp_main_irg(void);
105 /** Sets the main routine of the compiled program. */
106 void set_irp_main_irg(ir_graph *main_irg);
108 /** Adds irg to the list of ir graphs in irp. */
109 void add_irp_irg(ir_graph *irg);
111 /** Removes irg from the list of irgs, deallocates it and
112 shrinks the list by one. */
113 void remove_irp_irg(ir_graph *irg);
115 /** Returns the number of ir graphs in the irp. */
116 int get_irp_n_irgs(void);
118 /** Returns the ir graph at position pos in the irp. */
119 ir_graph *get_irp_irg(int pos);
121 /** Sets the ir graph at position pos. */
122 void set_irp_irg(int pos, ir_graph *irg);
125 /** Returns the "global" type of the irp. */
126 type *get_glob_type(void);
128 /** Adds type to the list of types in irp. */
129 void add_irp_type(type *typ);
131 /** Removes type from the list of types, deallocates it and
132 shrinks the list by one. */
133 void remove_irp_type(type *typ);
135 /** Returns the number of all types in the irp. */
136 int get_irp_n_types(void);
138 /** Returns the type at position pos in the irp. */
139 type *get_irp_type(int pos);
141 /** Overwrites the type at position pos with another type. */
142 void set_irp_type(int pos, type *typ);
144 /** Return the graph for global constants.
146 * Returns an irgraph that only contains constant expressions for
147 * constant entities. Do not use any access function for this
148 * graph, do not generate code for this graph. This graph contains
149 * only one block. The constant expressions may not contain control
151 * Walking the graph starting from any node will not reach the block
152 * or any controlflow.
153 * See also copy_const_code() in entity.h.
155 ir_graph *get_const_code_irg(void);
157 irg_outs_state get_irp_ip_outs_state(void);
158 void set_irp_ip_outs_inconsistent(void);
160 #endif /* ifndef _IRPROG_H_ */