- add functions for global (ir_prog) resource management
[libfirm] / ir / ir / irprog.c
index 122c268..22dff63 100644 (file)
@@ -1,32 +1,45 @@
 /*
- * Project:     libFIRM
- * File name:   ir/ir/irprog.c
- * Purpose:     Entry point to the representation of a whole program.
- * 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.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
+/**
+ * @file
+ * @brief    Entry point to the representation of a whole program.
+ * @author   Goetz Lindenmaier, Michael Beck
+ * @date     2000
+ * @version  $Id$
+ */
+#include "config.h"
 
 #ifdef HAVE_STRING_H
 # include <string.h>
 #endif
 
-# include "irprog_t.h"
-# include "irgraph_t.h"
-# include "pseudo_irg.h"
-# include "array.h"
-# include "obst.h"
-# include "typegmod.h"
-# include "irop_t.h"
+#include "irprog_t.h"
+#include "irgraph_t.h"
+#include "pseudo_irg.h"
+#include "array.h"
+#include "error.h"
+#include "obst.h"
+#include "irop_t.h"
+#include "irmemory.h"
 
-#define GLOBAL_TYPE_NAME "GlobalType"
+/** The initial name of the irp program. */
 #define INITAL_PROG_NAME "no_name_set"
 
 /* A variable from where everything in the ir can be accessed. */
@@ -36,79 +49,109 @@ ir_prog *get_irp(void) { return irp; }
 /**
  *  Create a new incomplete ir_prog.
  */
-static ir_prog *new_incomplete_ir_prog (void) {
-  ir_prog *res;
-
-  res = xmalloc (sizeof(*res));
-  memset(res, 0, sizeof(*res));
-  irp = res;
-
-  res->kind          = k_ir_prog;
-  res->graphs        = NEW_ARR_F(ir_graph *, 0);
-  res->pseudo_graphs = NEW_ARR_F(ir_graph *, 0);
-  res->types         = NEW_ARR_F(ir_type *, 0);
-  res->modes         = NEW_ARR_F(ir_mode *, 0);
-  res->opcodes       = NEW_ARR_F(ir_op *, 0);
+static ir_prog *new_incomplete_ir_prog(void)
+{
+       ir_prog *res = XMALLOCZ(ir_prog);
+
+       res->kind           = k_ir_prog;
+       res->graphs         = NEW_ARR_F(ir_graph *, 0);
+       res->pseudo_graphs  = NEW_ARR_F(ir_graph *, 0);
+       res->types          = NEW_ARR_F(ir_type *, 0);
+       res->modes          = NEW_ARR_F(ir_mode *, 0);
+       res->opcodes        = NEW_ARR_F(ir_op *, 0);
+       res->global_asms    = NEW_ARR_F(ident *, 0);
+       res->last_region_nr = 0;
+       res->last_label_nr  = 1;  /* 0 is reserved as non-label */
+       res->max_irg_idx    = 0;
 
 #ifdef DEBUG_libfirm
-  res->max_node_nr = 0;
+       res->max_node_nr    = 0;
+#endif
+#ifndef NDEBUG
+       res->reserved_resources = 0;
 #endif
 
-  return res;
+       return res;
 }
 
 /** Completes an incomplete irprog. */
 static ir_prog *complete_ir_prog(ir_prog *irp) {
-
-  irp->name      = new_id_from_str(INITAL_PROG_NAME);
-
-  irp->glob_type = new_type_class(new_id_from_str (GLOBAL_TYPE_NAME));
-  /* Remove type from type list.  Must be treated differently than
-     other types. */
-  remove_irp_type(irp->glob_type);
-
-  irp->const_code_irg   = new_const_code_irg();
-
-  irp->outs_state       = outs_none;
-  irp->ip_outedges      = NULL;
-  irp->trouts_state     = outs_none;
-  irp->class_cast_state = ir_class_casts_transitive;
-
-  return irp;
-}
-
-/* initializes ir_prog. Constructs only the basic lists */
+       int i;
+#define IDENT(s) new_id_from_chars(s, sizeof(s)-1)
+
+       irp->name              = IDENT(INITAL_PROG_NAME);
+
+       irp->segment_types[IR_SEGMENT_GLOBAL] = new_type_class(IDENT("GlobalType"));
+       irp->segment_types[IR_SEGMENT_THREAD_LOCAL]
+               = new_type_struct(IDENT("ThreadLocal"));
+       irp->segment_types[IR_SEGMENT_CONSTRUCTORS]
+               = new_type_struct(IDENT("Constructors"));
+       irp->segment_types[IR_SEGMENT_DESTRUCTORS]
+               = new_type_struct(IDENT("Destructors"));
+       /* Remove these types from type list.  Must be treated differently than
+          other types. */
+       for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
+               remove_irp_type(irp->segment_types[i]);
+       }
+
+       /* Set these flags for debugging. */
+       irp->segment_types[IR_SEGMENT_GLOBAL]->flags       |= tf_global_type;
+       irp->segment_types[IR_SEGMENT_THREAD_LOCAL]->flags |= tf_tls_type;
+
+       /* The global type is a class, but we cannot derive from it, so set
+          the final property to assist optimizations that checks for it. */
+       set_class_final(irp->segment_types[IR_SEGMENT_GLOBAL], 1);
+
+       irp->const_code_irg   = new_const_code_irg();
+
+       irp->phase_state                = phase_building;
+       irp->outs_state                 = outs_none;
+       irp->ip_outedges                = NULL;
+       irp->trouts_state               = outs_none;
+       irp->class_cast_state           = ir_class_casts_transitive;
+       irp->globals_entity_usage_state = ir_entity_usage_not_computed;
+
+       return irp;
+#undef IDENT
+}
+
+/* initializes ir_prog. Constructs only the basic lists. */
 void init_irprog_1(void) {
-  new_incomplete_ir_prog();
+       irp = new_incomplete_ir_prog();
 }
 
 /* Completes ir_prog. */
 void init_irprog_2(void) {
-  complete_ir_prog(irp);
+       complete_ir_prog(irp);
 }
 
 /* Create a new ir prog. Automatically called by init_firm through
    init_irprog. */
