1 /* Inline functions for tree-flow.h
2 Copyright (C) 2001, 2003, 2005, 2006, 2007 Free Software Foundation, Inc.
3 Contributed by Diego Novillo <dnovillo@redhat.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 #ifndef _TREE_FLOW_INLINE_H
22 #define _TREE_FLOW_INLINE_H 1
24 /* Inline functions for manipulating various data structures defined in
25 tree-flow.h. See tree-flow.h for documentation. */
27 /* Return true when gimple SSA form was built.
28 gimple_in_ssa_p is queried by gimplifier in various early stages before SSA
29 infrastructure is initialized. Check for presence of the datastructures
32 gimple_in_ssa_p (const struct function *fun)
34 return fun && fun->gimple_df && fun->gimple_df->in_ssa_p;
37 /* 'true' after aliases have been computed (see compute_may_aliases). */
39 gimple_aliases_computed_p (const struct function *fun)
41 gcc_assert (fun && fun->gimple_df);
42 return fun->gimple_df->aliases_computed_p;
45 /* Addressable variables in the function. If bit I is set, then
46 REFERENCED_VARS (I) has had its address taken. Note that
47 CALL_CLOBBERED_VARS and ADDRESSABLE_VARS are not related. An
48 addressable variable is not necessarily call-clobbered (e.g., a
49 local addressable whose address does not escape) and not all
50 call-clobbered variables are addressable (e.g., a local static
53 gimple_addressable_vars (const struct function *fun)
55 gcc_assert (fun && fun->gimple_df);
56 return fun->gimple_df->addressable_vars;
59 /* Call clobbered variables in the function. If bit I is set, then
60 REFERENCED_VARS (I) is call-clobbered. */
62 gimple_call_clobbered_vars (const struct function *fun)
64 gcc_assert (fun && fun->gimple_df);
65 return fun->gimple_df->call_clobbered_vars;
68 /* Array of all variables referenced in the function. */
70 gimple_referenced_vars (const struct function *fun)
74 return fun->gimple_df->referenced_vars;
77 /* Artificial variable used to model the effects of function calls. */
79 gimple_global_var (const struct function *fun)
81 gcc_assert (fun && fun->gimple_df);
82 return fun->gimple_df->global_var;
85 /* Artificial variable used to model the effects of nonlocal
88 gimple_nonlocal_all (const struct function *fun)
90 gcc_assert (fun && fun->gimple_df);
91 return fun->gimple_df->nonlocal_all;
94 /* Hashtable of variables annotations. Used for static variables only;
95 local variables have direct pointer in the tree node. */
97 gimple_var_anns (const struct function *fun)
99 return fun->gimple_df->var_anns;
102 /* Initialize the hashtable iterator HTI to point to hashtable TABLE */
105 first_htab_element (htab_iterator *hti, htab_t table)
108 hti->slot = table->entries;
109 hti->limit = hti->slot + htab_size (table);
112 PTR x = *(hti->slot);
113 if (x != HTAB_EMPTY_ENTRY && x != HTAB_DELETED_ENTRY)
115 } while (++(hti->slot) < hti->limit);
117 if (hti->slot < hti->limit)
122 /* Return current non-empty/deleted slot of the hashtable pointed to by HTI,
123 or NULL if we have reached the end. */
126 end_htab_p (const htab_iterator *hti)
128 if (hti->slot >= hti->limit)
133 /* Advance the hashtable iterator pointed to by HTI to the next element of the
137 next_htab_element (htab_iterator *hti)
139 while (++(hti->slot) < hti->limit)
141 PTR x = *(hti->slot);
142 if (x != HTAB_EMPTY_ENTRY && x != HTAB_DELETED_ENTRY)
148 /* Initialize ITER to point to the first referenced variable in the
149 referenced_vars hashtable, and return that variable. */
152 first_referenced_var (referenced_var_iterator *iter)
154 return (tree) first_htab_element (&iter->hti,
155 gimple_referenced_vars (cfun));
158 /* Return true if we have hit the end of the referenced variables ITER is
159 iterating through. */
162 end_referenced_vars_p (const referenced_var_iterator *iter)
164 return end_htab_p (&iter->hti);
167 /* Make ITER point to the next referenced_var in the referenced_var hashtable,
168 and return that variable. */
171 next_referenced_var (referenced_var_iterator *iter)
173 return (tree) next_htab_element (&iter->hti);
176 /* Fill up VEC with the variables in the referenced vars hashtable. */
179 fill_referenced_var_vec (VEC (tree, heap) **vec)
181 referenced_var_iterator rvi;
184 FOR_EACH_REFERENCED_VAR (var, rvi)
185 VEC_safe_push (tree, heap, *vec, var);
188 /* Return the variable annotation for T, which must be a _DECL node.
189 Return NULL if the variable annotation doesn't already exist. */
190 static inline var_ann_t
191 var_ann (const_tree t)
196 && (TREE_STATIC (t) || DECL_EXTERNAL (t)))
198 struct static_var_ann_d *sann
199 = ((struct static_var_ann_d *)
200 htab_find_with_hash (gimple_var_anns (cfun), t, DECL_UID (t)));
209 ann = (var_ann_t) t->base.ann;
212 gcc_assert (ann->common.type == VAR_ANN);
217 /* Return the variable annotation for T, which must be a _DECL node.
218 Create the variable annotation if it doesn't exist. */
219 static inline var_ann_t
220 get_var_ann (tree var)
222 var_ann_t ann = var_ann (var);
223 return (ann) ? ann : create_var_ann (var);
226 /* Return the function annotation for T, which must be a FUNCTION_DECL node.
227 Return NULL if the function annotation doesn't already exist. */
228 static inline function_ann_t
229 function_ann (const_tree t)
232 gcc_assert (TREE_CODE (t) == FUNCTION_DECL);
233 gcc_assert (!t->base.ann
234 || t->base.ann->common.type == FUNCTION_ANN);
236 return (function_ann_t) t->base.ann;
239 /* Return the function annotation for T, which must be a FUNCTION_DECL node.
240 Create the function annotation if it doesn't exist. */
241 static inline function_ann_t
242 get_function_ann (tree var)
244 function_ann_t ann = function_ann (var);
245 gcc_assert (!var->base.ann || var->base.ann->common.type == FUNCTION_ANN);
246 return (ann) ? ann : create_function_ann (var);
249 /* Return true if T has a statement annotation attached to it. */
252 has_stmt_ann (tree t)
254 #ifdef ENABLE_CHECKING
255 gcc_assert (is_gimple_stmt (t));
257 return t->base.ann && t->base.ann->common.type == STMT_ANN;
260 /* Return the statement annotation for T, which must be a statement
261 node. Return NULL if the statement annotation doesn't exist. */
262 static inline stmt_ann_t
265 #ifdef ENABLE_CHECKING
266 gcc_assert (is_gimple_stmt (t));
268 gcc_assert (!t->base.ann || t->base.ann->common.type == STMT_ANN);
269 return (stmt_ann_t) t->base.ann;
272 /* Return the statement annotation for T, which must be a statement
273 node. Create the statement annotation if it doesn't exist. */
274 static inline stmt_ann_t
275 get_stmt_ann (tree stmt)
277 stmt_ann_t ann = stmt_ann (stmt);
278 return (ann) ? ann : create_stmt_ann (stmt);
281 /* Set the uid of all non phi function statements. */
283 set_gimple_stmt_uid (tree stmt, unsigned int uid)
285 get_stmt_ann (stmt)->uid = uid;
288 /* Get the uid of all non phi function statements. */
289 static inline unsigned int
290 gimple_stmt_uid (tree stmt)
292 return get_stmt_ann (stmt)->uid;
295 /* Get the number of the next statement uid to be allocated. */
296 static inline unsigned int
297 gimple_stmt_max_uid (struct function *fn)
299 return fn->last_stmt_uid;
302 /* Set the number of the next statement uid to be allocated. */
304 set_gimple_stmt_max_uid (struct function *fn, unsigned int maxid)
306 fn->last_stmt_uid = maxid;
309 /* Set the number of the next statement uid to be allocated. */
310 static inline unsigned int
311 inc_gimple_stmt_max_uid (struct function *fn)
313 return fn->last_stmt_uid++;
316 /* Return the annotation type for annotation ANN. */
317 static inline enum tree_ann_type
318 ann_type (tree_ann_t ann)
320 return ann->common.type;
323 /* Return the basic block for statement T. */
324 static inline basic_block
329 if (TREE_CODE (t) == PHI_NODE)
333 return ann ? ann->bb : NULL;
336 /* Return the may_aliases bitmap for variable VAR, or NULL if it has
339 may_aliases (const_tree var)
341 return MTAG_ALIASES (var);
344 /* Return the line number for EXPR, or return -1 if we have no line
345 number information for it. */
347 get_lineno (const_tree expr)
349 if (expr == NULL_TREE)
352 if (TREE_CODE (expr) == COMPOUND_EXPR)
353 expr = TREE_OPERAND (expr, 0);
355 if (! EXPR_HAS_LOCATION (expr))
358 return EXPR_LINENO (expr);
361 /* Return true if T is a noreturn call. */
363 noreturn_call_p (tree t)
365 tree call = get_call_expr_in (t);
366 return call != 0 && (call_expr_flags (call) & ECF_NORETURN) != 0;
369 /* Mark statement T as modified. */
371 mark_stmt_modified (tree t)
374 if (TREE_CODE (t) == PHI_NODE)
379 ann = create_stmt_ann (t);
380 else if (noreturn_call_p (t) && cfun->gimple_df)
381 VEC_safe_push (tree, gc, MODIFIED_NORETURN_CALLS (cfun), t);
385 /* Mark statement T as modified, and update it. */
389 if (TREE_CODE (t) == PHI_NODE)
391 mark_stmt_modified (t);
392 update_stmt_operands (t);
396 update_stmt_if_modified (tree t)
398 if (stmt_modified_p (t))
399 update_stmt_operands (t);
402 /* Return true if T is marked as modified, false otherwise. */
404 stmt_modified_p (tree t)
406 stmt_ann_t ann = stmt_ann (t);
408 /* Note that if the statement doesn't yet have an annotation, we consider it
409 modified. This will force the next call to update_stmt_operands to scan
411 return ann ? ann->modified : true;
414 /* Delink an immediate_uses node from its chain. */
416 delink_imm_use (ssa_use_operand_t *linknode)
418 /* Return if this node is not in a list. */
419 if (linknode->prev == NULL)
422 linknode->prev->next = linknode->next;
423 linknode->next->prev = linknode->prev;
424 linknode->prev = NULL;
425 linknode->next = NULL;
428 /* Link ssa_imm_use node LINKNODE into the chain for LIST. */
430 link_imm_use_to_list (ssa_use_operand_t *linknode, ssa_use_operand_t *list)
432 /* Link the new node at the head of the list. If we are in the process of
433 traversing the list, we won't visit any new nodes added to it. */
434 linknode->prev = list;
435 linknode->next = list->next;
436 list->next->prev = linknode;
437 list->next = linknode;
440 /* Link ssa_imm_use node LINKNODE into the chain for DEF. */
442 link_imm_use (ssa_use_operand_t *linknode, tree def)
444 ssa_use_operand_t *root;
446 if (!def || TREE_CODE (def) != SSA_NAME)
447 linknode->prev = NULL;
450 root = &(SSA_NAME_IMM_USE_NODE (def));
451 #ifdef ENABLE_CHECKING
453 gcc_assert (*(linknode->use) == def);
455 link_imm_use_to_list (linknode, root);
459 /* Set the value of a use pointed to by USE to VAL. */
461 set_ssa_use_from_ptr (use_operand_p use, tree val)
463 delink_imm_use (use);
465 link_imm_use (use, val);
468 /* Link ssa_imm_use node LINKNODE into the chain for DEF, with use occurring
471 link_imm_use_stmt (ssa_use_operand_t *linknode, tree def, tree stmt)
474 link_imm_use (linknode, def);
476 link_imm_use (linknode, NULL);
477 linknode->stmt = stmt;
480 /* Relink a new node in place of an old node in the list. */
482 relink_imm_use (ssa_use_operand_t *node, ssa_use_operand_t *old)
484 /* The node one had better be in the same list. */
485 gcc_assert (*(old->use) == *(node->use));
486 node->prev = old->prev;
487 node->next = old->next;
490 old->prev->next = node;
491 old->next->prev = node;
492 /* Remove the old node from the list. */
497 /* Relink ssa_imm_use node LINKNODE into the chain for OLD, with use occurring
500 relink_imm_use_stmt (ssa_use_operand_t *linknode, ssa_use_operand_t *old, tree stmt)
503 relink_imm_use (linknode, old);
505 link_imm_use (linknode, NULL);
506 linknode->stmt = stmt;
510 /* Return true is IMM has reached the end of the immediate use list. */
512 end_readonly_imm_use_p (const imm_use_iterator *imm)
514 return (imm->imm_use == imm->end_p);
517 /* Initialize iterator IMM to process the list for VAR. */
518 static inline use_operand_p
519 first_readonly_imm_use (imm_use_iterator *imm, tree var)
521 gcc_assert (TREE_CODE (var) == SSA_NAME);
523 imm->end_p = &(SSA_NAME_IMM_USE_NODE (var));
524 imm->imm_use = imm->end_p->next;
525 #ifdef ENABLE_CHECKING
526 imm->iter_node.next = imm->imm_use->next;
528 if (end_readonly_imm_use_p (imm))
529 return NULL_USE_OPERAND_P;
533 /* Bump IMM to the next use in the list. */
534 static inline use_operand_p
535 next_readonly_imm_use (imm_use_iterator *imm)
537 use_operand_p old = imm->imm_use;
539 #ifdef ENABLE_CHECKING
540 /* If this assertion fails, it indicates the 'next' pointer has changed
541 since the last bump. This indicates that the list is being modified
542 via stmt changes, or SET_USE, or somesuch thing, and you need to be
543 using the SAFE version of the iterator. */
544 gcc_assert (imm->iter_node.next == old->next);
545 imm->iter_node.next = old->next->next;
548 imm->imm_use = old->next;
549 if (end_readonly_imm_use_p (imm))
550 return NULL_USE_OPERAND_P;
554 /* Return true if VAR has no uses. */
556 has_zero_uses (const_tree var)
558 const ssa_use_operand_t *const ptr = &(SSA_NAME_IMM_USE_NODE (var));
559 /* A single use means there is no items in the list. */
560 return (ptr == ptr->next);
563 /* Return true if VAR has a single use. */
565 has_single_use (const_tree var)
567 const ssa_use_operand_t *const ptr = &(SSA_NAME_IMM_USE_NODE (var));
568 /* A single use means there is one item in the list. */
569 return (ptr != ptr->next && ptr == ptr->next->next);
573 /* If VAR has only a single immediate use, return true, and set USE_P and STMT
574 to the use pointer and stmt of occurrence. */
576 single_imm_use (const_tree var, use_operand_p *use_p, tree *stmt)
578 const ssa_use_operand_t *const ptr = &(SSA_NAME_IMM_USE_NODE (var));
579 if (ptr != ptr->next && ptr == ptr->next->next)
582 *stmt = ptr->next->stmt;
585 *use_p = NULL_USE_OPERAND_P;
590 /* Return the number of immediate uses of VAR. */
591 static inline unsigned int
592 num_imm_uses (const_tree var)
594 const ssa_use_operand_t *const start = &(SSA_NAME_IMM_USE_NODE (var));
595 const ssa_use_operand_t *ptr;
596 unsigned int num = 0;
598 for (ptr = start->next; ptr != start; ptr = ptr->next)
604 /* Return the tree pointer to by USE. */
606 get_use_from_ptr (use_operand_p use)
611 /* Return the tree pointer to by DEF. */
613 get_def_from_ptr (def_operand_p def)
618 /* Return a def_operand_p pointer for the result of PHI. */
619 static inline def_operand_p
620 get_phi_result_ptr (tree phi)
622 return &(PHI_RESULT_TREE (phi));
625 /* Return a use_operand_p pointer for argument I of phinode PHI. */
626 static inline use_operand_p
627 get_phi_arg_def_ptr (tree phi, int i)
629 return &(PHI_ARG_IMM_USE_NODE (phi,i));
633 /* Return the bitmap of addresses taken by STMT, or NULL if it takes
636 addresses_taken (tree stmt)
638 stmt_ann_t ann = stmt_ann (stmt);
639 return ann ? ann->addresses_taken : NULL;
642 /* Return the PHI nodes for basic block BB, or NULL if there are no
645 phi_nodes (const_basic_block bb)
647 gcc_assert (!(bb->flags & BB_RTL));
650 return bb->il.tree->phi_nodes;
653 /* Return pointer to the list of PHI nodes for basic block BB. */
656 phi_nodes_ptr (basic_block bb)
658 gcc_assert (!(bb->flags & BB_RTL));
659 return &bb->il.tree->phi_nodes;
662 /* Set list of phi nodes of a basic block BB to L. */
665 set_phi_nodes (basic_block bb, tree l)
669 gcc_assert (!(bb->flags & BB_RTL));
670 bb->il.tree->phi_nodes = l;
671 for (phi = l; phi; phi = PHI_CHAIN (phi))
672 set_bb_for_stmt (phi, bb);
675 /* Return the phi argument which contains the specified use. */
678 phi_arg_index_from_use (use_operand_p use)
680 struct phi_arg_d *element, *root;
684 /* Since the use is the first thing in a PHI argument element, we can
685 calculate its index based on casting it to an argument, and performing
686 pointer arithmetic. */
688 phi = USE_STMT (use);
689 gcc_assert (TREE_CODE (phi) == PHI_NODE);
691 element = (struct phi_arg_d *)use;
692 root = &(PHI_ARG_ELT (phi, 0));
693 index = element - root;
695 #ifdef ENABLE_CHECKING
696 /* Make sure the calculation doesn't have any leftover bytes. If it does,
697 then imm_use is likely not the first element in phi_arg_d. */
699 (((char *)element - (char *)root) % sizeof (struct phi_arg_d)) == 0);
700 gcc_assert (index >= 0 && index < PHI_ARG_CAPACITY (phi));
706 /* Mark VAR as used, so that it'll be preserved during rtl expansion. */
709 set_is_used (tree var)
711 var_ann_t ann = get_var_ann (var);
716 /* Return true if T (assumed to be a DECL) is a global variable. */
719 is_global_var (const_tree t)
722 return (TREE_STATIC (t) || MTAG_GLOBAL (t));
724 return (TREE_STATIC (t) || DECL_EXTERNAL (t));
727 /* PHI nodes should contain only ssa_names and invariants. A test
728 for ssa_name is definitely simpler; don't let invalid contents
729 slip in in the meantime. */
732 phi_ssa_name_p (const_tree t)
734 if (TREE_CODE (t) == SSA_NAME)
736 #ifdef ENABLE_CHECKING
737 gcc_assert (is_gimple_min_invariant (t));
742 /* ----------------------------------------------------------------------- */
744 /* Returns the list of statements in BB. */
747 bb_stmt_list (const_basic_block bb)
749 gcc_assert (!(bb->flags & BB_RTL));
750 return bb->il.tree->stmt_list;
753 /* Sets the list of statements in BB to LIST. */
756 set_bb_stmt_list (basic_block bb, tree list)
758 gcc_assert (!(bb->flags & BB_RTL));
759 bb->il.tree->stmt_list = list;
762 /* Return a block_stmt_iterator that points to beginning of basic
764 static inline block_stmt_iterator
765 bsi_start (basic_block bb)
767 block_stmt_iterator bsi;
768 if (bb->index < NUM_FIXED_BLOCKS)
771 bsi.tsi.container = NULL;
774 bsi.tsi = tsi_start (bb_stmt_list (bb));
779 /* Return a block statement iterator that points to the first non-label
780 statement in block BB. */
782 static inline block_stmt_iterator
783 bsi_after_labels (basic_block bb)
785 block_stmt_iterator bsi = bsi_start (bb);
787 while (!bsi_end_p (bsi) && TREE_CODE (bsi_stmt (bsi)) == LABEL_EXPR)
793 /* Return a block statement iterator that points to the end of basic
795 static inline block_stmt_iterator
796 bsi_last (basic_block bb)
798 block_stmt_iterator bsi;
800 if (bb->index < NUM_FIXED_BLOCKS)
803 bsi.tsi.container = NULL;
806 bsi.tsi = tsi_last (bb_stmt_list (bb));
811 /* Return true if block statement iterator I has reached the end of
814 bsi_end_p (block_stmt_iterator i)
816 return tsi_end_p (i.tsi);
819 /* Modify block statement iterator I so that it is at the next
820 statement in the basic block. */
822 bsi_next (block_stmt_iterator *i)
827 /* Modify block statement iterator I so that it is at the previous
828 statement in the basic block. */
830 bsi_prev (block_stmt_iterator *i)
835 /* Return the statement that block statement iterator I is currently
838 bsi_stmt (block_stmt_iterator i)
840 return tsi_stmt (i.tsi);
843 /* Return a pointer to the statement that block statement iterator I
846 bsi_stmt_ptr (block_stmt_iterator i)
848 return tsi_stmt_ptr (i.tsi);
851 /* Returns the loop of the statement STMT. */
853 static inline struct loop *
854 loop_containing_stmt (tree stmt)
856 basic_block bb = bb_for_stmt (stmt);
860 return bb->loop_father;
864 /* Return the memory partition tag associated with symbol SYM. */
867 memory_partition (tree sym)
871 /* MPTs belong to their own partition. */
872 if (TREE_CODE (sym) == MEMORY_PARTITION_TAG)
875 gcc_assert (!is_gimple_reg (sym));
876 tag = get_var_ann (sym)->mpt;
878 #if defined ENABLE_CHECKING
880 gcc_assert (TREE_CODE (tag) == MEMORY_PARTITION_TAG);
886 /* Return true if NAME is a memory factoring SSA name (i.e., an SSA
887 name for a memory partition. */
890 factoring_name_p (const_tree name)
892 return TREE_CODE (SSA_NAME_VAR (name)) == MEMORY_PARTITION_TAG;
895 /* Return true if VAR is a clobbered by function calls. */
897 is_call_clobbered (const_tree var)
900 return var_ann (var)->call_clobbered;
902 return bitmap_bit_p (gimple_call_clobbered_vars (cfun), DECL_UID (var));
905 /* Mark variable VAR as being clobbered by function calls. */
907 mark_call_clobbered (tree var, unsigned int escape_type)
909 var_ann (var)->escape_mask |= escape_type;
911 var_ann (var)->call_clobbered = true;
912 bitmap_set_bit (gimple_call_clobbered_vars (cfun), DECL_UID (var));
915 /* Clear the call-clobbered attribute from variable VAR. */
917 clear_call_clobbered (tree var)
919 var_ann_t ann = var_ann (var);
920 ann->escape_mask = 0;
922 MTAG_GLOBAL (var) = 0;
924 var_ann (var)->call_clobbered = false;
925 bitmap_clear_bit (gimple_call_clobbered_vars (cfun), DECL_UID (var));
928 /* Return the common annotation for T. Return NULL if the annotation
929 doesn't already exist. */
930 static inline tree_ann_common_t
931 tree_common_ann (const_tree t)
933 /* Watch out static variables with unshared annotations. */
934 if (DECL_P (t) && TREE_CODE (t) == VAR_DECL)
935 return &var_ann (t)->common;
936 return &t->base.ann->common;
939 /* Return a common annotation for T. Create the constant annotation if it
941 static inline tree_ann_common_t
942 get_tree_common_ann (tree t)
944 tree_ann_common_t ann = tree_common_ann (t);
945 return (ann) ? ann : create_tree_common_ann (t);
948 /* ----------------------------------------------------------------------- */
950 /* The following set of routines are used to iterator over various type of
953 /* Return true if PTR is finished iterating. */
955 op_iter_done (const ssa_op_iter *ptr)
960 /* Get the next iterator use value for PTR. */
961 static inline use_operand_p
962 op_iter_next_use (ssa_op_iter *ptr)
965 #ifdef ENABLE_CHECKING
966 gcc_assert (ptr->iter_type == ssa_op_iter_use);
970 use_p = USE_OP_PTR (ptr->uses);
971 ptr->uses = ptr->uses->next;
976 use_p = VUSE_OP_PTR (ptr->vuses, ptr->vuse_index);
977 if (++(ptr->vuse_index) >= VUSE_NUM (ptr->vuses))
980 ptr->vuses = ptr->vuses->next;
986 use_p = VDEF_OP_PTR (ptr->mayuses, ptr->mayuse_index);
987 if (++(ptr->mayuse_index) >= VDEF_NUM (ptr->mayuses))
989 ptr->mayuse_index = 0;
990 ptr->mayuses = ptr->mayuses->next;
994 if (ptr->phi_i < ptr->num_phi)
996 return PHI_ARG_DEF_PTR (ptr->phi_stmt, (ptr->phi_i)++);
999 return NULL_USE_OPERAND_P;
1002 /* Get the next iterator def value for PTR. */
1003 static inline def_operand_p
1004 op_iter_next_def (ssa_op_iter *ptr)
1006 def_operand_p def_p;
1007 #ifdef ENABLE_CHECKING
1008 gcc_assert (ptr->iter_type == ssa_op_iter_def);
1012 def_p = DEF_OP_PTR (ptr->defs);
1013 ptr->defs = ptr->defs->next;
1018 def_p = VDEF_RESULT_PTR (ptr->vdefs);
1019 ptr->vdefs = ptr->vdefs->next;
1023 return NULL_DEF_OPERAND_P;
1026 /* Get the next iterator tree value for PTR. */
1028 op_iter_next_tree (ssa_op_iter *ptr)
1031 #ifdef ENABLE_CHECKING
1032 gcc_assert (ptr->iter_type == ssa_op_iter_tree);
1036 val = USE_OP (ptr->uses);
1037 ptr->uses = ptr->uses->next;
1042 val = VUSE_OP (ptr->vuses, ptr->vuse_index);
1043 if (++(ptr->vuse_index) >= VUSE_NUM (ptr->vuses))
1045 ptr->vuse_index = 0;
1046 ptr->vuses = ptr->vuses->next;
1052 val = VDEF_OP (ptr->mayuses, ptr->mayuse_index);
1053 if (++(ptr->mayuse_index) >= VDEF_NUM (ptr->mayuses))
1055 ptr->mayuse_index = 0;
1056 ptr->mayuses = ptr->mayuses->next;
1062 val = DEF_OP (ptr->defs);
1063 ptr->defs = ptr->defs->next;
1068 val = VDEF_RESULT (ptr->vdefs);
1069 ptr->vdefs = ptr->vdefs->next;
1079 /* This functions clears the iterator PTR, and marks it done. This is normally
1080 used to prevent warnings in the compile about might be uninitialized
1084 clear_and_done_ssa_iter (ssa_op_iter *ptr)
1090 ptr->mayuses = NULL;
1091 ptr->iter_type = ssa_op_iter_none;
1094 ptr->phi_stmt = NULL_TREE;
1096 ptr->vuse_index = 0;
1097 ptr->mayuse_index = 0;
1100 /* Initialize the iterator PTR to the virtual defs in STMT. */
1102 op_iter_init (ssa_op_iter *ptr, tree stmt, int flags)
1104 #ifdef ENABLE_CHECKING
1105 gcc_assert (stmt_ann (stmt));
1108 ptr->defs = (flags & SSA_OP_DEF) ? DEF_OPS (stmt) : NULL;
1109 ptr->uses = (flags & SSA_OP_USE) ? USE_OPS (stmt) : NULL;
1110 ptr->vuses = (flags & SSA_OP_VUSE) ? VUSE_OPS (stmt) : NULL;
1111 ptr->vdefs = (flags & SSA_OP_VDEF) ? VDEF_OPS (stmt) : NULL;
1112 ptr->mayuses = (flags & SSA_OP_VMAYUSE) ? VDEF_OPS (stmt) : NULL;
1117 ptr->phi_stmt = NULL_TREE;
1118 ptr->vuse_index = 0;
1119 ptr->mayuse_index = 0;
1122 /* Initialize iterator PTR to the use operands in STMT based on FLAGS. Return
1124 static inline use_operand_p
1125 op_iter_init_use (ssa_op_iter *ptr, tree stmt, int flags)
1127 gcc_assert ((flags & SSA_OP_ALL_DEFS) == 0);
1128 op_iter_init (ptr, stmt, flags);
1129 ptr->iter_type = ssa_op_iter_use;
1130 return op_iter_next_use (ptr);
1133 /* Initialize iterator PTR to the def operands in STMT based on FLAGS. Return
1135 static inline def_operand_p
1136 op_iter_init_def (ssa_op_iter *ptr, tree stmt, int flags)
1138 gcc_assert ((flags & SSA_OP_ALL_USES) == 0);
1139 op_iter_init (ptr, stmt, flags);
1140 ptr->iter_type = ssa_op_iter_def;
1141 return op_iter_next_def (ptr);
1144 /* Initialize iterator PTR to the operands in STMT based on FLAGS. Return
1145 the first operand as a tree. */
1147 op_iter_init_tree (ssa_op_iter *ptr, tree stmt, int flags)
1149 op_iter_init (ptr, stmt, flags);
1150 ptr->iter_type = ssa_op_iter_tree;
1151 return op_iter_next_tree (ptr);
1154 /* Get the next iterator mustdef value for PTR, returning the mustdef values in
1157 op_iter_next_vdef (vuse_vec_p *use, def_operand_p *def,
1160 #ifdef ENABLE_CHECKING
1161 gcc_assert (ptr->iter_type == ssa_op_iter_vdef);
1165 *def = VDEF_RESULT_PTR (ptr->mayuses);
1166 *use = VDEF_VECT (ptr->mayuses);
1167 ptr->mayuses = ptr->mayuses->next;
1171 *def = NULL_DEF_OPERAND_P;
1179 op_iter_next_mustdef (use_operand_p *use, def_operand_p *def,
1183 op_iter_next_vdef (&vp, def, ptr);
1186 gcc_assert (VUSE_VECT_NUM_ELEM (*vp) == 1);
1187 *use = VUSE_ELEMENT_PTR (*vp, 0);
1190 *use = NULL_USE_OPERAND_P;
1193 /* Initialize iterator PTR to the operands in STMT. Return the first operands
1196 op_iter_init_vdef (ssa_op_iter *ptr, tree stmt, vuse_vec_p *use,
1199 gcc_assert (TREE_CODE (stmt) != PHI_NODE);
1201 op_iter_init (ptr, stmt, SSA_OP_VMAYUSE);
1202 ptr->iter_type = ssa_op_iter_vdef;
1203 op_iter_next_vdef (use, def, ptr);
1207 /* If there is a single operand in STMT matching FLAGS, return it. Otherwise
1210 single_ssa_tree_operand (tree stmt, int flags)
1215 var = op_iter_init_tree (&iter, stmt, flags);
1216 if (op_iter_done (&iter))
1218 op_iter_next_tree (&iter);
1219 if (op_iter_done (&iter))
1225 /* If there is a single operand in STMT matching FLAGS, return it. Otherwise
1227 static inline use_operand_p
1228 single_ssa_use_operand (tree stmt, int flags)
1233 var = op_iter_init_use (&iter, stmt, flags);
1234 if (op_iter_done (&iter))
1235 return NULL_USE_OPERAND_P;
1236 op_iter_next_use (&iter);
1237 if (op_iter_done (&iter))
1239 return NULL_USE_OPERAND_P;
1244 /* If there is a single operand in STMT matching FLAGS, return it. Otherwise
1246 static inline def_operand_p
1247 single_ssa_def_operand (tree stmt, int flags)
1252 var = op_iter_init_def (&iter, stmt, flags);
1253 if (op_iter_done (&iter))
1254 return NULL_DEF_OPERAND_P;
1255 op_iter_next_def (&iter);
1256 if (op_iter_done (&iter))
1258 return NULL_DEF_OPERAND_P;
1262 /* Return true if there are zero operands in STMT matching the type
1265 zero_ssa_operands (tree stmt, int flags)
1269 op_iter_init_tree (&iter, stmt, flags);
1270 return op_iter_done (&iter);
1274 /* Return the number of operands matching FLAGS in STMT. */
1276 num_ssa_operands (tree stmt, int flags)
1282 FOR_EACH_SSA_TREE_OPERAND (t, stmt, iter, flags)
1288 /* Delink all immediate_use information for STMT. */
1290 delink_stmt_imm_use (tree stmt)
1293 use_operand_p use_p;
1295 if (ssa_operands_active ())
1296 FOR_EACH_SSA_USE_OPERAND (use_p, stmt, iter, SSA_OP_ALL_USES)
1297 delink_imm_use (use_p);
1301 /* This routine will compare all the operands matching FLAGS in STMT1 to those
1302 in STMT2. TRUE is returned if they are the same. STMTs can be NULL. */
1304 compare_ssa_operands_equal (tree stmt1, tree stmt2, int flags)
1306 ssa_op_iter iter1, iter2;
1307 tree op1 = NULL_TREE;
1308 tree op2 = NULL_TREE;
1314 look1 = stmt1 && stmt_ann (stmt1);
1315 look2 = stmt2 && stmt_ann (stmt2);
1319 op1 = op_iter_init_tree (&iter1, stmt1, flags);
1321 return op_iter_done (&iter1);
1324 clear_and_done_ssa_iter (&iter1);
1328 op2 = op_iter_init_tree (&iter2, stmt2, flags);
1330 return op_iter_done (&iter2);
1333 clear_and_done_ssa_iter (&iter2);
1335 while (!op_iter_done (&iter1) && !op_iter_done (&iter2))
1339 op1 = op_iter_next_tree (&iter1);
1340 op2 = op_iter_next_tree (&iter2);
1343 return (op_iter_done (&iter1) && op_iter_done (&iter2));
1347 /* If there is a single DEF in the PHI node which matches FLAG, return it.
1348 Otherwise return NULL_DEF_OPERAND_P. */
1350 single_phi_def (tree stmt, int flags)
1352 tree def = PHI_RESULT (stmt);
1353 if ((flags & SSA_OP_DEF) && is_gimple_reg (def))
1355 if ((flags & SSA_OP_VIRTUAL_DEFS) && !is_gimple_reg (def))
1360 /* Initialize the iterator PTR for uses matching FLAGS in PHI. FLAGS should
1361 be either SSA_OP_USES or SSA_OP_VIRTUAL_USES. */
1362 static inline use_operand_p
1363 op_iter_init_phiuse (ssa_op_iter *ptr, tree phi, int flags)
1365 tree phi_def = PHI_RESULT (phi);
1368 clear_and_done_ssa_iter (ptr);
1371 gcc_assert ((flags & (SSA_OP_USE | SSA_OP_VIRTUAL_USES)) != 0);
1373 comp = (is_gimple_reg (phi_def) ? SSA_OP_USE : SSA_OP_VIRTUAL_USES);
1375 /* If the PHI node doesn't the operand type we care about, we're done. */
1376 if ((flags & comp) == 0)
1379 return NULL_USE_OPERAND_P;
1382 ptr->phi_stmt = phi;
1383 ptr->num_phi = PHI_NUM_ARGS (phi);
1384 ptr->iter_type = ssa_op_iter_use;
1385 return op_iter_next_use (ptr);
1389 /* Start an iterator for a PHI definition. */
1391 static inline def_operand_p
1392 op_iter_init_phidef (ssa_op_iter *ptr, tree phi, int flags)
1394 tree phi_def = PHI_RESULT (phi);
1397 clear_and_done_ssa_iter (ptr);
1400 gcc_assert ((flags & (SSA_OP_DEF | SSA_OP_VIRTUAL_DEFS)) != 0);
1402 comp = (is_gimple_reg (phi_def) ? SSA_OP_DEF : SSA_OP_VIRTUAL_DEFS);
1404 /* If the PHI node doesn't the operand type we care about, we're done. */
1405 if ((flags & comp) == 0)
1408 return NULL_USE_OPERAND_P;
1411 ptr->iter_type = ssa_op_iter_def;
1412 /* The first call to op_iter_next_def will terminate the iterator since
1413 all the fields are NULL. Simply return the result here as the first and
1414 therefore only result. */
1415 return PHI_RESULT_PTR (phi);
1418 /* Return true is IMM has reached the end of the immediate use stmt list. */
1421 end_imm_use_stmt_p (const imm_use_iterator *imm)
1423 return (imm->imm_use == imm->end_p);
1426 /* Finished the traverse of an immediate use stmt list IMM by removing the
1427 placeholder node from the list. */
1430 end_imm_use_stmt_traverse (imm_use_iterator *imm)
1432 delink_imm_use (&(imm->iter_node));
1435 /* Immediate use traversal of uses within a stmt require that all the
1436 uses on a stmt be sequentially listed. This routine is used to build up
1437 this sequential list by adding USE_P to the end of the current list
1438 currently delimited by HEAD and LAST_P. The new LAST_P value is
1441 static inline use_operand_p
1442 move_use_after_head (use_operand_p use_p, use_operand_p head,
1443 use_operand_p last_p)
1445 gcc_assert (USE_FROM_PTR (use_p) == USE_FROM_PTR (head));
1446 /* Skip head when we find it. */
1449 /* If use_p is already linked in after last_p, continue. */
1450 if (last_p->next == use_p)
1454 /* Delink from current location, and link in at last_p. */
1455 delink_imm_use (use_p);
1456 link_imm_use_to_list (use_p, last_p);
1464 /* This routine will relink all uses with the same stmt as HEAD into the list
1465 immediately following HEAD for iterator IMM. */
1468 link_use_stmts_after (use_operand_p head, imm_use_iterator *imm)
1470 use_operand_p use_p;
1471 use_operand_p last_p = head;
1472 tree head_stmt = USE_STMT (head);
1473 tree use = USE_FROM_PTR (head);
1474 ssa_op_iter op_iter;
1477 /* Only look at virtual or real uses, depending on the type of HEAD. */
1478 flag = (is_gimple_reg (use) ? SSA_OP_USE : SSA_OP_VIRTUAL_USES);
1480 if (TREE_CODE (head_stmt) == PHI_NODE)
1482 FOR_EACH_PHI_ARG (use_p, head_stmt, op_iter, flag)
1483 if (USE_FROM_PTR (use_p) == use)
1484 last_p = move_use_after_head (use_p, head, last_p);
1488 FOR_EACH_SSA_USE_OPERAND (use_p, head_stmt, op_iter, flag)
1489 if (USE_FROM_PTR (use_p) == use)
1490 last_p = move_use_after_head (use_p, head, last_p);
1492 /* LInk iter node in after last_p. */
1493 if (imm->iter_node.prev != NULL)
1494 delink_imm_use (&imm->iter_node);
1495 link_imm_use_to_list (&(imm->iter_node), last_p);
1498 /* Initialize IMM to traverse over uses of VAR. Return the first statement. */
1500 first_imm_use_stmt (imm_use_iterator *imm, tree var)
1502 gcc_assert (TREE_CODE (var) == SSA_NAME);
1504 imm->end_p = &(SSA_NAME_IMM_USE_NODE (var));
1505 imm->imm_use = imm->end_p->next;
1506 imm->next_imm_name = NULL_USE_OPERAND_P;
1508 /* iter_node is used as a marker within the immediate use list to indicate
1509 where the end of the current stmt's uses are. Initialize it to NULL
1510 stmt and use, which indicates a marker node. */
1511 imm->iter_node.prev = NULL_USE_OPERAND_P;
1512 imm->iter_node.next = NULL_USE_OPERAND_P;
1513 imm->iter_node.stmt = NULL_TREE;
1514 imm->iter_node.use = NULL_USE_OPERAND_P;
1516 if (end_imm_use_stmt_p (imm))
1519 link_use_stmts_after (imm->imm_use, imm);
1521 return USE_STMT (imm->imm_use);
1524 /* Bump IMM to the next stmt which has a use of var. */
1527 next_imm_use_stmt (imm_use_iterator *imm)
1529 imm->imm_use = imm->iter_node.next;
1530 if (end_imm_use_stmt_p (imm))
1532 if (imm->iter_node.prev != NULL)
1533 delink_imm_use (&imm->iter_node);
1537 link_use_stmts_after (imm->imm_use, imm);
1538 return USE_STMT (imm->imm_use);
1541 /* This routine will return the first use on the stmt IMM currently refers
1544 static inline use_operand_p
1545 first_imm_use_on_stmt (imm_use_iterator *imm)
1547 imm->next_imm_name = imm->imm_use->next;
1548 return imm->imm_use;
1551 /* Return TRUE if the last use on the stmt IMM refers to has been visited. */
1554 end_imm_use_on_stmt_p (const imm_use_iterator *imm)
1556 return (imm->imm_use == &(imm->iter_node));
1559 /* Bump to the next use on the stmt IMM refers to, return NULL if done. */
1561 static inline use_operand_p
1562 next_imm_use_on_stmt (imm_use_iterator *imm)
1564 imm->imm_use = imm->next_imm_name;
1565 if (end_imm_use_on_stmt_p (imm))
1566 return NULL_USE_OPERAND_P;
1569 imm->next_imm_name = imm->imm_use->next;
1570 return imm->imm_use;
1574 /* Return true if VAR cannot be modified by the program. */
1577 unmodifiable_var_p (const_tree var)
1579 if (TREE_CODE (var) == SSA_NAME)
1580 var = SSA_NAME_VAR (var);
1585 return TREE_READONLY (var) && (TREE_STATIC (var) || DECL_EXTERNAL (var));
1588 /* Return true if REF, an ARRAY_REF, has an INDIRECT_REF somewhere in it. */
1591 array_ref_contains_indirect_ref (const_tree ref)
1593 gcc_assert (TREE_CODE (ref) == ARRAY_REF);
1596 ref = TREE_OPERAND (ref, 0);
1597 } while (handled_component_p (ref));
1599 return TREE_CODE (ref) == INDIRECT_REF;
1602 /* Return true if REF, a handled component reference, has an ARRAY_REF
1606 ref_contains_array_ref (const_tree ref)
1608 gcc_assert (handled_component_p (ref));
1611 if (TREE_CODE (ref) == ARRAY_REF)
1613 ref = TREE_OPERAND (ref, 0);
1614 } while (handled_component_p (ref));
1619 /* Return true, if the two ranges [POS1, SIZE1] and [POS2, SIZE2]
1620 overlap. SIZE1 and/or SIZE2 can be (unsigned)-1 in which case the
1621 range is open-ended. Otherwise return false. */
1624 ranges_overlap_p (unsigned HOST_WIDE_INT pos1,
1625 unsigned HOST_WIDE_INT size1,
1626 unsigned HOST_WIDE_INT pos2,
1627 unsigned HOST_WIDE_INT size2)
1630 && (size2 == (unsigned HOST_WIDE_INT)-1
1631 || pos1 < (pos2 + size2)))
1634 && (size1 == (unsigned HOST_WIDE_INT)-1
1635 || pos2 < (pos1 + size1)))
1641 /* Return the memory tag associated with symbol SYM. */
1644 symbol_mem_tag (tree sym)
1646 tree tag = get_var_ann (sym)->symbol_mem_tag;
1648 #if defined ENABLE_CHECKING
1650 gcc_assert (TREE_CODE (tag) == SYMBOL_MEMORY_TAG);
1657 /* Set the memory tag associated with symbol SYM. */
1660 set_symbol_mem_tag (tree sym, tree tag)
1662 #if defined ENABLE_CHECKING
1664 gcc_assert (TREE_CODE (tag) == SYMBOL_MEMORY_TAG);
1667 get_var_ann (sym)->symbol_mem_tag = tag;
1670 /* Get the value handle of EXPR. This is the only correct way to get
1671 the value handle for a "thing". If EXPR does not have a value
1672 handle associated, it returns NULL_TREE.
1673 NB: If EXPR is min_invariant, this function is *required* to return
1677 get_value_handle (tree expr)
1679 if (TREE_CODE (expr) == SSA_NAME)
1680 return SSA_NAME_VALUE (expr);
1681 else if (DECL_P (expr) || TREE_CODE (expr) == TREE_LIST
1682 || TREE_CODE (expr) == CONSTRUCTOR)
1684 tree_ann_common_t ann = tree_common_ann (expr);
1685 return ((ann) ? ann->value_handle : NULL_TREE);
1687 else if (is_gimple_min_invariant (expr))
1689 else if (EXPR_P (expr))
1691 tree_ann_common_t ann = tree_common_ann (expr);
1692 return ((ann) ? ann->value_handle : NULL_TREE);
1698 /* Accessor to tree-ssa-operands.c caches. */
1699 static inline struct ssa_operands *
1700 gimple_ssa_operands (const struct function *fun)
1702 return &fun->gimple_df->ssa_operands;
1705 /* Map describing reference statistics for function FN. */
1706 static inline struct mem_ref_stats_d *
1707 gimple_mem_ref_stats (const struct function *fn)
1709 return &fn->gimple_df->mem_ref_stats;
1712 /* Given an edge_var_map V, return the PHI arg definition. */
1715 redirect_edge_var_map_def (edge_var_map *v)
1720 /* Given an edge_var_map V, return the PHI result. */
1723 redirect_edge_var_map_result (edge_var_map *v)
1729 /* Return an SSA_NAME node for variable VAR defined in statement STMT
1730 in function cfun. */
1733 make_ssa_name (tree var, tree stmt)
1735 return make_ssa_name_fn (cfun, var, stmt);
1738 #endif /* _TREE_FLOW_INLINE_H */