2 * Copyright (C) 1995-2007 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 scalar replacement of arrays and compounds
23 * @author Beyhan Veliev, Michael Beck
30 #include "iroptimize.h"
44 #include "analyze_irg_args.h"
46 #include "compute_loop_info.h"
50 #define SET_ENT_VNUM(ent, vnum) set_entity_link(ent, INT_TO_PTR(vnum))
51 #define GET_ENT_VNUM(ent) (unsigned)PTR_TO_INT(get_entity_link(ent))
52 #define SET_IRN_VNUM(irn, vnum) set_irn_link(irn, INT_TO_PTR(vnum))
53 #define GET_IRN_VNUM(irn) (unsigned)PTR_TO_INT(get_irn_link(irn))
57 typedef struct _ent_leaves_t{
58 ir_entity *ent; /**< An entity, that contains scalars for replace.*/
59 pset *leaves; /**< All leaves of this entity.*/
62 typedef struct _sels_t {
63 ir_node *sel; /**< A sel node, thats entity have scalars.*/
64 ir_entity *ent; /**< The entity of this sel node.*/
67 typedef struct _call_access_t {
68 ir_node *call; /**< A call node, that have as parameter a scalar.*/
69 unsigned int access_type; /**< The access type, with that this call access this scalar.*/
72 typedef struct _fixlist_entry_t {
73 ir_node *irn; /**< An ir node, that must be fixed.*/
74 unsigned int vnum; /**< The value number, that must became this ir node.*/
77 typedef struct _syncs_fixlist_entry_t {
78 ir_node *irn; /**< A sync node that must be fixed.*/
79 int *accessed_vnum; /**< A pointer to save an array with value numbers, that must became this sync.*/
80 }syncs_fixlist_entry_t;
82 /* A entry, that save the memory
83 * edge state and the access state for this leave
84 * int the array,that is created for every block.*/
85 typedef struct _leave_t {
86 ir_node *mem_edge_state; /**< memory state for this scalar in this block.*/
87 unsigned int access_type; /**< access state for this scalar in this block.*/
88 set *calls; /**< call nodes,that change this scalar in this block.*/
92 * A path element entry: it is either an entity
93 * or a tarval, because we evaluate only constant array
94 * accesses like a.b.c[8].d
102 * An access path, used to assign value numbers
103 * to variables that will be scalar replaced
105 typedef struct _path_t {
106 unsigned vnum; /**< the value number */
107 unsigned path_len; /**< the length of the access path */
108 path_elem_t path[1]; /**< the path */
112 * environment for memory walker
114 typedef struct _env_t {
115 struct obstack obst; /**< a obstack for the memory edge */
116 set *set_sels; /**< a set with all sels, that are reachable from an entity with a scalar.*/
117 set *set_ent; /**< a set with all entities that have one or more scalars.*/
118 fixlist_entry_t *fix_phis; /**< list of all Phi nodes that must be fixed */
119 fixlist_entry_t *fix_ls; /**< list of all Load or Store nodes that must be fixed */
120 syncs_fixlist_entry_t *fix_syncs; /**< list of all Sync nodes that must be fixed */
121 unsigned int nvals; /**< to save the number of scalars.*/
122 unsigned int gl_mem_vnum; /**< indicate the position of the globule memory edge state in var_arr.*/
123 unsigned int vnum_state; /**< indicate the position of the value number state in var_arr.*/
124 unsigned int changes; /**< to save if by anlyse_calls is changed anything.*/
130 * Compare two elements of the ent_leaves_t set.
132 * @return 0 if they are identically
134 static int ent_leaves_t_cmp(const void *elt, const void *key, size_t size)
136 const ent_leaves_t *c1 = elt;
137 const ent_leaves_t *c2 = key;
139 return c1->ent != c2->ent;
143 * Compare two elements of the ent_access_t set.
145 * @return 0 if they are identically
147 static int ent_cmp(const void *elt, const void *key)
149 const ir_entity *c1 = elt;
150 const ir_entity *c2 = key;
156 * Compare two elements of the sels_t set.
158 * @return 0 if they are identically
160 static int sels_cmp(const void *elt, const void *key, size_t size)
162 const sels_t *c1 = elt;
163 const sels_t *c2 = key;
165 return c1->sel != c2->sel;
169 * Compare two elements of the leave_t set.
171 * @return 0 if they are identically
173 static int leave_cmp(const void *elt, const void *key)
175 ir_node *c1 = (ir_node *)elt;
176 ir_node *c2 = (ir_node *)key;
178 return get_Sel_entity(c1) != get_Sel_entity(c2);
182 * Compare two elements of the call_access_t set.
184 * @return 0 if they are identically
186 static int call_cmp(const void *elt, const void *key, size_t size)
188 const call_access_t *c1 = elt;
189 const call_access_t *c2 = key;
191 return c1->call != c2->call;
197 * @return 0 if they are identically
199 static int path_cmp(const void *elt, const void *key, size_t size)
201 const path_t *p1 = elt;
202 const path_t *p2 = key;
204 /* we can use memcmp here, because identical tarvals should have identical addresses */
205 return memcmp(p1->path, p2->path, p1->path_len * sizeof(p1->path[0]));
209 * Calculate a hash value for a path.
211 static unsigned path_hash(const path_t *path)
216 for (i = 0; i < path->path_len; ++i)
217 hash ^= (unsigned)PTR_TO_INT(path->path[i].ent);
223 * Returns non-zero, if all induces of a Sel node are constants.
225 * @param sel the Sel node that will be checked
227 static int is_const_sel(ir_node *sel) {
228 int i, n = get_Sel_n_indexs(sel);
230 for (i = 0; i < n; ++i) {
231 ir_node *idx = get_Sel_index(sel, i);
233 if (get_irn_op(idx) != op_Const)
240 * Returns non-zero, if the address of an entity
241 * represented by a Sel node (or it's successor Sels) is taken.
243 static int is_address_taken_2(ir_node *sel)
247 if (! is_const_sel(sel))
250 for (i = get_irn_n_outs(sel) - 1; i >= 0; --i) {
251 ir_node *succ = get_irn_out(sel, i);
253 switch (get_irn_opcode(succ)) {
255 /* ok, we just load from that entity */
259 /* check that Sel is not the Store's value */
260 if (get_Store_value(succ) == sel)
265 /* Check the Sel successor of Sel */
266 int res = is_address_taken_2(succ);
274 /* The address of an entity is given as a parameter.
275 * We analyzes that later and optimizes this scalar
281 /* another op, the address is taken */
289 * Link all Sels with the entity.
291 * @param ent the entity that will be scalar replaced
292 * @param sel a Sel node that selects some fields of this entity
294 static void link_all_leave_sels(ir_entity *ent, ir_node *sel)
298 n = get_irn_n_outs(sel);
299 for (i = 0; i < n; ++i) {
300 ir_node *succ = get_irn_out(sel, i);
302 if (get_irn_op(succ) == op_Sel)
303 link_all_leave_sels(ent, succ);
307 /* if Sel nodes with memory inputs are used, a entity can be
308 * visited more than once causing a ring here, so we use the
309 * node flag to mark linked nodes
311 if (irn_visited(sel))
315 * we link the sels to the entity.
317 set_irn_link(sel, get_entity_link(ent));
318 set_entity_link(ent, sel);
320 mark_irn_visited(sel);
323 /* we need a special address that serves as an address taken marker */
325 static void *ADDRESS_TAKEN = &_x;
328 * Find possible scalar replacements.
330 * @param irg an IR graph
332 * This function finds variables on the (members of the) frame type
333 * that can be scalar replaced, because their address is never taken.
334 * If such a variable is found, it's entity link will hold a list of all
335 * Sel nodes, that selects anythings of this entity.
336 * Otherwise, the link will be ADDRESS_TAKEN or NULL.
338 * @return non-zero if at least one entity could be replaced
341 static int find_possible_replacements(ir_graph *irg)
343 ir_node *irg_frame = get_irg_frame(irg);
347 inc_irg_visited(irg);
349 n = get_irn_n_outs(irg_frame);
352 * First, clear the link field of all interestingentities.
353 * Note that we did not rely on the fact that there is only
354 * one Sel node per entity, so we might access one entity
355 * more than once here.
356 * That's why we have need two loops.
358 for (i = 0; i < n; ++i) {
359 ir_node *succ = get_irn_out(irg_frame, i);
361 if (get_irn_op(succ) == op_Sel) {
362 ir_entity *ent = get_Sel_entity(succ);
363 set_entity_link(ent, NULL);
368 * Check the ir_graph for Sel nodes. If the entity of Sel
369 * isn't a scalar replacement set the link of this entity
370 * equal ADDRESS_TAKEN.
372 for (i = 0; i < n; ++i) {
373 ir_node *succ = get_irn_out(irg_frame, i);
375 if (get_irn_op(succ) == op_Sel) {
376 ir_entity *ent = get_Sel_entity(succ);
379 if (get_entity_link(ent) == ADDRESS_TAKEN)
383 * Beware: in rare cases even entities on the frame might be
384 * volatile. This might happen if the entity serves as a store
385 * to a value that must survive a exception. Do not optimize
386 * such entities away.
388 if (get_entity_volatility(ent) == volatility_is_volatile) {
389 set_entity_link(ent, ADDRESS_TAKEN);
393 ent_type = get_entity_type(ent);
395 /* we can handle arrays, structs and atomic types yet */
396 if (is_Array_type(ent_type) || is_Struct_type(ent_type) || is_atomic_type(ent_type)) {
397 if (is_address_taken_2(succ)) {
398 if (get_entity_link(ent)) /* killing one */
400 set_entity_link(ent, ADDRESS_TAKEN);
403 /* possible found one */
404 if (get_entity_link(ent) == NULL)
406 link_all_leave_sels(ent, succ);
415 static int is_leave_sel(ir_node *sel) {
419 for(i = get_irn_n_outs(sel) - 1; i >= 0; i--) {
420 succ = get_irn_out(sel, i);
421 if(get_irn_op(succ) == op_Sel)
429 * Return a path from the Sel node sel to it's root.
431 * @param sel the Sel node
432 * @param len the length of the path so far
434 static path_t *find_path(ir_node *sel, unsigned len)
438 ir_node *pred = get_Sel_ptr(sel);
440 /* the current Sel node will add some path elements */
441 n = get_Sel_n_indexs(sel);
444 if (get_irn_op(pred) != op_Sel) {
445 /* we found the root */
447 res = xmalloc(sizeof(*res) + (len - 1) * sizeof(res->path));
451 res = find_path(pred, len);
453 pos = res->path_len - len;
455 res->path[pos++].ent = get_Sel_entity(sel);
456 for (i = 0; i < n; ++i) {
457 ir_node *index = get_Sel_index(sel, i);
459 if(get_irn_op(index) == op_Const)
460 res->path[pos++].tv = get_Const_tarval(index);
466 * Allocate value numbers for the leaves
467 * in our found entities.
469 * @param sels a set that will contain all Sels that have a value number
470 * @param ent the entity that will be scalar replaced
471 * @param vnum the first value number we can assign
472 * @param modes a flexible array, containing all the modes of
475 * @return the next free value number
477 static unsigned allocate_value_numbers(set *set_sels, pset *leaves, ir_entity *ent, unsigned vnum)
482 set *pathes = new_set(path_cmp, 8);
484 /* visit all Sel nodes in the chain of the entity */
485 for (sel = get_entity_link(ent); sel; sel = next) {
486 next = get_irn_link(sel);
488 /* we save for every sel it root entity, why
489 * we need this information, when we split the memory edge,
490 * and we must mark this sel for later. */
493 set_insert(set_sels, &key_sels, sizeof(key_sels), HASH_PTR(sel));
495 if(! is_leave_sel(sel))
497 /* We have found a leave and we add it to the pset of this entity.*/
498 pset_insert(leaves, sel, HASH_PTR(get_Sel_entity(sel)));
500 key = find_path(sel, 0);
501 path = set_find(pathes, key, sizeof(*key) + sizeof(key->path[0]) * key->path_len, path_hash(key));
504 SET_IRN_VNUM(sel, path->vnum);
509 set_insert(pathes, key, sizeof(*key) + sizeof(key->path[0]) * key->path_len, path_hash(key));
511 SET_IRN_VNUM(sel, key->vnum);
517 set_entity_link(ent, NULL);
521 * Add a sync node to it fix list.
523 * @param sync The sync node, that myst be addet to the fix list.
524 * @param unk_vnum An array whit the value number, that are synced with this sync node.
525 * @param env The enviroment pinter.
527 static void add_sync_to_fixlist(ir_node *sync, int *unk_vnum, env_t *env) {
529 syncs_fixlist_entry_t *s;
531 s = obstack_alloc(&env->obst, sizeof(*s));
533 s->accessed_vnum = unk_vnum;
534 set_irn_link(sync, env->fix_syncs);
538 * Add a ir node to it fix list.
540 * @param irn The ir node, that myst be addet to the fix list.
541 * @param vnum The value number, that must baceme this ir node as predecessor later.
542 * @param env The enviroment pinter.
544 static void add_ls_to_fixlist(ir_node *irn, int vnum, env_t *env) {
548 l = obstack_alloc(&env->obst, sizeof(*l));
552 if(get_irn_op(irn) == op_Phi) {
553 set_irn_link(l->irn, env->fix_phis);
556 set_irn_link(l->irn, env->fix_ls);
561 static void add_mem_edge(value_arr_entry_t *val_arr, int vnum, ir_node ***in, int **accessed_vnum) {
563 if(val_arr[vnum].mem_edge_state != NULL)
564 ARR_APP1(ir_node *, *in, val_arr[vnum].mem_edge_state);
566 ARR_APP1(int, *accessed_vnum, vnum);
567 ARR_APP1(ir_node *, *in, new_Unknown(mode_M));
571 * The function handles the scalars, that wase stored
574 * @param blk The block, that must be handled.
575 * @param env The enviroment pinter.
578 /* Return the memory successor of the call node.*/
579 static ir_node *get_Call_mem_out(ir_node *call) {
584 for(i = get_irn_n_outs(call) - 1; i >= 0; i--) {
585 mem = get_irn_out(call, i);
586 if(get_irn_mode(mem) == mode_M)
589 /* is not reachable*/
594 static void sync_stored_scalars(ir_node *blk, env_t *env) {
597 int *unk_vnum; /**< An arraw, where are saved the value number, that
598 are synced from this sync node.*/
599 ent_leaves_t *value_ent;
600 value_arr_entry_t *val_arr_blk, *val_arr;
601 ir_node *pred, *leave, *sync, **in;
602 ir_node *sync_blk; /**< The block, where the sync node must be created.*/
605 val_arr_blk = get_irn_link(blk);
607 for(value_ent = set_first(env->set_ent); value_ent; value_ent = set_next(env->set_ent)) {
610 if(val_arr_blk[GET_ENT_VNUM(value_ent->ent)].access_type <= 3)
611 /* This entity is not stored in this block.*/
614 for(i = get_Block_n_cfgpreds(blk) - 1; i >= 0; i--) {
616 pred = get_Block_cfgpred(blk, i);
617 pred = get_nodes_block(pred);
618 val_arr = get_irn_link(pred);
620 if(val_arr[GET_ENT_VNUM(value_ent->ent)].access_type == SYNCED)
621 /* This entity was synced.*/
624 if(val_arr[GET_ENT_VNUM(value_ent->ent)].access_type <= 3) {
626 /* To avoid repeated sync of this entity in this block.*/
627 val_arr[GET_ENT_VNUM(value_ent->ent)].access_type = SYNCED;
628 /* In this predecessor block is this entity not acessed.
629 * We must sync in the end ot this block.*/
630 if(get_Block_n_cfgpreds(blk) > 1)
631 sync_blk = get_nodes_block(get_Block_cfgpred(blk, i));
635 val_arr = get_irn_link(sync_blk);
636 /* An array to save the memory edges, that must be
638 in = NEW_ARR_F(ir_node *, 1);
640 /* An array to save the value numbers,
641 * that must be repaired.*/
642 unk_vnum = NEW_ARR_F(int, 0);
643 /* The global memory edge.*/
644 if(val_arr[env->gl_mem_vnum].mem_edge_state == NULL)
645 in[0] = new_Unknown(mode_M);
647 in[0] = val_arr[env->gl_mem_vnum].mem_edge_state;
649 for(leave = pset_first(value_ent->leaves); leave; leave = pset_next(value_ent->leaves))
650 /* All this memory edges must be synced.*/
651 add_mem_edge(val_arr, GET_IRN_VNUM(leave), &in, &unk_vnum);
653 /* We create the sync and set it in the global memory state.*/
654 sync = new_r_Sync(current_ir_graph, sync_blk, ARR_LEN(in), in);
655 /* We must check this, why it is possible to get a Bad node
656 * form new_r_Sync(), when the node can be optimized.
657 * In this case we must do nothing.*/
658 if(get_irn_op(sync) == op_Sync) {
659 val_arr[env->gl_mem_vnum].mem_edge_state = sync;
660 /* We add this sync node to the sync's fix list.*/
661 add_sync_to_fixlist(val_arr[env->gl_mem_vnum].mem_edge_state, unk_vnum, env);
669 * The function split the memory edge of load and store nodes, that have
670 * as predecessor a scalar
672 * @param irn The node, that memory edge must be spleted.
673 * @param env The enviroment pinter.
675 static void split_ls_mem_edge(ir_node *irn, env_t *env) {
678 ir_node *leave, *irn_blk, *mem_state, *new_mem_state;
679 unsigned ent_vnum, sel_vnum, i;
680 value_arr_entry_t *val_arr;
681 sels_t key_sels, *value_sels;
682 ent_leaves_t key_ent, *value_ent;
684 op = get_irn_op(irn);
687 key_sels.sel = get_Load_ptr(irn);
689 key_sels.sel = get_Store_ptr(irn);
691 value_sels = set_find(env->set_sels, &key_sels, sizeof(key_sels), HASH_PTR(key_sels.sel));
693 if(value_sels != NULL) {
694 /* we have found a load or store, that use a sel of our set
695 * and we must split or extend, if the memory edge have been
696 * split for this sel, the memory edge.*/
698 key_ent.ent = value_sels->ent;
699 value_ent = set_find(env->set_ent, &key_ent, sizeof(key_ent), HASH_PTR(key_ent.ent));
700 /*To check if the enities set is right filled. */
701 assert(value_ent && " This sel's entity isn't int the entity set.");
703 leave = pset_find(value_ent->leaves, key_sels.sel, HASH_PTR(get_Sel_entity(key_sels.sel)));
704 /*To check if the leaves set is right filled. */
705 assert(leave && "Anything in data_flow_scalar_replacment algorithm is wrong.");
707 ent_vnum = GET_ENT_VNUM(value_ent->ent);
708 sel_vnum = GET_IRN_VNUM(leave);
709 irn_blk = get_nodes_block(irn);
710 val_arr = get_irn_link(irn_blk);
712 if(val_arr[ent_vnum].access_type == 0)
713 /* We have found a scalar, that address is not stored as jet.*/
716 /* This scalar have been stored.*/
717 i = env->gl_mem_vnum;
719 if(val_arr[i].mem_edge_state == NULL) {
720 /* We split now for this sel the memory edge in this block.*/
721 mem_state = new_Unknown(mode_M);
722 /* We must mark this node to fix later*/
723 add_ls_to_fixlist(irn, i, env);
726 /* We have split the memory edge and the current state is saved.*/
727 mem_state = val_arr[i].mem_edge_state;
729 /* We set this Load or Store to the memory edge of this
732 set_Load_mem(irn, mem_state);
734 set_Store_mem(irn, mem_state);
736 /* When we have split or extended the memory edge we must
737 * update the memory_edge_state of this sel*/
738 new_mem_state = get_irn_out(irn, 0);
739 if(get_irn_mode(new_mem_state) == mode_M)
740 val_arr[i].mem_edge_state = new_mem_state;
742 val_arr[i].mem_edge_state = get_irn_out(irn, 1);
747 * The function split the memory edge of phi nodes, that have
748 * as predecessor a scalar
750 * @param irn The phi node, that memory edge must be spleted.
751 * @param env The enviroment pinter.
753 static void split_phi_mem_edge(ir_node *irn, env_t *env) {
755 ir_node *irn_blk, *unk, *leave, **in;
757 ent_leaves_t *value_ent;
758 value_arr_entry_t *val_arr;
760 irn_blk = get_nodes_block(irn);
761 val_arr = get_irn_link(irn_blk);
763 n = get_Block_n_cfgpreds(irn_blk);
765 in = alloca(sizeof(*in) * n);
767 for(value_ent = set_first(env->set_ent); value_ent; value_ent = set_next(env->set_ent))
768 if(val_arr[GET_ENT_VNUM(value_ent->ent)].access_type < 3)
769 /* This scalar wasn't be saved and we need to produce a phi for it.*/
770 for(leave = pset_first(value_ent->leaves); leave; leave = pset_next(value_ent->leaves)){
772 unk = new_Unknown(mode_M);
773 for (j = n - 1; j >= 0; --j)
776 val_arr[GET_IRN_VNUM(leave)].mem_edge_state = new_r_Phi(current_ir_graph, irn_blk, n, in, mode_M);
778 add_ls_to_fixlist(val_arr[GET_IRN_VNUM(leave)].mem_edge_state, GET_IRN_VNUM(leave), env);
781 /* We use for the global memory the phi node, that
782 * is already available.*/
783 val_arr[env->gl_mem_vnum].mem_edge_state = irn;
787 * The function handles the call nodes, that have
788 * as parameter a scalar
790 * @param env The enviroment pinter.
791 * @param call The call node, that must be handled.
792 * @param accessed_entities A set wit all entities, that are accessed from this call node.*/
793 static void split_call_mem_edge(env_t *env, ir_node *call, pset *accessed_entities) {
795 ent_leaves_t key_ent, *value_ent;
796 value_arr_entry_t *val_arr;
797 call_access_t key_call, *value_call;
798 ir_node *call_blk, *new_mem_state, *leave;
802 int fix_irn = 0; /**< Set to 1 if we must add this call to it fix list.*/
803 int *accessed_leaves_vnum = NULL; /**< An arraw, where are saved the value number, that
804 are synced from call's sync node, if we need it.*/
806 if(get_irn_node_nr(call) == 2763)
809 call_blk = get_nodes_block(call);
810 val_arr = get_irn_link(call_blk);
811 /* An array to save the memory edges, that must be
813 in = NEW_ARR_F(ir_node *, 1);
814 /* An array to save the value numbers of the memory
815 * edges that must be repaired.*/
816 accessed_leaves_vnum = NEW_ARR_F(int, 0);
818 /* We get the memory successor of the call node.
819 * It is the new memory state for all synced memory
821 new_mem_state = get_Call_mem_out(call);
823 /* The global memory is the first predecessor of the create sync node.*/
824 if(val_arr[env->gl_mem_vnum].mem_edge_state == NULL) {
825 in[0] = new_Unknown(mode_M);
829 in[0] = val_arr[env->gl_mem_vnum].mem_edge_state;
832 for(ent = pset_first(accessed_entities); ent; ent = pset_next(accessed_entities)) {
833 /* Whit this loop we iterate all accessed entities from this call and collect
834 * all memory edges, that we must sync.*/
835 ent_vnum = GET_ENT_VNUM(ent);
837 key_call.call = call;
838 value_call = set_find(val_arr[ent_vnum].calls, &key_call, sizeof(key_call), HASH_PTR(key_call.call));
841 value_ent = set_find(env->set_ent, &key_ent, sizeof(key_ent), HASH_PTR(key_ent.ent));
843 if(val_arr[ent_vnum].access_type <= 3) {
844 /* This scalar's address wasn't stored in this block.*/
845 switch(value_call->access_type) {
847 case ptr_access_none :
848 /* In this case we have nothing to do.*/
851 case ptr_access_read:
852 case ptr_access_write:
854 /* All this cases must be traded equal.*/
856 for(leave = pset_first(value_ent->leaves); leave; leave = pset_next(value_ent->leaves)){
857 /* All this memory edges must be synced.*/
858 add_mem_edge(val_arr, GET_IRN_VNUM(leave), &in, &accessed_leaves_vnum);
860 /* We update the memory state of this leave.*/
861 if(value_call->access_type != ptr_access_read)
862 val_arr[GET_IRN_VNUM(leave)].mem_edge_state = new_mem_state;
871 /* We must update the global memory state.*/
872 val_arr[env->gl_mem_vnum].mem_edge_state = new_mem_state;
874 if(ARR_LEN(in) == 1) {
875 /* we must set the call memory to gobale momory*/
876 set_Call_mem(call,in[0]);
879 /* We add this call node to the call fix list..*/
880 add_ls_to_fixlist(call, env->gl_mem_vnum, env);
883 /* We create the sync and set it as memory predecessor of the call node.*/
884 sync = new_r_Sync(current_ir_graph, call_blk, ARR_LEN(in), in);
885 /* We must check this, why it is possible to get a Bad node
886 * form new_r_Sync(), when the node can be optimized.
887 * In this case we must do nothing.*/
888 if(get_irn_op(sync) == op_Sync) {
890 set_Call_mem(call, sync);
891 if(ARR_LEN(accessed_leaves_vnum))
892 /* We add this sync node to the sync's fix list.*/
893 add_sync_to_fixlist(sync, accessed_leaves_vnum, env);
900 * The function split the memory edge from the passed
901 * ir node if this is needed
903 * @param irn The node, that memory edge must be spleted.
904 * @param env The enviroment pinter.
906 static void split_memory_edge(ir_node *irn, void *ctx) {
909 ir_node *sel, *irn_blk;
911 sels_t key_sels, *value_sels;
912 value_arr_entry_t *val_arr;
913 pset *accessed_entities; /**< A set to save all entities accessed from a call.*/
917 op = get_irn_op(irn);
922 irn_blk = get_nodes_block(irn);
924 if (Block_not_block_visited(irn_blk)) {
925 /* We sync first the stored scalar address in this block.*/
926 mark_Block_block_visited(irn_blk);
927 sync_stored_scalars(irn_blk, env);
930 if(op == op_Load || op == op_Store)
932 split_ls_mem_edge(irn, env);
935 if (op == op_Phi && get_irn_mode(irn) == mode_M) {
937 * found a memory Phi: Here, we must create new Phi nodes
939 split_phi_mem_edge(irn, env);
944 /* Calls that have a NoMem input do neither read nor write memory.
945 We can completely ignore them here. */
946 if (get_irn_op(get_Call_mem(irn)) == op_NoMem)
949 /* We save in this set all entities,
950 * that are accessed from this call node.*/
951 accessed_entities = new_pset(ent_cmp, 8);
952 val_arr = get_irn_link(get_nodes_block(irn));
954 for ( i = get_Call_n_params(irn) - 1; i >= 0; i--) {
956 sel = get_Call_param(irn, i);
958 if(get_irn_op(sel) == op_Sel) {
960 value_sels = set_find(env->set_sels, &key_sels, sizeof(key_sels), HASH_PTR(key_sels.sel));
962 if(value_sels != NULL && val_arr[GET_ENT_VNUM(value_sels->ent)].access_type <= 3)
963 /* We save in this set all accessed entities from this call node whit
964 * access none, read, write or rw..*/
965 pset_insert(accessed_entities, value_sels->ent, HASH_PTR(value_sels->ent));
969 if(pset_count(accessed_entities))
970 split_call_mem_edge(env, irn, accessed_entities);
972 del_pset(accessed_entities);
979 * searches through blocks beginning from block for value
980 * vnum and return it.
982 * @param block A block from the current ir graph.
983 * @param vnum The value number, that must be found.
985 static ir_node *find_vnum_value(ir_node *block, unsigned vnum)
987 value_arr_entry_t *val_arr;
991 if (Block_not_block_visited(block)) {
992 mark_Block_block_visited(block);
994 val_arr = get_irn_link(block);
996 if (val_arr[vnum].mem_edge_state)
997 return val_arr[vnum].mem_edge_state;
999 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
1000 ir_node *pred = get_Block_cfgpred(block, i);
1002 res = find_vnum_value(get_nodes_block(pred), vnum);
1011 * fix the Load/Store or Call list
1013 * @param The enviroment pinter.
1015 static void fix_ls(env_t *env)
1018 ir_node *irn, *block, *pred, *val = NULL;
1022 for (l = env->fix_ls; l; l = get_irn_link(irn)) {
1025 op = get_irn_op(irn);
1026 block = get_nodes_block(irn);
1027 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
1028 pred = get_Block_cfgpred(block, i);
1029 pred = get_nodes_block(pred);
1031 inc_irg_block_visited(current_ir_graph);
1032 val = find_vnum_value(pred, l->vnum);
1040 set_Store_mem(irn, val);
1043 set_Load_mem(irn, val);
1045 set_Call_mem(irn, val);
1053 * @param The enviroment pinter.
1055 static void fix_phis(env_t *env)
1058 ir_node *phi, *block, *pred, *val;
1061 for (l = env->fix_phis; l; l = get_irn_link(phi)) {
1064 block = get_nodes_block(phi);
1065 for (i = get_Block_n_cfgpreds(block) - 1; i >= 0; --i) {
1067 pred = get_Block_cfgpred(block, i);
1068 pred = get_nodes_block(pred);
1070 inc_irg_block_visited(current_ir_graph);
1071 val = find_vnum_value(pred, l->vnum);
1074 set_irn_n(phi, i, val);
1083 * @param The enviroment pinter.
1085 static void fix_syncs(env_t *env)
1087 syncs_fixlist_entry_t *l;
1088 ir_node *sync, *block, *pred, *val;
1092 for (l = env->fix_syncs; l; l = get_irn_link(sync)) {
1096 /* The sync block must have one predecessor, when it
1097 have unknown nodes as predecessor.*/
1098 block = get_nodes_block(sync);
1099 pred = get_Block_cfgpred(block, 0);
1100 pred = get_nodes_block(pred);
1102 /* We first repair the global memory edge at the first position of sync predecessors.*/
1103 if(get_irn_op(get_irn_n(sync, 0)) == op_Unknown) {
1104 inc_irg_block_visited(current_ir_graph);
1105 val = find_vnum_value(pred, env->gl_mem_vnum);
1108 set_irn_n(sync, 0, val);
1111 for (i = get_irn_arity(sync) - 1; i >= 1; --i) {
1112 /* We repair the leaves*/
1114 assert(k <= ARR_LEN(l->accessed_vnum) && "The algorythm for sync repair is wron");
1115 if(get_irn_op(get_irn_n(sync, i)) == op_Unknown) {
1116 inc_irg_block_visited(current_ir_graph);
1117 val = find_vnum_value(pred, l->accessed_vnum[k++]);
1120 set_irn_n(sync, i, val);
1123 DEL_ARR_F(l->accessed_vnum);
1127 * For the end node we must sync all memory edges.
1129 * @param The enviroment pinter.
1131 static void sync_mem_edges(env_t *env) {
1133 value_arr_entry_t *val_arr;
1134 ir_node **in, *sync, *Return, *Return_blk;
1135 int i, vnum, vnum_state;
1137 Return = get_Block_cfgpred(get_irg_end_block(current_ir_graph), 0);
1138 Return_blk = get_nodes_block(Return);
1139 val_arr = get_irn_link(Return_blk);
1143 for(i = 0; i <= (int)env->gl_mem_vnum; i++)
1144 /* we get the current state of non saved scalars.*/
1145 if(val_arr[i].access_type <= 3)
1148 /* We allocate the memory, that we need for the predecessors of the sync.*/
1149 in = xmalloc(sizeof(ir_node*) *vnum_state);
1151 /* The global memory edge is the first predecessor of this sync node.*/
1152 if(val_arr[env->gl_mem_vnum].mem_edge_state == NULL) {
1153 /* We must search through blocks for this memory state.*/
1154 inc_irg_block_visited(current_ir_graph);
1155 in[0] = find_vnum_value(Return_blk, env->gl_mem_vnum);
1158 in[0] = val_arr[env->gl_mem_vnum].mem_edge_state;
1161 for(i = 1, vnum = 0; vnum < (int)env->gl_mem_vnum; vnum++) {
1163 if(val_arr[vnum].access_type <= 3) {
1164 /* we add the non saved scalars as predecessors of the sync.*/
1166 if(val_arr[vnum].mem_edge_state == NULL) {
1167 /* We must search through blocks for this memory state.*/
1168 inc_irg_block_visited(current_ir_graph);
1169 in[i] = find_vnum_value(Return_blk, vnum);
1172 in[i] = val_arr[vnum].mem_edge_state;
1177 sync = new_r_Sync(current_ir_graph, Return_blk, vnum_state, in);
1178 set_Return_mem(Return, sync);
1184 * Walker: allocate the value array for every block.
1186 * @param block A block from the current ir graph for that must be allocated a value array.
1187 * @param ctx The enviroment pinter.
1189 static void alloc_value_arr(ir_node *block, void *ctx)
1194 value_arr_entry_t *var_arr = obstack_alloc(&env->obst, sizeof(value_arr_entry_t) *(env->nvals + set_count(env->set_ent) + 1));
1196 /* the value array is empty at start */
1197 memset(var_arr, 0, sizeof(value_arr_entry_t) * (env->nvals + set_count(env->set_ent) + 1));
1198 set_irn_link(block, var_arr);
1200 /* We set the block value number state to optimal and later we update this.*/
1201 var_arr[env->vnum_state].access_type = env->nvals;
1203 if(get_irg_start_block(current_ir_graph) == block)
1204 /* We initilize the startblocks array with the irg initilize memory, why
1205 * it must be the start point of all memory edges.*/
1206 for(i = (env->nvals + set_count(env->set_ent)) ; i >=0; i--)
1207 var_arr[i].mem_edge_state = get_irg_initial_mem(current_ir_graph);
1211 /* Analyze call nodes to get information, if they store the address of a scalar.
1213 * @param *irn An ir node from the current_ir_graph.
1214 * @param *env The enviroment pointer.
1216 static void analyse_calls(ir_node *irn, void *ctx) {
1219 unsigned int acces_type;
1220 ir_node *param, *call_ptr, *blk;
1222 ir_entity *meth_ent;
1223 sels_t key_sels, *value_sels;
1224 call_access_t key_call, *value_call;
1225 value_arr_entry_t *val_arr;
1229 if(get_irn_op(irn) != op_Call)
1232 /* Calls that have a NoMem input do neither read nor write memory.
1233 We can completely ignore them here. */
1234 if (get_irn_op(get_Call_mem(irn)) == op_NoMem)
1237 /* We iterate over the parameters of this call nodes.*/
1238 for ( i = get_Call_n_params(irn) - 1; i >= 0; i--) {
1239 param = get_Call_param(irn, i);
1240 if(get_irn_op(param) == op_Sel) {
1241 /* We have found a parameter with operation sel.*/
1242 key_sels.sel = param;
1243 value_sels = set_find(env->set_sels, &key_sels, sizeof(key_sels), HASH_PTR(key_sels.sel));
1244 if(value_sels != NULL ) {
1246 /* We have found a call, that have as parameter a sel from our set_sels.*/
1247 call_ptr = get_Call_ptr(irn);
1248 op = get_irn_op(call_ptr);
1250 if(op == op_SymConst && get_SymConst_kind(call_ptr) == symconst_addr_ent) {
1251 meth_ent = get_SymConst_entity(call_ptr);
1252 /* we get the access type for our sel.*/
1253 acces_type = get_method_param_access(meth_ent, i);
1255 /* We can't analyze this function and we asume, that it store the address.*/
1256 acces_type = ptr_access_store;
1258 /* we save the access type and this call in the array allocated for this block.
1259 * The value number of this entity get us the position in the array to save this
1260 * information. Why we expect more calls as one we allocate a set.*/
1261 vnum = GET_ENT_VNUM(value_sels->ent);
1262 blk = get_nodes_block(irn);
1263 val_arr = get_irn_link(blk);
1265 if(val_arr[vnum].access_type > 3)
1266 /* The address of this entity have been stored.*/
1269 if(val_arr[vnum].calls == NULL)
1270 /* for this entity i have found the firs call in this block and we must allocate the set.*/
1271 val_arr[vnum].calls = new_set(call_cmp, 8);
1273 /* This call performs anything with the scalar and we must mark it.*/
1274 key_call.call = irn;
1275 key_call.access_type = acces_type;
1276 value_call = set_insert(val_arr[vnum].calls, &key_call, sizeof(key_call), HASH_PTR(key_call.call));
1278 if(value_call->access_type < acces_type)
1279 /* this case tread, when a call access an entity more at once.
1280 * Than we must save the highest access type.*/
1281 value_call->access_type = acces_type;
1284 /* This call save the address of our scalar and we can't
1285 * use the scalars of this entity for optimization as from now.
1287 val_arr[vnum].access_type = acces_type;
1293 static int set_block_dominated_first_access(ir_node *blk, int vnum, unsigned int access) {
1295 ir_node *idom, *succ;
1296 value_arr_entry_t *val_arr;
1299 idom = get_Block_idom(blk);
1300 for(i = get_Block_n_cfg_outs(idom) - 1; i >=1; i--) {
1301 succ = get_Block_cfg_out(idom, i);
1302 val_arr = get_irn_link(succ);
1303 if(val_arr[vnum].access_type < 3) {
1304 val_arr[vnum].access_type = access;
1310 /* Update the access information of a block if a predecessor of
1311 * this black have a higher access for an entity.
1313 * @param *irn An ir node from the current_ir_graph.
1314 * @param *env The enviroment pointer.
1316 static void set_block_access(ir_node *irn, void *ctx){
1318 value_arr_entry_t *val_arr, *val_arr_pred;
1319 ent_leaves_t *value_leaves;
1320 ir_node *pred, *pred_blk, *leave;
1325 val_arr = get_irn_link(irn);
1327 for( i = get_Block_n_cfgpreds(irn) - 1; i >= 0; i--) {
1328 /* We analyze the predecessors of this block to see if this block must
1330 pred = get_Block_cfgpred(irn, i);
1331 pred_blk = get_nodes_block(pred);
1333 val_arr_pred = get_irn_link(pred_blk);
1335 for(value_leaves = set_first(env->set_ent); value_leaves; value_leaves = set_next(env->set_ent)) {
1336 vnum = GET_ENT_VNUM(value_leaves->ent);
1338 if((get_Block_n_cfgpreds(irn) > 1) && (val_arr[vnum].access_type > 3))
1339 env->changes = set_block_dominated_first_access(irn, vnum, val_arr[vnum].access_type);
1341 if((val_arr_pred[vnum].access_type > 3) && (val_arr[vnum].access_type < 3)) {
1342 /* We have found a block for update it access and value number information.*/
1343 val_arr[vnum].access_type = val_arr_pred[vnum].access_type;
1344 /* We update the access information of all leave, that belong to
1347 for(leave = pset_first(value_leaves->leaves); leave; leave = pset_next(value_leaves->leaves))
1348 val_arr[GET_IRN_VNUM(leave)].access_type = val_arr[vnum].access_type;
1350 /* In this way can't be got the actuall number of value numbers.
1351 val_arr[env->vnum_state].access_type = val_arr_pred[env->vnum_state].access_type; */
1357 /* Free the allocated call sets.
1359 * @param irn A block form the ir graph.
1360 * @param env The enviroment pinter.
1362 static void free_call_info(ir_node *irn, void *ctx) {
1366 value_arr_entry_t *val_arr;
1369 val_arr = get_irn_link(irn);
1371 for(i = env->nvals + set_count(env->set_ent); i >= 0; i--) {
1372 if(val_arr[i].calls != NULL)
1374 del_set(val_arr[i].calls);
1378 static void print_block_state(ir_node *irn, void *ctx) {
1380 value_arr_entry_t *val_arr;
1381 ent_leaves_t *value_leaves;
1382 call_access_t *value_calls;
1387 val_arr = get_irn_link(irn);
1388 ir_printf("\n\nThe actual value number state of this block is: %i \n",
1389 val_arr[env->vnum_state].access_type - 1);
1391 for(value_leaves = set_first(env->set_ent); value_leaves; value_leaves = set_next(env->set_ent)) {
1393 vnum = GET_ENT_VNUM(value_leaves->ent);
1394 ir_printf("The entity %F access type in the block with nr %u is %i \n",
1395 value_leaves->ent, get_irn_node_nr(irn), val_arr[vnum].access_type);
1397 if(val_arr[vnum].calls != NULL)
1398 for(value_calls = set_first(val_arr[vnum].calls); value_calls; value_calls = set_next(val_arr[vnum].calls))
1400 ir_printf("A call with nr %i acess a element of this entity with access %u \n",
1401 get_irn_node_nr(value_calls->call), value_calls->access_type);
1406 /** Optimize the found scalar replacements.
1408 * @param set_sels A set with all entities, that
1410 * @param set_ent A set with all sels nodes,
1411 * that belong to our scalars.
1412 * @param vnum The number of scalars.
1414 static void do_data_flow_scalar_replacement(set *set_ent, set *set_sels, int vnum) {
1418 obstack_init(&env.obst);
1419 env.set_ent = set_ent;
1420 env.set_sels = set_sels;
1422 env.fix_phis = NULL;
1423 env.fix_syncs = NULL;
1424 env.gl_mem_vnum = vnum - 2;
1425 env.vnum_state = vnum - 1;
1426 /* nvals are vnum - 1, why we indicate with nvals the number
1427 * of memory edges we will produce. For vnum_state we don't
1428 * need to produce a memory edge.*/
1429 env.nvals = vnum - 1;
1432 /* first step: allocate the value arrays for every block */
1433 irg_block_walk_graph(current_ir_graph, NULL, alloc_value_arr, &env);
1435 /* second step: we analyze all calls, that have as parameter scalar(s).
1436 * We mark the calls, that save the address of a scalar and we
1437 * mark the entity owner of this scalar as not optimizeble by now.*/
1438 irg_walk_graph(current_ir_graph, NULL, analyse_calls, &env);
1440 while(env.changes) {
1445 * third step: walk over the blocks of a graph and update
1446 * the information for the access of our scalars.
1448 irg_block_walk_graph(current_ir_graph, NULL, set_block_access, &env);
1452 // if(get_firm_verbosity())
1453 /* Debug info to see if analyse_calls work properly.*/
1454 irg_block_walk_graph(current_ir_graph, NULL, print_block_state, &env);
1457 * fourth step: walk over the graph blockwise in topological order
1458 * and split the memrory edge.
1460 inc_irg_block_visited(current_ir_graph);
1461 irg_walk_blkwise_graph(current_ir_graph, NULL, split_memory_edge, &env);
1465 /* fifth step: fix all nodes, that have as predecessor Unknown.*/
1470 /* sixth step: sync memory enges for the end block.*/
1471 sync_mem_edges(&env);
1473 /*seventh step: free the allocated memory*/
1474 irg_block_walk_graph(current_ir_graph, NULL, free_call_info, &env);
1475 obstack_free(&env.obst, NULL);
1479 * Find possible scalar replacements
1481 * @param irg The current ir graph.
1483 void data_flow_scalar_replacement_opt(ir_graph *irg) {
1489 ent_leaves_t key_leaves, *value_leaves;
1492 if (! get_opt_scalar_replacement())
1495 set_sels = new_set(sels_cmp, 8);
1496 set_ent = new_set(ent_leaves_t_cmp, 8);
1498 /* Call algorithm that remove the critical edges of a ir graph. */
1499 remove_critical_cf_edges(irg);
1501 /* Call algorithm that computes the out edges.*/
1502 if (get_irg_outs_state(irg) != outs_consistent)
1503 compute_irg_outs(irg);
1505 /* Call algorithm that computes the loop information.*/
1506 compute_loop_info(irg);
1507 /* Call algorithm that computes the dominance information.*/
1510 /* Find possible scalar replacements */
1511 if (find_possible_replacements(irg)) {
1513 /* Insert in set the scalar replacements. */
1514 irg_frame = get_irg_frame(irg);
1516 for (i = 0 ; i < get_irn_n_outs(irg_frame); i++) {
1517 ir_node *succ = get_irn_out(irg_frame, i);
1519 if (get_irn_op(succ) == op_Sel) {
1520 ir_entity *ent = get_Sel_entity(succ);
1522 if (get_entity_link(ent) == NULL || get_entity_link(ent) == ADDRESS_TAKEN)
1524 /* we have found a entity, that have scalars and we insert it to our set_ent*/
1525 key_leaves.ent = ent;
1526 key_leaves.leaves = new_pset(leave_cmp, 8);
1527 value_leaves = set_insert(set_ent, &key_leaves, sizeof(key_leaves), HASH_PTR(ent));
1529 /* We allocate for every leave sel a vnum.*/
1530 vnum = allocate_value_numbers(set_sels, value_leaves->leaves, ent, vnum);
1534 if(get_firm_verbosity())
1535 printf("vnumber in data flow= %i\n", vnum);
1537 /* Allocate value number for the globule memory edge.
1538 * and a value number for the value numbers state.*/
1541 /* Allocate value numbers for the entities .*/
1542 for(i = vnum,value_leaves = set_first(set_ent); value_leaves; i++, value_leaves = set_next(set_ent))
1543 SET_ENT_VNUM(value_leaves->ent, i);
1546 do_data_flow_scalar_replacement(set_ent, set_sels, vnum);
1548 /*free the allocated memory.*/
1549 for(value_leaves = set_first(set_ent); value_leaves; value_leaves = set_next(set_ent))
1550 del_pset(value_leaves->leaves);