-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-* All rights reserved.
-*/
+/*
+ * Project: libFIRM
+ * File name: ir/ir/irgraph.c
+ * Purpose: Entry point to the representation of procedure code.
+ * Author: Martin Trapp, Christian Schaefer
+ * Modified by: Goetz Lindenmaier
+ * Created:
+ * CVS-ID: $Id$
+ * Copyright: (c) 1998-2003 Universität Karlsruhe
+ * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ */
/**
* @file irgraph.h
* @author Martin Trapp, Christian Schaefer
*/
-/* $Id$ */
#include "irop.h"
* did actually change something). Code placement is necessary.
*/
-/* Global variable holding the current_ir_graph. This global variable
- is used by the ir construction interface in ircons and by the
- optimizations. */
+/** Global variable holding the current ir graph.
+ *
+ * This global variable is used by the ir construction
+ * interface in ircons and by the optimizations.
+ */
extern ir_graph *current_ir_graph;
+
ir_graph *get_current_ir_graph(void);
void set_current_ir_graph(ir_graph *graph);
void set_interprocedural_view(bool state);
/** Create a new ir graph to built ir for a procedure.
- ent is the entity representing this procedure, i.e., the type of the
- entity must be of a method type. The constructor automatically sets the
- field irg of the entity as well as current_ir_graph to the new ir graph.
- n_loc is the number of local variables in this procedure including
- the procedure parameters.
- The state of the ir graph is: phase_building, pinned, no_outs. */
+ *
+ * ent is the entity representing this procedure, i.e., the type of the
+ * entity must be of a method type. The constructor automatically sets the
+ * field irg of the entity as well as current_ir_graph to the new ir graph.
+ * n_loc is the number of local variables in this procedure including
+ * the procedure parameters.
+ * The constructor adds the new irgraph to the list in ir_prog.
+ * The state of the ir graph is: phase_building, pinned, no_outs. */
ir_graph *new_ir_graph (entity *ent, int n_loc);
/** Frees the passed irgraph.
- Deallocates all nodes in this graph and the ir_graph structure.
- Sets the field irgraph in the corresponding entity to NULL.
- Does not remove the irgraph from the list in irprog (requires
- inefficient search, call remove_irp_irg by hand).
- Does not free types, entities or modes that are used only by this
- graph, nor the entity standing for this graph. */
+ * Deallocates all nodes in this graph and the ir_graph structure.
+ * Sets the field irgraph in the corresponding entity to NULL.
+ * Does not remove the irgraph from the list in irprog (requires
+ * inefficient search, call remove_irp_irg by hand).
+ * Does not free types, entities or modes that are used only by this
+ * graph, nor the entity standing for this graph.
+ */
void free_ir_graph (ir_graph *irg);
/* --- access routines for all ir_graph attributes --- */
+
+/**
+ * Checks whether a pointer points to a ir graph.
+ *
+ * @param thing an arbitrary pointer
+ *
+ * @return
+ * true if the thing is a ir graph, else false
+ */
+int is_ir_graph(void *thing);
+
+#define get_irg_entity get_irg_ent
+#define set_irg_entity set_irg_ent
entity *get_irg_ent (ir_graph *irg);
void set_irg_ent (ir_graph *irg, entity *ent);
type *get_irg_frame_type (ir_graph *irg);
void set_irg_frame_type (ir_graph *irg, type *ftp);
-/* To test for a frame type */
-int is_frame_type(type *ftp);
+/* To test for a frame type. O(#irgs) if ftp is class type. */
+int is_frame_type (type *ftp);
ir_node *get_irg_start_block (ir_graph *irg);
void set_irg_start_block (ir_graph *irg, ir_node *node);
ir_node *get_irg_end (ir_graph *irg);
void set_irg_end (ir_graph *irg, ir_node *node);
+/* The fields end_reg and end_except contain the end nodes of the
+ interprocedural view. If the view is not constructed they contain
+ the nomal end node. */
+ir_node *get_irg_end_reg (ir_graph *irg);
+void set_irg_end_reg (ir_graph *irg, ir_node *node);
+
+ir_node *get_irg_end_except (ir_graph *irg);
+void set_irg_end_except (ir_graph *irg, ir_node *node);
+
+
/* @@@ oblivious, no more supported. */
ir_node *get_irg_cstore (ir_graph *irg);
void set_irg_cstore (ir_graph *irg, ir_node *node);
/* end oblivious */
+/** Returns the node that represents the frame pointer. */
ir_node *get_irg_frame (ir_graph *irg);
+/** Sets the node that represents the frame pointer. */
void set_irg_frame (ir_graph *irg, ir_node *node);
+/** Returns the node that represents the global pointer. */
ir_node *get_irg_globals (ir_graph *irg);
+/** Sets the node that represents the global pointer. */
void set_irg_globals (ir_graph *irg, ir_node *node);
+/** Returns the node that represents the initial memory. */
+ir_node *get_irg_initial_mem (ir_graph *irg);
+/** Sets the node that represents the initial memory. */
+void set_irg_initial_mem (ir_graph *irg, ir_node *node);
+
+/** Returns the node that represents the argument pointer. */
ir_node *get_irg_args (ir_graph *irg);
+/** Sets the node that represents the argument pointer. */
void set_irg_args (ir_graph *irg, ir_node *node);
+/** Returns the current block of a graph. */
ir_node *get_irg_current_block (ir_graph *irg);
+/** Sets the current block of a graph. */
void set_irg_current_block (ir_graph *irg, ir_node *node);
/* Use new_Bad() instead!! */
void set_irg_bad (ir_graph *irg, ir_node *node);
/* Use new_Unknown() instead!! */
+/* GL removed: we need unknown with mode for analyses.
ir_node *get_irg_unknown (ir_graph *irg);
void set_irg_unknown (ir_graph *irg, ir_node *node);
+*/
+/** Returns teh number of value numbers of a graph. */
int get_irg_n_locs (ir_graph *irg);
-INLINE long get_irg_graph_nr(ir_graph *irg);
+/** Returns the graph number. */
+long get_irg_graph_nr(ir_graph *irg);
/********************************************************************************/
/* States of an ir_graph. */
irg_phase_state get_irg_phase_state (ir_graph *irg);
void set_irg_phase_low(ir_graph *irg);
-/* state: pinned
+/** state: pinned
The graph is "pinned" if all nodes are associated with a basic block.
It is in state "floats" if nodes are in arbitrary blocks. In state
"floats" the block predecessor is set in all nodes, but this can be an
/* state: loopinfo_state
Loop information describes the loops within the control and
- data flow of the procedure.
-tpedef enum { @@@ make unrecognizable for jni script!!!
- no_loopinfo,
- loopinfo_consistent,
- loopinfo_inconsistent
+ data flow of the procedure. */
+typedef enum {
+ loopinfo_none, /**< No loop information is constructed. Default. */
+ loopinfo_consistent, /**< IntRAprocedural loop information constructed and valid. */
+ loopinfo_inconsistent, /**< IntRAprocedural loop information constructed and invalid. */
+ loopinfo_ip_consistent, /**< IntERprocedural loop information constructed and valid. */
+ loopinfo_ip_inconsistent, /**< IntERprocedural loop information constructed and invalid. */
+ loopinfo_cf_consistent, /**< IntRAprocedural control loop information constructed and valid. */
+ loopinfo_cf_inconsistent, /**< IntRAprocedural control loop information constructed and invalid. */
+ loopinfo_cf_ip_consistent, /**< IntERprocedural control loop information constructed and valid. */
+ loopinfo_cf_ip_inconsistent /**< IntERprocedural control loop information constructed and invalid. */
} irg_loopinfo_state;
irg_loopinfo_state get_irg_loopinfo_state(ir_graph *irg);
+void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
+/* Sets the loopinformation state to the appropriate inconsistent state.
+ If state is 'none' does not change. */
void set_irg_loopinfo_inconsistent(ir_graph *irg);
-*/
-/* A void * field to link arbritary information to the node. */
-void set_irg_link (ir_graph *irg, void *thing);
+
+/** state: callee_information_state
+ * Call nodes contain a list of possible callees. This list must be
+ * computed by an anlyses. */
+typedef enum {
+ irg_callee_info_none,
+ irg_callee_info_consistent,
+ irg_callee_info_inconsistent
+} irg_callee_info_state;
+irg_callee_info_state get_irg_callee_info_state(ir_graph *irg);
+void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
+
+/** property:
+ * Tells how to handle an ir graph in inlineing.
+ */
+typedef enum {
+ irg_inline_any, /**< No restriction on inlineing. Default. */
+ irg_inline_forbidden, /**< The graph may not be inlined. */
+ irg_inline_recomended, /**< The graph should be inlined. */
+ irg_inline_forced /**< The graph must be inlined. */
+} irg_inline_property;
+irg_inline_property get_irg_inline_property(ir_graph *irg);
+void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
+
+/** A void * field to link arbritary information to the node. */
+void set_irg_link (ir_graph *irg, void *thing);
void *get_irg_link (ir_graph *irg);
/* increments visited by one */
-void inc_irg_visited(ir_graph *irg);
+void inc_irg_visited (ir_graph *irg);
unsigned long get_irg_visited (ir_graph *irg);
-void set_irg_visited(ir_graph *irg, unsigned long i);
-unsigned long get_max_irg_visited(void);
-void set_max_irg_visited(int val);
-unsigned long inc_max_irg_visited(void);
+void set_irg_visited (ir_graph *irg, unsigned long i);
+unsigned long get_max_irg_visited (void);
+void set_max_irg_visited (int val);
+unsigned long inc_max_irg_visited (void);
/* increments block_visited by one */
-void inc_irg_block_visited(ir_graph *irg);
+void inc_irg_block_visited (ir_graph *irg);
unsigned long get_irg_block_visited (ir_graph *irg);
-void set_irg_block_visited(ir_graph *irg, unsigned long i);
+void set_irg_block_visited (ir_graph *irg, unsigned long i);
# endif /* _IRGRAPH_H_ */
projects / libfirm / blobdiff