nsz Git - libfirm/blob - ir/lower/lower_copyb.c

   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  * @file
  22  * @brief   Lower small CopyB nodes into a series of Load/Store nodes
  23  * @author  Michael Beck, Matthias Braun, Manuel Mohr
  24  */
  25 #include "config.h"
  26
  27 #include "adt/list.h"
  28 #include "ircons.h"
  29 #include "lowering.h"
  30 #include "irprog_t.h"
  31 #include "irgwalk.h"
  32 #include "irnode_t.h"
  33 #include "type_t.h"
  34 #include "irtools.h"
  35 #include "irgmod.h"
  36 #include "error.h"
  37 #include "be.h"
  38
  39 typedef struct entry entry_t;
  40 struct entry {
  41         struct list_head list;
  42         ir_node *copyb;
  43 };
  44
  45 /**
  46  * Every CopyB is assigned a size category as follows:
  47  *  - 'small'  iff                  size <= max_small_size,
  48  *  - 'medium' iff max_small_size < size <  min_large_size,
  49  *  - 'large'  iff                  size >= min_large_size.
  50  *
  51  * The idea is that each backend can apply different optimizations in each
  52  * of the three categories.
  53  *
  54  * For small CopyBs, the x86 backend could, e.g., emit a single SSE
  55  * instruction to copy 16 bytes.  Other backends might just go with a series
  56  * of Load/Stores.  Therefore, x86 would like to keep the small CopyB nodes
  57  * around whereas other backends would not.
  58  * For medium-sized CopyBs, the x86 backend might generate a rep-prefixed mov
  59  * instruction.  Hence, it also wants to keep the CopyBs in these cases.  Other
  60  * backends might handle this differently.
  61  * For large CopyBs, a call to memcpy is worth the call overhead, so large
  62  * CopyBs should always be lowered to memcpy calls.
  63  *
  64  * The lowerer performs the following actions if the CopyB is
  65  * - 'small':  Replace it with a series of Loads/Stores
  66  * - 'medium': Nothing.
  67  * - 'large':  Replace it with a call to memcpy.
  68  *
  69  * max_small_size and min_large_size allow for a flexible configuration.
  70  * For example, one backend could specify max_small_size == 0 and
  71  * min_large_size == 8192 to keep all CopyB nodes smaller than 8192 and get
  72  * memcpy Calls for all others.  Here, the set of small CopyBs is empty.
  73  * Another backend could specify max_small_size == 63 and min_large_size == 64
  74  * to lower all small CopyBs to Loads/Stores and all big CopyBs to memcpy.
  75  * Hence, the set of medium-sized CopyBs is empty and this backend never
  76  * sees a CopyB node at all.
  77  * If memcpy is not available, min_large_size can be set to UINT_MAX to prevent
  78  * the creation of calls to memcpy.  Note that CopyBs whose size is UINT_MAX
  79  * will still be lowered to memcpy calls because we check if the size is greater
  80  * *or equal* to min_large_size.  However, this should never occur in practice.
  81  */
  82
  83 static unsigned max_small_size; /**< The maximum size of a CopyB node
  84                                      so that it is regarded as 'small'. */
  85 static unsigned min_large_size; /**< The minimum size of a CopyB node
  86                                      so that it is regarded as 'large'. */
  87 static unsigned native_mode_bytes; /**< The size of the native mode in bytes. */
  88 static int allow_misalignments; /**< Whether backend can handle misaligned
  89                                      loads and stores. */
  90
  91 typedef struct walk_env {
  92         struct obstack   obst;           /**< the obstack where data is allocated
  93                                               on. */
  94         struct list_head list;           /**< the list of copyb nodes. */
  95 } walk_env_t;
  96
  97 static ir_mode *get_ir_mode(unsigned mode_bytes)
  98 {
  99         switch (mode_bytes) {
 100         case 1:  return mode_Bu;
 101         case 2:  return mode_Hu;
 102         case 4:  return mode_Iu;
 103         case 8:  return mode_Lu;
 104         case 16: return mode_LLu;
 105         default:
 106                 panic("unexpected mode size requested in copyb lowering");
 107         }
 108 }
 109
 110 /**
 111  * Turn a small CopyB node into a series of Load/Store nodes.
 112  */
 113 static void lower_small_copyb_node(ir_node *irn)
 114 {
 115         ir_graph *irg        = get_irn_irg(irn);
 116         ir_node  *block      = get_nodes_block(irn);
 117         ir_type  *tp         = get_CopyB_type(irn);
 118         ir_node  *addr_src   = get_CopyB_src(irn);
 119         ir_node  *addr_dst   = get_CopyB_dst(irn);
 120         ir_node  *mem        = get_CopyB_mem(irn);
 121         ir_mode  *addr_mode  = get_irn_mode(addr_src);
 122         unsigned  mode_bytes = allow_misalignments ? native_mode_bytes : tp->align;
 123         unsigned  size       = get_type_size_bytes(tp);
 124         unsigned  offset     = 0;
 125         ir_mode  *mode;
 126
 127         while (offset < size) {
 128                 mode = get_ir_mode(mode_bytes);
 129                 for (; offset + mode_bytes <= size; offset += mode_bytes) {
 130                         /* construct offset */
 131                         ir_node *addr_const;
 132                         ir_node *add;
 133                         ir_node *load;
 134                         ir_node *load_res;
 135                         ir_node *load_mem;
 136                         ir_node *store;
 137                         ir_node *store_mem;
 138
 139                         addr_const = new_r_Const_long(irg, mode_Iu, offset);
 140                         add        = new_r_Add(block, addr_src, addr_const, addr_mode);
 141
 142                         load     = new_r_Load(block, mem, add, mode, cons_none);
 143                         load_res = new_r_Proj(load, mode, pn_Load_res);
 144                         load_mem = new_r_Proj(load, mode_M, pn_Load_M);
 145
 146                         addr_const = new_r_Const_long(irg, mode_Iu, offset);
 147                         add        = new_r_Add(block, addr_dst, addr_const, addr_mode);
 148
 149                         store     = new_r_Store(block, load_mem, add, load_res, cons_none);
 150                         store_mem = new_r_Proj(store, mode_M, pn_Store_M);
 151
 152                         mem = store_mem;
 153                 }
 154
 155                 mode_bytes /= 2;
 156         }
 157
 158         turn_into_tuple(irn, pn_CopyB_max+1);
 159         set_Tuple_pred(irn, pn_CopyB_M,         mem);
 160         set_Tuple_pred(irn, pn_CopyB_X_regular, new_r_Bad(irg, mode_X));
 161         set_Tuple_pred(irn, pn_CopyB_X_except,  new_r_Bad(irg, mode_X));
 162 }
 163
 164 static ir_type *get_memcpy_methodtype(void)
 165 {
 166         ir_type *tp          = new_type_method(3, 1);
 167         ir_mode *size_t_mode = get_ir_mode(native_mode_bytes);
 168
 169         set_method_param_type(tp, 0, get_type_for_mode(mode_P));
 170         set_method_param_type(tp, 1, get_type_for_mode(mode_P));
 171         set_method_param_type(tp, 2, get_type_for_mode(size_t_mode));
 172         set_method_res_type  (tp, 0, get_type_for_mode(mode_P));
 173
 174         return tp;
 175 }
 176
 177 static ir_node *get_memcpy_symconst(ir_graph *irg)
 178 {
 179         ident     *id  = new_id_from_str("memcpy");
 180         ir_type   *mt  = get_memcpy_methodtype();
 181         ir_entity *ent = create_compilerlib_entity(id, mt);
 182         symconst_symbol sym;
 183
 184         sym.entity_p = ent;
 185         return new_r_SymConst(irg, mode_P_code, sym, symconst_addr_ent);
 186 }
 187
 188 /**
 189  * Turn a large CopyB node into a memcpy call.
 190  */
 191 static void lower_large_copyb_node(ir_node *irn)
 192 {
 193         ir_graph *irg      = get_irn_irg(irn);
 194         ir_node  *block    = get_nodes_block(irn);
 195         dbg_info *dbgi     = get_irn_dbg_info(irn);
 196         ir_node  *mem      = get_CopyB_mem(irn);
 197         ir_node  *addr_src = get_CopyB_src(irn);
 198         ir_node  *addr_dst = get_CopyB_dst(irn);
 199         ir_type  *copyb_tp = get_CopyB_type(irn);
 200         unsigned  size     = get_type_size_bytes(copyb_tp);
 201
 202         ir_node  *symconst    = get_memcpy_symconst(irg);
 203         ir_type  *call_tp     = get_memcpy_methodtype();
 204         ir_mode  *mode_size_t = get_ir_mode(native_mode_bytes);
 205         ir_node  *in[3];
 206         ir_node  *call;
 207         ir_node  *call_mem;
 208
 209         in[0]    = addr_dst;
 210         in[1]    = addr_src;
 211         in[2]    = new_r_Const_long(irg, mode_size_t, size);
 212         call     = new_rd_Call(dbgi, block, mem, symconst, 3, in, call_tp);
 213         call_mem = new_r_Proj(call, mode_M, pn_Call_M);
 214
 215         turn_into_tuple(irn, 1);
 216         set_irn_n(irn, pn_CopyB_M, call_mem);
 217 }
 218
 219 static void lower_copyb_node(ir_node *irn)
 220 {
 221         ir_type *tp   = get_CopyB_type(irn);
 222         unsigned size = get_type_size_bytes(tp);
 223
 224         if (size <= max_small_size)
 225                 lower_small_copyb_node(irn);
 226         else if (size >= min_large_size)
 227                 lower_large_copyb_node(irn);
 228         else
 229                 assert(!"CopyB of invalid size handed to lower_copyb_node");
 230 }
 231
 232 /**
 233  * Post-Walker: find CopyB nodes.
 234  */
 235 static void find_copyb_nodes(ir_node *irn, void *ctx)
 236 {
 237         walk_env_t *env = (walk_env_t*)ctx;
 238         ir_type    *tp;
 239         unsigned   size;
 240         entry_t    *entry;
 241         bool        medium_sized;
 242
 243         if (is_Proj(irn)) {
 244                 ir_node *pred = get_Proj_pred(irn);
 245
 246                 if (is_CopyB(pred) && get_Proj_proj(irn) != pn_CopyB_M) {
 247                         /* found an exception Proj: remove it from the list again */
 248                         entry = (entry_t*)get_irn_link(pred);
 249                         list_del(&entry->list);
 250                 }
 251                 return;
 252         }
 253
 254         if (! is_CopyB(irn))
 255                 return;
 256
 257         tp = get_CopyB_type(irn);
 258         if (get_type_state(tp) != layout_fixed)
 259                 return;
 260
 261         size         = get_type_size_bytes(tp);
 262         medium_sized = max_small_size < size && size < min_large_size;
 263         if (medium_sized)
 264                 return; /* Nothing to do for medium-sized CopyBs. */
 265
 266         /* Okay, either small or large CopyB, so link it in and lower it later. */
 267         entry = OALLOC(&env->obst, entry_t);
 268         entry->copyb = irn;
 269         INIT_LIST_HEAD(&entry->list);
 270         set_irn_link(irn, entry);
 271         list_add_tail(&entry->list, &env->list);
 272 }
 273
 274 void lower_CopyB(ir_graph *irg, unsigned max_small_sz, unsigned min_large_sz,
 275                  int allow_misaligns)
 276 {
 277         const backend_params *bparams = be_get_backend_param();
 278         walk_env_t            env;
 279
 280         assert(max_small_sz < min_large_sz && "CopyB size ranges must not overlap");
 281
 282         max_small_size      = max_small_sz;
 283         min_large_size      = min_large_sz;
 284         native_mode_bytes   = bparams->machine_size / 8;
 285         allow_misalignments = allow_misaligns;
 286
 287         obstack_init(&env.obst);
 288         INIT_LIST_HEAD(&env.list);
 289         irg_walk_graph(irg, NULL, find_copyb_nodes, &env);
 290
 291         list_for_each_entry(entry_t, entry, &env.list, list) {
 292                 lower_copyb_node(entry->copyb);
 293         }
 294
 295         obstack_free(&env.obst, NULL);
 296 }