beloopana: Remove duplicate comments.
[libfirm] / ir / ir / irprog_t.h
index d152038..32ae0c8 100644 (file)
 /*
- * Project:     libFIRM
- * File name:   ir/ir/irprog_t.h
- * Purpose:     Entry point to the representation of a whole program 0-- private header.
- * Author:      Goetz Lindenmaier
- * Modified by:
- * Created:     2000
- * CVS-ID:      $Id$
- * Copyright:   (c) 2000-2003 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * This file is part of libFirm.
+ * Copyright (C) 2012 University of Karlsruhe.
  */
 
 /**
- * @file irprog_t.h
+ * @file
+ * @brief    Entry point to the representation of a whole program 0-- private header.
+ * @author   Goetz Lindenmaier
+ * @date     2000
  */
-
-#ifndef _IRPROG_T_H_
-#define _IRPROG_T_H_
-
-#ifdef HAVE_CONFIG_H
-#include "firm_config.h"
-#endif
+#ifndef FIRM_IR_IRPROG_T_H
+#define FIRM_IR_IRPROG_T_H
 
 #include "irprog.h"
-#include "irgraph.h"
-#include "pseudo_irg.h"
-#include "ircgcons.h"
-#include "firm_common_t.h"
-#include "typegmod.h"
+#include "irtypes.h"
 #include "irtypeinfo.h"
-#include "tr_inheritance.h"
+#include "irmemory.h"
 
 #include "callgraph.h"
-#include "field_temperature.h"
-#include "execution_frequency.h"
 
 #include "array.h"
 
-/** ir_prog */
-struct ir_prog {
-  firm_kind kind;
-  ident     *name;                /**< A file name or the like. */
-  ir_graph  *main_irg;            /**< entry point to the compiled program
-                                      @@@ or a list, in case we compile a library or the like? */
-  ir_graph **graphs;              /**< all graphs in the ir */
-  ir_graph **pseudo_graphs;       /**< all pseudo graphs in the ir. See pseudo_irg.c */
-  ir_graph  *const_code_irg;      /**< This ir graph gives the proper environment
-                                      to allocate nodes the represent values
-                                      of constant entities. It is not meant as
-                                      a procedure.  */
-  type      *glob_type;           /**< global type.  Must be a class as it can
-                                      have fields and procedures.  */
-  type     **types;               /**< all types in the ir */
-
-  /* -- states of and access to generated information -- */
-  irg_phase_state phase_state;    /**< State of construction. */
-
-  ip_view_state ip_view;          /**< State of interprocedural view. */
-
-  irg_outs_state outs_state;      /**< State of out edges of ir nodes. */
-  ir_node **ip_outedges;          /**< Huge Array that contains all out edges
-                                      in interprocedural view. */
-  irg_outs_state trouts_state;    /**< State of out edges of type information. */
-
-  irg_callee_info_state callee_info_state; /**< Validity of callee information.
-                                             Contains the lowest value or all irgs.  */
-  ir_typeinfo_state typeinfo_state;    /**< Validity of type information. */
-  inh_transitive_closure_state inh_trans_closure_state;  /**< trans closure of inh relations. */
-
-  irp_callgraph_state callgraph_state; /**< State of the callgraph. */
-  struct ir_loop *outermost_cg_loop;   /**< For callgraph analysis: entry point
-                                           to looptree over callgraph. */
-  int max_callgraph_loop_depth;        /**< needed in callgraph. */
-  int max_callgraph_recursion_depth;   /**< needed in callgraph. */
-  int max_method_execution_frequency;  /**< needed in callgraph. */
-  irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
-  exec_freq_state execfreq_state;        /**< State of execution freqency information */
-  loop_nesting_depth_state lnd_state;  /**< State of loop nesting depth information. */
-#ifdef DEBUG_libfirm
-  long max_node_nr;                /**< to generate unique numbers for nodes. */
-#endif
-};
-
-void remove_irp_type_from_list (type *typ);
+/* Inline functions. */
+#define get_irp_n_irgs()                 get_irp_n_irgs_()
+#define get_irp_irg(pos)                 get_irp_irg_(pos)
+#define get_irp_n_types()                get_irp_n_types_()
+#define get_irp_type(pos)                get_irp_type_(pos)
+#define get_const_code_irg()             get_const_code_irg_()
+#define get_segment_type(s)              get_segment_type_(s)
+#define get_glob_type()                  get_glob_type_()
+#define get_tls_type()                   get_tls_type_()
+#define get_irp_next_label_nr()          get_irp_next_label_nr_()
+
+/* inline functions */
+static inline ir_type *get_segment_type_(ir_segment_t segment)
+{
+       assert(segment <= IR_SEGMENT_LAST);
+       return irp->segment_types[segment];
+}
 
