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 <stdio.h>
  30
  31 #include "firm_types.h"
  32 #include "pset.h"
  33
  34 #include "bearch.h"
  35
  36 #ifdef _MSC_VER
  37 typedef          __int64 long64;
  38 typedef unsigned __int64 ulong64;
  39
  40 #define LL_FMT  "i64"
  41 #define ULL_FMT "ui64"
  42
  43 #else
  44 typedef          long long long64;
  45 typedef unsigned long long ulong64;
  46
  47 #define LL_FMT  "ll"
  48 #define ULL_FMT "llu"
  49
  50 #endif /* _MSC_VER */
  51
  52 /* iterate over a list of ir_nodes linked by link field */
  53 #define foreach_linked_irns(head, iter) for ((iter) = (head); (iter); (iter) = get_irn_link((iter)))
  54
  55 /**
  56  * Convenient block getter.
  57  * Works also, if the given node is a block.
  58  * @param  irn The node.
  59  * @return The block of the node, or the node itself, if the node is a
  60  *         block.
  61  */
  62 static inline ir_node *get_block(ir_node *irn)
  63 {
  64         return is_Block(irn) ? irn : get_nodes_block(irn);
  65 }
  66
  67 static inline const ir_node *get_block_const(const ir_node *irn)
  68 {
  69         return is_Block(irn) ? irn : get_nodes_block(irn);
  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 (mode_is_data(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 (mode_is_data(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  * Clears the link fields of all nodes of the given graph.
 101  * @param irg The graph.
 102  */
 103 void be_clear_links(ir_graph *irg);
 104
 105 /**
 106  * Dump a graph with schedule edges.
 107  * @param irg The graph.
 108  * @param suffix A suffix to its file name.
 109  */
 110 void dump_ir_block_graph_sched(ir_graph *irg, const char *suffix);
 111
 112 /**
 113  * Dump a extended block graph with schedule edges.
 114  * @param irg The graph.
 115  * @param suffix A suffix to its file name.
 116  */
 117 void dump_ir_extblock_graph_sched(ir_graph *irg, const char *suffix);
 118
 119 /**
 120  * Dumps a graph and numbers all dumps.
 121  * @param irg    The graph
 122  * @param suffix A suffix to its file name.
 123  * @param dumper The dump function
 124  */
 125 void be_dump(ir_graph *irg, const char *suffix, void (*dumper)(ir_graph *, const char *));
 126
 127 /**
 128  * Returns the number of reachable nodes in an irg.
 129  * @param irg The irg.
 130  * @return The number of reachable nodes.
 131  */
 132 unsigned get_num_reachable_nodes(ir_graph *irg);
 133
 134 /**
 135  * Gets the Proj with number pn from irn.
 136  */
 137 ir_node *be_get_Proj_for_pn(const ir_node *irn, long pn);
 138
 139 /**
 140  * Returns an array (an ARR_F) of the programs blocks in reverse postorder
 141  * (note: caller has to free the memory with DEL_ARR_F after use;
 142  *  of course you can use ARR_LEN on the array too.)
 143  */
 144 ir_node **be_get_cfgpostorder(ir_graph *irg);
 145
 146 /**
 147  * Opens a file named base.ext with the mode mode.
 148  */
 149 FILE *be_ffopen(const char *base, const char *ext, const char *mode);
 150
 151 /**
 152  * convenience function to return the first successor block
 153  * (it is often known that there is exactly 1 successor anyway)
 154  */
 155 ir_node *get_first_block_succ(const ir_node *block);
 156
 157 #endif