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

   1 /*
   2  * Copyright (C) 1995-2008 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  * @file
  22  * @brief       Contains some useful function for the backend.
  23  * @author      Sebastian Hack
  24  * @version     $Id$
  25  */
  26 #ifndef FIRM_BE_BEUTIL_H
  27 #define FIRM_BE_BEUTIL_H
  28
  29 #include "firm_config.h"
  30
  31 #include <stdio.h>
  32
  33 #include "firm_types.h"
  34 #include "pset.h"
  35
  36 #include "bearch_t.h"
  37
  38 /* iterate over a list of ir_nodes linked by link field */
  39 #define foreach_linked_irns(head, iter) for ((iter) = (head); (iter); (iter) = get_irn_link((iter)))
  40
  41 /**
  42  * Get an empty set.
  43  * This function always returns the same set.
  44  */
  45 pset *be_empty_set(void);
  46
  47 /** Undefine this to disable debugging mode. */
  48 #define BE_DEBUG 1
  49
  50 /**
  51  * Convenient block getter.
  52  * Works also, if the given node is a block.
  53  * @param  irn The node.
  54  * @return The block of the node, or the node itself, if the node is a
  55  *         block.
  56  */
  57 static INLINE ir_node *get_block(ir_node *irn)
  58 {
  59         return is_Block(irn) ? irn : get_nodes_block(irn);
  60 }
  61
  62 static INLINE const ir_node *get_block_const(const ir_node *irn)
  63 {
  64         return is_Block(irn) ? irn : get_nodes_block(irn);
  65 }
  66
  67 static INLINE int is_firm_be_mode(const ir_mode *mode)
  68 {
  69         return mode_is_data(mode);
  70 }
  71
  72 /**
  73  * Check, if a node produces or consumes a data value.
  74  * If it does, it is significant for scheduling and register allocation.
  75  * A node produces/consumes a data value, if one of its operands is of
  76  * mode datab, or his retuning mode is of mode datab.
  77  * @param irn The node to check for.
  78  * @return 1, if the node is a data node, 0 if not.
  79  */
  80 static INLINE int is_data_node(const ir_node *irn)
  81 {
  82         int i, n;
  83
  84         /* If the node produces a data value, return immediately. */
  85         if (is_firm_be_mode(get_irn_mode(irn)))
  86                 return 1;
  87
  88         /* else check, if it takes a data value, if that is so, return */
  89         for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
  90                 ir_node *op = get_irn_n(irn, i);
  91                 if (is_firm_be_mode(get_irn_mode(op)))
  92                         return 1;
  93         }
  94
  95         /* Else the node does not produce/consume a data value */
  96         return 0;
  97 }
  98
  99 /**
 100  * Dump a vcg graph containing the controlflow graph, the schedule and
 101  * allocated registers.
 102  * @param irg The irg. Note that scheduling, register allocation must
 103  * have been performed.
 104  */
 105 void dump_allocated_irg(arch_env_t *env, ir_graph *irg, char *suffix);
 106
 107 void be_clear_links(ir_graph *irg);
 108
 109 /**
 110  * Dump a graph with schedule edges.
 111  * @param irg The graph.
 112  * @param suffix A suffix to its file name.
 113  */
 114 void dump_ir_block_graph_sched(ir_graph *irg, const char *suffix);
 115
 116 /**
 117  * Dump a extended block graph with schedule edges.
 118  * @param irg The graph.
 119  * @param suffix A suffix to its file name.
 120  */
 121 void dump_ir_extblock_graph_sched(ir_graph *irg, const char *suffix);
 122
 123 /**
 124  * Dumps a graph and numbers all dumps.
 125  * @param irg    The graph
 126  * @param suffix A suffix to its file name.
 127  * @param dumper The dump function
 128  */
 129 void be_dump(ir_graph *irg, const char *suffix, void (*dumper)(ir_graph *, const char *));
 130
 131 /**
 132  * Returns the number of reachable nodes in an irg.
 133  * @param irg The irg.
 134  * @return The number of reachable nodes.
 135  */
 136 unsigned get_num_reachable_nodes(ir_graph *irg);
 137
 138 /**
 139  * Sets all node inputs to BAD node.
 140  * @param irn  The node to be killed.
 141  */
 142 void be_kill_node(ir_node *irn);
 143
 144 /**
 145  * Gets the Proj with number pn from irn.
 146  */
 147 ir_node *be_get_Proj_for_pn(const ir_node *irn, long pn);
 148
 149 /**
 150  * Opens a file named base.ext with the mode mode.
 151  */
 152 FILE *be_ffopen(const char *base, const char *ext, const char *mode);
 153
 154 #endif /* FIRM_BE_BEUTIL_H */