added support for Thread local storage
[libfirm] / ir / ir / irprog.h
index 95f4ecc..5c65985 100644 (file)
  */
 
 /**
-* @file irprog.h
-*
-* ir representation of a program.
-*
-* @author Goetz Lindenmaier
-*
-* This file defines a construct that keeps all information about a
-* program:
-*   - A reference point to the method to be executed on program start.
-*   - A list of all procedures.
-*   - A list of all types.
-*   - A global type that contais all global variables and procedures that do
-*     not belong to a class.  This type represents the data segment of the
-*     program.  It is not the base class of
-*     all classes in a class hierarchy (as, e.g., "object" in java).
-*   - A degenerated graph that contains constant expressions.
-*   - interprocedural outs state.
-*   - a flag indicating validity of the interprocedural representation.
-*   - the output file name
-*/
-
-# ifndef _IRPROG_H_
-# define _IRPROG_H_
-
-# include "irnode.h"
-# include "type.h"
+ * @file irprog.h
+ *
+ * ir representation of a program.
+ *
+ * @author Goetz Lindenmaier
+ *
+ * This file defines a construct that keeps all information about a
+ * program:
+ *   - A reference point to the method to be executed on program start.
+ *   - A list of all procedures.
+ *   - A list of all types.
+ *   - A global type that contais all global variables and procedures that do
+ *     not belong to a class.  This type represents the data segment of the
+ *     program.  It is not the base class of
+ *     all classes in a class hierarchy (as, e.g., "object" in java).
+ *   - A degenerated graph that contains constant expressions.
+ *   - interprocedural outs state.
+ *   - a flag indicating validity of the interprocedural representation.
+ *   - the output file name
+ */
+
+#ifndef _FIRM_IR_IRPROG_H_
+#define _FIRM_IR_IRPROG_H_
+
+#include "irnode.h"
+#include "type.h"
+#include "irgraph.h"
 
 
 /**
@@ -83,16 +84,18 @@ ir_prog *new_ir_prog (void);
  *  list must be freed by hand before. */
 void     free_ir_prog(void);
 
-/** Sets the file name / executable name or the like. Initially NULL. */
+/** Sets the file name / executable name or the like. Initially the
+    ident 'no_name_set'. */
 void   set_irp_prog_name (ident *name);
 
-/** Gets the file name / executable name or the like. Returns NULL if
- *  not yet set.
+/** Returns true if the user ever set a program name */
+int    irp_prog_name_is_set(void);
+
+/** Gets the file name / executable name or the like.
  */
 ident *get_irp_prog_ident(void);
 
-/** Gets the file name / executable name or the like. Returns NULL if
- *  not yet set.
+/** Gets the file name / executable name or the like.
  */
 const char *get_irp_prog_name (void);
 
@@ -105,6 +108,9 @@ void      set_irp_main_irg(ir_graph *main_irg);
 /** Adds irg to the list of ir graphs in irp. */
 void      add_irp_irg(ir_graph *irg);
 
+/** Removes irg from the list of irgs and
+    shrinks the list by one. */
+void      remove_irp_irg_from_list(ir_graph *irg);
 /** Removes irg from the list of irgs, deallocates it and
     shrinks the list by one. */
 void      remove_irp_irg(ir_graph *irg);
@@ -118,25 +124,63 @@ ir_graph *get_irp_irg(int pos);
 /** Sets the ir graph at position pos. */
 void      set_irp_irg(int pos, ir_graph *irg);
 
+/** Gets the number of graphs _and_ pseudo graphs. */
+int       get_irp_n_allirgs(void);
+
+/** Returns the ir graph at position pos of all graphs (including
+ pseudo graphs).  Visits first graphs, then pseudo graphs. */
+ir_graph *get_irp_allirg(int pos);
 
-/** Returns the "global" type of the irp. */
-type *get_glob_type(void);
+/**
+ * Returns the "global" type of the irp.
+ * Upon creation this is an empty class type.
+ */
+ir_type *get_glob_type(void);
+
+/**
+ * Returns the "thread local storage" type of the irp.
+ * Upon creation this is an empty struct type.
+ */
+ir_type *get_tls_type(void);
 
 /** Adds type to the list of types in irp. */
-void  add_irp_type(type *typ);
+void  add_irp_type(ir_type *typ);
 
 /** Removes type from the list of types, deallocates it and
     shrinks the list by one. */
-void  remove_irp_type(type *typ);
+void  remove_irp_type(ir_type *typ);
 
 /** Returns the number of all types in the irp. */
 int   get_irp_n_types(void);
 
 /** Returns the type at position pos in the irp. */
-type *get_irp_type(int pos);
+ir_type *get_irp_type(int pos);
 
 /** Overwrites the type at position pos with another type. */
-void  set_irp_type(int pos, type *typ);
+void  set_irp_type(int pos, ir_type *typ);
+
+/** Returns the number of all modes in the irp. */
+int   get_irp_n_modes(void);
+
+/** Returns the mode at position pos in the irp. */
+ir_mode *get_irp_mode(int pos);
+
+/** Adds opcode to the list of opcodes in irp. */
+void  add_irp_opcode(ir_op *opcode);
+
+/** Removes opcode from the list of opcodes, deallocates it and
+    shrinks the list by one. */
+void  remove_irp_opcode(ir_op *opcode);
+
+/** Returns the number of all opcodes in the irp. */
+int   get_irp_n_opcodes(void);
+
+/** Returns the opcode at position pos in the irp. */
+ir_op *get_irp_opcode(int pos);
+
+/** Sets the generic function pointer of all opcodes to NULL */
+void  clear_irp_opcodes_generic_func(void);
+
 
 /**  Return the graph for global constants.
  *
@@ -151,6 +195,18 @@ void  set_irp_type(int pos, type *typ);
  */
 ir_graph *get_const_code_irg(void);
 
+
+/** The phase state for the program.
+ *
+ *  The phase state of the whole program is
+ *   building:  if at least one graph is state_building
+ *              or one type is incomplete.
+ *   high:      all graphs are in state high or low, all types are constructed.
+ *   low:       all graphs are in state low, all types are in state layout fixed.
+ */
+irg_phase_state get_irp_phase_state(void);
+void            set_irp_phase_state(irg_phase_state s);
+
 irg_outs_state get_irp_ip_outs_state(void);
 void           set_irp_ip_outs_inconsistent(void);
 
@@ -158,4 +214,4 @@ void           set_irp_ip_outs_inconsistent(void);
 irg_callee_info_state get_irp_callee_info_state(void);
 void                  set_irp_callee_info_state(irg_callee_info_state s);
 
-#endif /* ifndef _IRPROG_H_ */
+#endif /* ifndef _FIRM_IR_IRPROG_H_ */