nsz Git - libfirm/blob - ir/be/beutil.h

   1 /*
   2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20
  21 #ifndef _BEUTIL_H
  22 #define _BEUTIL_H
  23
  24 #include "firm_config.h"
  25
  26 #include <stdio.h>
  27
  28 #include "pset.h"
  29 #include "irnode.h"
  30 #include "bearch_t.h"
  31
  32 /* iterate over a list of ir_nodes linked by link field */
  33 #define foreach_linked_irns(head, iter) for ((iter) = (head); (iter); (iter) = get_irn_link((iter)))
  34
  35 /**
  36  * Get an empty set.
  37  * This function always returns the same set.
  38  */
  39 pset *be_empty_set(void);
  40
  41 /** Undefine this to disable debugging mode. */
  42 #define BE_DEBUG 1
  43
  44 /**
  45  * Convenient block getter.
  46  * Works also, if the given node is a block.
  47  * @param  irn The node.
  48  * @return The block of the node, or the node itself, if the node is a
  49  *         block.
  50  */
  51 static INLINE const ir_node *get_block(const ir_node *irn)
  52 {
  53         return is_Block(irn) ? irn : get_nodes_block(irn);
  54 }
  55
  56 static INLINE int is_firm_be_mode(const ir_mode *mode)
  57 {
  58         return mode_is_data(mode);
  59 }
  60
  61 /**
  62  * Check, if a node produces or consumes a data value.
  63  * If it does, it is significant for scheduling and register allocation.
  64  * A node produces/consumes a data value, if one of its operands is of
  65  * mode datab, or his retuning mode is of mode datab.
  66  * @param irn The node to check for.
  67  * @return 1, if the node is a data node, 0 if not.
  68  */
  69 static INLINE int is_data_node(const ir_node *irn)
  70 {
  71         int i, n;
  72
  73         /* If the node produces a data value, return immediately. */
  74         if(is_firm_be_mode(get_irn_mode(irn)))
  75                 return 1;
  76
  77         /* else check, if it takes a data value, if that is so, return */
  78         for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
  79                 ir_node *op = get_irn_n(irn, i);
  80                 if(is_firm_be_mode(get_irn_mode(op)))
  81                         return 1;
  82         }
  83
  84         /* Else the node does not produce/consume a data value */
  85         return 0;
  86 }
  87
  88 /**
  89  * Dump a vcg graph containing the controlflow graph, the schedule and
  90  * allocated registers.
  91  * @param irg The irg. Note that scheduling, register allocation must
  92  * have been performed.
  93  */
  94 void dump_allocated_irg(arch_env_t *env, ir_graph *irg, char *suffix);
  95
  96 void be_clear_links(ir_graph *irg);
  97
  98 static INLINE FILE *ffopen(const char *base, const char *ext, const char *mode) {
  99         FILE *out;
 100         char buf[1024];
 101
 102         snprintf(buf, sizeof(buf), "%s.%s", base, ext);
 103         buf[sizeof(buf) - 1] = '\0';
 104         if (! (out = fopen(buf, mode))) {
 105                 fprintf(stderr, "Cannot open file %s in mode %s\n", buf, mode);
 106                 return NULL;
 107         }
 108         return out;
 109 }
 110
 111 /**
 112  * Dump a graph with schedule edges.
 113  * @param irg The graph.
 114  * @param suffix A suffix to its file name.
 115  */
 116 void dump_ir_block_graph_sched(ir_graph *irg, const char *suffix);
 117
 118 /**
 119  * Dump a extended block graph with schedule edges.
 120  * @param irg The graph.
 121  * @param suffix A suffix to its file name.
 122  */
 123 void dump_ir_extblock_graph_sched(ir_graph *irg, const char *suffix);
 124
 125 /**
 126  * Dumps a graph and numbers all dumps.
 127  * @param irg    The graph
 128  * @param suffix A suffix to its file name.
 129  * @param dumper The dump function
 130  */
 131 void be_dump(ir_graph *irg, const char *suffix, void (*dumper)(ir_graph *, const char *));
 132
 133 /**
 134  * Returns the number of reachable nodes in an irg.
 135  * @param irg The irg.
 136  * @return The number of reachable nodes.
 137  */
 138 unsigned get_num_reachable_nodes(ir_graph *irg);
 139
 140 /**
 141  * Sets all node inputs to BAD node.
 142  * @param irn  The node to be killed.
 143  */
 144 void be_kill_node(ir_node *irn);
 145
 146 /**
 147  * Search for an irn in @p accept.
 148  * The search is started at @p start_point_exclusive and continues upwards the dom-tree
 149  * @return The first node out of accept if found. Else NULL is returned.
 150  */
 151 ir_node *dom_up_search(pset *accept, ir_node *start_point_exclusive);
 152
 153 /**
 154  * Gets the Proj with number pn from irn.
 155  */
 156 ir_node *be_get_Proj_for_pn(const ir_node *irn, long pn);
 157
 158 #endif /* _BEUTIL_H */