2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Procedure cloning.
23 * @author Beyhan Veliev, Michael Beck
27 * The purpose is first to find and analyze functions, that are called
28 * with constant parameter(s).
29 * The second step is to optimize the function that are found from our
30 * analyze. Optimize mean to make a new function with parameters, that
31 * aren't be constant. The constant parameters of the function are placed
32 * in the function graph. They aren't be passed as parameters.
38 #include "iroptimize.h"
44 #include "analyze_irg_args.h"
55 * This struct contains the information quadruple for a Call, which we need to
56 * decide if this function must be cloned.
58 typedef struct quadruple {
59 ir_entity *ent; /**< The entity of our Call. */
60 size_t pos; /**< Position of a constant argument of our Call. */
61 ir_tarval *tv; /**< The tarval of this argument if Const node. */
62 ir_node **calls; /**< The list of all calls with the same characteristics */
66 * The quadruplets are hold in a sorted list
68 typedef struct entry {
69 quadruple_t q; /**< the quadruple */
70 float weight; /**< its weight */
71 struct entry *next; /**< link to the next one */
74 typedef struct q_set {
75 struct obstack obst; /**< an obstack containing all entries */
76 pset *map; /**< a hash map containing the quadruples */
77 entry_t *heavy_uses; /**< the ordered list of heavy uses */
81 * Compare two quadruplets.
83 * @return zero if they are identically, non-zero else
85 static int entry_cmp(const void *elt, const void *key)
87 const entry_t *e1 = (const entry_t*)elt;
88 const entry_t *e2 = (const entry_t*)key;
90 return (e1->q.ent != e2->q.ent) || (e1->q.pos != e2->q.pos) || (e1->q.tv != e2->q.tv);
94 * Hash an element of type entry_t.
96 * @param entry The element to be hashed.
98 static unsigned hash_entry(const entry_t *entry)
100 return HASH_PTR(entry->q.ent) ^ HASH_PTR(entry->q.tv) ^ (unsigned)(entry->q.pos * 9);
104 * Free memory associated with a quadruplet.
106 static void kill_entry(entry_t *entry)
108 if (entry->q.calls) {
109 DEL_ARR_F(entry->q.calls);
110 entry->q.calls = NULL;
115 * Process a call node.
117 * @param call A ir_node to be checked.
118 * @param callee The entity of the callee
119 * @param hmap The quadruple-set containing the calls with constant parameters
121 static void process_call(ir_node *call, ir_entity *callee, q_set *hmap)
123 entry_t *key, *entry;
127 n_params = get_Call_n_params(call);
130 * Beware: we cannot clone variadic parameters as well as the
131 * last non-variadic one, which might be needed for the va_start()
135 /* In this for loop we collect the calls, that have
136 an constant parameter. */
137 for (i = n_params; i > 0;) {
138 call_param = get_Call_param(call, --i);
139 if (is_Const(call_param)) {
140 /* we have found a Call to collect and we save the informations,
143 hmap->map = new_pset(entry_cmp, 8);
145 key = OALLOC(&hmap->obst, entry_t);
149 key->q.tv = get_Const_tarval(call_param);
154 /* We insert our information in the set, where we collect the calls.*/
155 entry = (entry_t*)pset_insert(hmap->map, key, hash_entry(key));
158 obstack_free(&hmap->obst, key);
160 /* add the call to the list */
161 if (! entry->q.calls) {
162 entry->q.calls = NEW_ARR_F(ir_node *, 1);
163 entry->q.calls[0] = call;
165 ARR_APP1(ir_node *, entry->q.calls, call);
171 * Collect all calls in a ir_graph to a set.
173 * @param call A ir_node to be checked.
174 * @param env The quadruple-set containing the calls with constant parameters
176 static void collect_irg_calls(ir_node *call, void *env)
178 q_set *hmap = (q_set*)env;
182 /* We collect just "Call" nodes */
184 call_ptr = get_Call_ptr(call);
186 if (! is_Global(call_ptr))
189 callee = get_Global_entity(call_ptr);
191 /* we don't know which function gets finally bound to a weak symbol */
192 if (get_entity_linkage(callee) & IR_LINKAGE_WEAK)
195 /* we can only clone calls to existing entities */
196 if (get_entity_irg(callee) == NULL)
199 process_call(call, callee, hmap);
204 * Make a name for a clone. The clone name is
205 * the name of the original method suffixed with "_cl_pos_nr".
206 * pos is the pos from our quadruplet and nr is a counter.
208 * @param id The ident of the cloned function.
209 * @param pos The "pos" from our quadruplet.
210 * @param nr A counter for the clones.
212 static ident *get_clone_ident(ident *id, size_t pos, size_t nr)
214 char clone_postfix[32];
216 ir_snprintf(clone_postfix, sizeof(clone_postfix), "_cl_%zu_%zu", pos, nr);
218 return id_mangle(id, new_id_from_str(clone_postfix));
222 * Pre-Walker: Copies blocks and nodes from the original method graph
223 * to the cloned graph. Fixes the argument projection numbers for
224 * all arguments behind the removed one.
226 * @param irn A node from the original method graph.
227 * @param env The clone graph.
229 static void copy_nodes(ir_node *irn, void *env)
231 ir_graph *clone_irg = (ir_graph*)env;
232 ir_node *arg = (ir_node*)get_irg_link(clone_irg);
233 ir_node *irg_args = get_Proj_pred(arg);
237 /* Copy all nodes except the arg. */
239 copy_irn_to_irg(irn, clone_irg);
241 irn_copy = (ir_node*)get_irn_link(irn);
243 /* Fix argument numbers */
244 if (is_Proj(irn) && get_Proj_pred(irn) == irg_args) {
245 proj_nr = get_Proj_proj(irn);
246 if (get_Proj_proj(arg) < proj_nr)
247 set_Proj_proj(irn_copy, proj_nr - 1);
252 * Post-walker: Set the predecessors of the copied nodes.
253 * The copied nodes are set as link of their original nodes. The links of
254 * "irn" predecessors are the predecessors of copied node.
256 static void set_preds(ir_node *irn, void *env)
258 ir_graph *clone_irg = (ir_graph*)env;
259 ir_node *arg = (ir_node*)get_irg_link(clone_irg);
264 /* Arg is the method argument, that we have replaced by a constant.*/
268 irn_copy = (ir_node*)get_irn_link(irn);
271 for (i = get_Block_n_cfgpreds(irn) - 1; i >= 0; --i) {
272 pred = get_Block_cfgpred(irn, i);
273 /* "End" block must be handled extra, because it is not matured.*/
274 if (get_irg_end_block(current_ir_graph) == irn)
275 add_immBlock_pred(get_irg_end_block(clone_irg), (ir_node*)get_irn_link(pred));
277 set_Block_cfgpred(irn_copy, i, (ir_node*)get_irn_link(pred));
280 /* First we set the block our copy if it is not a block.*/
281 set_nodes_block(irn_copy, (ir_node*)get_irn_link(get_nodes_block(irn)));
283 /* Handle the keep-alives. This must be done separately, because
284 the End node was NOT copied */
285 for (i = 0; i < get_End_n_keepalives(irn); ++i)
286 add_End_keepalive(irn_copy, (ir_node*)get_irn_link(get_End_keepalive(irn, i)));
288 for (i = get_irn_arity(irn) - 1; i >= 0; i--) {
289 pred = get_irn_n(irn, i);
290 set_irn_n(irn_copy, i, (ir_node*)get_irn_link(pred));
297 * Get the method argument at the position "pos".
299 * @param irg irg that must be cloned.
300 * @param pos The position of the argument.
302 static ir_node *get_irg_arg(ir_graph *irg, size_t pos)
304 ir_node *irg_args = get_irg_args(irg), *arg = NULL;
307 /* Call algorithm that computes the out edges */
308 assure_irg_outs(irg);
310 /* Search the argument with the number pos.*/
311 for (i = get_irn_n_outs(irg_args) - 1; i >= 0; --i) {
312 ir_node *proj = get_irn_out(irg_args, i);
313 if ((int)pos == get_Proj_proj(proj)) {
316 * More than one arg node found:
317 * We rely on the fact that only one arg exists, so do
318 * a cheap CSE in this case.
320 set_irn_out(irg_args, i, arg, 0);
326 assert(arg && "Argument not found");
331 * Create a new graph for the clone of the method,
332 * that we want to clone.
334 * @param ent The entity of the method that must be cloned.
335 * @param q Our quadruplet.
337 static void create_clone_proc_irg(ir_entity *ent, const quadruple_t *q)
339 ir_graph *method_irg, *clone_irg;
340 ir_node *arg, *const_arg;
342 method_irg = get_entity_irg(ent);
344 /* We create the skeleton of the clone irg.*/
345 clone_irg = new_ir_graph(ent, 0);
347 arg = get_irg_arg(get_entity_irg(q->ent), q->pos);
348 /* we will replace the argument in position "q->pos" by this constant. */
349 const_arg = new_r_Const(clone_irg, q->tv);
351 /* args copy in the cloned graph will be the const. */
352 set_irn_link(arg, const_arg);
354 /* Store the arg that will be replaced here, so we can easily detect it. */
355 set_irg_link(clone_irg, arg);
357 /* We copy the blocks and nodes, that must be in
358 the clone graph and set their predecessors. */
359 irg_walk_graph(method_irg, copy_nodes, set_preds, clone_irg);
361 /* The "cloned" graph must be matured. */
362 mature_immBlock(get_irg_end_block(clone_irg));
363 irg_finalize_cons(clone_irg);
367 * The function create a new entity type
368 * for our clone and set it to clone entity.
370 * @param q Contains information for the method to clone.
371 * @param ent The entity of the clone.
372 * @param nr A pointer to the counter of clones.
374 static void change_entity_type(const quadruple_t *q, ir_entity *ent)
376 ir_type *mtp, *new_mtp, *tp;
377 size_t i, j, n_params, n_ress;
379 mtp = get_entity_type(q->ent);
380 n_params = get_method_n_params(mtp);
381 n_ress = get_method_n_ress(mtp);
383 /* Create the new type for our clone. It must have one parameter
384 less then the original.*/
385 new_mtp = new_type_method(n_params - 1, n_ress);
387 /* We must set the type of the methods parameters.*/
388 for (i = j = 0; i < n_params; ++i) {
390 /* This is the position of the argument, that we have
394 tp = get_method_param_type(mtp, i);
395 set_method_param_type(new_mtp, j++, tp);
397 /* Copy the methods result types. */
398 for (i = 0; i < n_ress; ++i) {
399 tp = get_method_res_type(mtp, i);
400 set_method_res_type(new_mtp, i, tp);
402 set_entity_type(ent, new_mtp);
406 * Make a clone of a method.
408 * @param q Contains information for the method to clone.
410 static ir_entity *clone_method(const quadruple_t *q)
412 ir_entity *new_entity;
414 /* A counter for the clones.*/
415 static size_t nr = 0;
417 /* We get a new ident for our clone method.*/
418 clone_ident = get_clone_ident(get_entity_ident(q->ent), q->pos, nr);
419 /* We get our entity for the clone method. */
420 new_entity = copy_entity_name(q->ent, clone_ident);
422 /* a cloned entity is always local */
423 set_entity_visibility(new_entity, ir_visibility_local);
425 /* set a ld name here: Should we mangle this ? */
426 set_entity_ld_ident(new_entity, get_entity_ident(new_entity));
428 /* set a new type here. */
429 change_entity_type(q, new_entity);
431 /* We need now a new ir_graph for our clone method. */
432 create_clone_proc_irg(new_entity, q);
434 /* The "new_entity" don't have this information. */
435 new_entity->attr.mtd_attr.param_access = NULL;
436 new_entity->attr.mtd_attr.param_weight = NULL;
442 * Creates a new "cloned" Call node and return it.
444 * @param call The call that must be cloned.
445 * @param new_entity The entity of the cloned function.
446 * @param pos The position of the replaced parameter of this call.
448 static ir_node *new_cl_Call(ir_node *call, ir_entity *new_entity, size_t pos)
451 size_t i, n_params, new_params = 0;
454 ir_graph *irg = get_irn_irg(call);
455 ir_node *bl = get_nodes_block(call);
457 sym.entity_p = new_entity;
458 callee = new_r_SymConst(irg, mode_P_code, sym, symconst_addr_ent);
460 n_params = get_Call_n_params(call);
461 NEW_ARR_A(ir_node *, in, n_params - 1);
463 /* we save the parameters of the new call in the array "in" without the
464 * parameter in position "pos", that is replaced with a constant.*/
465 for (i = 0; i < n_params; ++i) {
467 in[new_params++] = get_Call_param(call, i);
469 /* Create and return the new Call. */
470 return new_r_Call(bl, get_Call_mem(call),
471 callee, n_params - 1, in, get_entity_type(new_entity));
475 * Exchange all Calls stored in the quadruplet to Calls of the cloned entity.
477 * @param q The quadruple
478 * @param cloned_ent The entity of the new function that must be called
481 static void exchange_calls(quadruple_t *q, ir_entity *cloned_ent)
484 ir_node *new_call, *call;
487 /* We iterate the list of the "call".*/
488 for (i = 0; i < ARR_LEN(q->calls); ++i) {
491 /* A clone exist and the copy of "call" in this
492 * clone graph must be exchanged with new one.*/
493 new_call = new_cl_Call(call, cloned_ent, pos);
494 exchange(call, new_call);
499 * The weight formula:
500 * We save one instruction in every caller and param_weight instructions
503 static float calculate_weight(const entry_t *entry)
505 return ARR_LEN(entry->q.calls) *
506 (float)(get_method_param_weight(entry->q.ent, entry->q.pos) + 1);
510 * After we exchanged all calls, some entries on the list for
511 * the next cloned entity may get invalid, so we have to check
512 * them and may even update the list of heavy uses.
514 static void reorder_weights(q_set *hmap, float threshold)
516 entry_t **adr, *p, *entry;
521 entry = hmap->heavy_uses;
525 len = ARR_LEN(entry->q.calls);
526 for (i = 0; i < len; ++i) {
527 ir_node *ptr, *call = entry->q.calls[i];
529 /* might be exchanged, so skip Id nodes here. */
530 call = skip_Id(call);
532 /* we know, that a SymConst is here */
533 ptr = get_Call_ptr(call);
534 assert(is_SymConst(ptr));
536 callee = get_SymConst_entity(ptr);
537 if (callee != entry->q.ent) {
539 * This call is already changed because of a previous
540 * optimization. Remove it from the list.
543 entry->q.calls[i] = entry->q.calls[len];
544 entry->q.calls[len] = NULL;
546 /* the new call should be processed */
547 process_call(call, callee, hmap);
552 /* the length might be changed */
553 ARR_SHRINKLEN(entry->q.calls, len);
555 /* recalculate the weight and resort the heavy uses map */
556 entry->weight = calculate_weight(entry);
558 if (len <= 0 || entry->weight < threshold) {
559 hmap->heavy_uses = entry->next;
562 /* we have changed the list, check the next one */
567 for (p = entry->next; p && entry->weight < p->weight; p = p->next) {
572 hmap->heavy_uses = entry->next;
575 entry = hmap->heavy_uses;
577 /* we have changed the list, check the next one */
583 * Do the procedure cloning. Evaluate a heuristic weight for every
584 * call(..., Const, ...). If the weight is bigger than threshold,
585 * clone the entity and fix the calls.
587 void proc_cloning(float threshold)
589 entry_t *entry = NULL, *p;
593 DEBUG_ONLY(firm_dbg_module_t *dbg;)
595 /* register a debug mask */
596 FIRM_DBG_REGISTER(dbg, "firm.opt.proc_cloning");
598 obstack_init(&hmap.obst);
600 hmap.heavy_uses = NULL;
602 /* initially fill our map by visiting all irgs */
603 for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
604 ir_graph *irg = get_irp_irg(i);
605 irg_walk_graph(irg, collect_irg_calls, NULL, &hmap);
608 /* We have the "Call" nodes to optimize in set "set_entries". Our algorithm
609 replace one constant parameter and make a new "Call" node for all found "Calls". It exchange the
610 old one with the new one and the algorithm is called with the new "Call".
612 while (hmap.map || hmap.heavy_uses) {
613 /* We iterate the set and arrange the element of the set in a list.
614 The elements are arranged dependent of their value descending.*/
616 foreach_pset(hmap.map, entry_t*, entry) {
617 entry->weight = calculate_weight(entry);
620 * Do not put entry with a weight < threshold in the list
622 if (entry->weight < threshold) {
627 /* put entry in the heavy uses list */
629 if (! hmap.heavy_uses)
630 hmap.heavy_uses = entry;
632 if (entry->weight >= hmap.heavy_uses->weight) {
633 entry->next = hmap.heavy_uses;
634 hmap.heavy_uses = entry;
636 for (p = hmap.heavy_uses; p->next; p = p->next) {
637 if (entry->weight >= p->next->weight) {
638 entry->next = p->next;
653 /* Print some information about the list. */
654 DB((dbg, LEVEL_2, "-----------------\n"));
655 for (entry = hmap.heavy_uses; entry; entry = entry->next) {
656 DB((dbg, LEVEL_2, "\nweight: is %f\n", entry->weight));
657 DB((dbg, LEVEL_2, "Call for Method %E\n", entry->q.ent));
658 DB((dbg, LEVEL_2, "Position %zu\n", entry->q.pos));
659 DB((dbg, LEVEL_2, "Value %T\n", entry->q.tv));
662 entry = hmap.heavy_uses;
664 quadruple_t *qp = &entry->q;
666 ir_entity *ent = clone_method(qp);
667 DB((dbg, LEVEL_1, "Cloned <%+F, %zu, %T> info %+F\n", qp->ent, qp->pos, qp->tv, ent));
669 hmap.heavy_uses = entry->next;
671 /* We must exchange the copies of this call in all clones too.*/
672 exchange_calls(&entry->q, ent);
676 * after we exchanged all calls, some entries on the list for
677 * the next cloned entity may get invalid, so we have to check
678 * them and may even update the list of heavy uses.
680 reorder_weights(&hmap, threshold);
683 obstack_free(&hmap.obst, NULL);
686 typedef struct pass_t {
692 * Wrapper to run proc_cloning() as an ir_prog pass.
694 static int proc_cloning_wrapper(ir_prog *irp, void *context)
696 pass_t *pass = (pass_t*)context;
699 proc_cloning(pass->threshold);
703 /* create a ir_prog pass */
704 ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold)
706 pass_t *pass = XMALLOCZ(pass_t);
708 pass->threshold = threshold;
709 return def_prog_pass_constructor(
710 &pass->pass, name ? name : "cloning", proc_cloning_wrapper);