-static INLINE type *
-__get_glob_type(void) {
-  assert(irp);
-  return irp->glob_type = skip_tid(irp->glob_type);
+static inline ir_type *get_glob_type_(void)
+{
+       return get_segment_type_(IR_SEGMENT_GLOBAL);
 }
 
-static INLINE int
-__get_irp_n_irgs(void) {
-  assert (irp && irp->graphs);
-  if (get_visit_pseudo_irgs()) return get_irp_n_allirgs();
-  return (ARR_LEN((irp)->graphs));
+static inline ir_type *get_tls_type_(void)
+{
+       return get_segment_type_(IR_SEGMENT_THREAD_LOCAL);
 }
 
-static INLINE ir_graph *
-__get_irp_irg(int pos){
-  if (get_visit_pseudo_irgs()) return get_irp_allirg(pos);
-  assert(0 <= pos && pos <= get_irp_n_irgs());
-  return irp->graphs[pos];
+static inline size_t get_irp_n_irgs_(void)
+{
+       return ARR_LEN(irp->graphs);
 }
 
+static inline ir_graph *get_irp_irg_(size_t pos)
+{
+       assert(pos < ARR_LEN(irp->graphs));
+       return irp->graphs[pos];
+}
 
-static INLINE int
-__get_irp_n_types (void) {
-  assert (irp && irp->types);
-  return (ARR_LEN((irp)->types));
+static inline size_t get_irp_n_types_(void)
+{
+       return ARR_LEN(irp->types);
 }
 
-static INLINE type *
-__get_irp_type(int pos) {
-  assert (irp && irp->types);
-  /* Don't set the skip_tid result so that no double entries are generated. */
-  return skip_tid(irp->types[pos]);
+static inline ir_type *get_irp_type_(size_t pos)
+{
+       assert(pos < ARR_LEN(irp->types));
+       /* Don't set the skip_tid result so that no double entries are generated. */
+       return irp->types[pos];
 }
 
-#ifdef DEBUG_libfirm
 /** Returns a new, unique number to number nodes or the like. */
-int get_irp_new_node_nr(void);
-#endif
+static inline long get_irp_new_node_nr(void)
+{
+       return irp->max_node_nr++;
+}
+
+static inline size_t get_irp_new_irg_idx(void)
+{
+       return irp->max_irg_idx++;
+}
+
+static inline ir_graph *get_const_code_irg_(void)
+{
+       return irp->const_code_irg;
+}
 
-static INLINE ir_graph *
-__get_const_code_irg(void)
+/** Returns a new, unique label number. */
+static inline ir_label_t get_irp_next_label_nr_(void)
 {
-  return irp->const_code_irg;
+       return ++irp->last_label_nr;
 }
 
-void           set_irp_ip_outedges(ir_node ** ip_outedges);
-ir_node**      get_irp_ip_outedges(void);
+void      set_irp_ip_outedges(ir_node ** ip_outedges);
+ir_node** get_irp_ip_outedges(void);
+
+/** initializes ir_prog. Constructs only the basic lists */
+void init_irprog_1(void);
+
+/** Completes ir_prog. */
+void init_irprog_2(void);
 
-/** initializes ir_prog. Calls the constructor for an ir_prog. */
-void init_irprog(void);
+/** Adds type to the list of types in irp. */
+void add_irp_type(ir_type *typ);
 
-#define get_irp_n_irgs()       __get_irp_n_irgs()
-#define get_irp_irg(pos)       __get_irp_irg(pos)
-#define get_irp_n_types()      __get_irp_n_types()
-#define get_irp_type(pos)      __get_irp_type(pos)
-#define get_const_code_irg()   __get_const_code_irg()
-#define get_glob_type()        __get_glob_type()
+/** Removes type from the list of types, deallocates it and
+    shrinks the list by one. */
+void remove_irp_type(ir_type *typ);
 
-#endif /* ifndef _IRPROG_T_H_ */
+/** Adds irg to the list of ir graphs in the current irp. */
+FIRM_API void add_irp_irg(ir_graph *irg);
+
+/** Removes irg from the list of irgs and
+    shrinks the list by one. */
+FIRM_API void remove_irp_irg(ir_graph *irg);
+
+#endif