-ir_prog *new_ir_prog (void) {
-  return complete_ir_prog(new_incomplete_ir_prog());
+ir_prog *new_ir_prog(void) {
+       return complete_ir_prog(new_incomplete_ir_prog());
 }
 
 /* frees all memory used by irp.  Types in type list, irgs in irg
-    list and entities in global type must be freed by hand before. */
-void     free_ir_prog(void) {
-  if (irp->glob_type)
-    free_type(irp->glob_type);
+   list and entities in global type must be freed by hand before. */
+void free_ir_prog(void) {
+       int i;
+       for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
+               free_type(irp->segment_types[i]);
+       }
 
-  /* @@@ * free_ir_graph(irp->const_code_irg); * ?? End has no in?? */
-  DEL_ARR_F(irp->graphs);
-  DEL_ARR_F(irp->pseudo_graphs);
-  DEL_ARR_F(irp->types);
-  DEL_ARR_F(irp->modes);
-  DEL_ARR_F(irp->opcodes);
+       free_ir_graph(irp->const_code_irg);
+       DEL_ARR_F(irp->graphs);
+       DEL_ARR_F(irp->pseudo_graphs);
+       DEL_ARR_F(irp->types);
+       DEL_ARR_F(irp->modes);
 
-  irp->name           = NULL;
-  irp->const_code_irg = NULL;
-  irp->kind           = k_BAD;
+       finish_op();
+       DEL_ARR_F(irp->opcodes);
+       DEL_ARR_F(irp->global_asms);
+
+       irp->name           = NULL;
+       irp->const_code_irg = NULL;
+       irp->kind           = k_BAD;
 }
 
 /*- Functions to access the fields of ir_prog -*/
@@ -116,238 +159,293 @@ void     free_ir_prog(void) {
 
 /* Access the main routine of the compiled program. */
 ir_graph *get_irp_main_irg(void) {
-  assert (irp);
-  return irp->main_irg;
+       assert(irp);
+       return irp->main_irg;
 }
 
 void set_irp_main_irg(ir_graph *main_irg) {
-  assert (irp);
-  irp->main_irg = main_irg;
+       assert(irp);
+       irp->main_irg = main_irg;
+}
+
+ir_type *(get_segment_type)(ir_segment_t segment) {
+       return _get_segment_type(segment);
 }
 
 ir_type *(get_glob_type)(void) {
-  return _get_glob_type();
+       return _get_glob_type();
+}
+
+ir_type *(get_tls_type)(void) {
+       return _get_tls_type();
 }
 
 /* Adds irg to the list of ir graphs in irp. */
 void add_irp_irg(ir_graph *irg) {
-  assert (irg != NULL);
-  assert(irp && irp->graphs);
-  ARR_APP1 (ir_graph *, irp->graphs, irg);
+       assert(irg != NULL);
+       assert(irp && irp->graphs);
+       ARR_APP1(ir_graph *, irp->graphs, irg);
 }
 
 /* Removes irg from the list or irgs, shrinks the list by one. */
 void remove_irp_irg_from_list(ir_graph *irg){
-  int i, found = 0;
-  assert(irg);
-  for (i = 0; i < (ARR_LEN (irp->graphs)); i++) {
-    if (irp->graphs[i] == irg) {
-      found = 1;
-      for(; i < (ARR_LEN (irp->graphs)) - 1; i++) {
-        irp->graphs[i] = irp->graphs[i+1];
-      }
-      ARR_SETLEN(ir_graph*, irp->graphs, (ARR_LEN(irp->graphs)) - 1);
-      break;
-    }
-  }
-  if (!found) {
-    for (i = 0; i < (ARR_LEN (irp->pseudo_graphs)); i++) {
-      if (irp->pseudo_graphs[i] == irg) {
-             for(; i < (ARR_LEN (irp->pseudo_graphs)) - 1; i++) {
-               irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
-             }
-             ARR_SETLEN(ir_graph*, irp->pseudo_graphs, (ARR_LEN(irp->pseudo_graphs)) - 1);
-             break;
-      }
-    }
-  }
+       int i, found = 0;
+
+       assert(irg);
+       for (i = 0; i < (ARR_LEN (irp->graphs)); i++) {
+               if (irp->graphs[i] == irg) {
+                       found = 1;
+                       for(; i < (ARR_LEN (irp->graphs)) - 1; i++) {
+                               irp->graphs[i] = irp->graphs[i+1];
+                       }
+                       ARR_SETLEN(ir_graph*, irp->graphs, (ARR_LEN(irp->graphs)) - 1);
+                       break;
+               }
+       }
+       if (!found) {
+               for (i = 0; i < (ARR_LEN (irp->pseudo_graphs)); i++) {
+                       if (irp->pseudo_graphs[i] == irg) {
+                               for(; i < (ARR_LEN (irp->pseudo_graphs)) - 1; i++) {
+                                       irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
+                               }
+                               ARR_SETLEN(ir_graph*, irp->pseudo_graphs, (ARR_LEN(irp->pseudo_graphs)) - 1);
+                               break;
+                       }
+               }
+       }
 }
 
 /* Removes irg from the list or irgs, shrinks the list by one. */
 void remove_irp_irg(ir_graph *irg){
-  assert(irg);
-  free_ir_graph(irg);
-  remove_irp_irg_from_list(irg);
+       assert(irg);
+       free_ir_graph(irg);
+       remove_irp_irg_from_list(irg);
 }
 
 int (get_irp_n_irgs)(void) {
-  return _get_irp_n_irgs();
+       return _get_irp_n_irgs();
 }
 
 ir_graph *(get_irp_irg)(int pos){
-  return _get_irp_irg(pos);
+       return _get_irp_irg(pos);
+}
+
+int get_irp_last_idx(void) {
+       return irp->max_irg_idx;
 }
 
 void set_irp_irg(int pos, ir_graph *irg) {
-  assert (irp && irg);
-  assert (pos < (ARR_LEN(irp->graphs)));
-  irp->graphs[pos] = irg;
+       assert(irp && irg);
+       assert(pos < (ARR_LEN(irp->graphs)));
+       irp->graphs[pos] = irg;
 }
 
 /* Gets the number of graphs _and_ pseudo graphs. */
-int       get_irp_n_allirgs(void) {
-  /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
-  return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
+int get_irp_n_allirgs(void) {
+       /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
+       return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
 }
 
 /* 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) {
-  int n_irgs = ARR_LEN(irp->graphs);
-  assert(0 <= pos);
-  if (pos < n_irgs) {
-    return irp->graphs[pos];
-  } else {
-    return get_irp_pseudo_irg(pos-n_irgs);
-  }
+       int n_irgs = ARR_LEN(irp->graphs);
+       assert(0 <= pos);
+       if (pos < n_irgs) {
+               return irp->graphs[pos];
+       } else {
+               return get_irp_pseudo_irg(pos-n_irgs);
+       }
 }
 
 /* Adds type to the list of types in irp. */
 void add_irp_type(ir_type *typ) {
-  assert (typ != NULL);
-  assert(irp);
-  ARR_APP1 (ir_type *, irp->types, typ);
+       assert(typ != NULL);
+       assert(irp);
+       ARR_APP1 (ir_type *, irp->types, typ);
 }
 
 /* Remove type form the list of types in irp. */
 void remove_irp_type(ir_type *typ) {
-  int i;
-  assert(typ);
+       int i;
+       assert(typ);
 
-  for (i = ARR_LEN(irp->types) -1; i >= 0; i--) {
-    if (irp->types[i] == typ) {
-      for(; i < (ARR_LEN(irp->types)) - 1; i++) {
-        irp->types[i] = irp->types[i+1];
-      }
-      ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
-      break;
-    }
-  }
+       for (i = ARR_LEN(irp->types) -1; i >= 0; i--) {
+               if (irp->types[i] == typ) {
+                       for(; i < (ARR_LEN(irp->types)) - 1; i++) {
+                               irp->types[i] = irp->types[i+1];
+                       }
+                       ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
+                       break;
+               }
+       }
 }
 
 int (get_irp_n_types) (void) {
-  return _get_irp_n_types();
+       return _get_irp_n_types();
 }
 
 ir_type *(get_irp_type) (int pos) {
-  return _get_irp_type(pos);
+       return _get_irp_type(pos);
 }
 
 void set_irp_type(int pos, ir_type *typ) {
-  assert (irp && typ);
-  assert (pos < (ARR_LEN((irp)->types)));
-  irp->types[pos] = typ;
+       assert(irp && typ);
+       assert(pos < (ARR_LEN((irp)->types)));
+       irp->types[pos] = typ;
 }
 
 /* Returns the number of all modes in the irp. */
 int (get_irp_n_modes)(void) {
-  return _get_irp_n_modes();
+       return _get_irp_n_modes();
 }
 
 /* Returns the mode at position pos in the irp. */
 ir_mode *(get_irp_mode)(int pos) {
-  return _get_irp_mode(pos);
+       return _get_irp_mode(pos);
 }
 
 /* Adds mode to the list of modes in irp. */
 void add_irp_mode(ir_mode *mode) {
-  assert(mode != NULL);
-  assert(irp);
-  ARR_APP1(ir_mode *, irp->modes, mode);
+       assert(mode != NULL);
+       assert(irp);
+       ARR_APP1(ir_mode *, irp->modes, mode);
 }
 
 /* Adds opcode to the list of opcodes in irp. */
 void add_irp_opcode(ir_op *opcode) {
-  assert(opcode != NULL);
-  assert(irp);
-  ARR_APP1(ir_op *, irp->opcodes, opcode);
+       assert(opcode != NULL);
+       assert(irp);
+       assert(opcode->code == (unsigned) ARR_LEN(irp->opcodes) && "new_ir_op() called in wrong order");
+       ARR_APP1(ir_op *, irp->opcodes, opcode);
 }
 
 /* Removes opcode from the list of opcodes and shrinks the list by one. */
 void remove_irp_opcode(ir_op *opcode) {
-  int i;
-  assert(opcode);
+       int i;
 
-  for (i = ARR_LEN(irp->opcodes) -1; i >= 0; i--) {
-    if (irp->opcodes[i] == opcode) {
-      for(; i < (ARR_LEN(irp->opcodes)) - 1; i++) {
-        irp->opcodes[i] = irp->opcodes[i+1];
-      }
-      ARR_SETLEN(ir_op *, irp->opcodes, (ARR_LEN(irp->opcodes)) - 1);
-      break;
-    }
-  }
+       assert(opcode);
+       for (i = ARR_LEN(irp->opcodes) -1; i >= 0; i--) {
+               if (irp->opcodes[i] != opcode)
+                       continue;
+               for (; i < (ARR_LEN(irp->opcodes)) - 1; i++) {
+                       irp->opcodes[i] = irp->opcodes[i+1];
+               }
+               ARR_SETLEN(ir_op *, irp->opcodes, (ARR_LEN(irp->opcodes)) - 1);
+               return;
+       }
+       panic("Deleting unknown opcode");
 }
 
 /* Returns the number of all opcodes in the irp. */
 int (get_irp_n_opcodes)(void) {
-  return _get_irp_n_opcodes();
+       return _get_irp_n_opcodes();
 }
 
 /* Returns the opcode at position pos in the irp. */
 ir_op *(get_irp_opcode)(int pos) {
-  return _get_irp_opcode(pos);
+       return _get_irp_opcode(pos);
 }
 
 /* Sets the generic function pointer of all opcodes to NULL */
 void  clear_irp_opcodes_generic_func(void) {
-  int i;
+       int i;
 
-  for (i = get_irp_n_opcodes() - 1; i >= 0; --i) {
-    ir_op *op = get_irp_opcode(i);
-    op->ops.generic = (op_func)NULL;
-  }
+       for (i = get_irp_n_opcodes() - 1; i >= 0; --i) {
+               ir_op *op = get_irp_opcode(i);
+               op->ops.generic = (op_func)NULL;
+       }
 }
 
 /*- File name / executable name or the like -*/
 void   set_irp_prog_name(ident *name) {
-  irp->name = name;
+       irp->name = name;
 }
 int irp_prog_name_is_set(void) {
-  return irp->name != new_id_from_str(INITAL_PROG_NAME);
+       return irp->name != new_id_from_str(INITAL_PROG_NAME);
 }
 ident *get_irp_prog_ident(void) {
-  return irp->name;
+       return irp->name;
 }
 const char  *get_irp_prog_name(void) {
-  return get_id_str(irp->name);
+       return get_id_str(irp->name);
 }
 
 
 ir_graph *(get_const_code_irg)(void) {
-  return _get_const_code_irg();
+       return _get_const_code_irg();
 }
 
 irg_phase_state get_irp_phase_state(void) {
-  return irp->phase_state;
+       return irp->phase_state;
 }
-void           set_irp_phase_state(irg_phase_state s) {
-  irp->phase_state = s;
+
+void set_irp_phase_state(irg_phase_state s) {
+       irp->phase_state = s;
 }
 
 irg_outs_state get_irp_ip_outs_state(void) {
-  return irp->outs_state;
+       return irp->outs_state;
 }
 
 void set_irp_ip_outs_inconsistent(void) {
-  irp->outs_state = outs_inconsistent;
+       irp->outs_state = outs_inconsistent;
 }
 
-void      set_irp_ip_outedges(ir_node ** ip_outedges)
-{
-  irp->ip_outedges = ip_outedges;
+void set_irp_ip_outedges(ir_node ** ip_outedges) {
+       irp->ip_outedges = ip_outedges;
 }
 
-ir_node** get_irp_ip_outedges(void)
-{
-  return irp->ip_outedges;
+ir_node** get_irp_ip_outedges(void) {
+       return irp->ip_outedges;
 }
 
-
 irg_callee_info_state get_irp_callee_info_state(void) {
-  return irp->callee_info_state;
+       return irp->callee_info_state;
 }
 
 void set_irp_callee_info_state(irg_callee_info_state s) {
-  irp->callee_info_state = s;
+       irp->callee_info_state = s;
+}
+
+/* Returns a new, unique exception region number. */
+ir_exc_region_t (get_irp_next_region_nr)(void) {
+       return _get_irp_next_region_nr();
 }
+
+/* Returns a new, unique label number. */
+ir_label_t (get_irp_next_label_nr)(void) {
+       return _get_irp_next_label_nr();
+}
+
+/* Add a new global asm include */
+void add_irp_asm(ident *asm_string) {
+       ARR_APP1(ident *, irp->global_asms, asm_string);
+}
+
+/* Return the number of global asm includes. */
+int get_irp_n_asms(void) {
+       return ARR_LEN(irp->global_asms);
+}
+
+/* Return the global asm include at position pos. */
+ident *get_irp_asm(int pos) {
+       assert(pos <= 0 && pos < get_irp_n_asms());
+       return irp->global_asms[pos];
+}
+
+#ifndef NDEBUG
+void irp_reserve_resources(ir_prog *irp, ir_resources_t resources) {
+       assert((irp->reserved_resources & resources) == 0);
+       irp->reserved_resources |= resources;
+}
+
+void irp_free_resources(ir_prog *irp, ir_resources_t resources) {
+       assert((irp->reserved_resources & resources) == resources);
+       irp->reserved_resources &= ~resources;
+}
+
+ir_resources_t irp_resources_reserved(const ir_prog *irp) {
+       return irp->reserved_resources;
+}
+#endif