1 /* Inline functions for tree-flow.h
2 Copyright (C) 2001, 2003, 2005, 2006 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 2, 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 COPYING. If not, write to
19 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 #ifndef _TREE_FLOW_INLINE_H
23 #define _TREE_FLOW_INLINE_H 1
25 /* Inline functions for manipulating various data structures defined in
26 tree-flow.h. See tree-flow.h for documentation. */
28 /* Return true when gimple SSA form was built.
29 gimple_in_ssa_p is queried by gimplifier in various early stages before SSA
30 infrastructure is initialized. Check for presence of the datastructures
33 gimple_in_ssa_p (struct function *fun)
35 return fun && fun->gimple_df && fun->gimple_df->in_ssa_p;
38 /* 'true' after aliases have been computed (see compute_may_aliases). */
40 gimple_aliases_computed_p (struct function *fun)
42 gcc_assert (fun && fun->gimple_df);
43 return fun->gimple_df->aliases_computed_p;
46 /* Addressable variables in the function. If bit I is set, then
47 REFERENCED_VARS (I) has had its address taken. Note that
48 CALL_CLOBBERED_VARS and ADDRESSABLE_VARS are not related. An
49 addressable variable is not necessarily call-clobbered (e.g., a
50 local addressable whose address does not escape) and not all
51 call-clobbered variables are addressable (e.g., a local static
54 gimple_addressable_vars (struct function *fun)
56 gcc_assert (fun && fun->gimple_df);
57 return fun->gimple_df->addressable_vars;
60 /* Call clobbered variables in the function. If bit I is set, then
61 REFERENCED_VARS (I) is call-clobbered. */
63 gimple_call_clobbered_vars (struct function *fun)
65 gcc_assert (fun && fun->gimple_df);
66 return fun->gimple_df->call_clobbered_vars;
69 /* Array of all variables referenced in the function. */
71 gimple_referenced_vars (struct function *fun)
75 return fun->gimple_df->referenced_vars;
78 /* Artificial variable used to model the effects of function calls. */
80 gimple_global_var (struct function *fun)
82 gcc_assert (fun && fun->gimple_df);
83 return fun->gimple_df->global_var;
86 /* Artificial variable used to model the effects of nonlocal
89 gimple_nonlocal_all (struct function *fun)
91 gcc_assert (fun && fun->gimple_df);
92 return fun->gimple_df->nonlocal_all;
95 /* Hashtable of variables annotations. Used for static variables only;
96 local variables have direct pointer in the tree node. */
98 gimple_var_anns (struct function *fun)
100 return fun->gimple_df->var_anns;
103 /* Initialize the hashtable iterator HTI to point to hashtable TABLE */
106 first_htab_element (htab_iterator *hti, htab_t table)
109 hti->slot = table->entries;
110 hti->limit = hti->slot + htab_size (table);
113 PTR x = *(hti->slot);
114 if (x != HTAB_EMPTY_ENTRY && x != HTAB_DELETED_ENTRY)
116 } while (++(hti->slot) < hti->limit);
118 if (hti->slot < hti->limit)
123 /* Return current non-empty/deleted slot of the hashtable pointed to by HTI,
124 or NULL if we have reached the end. */
127 end_htab_p (htab_iterator *hti)
129 if (hti->slot >= hti->limit)
134 /* Advance the hashtable iterator pointed to by HTI to the next element of the
138 next_htab_element (htab_iterator *hti)
140 while (++(hti->slot) < hti->limit)
142 PTR x = *(hti->slot);
143 if (x != HTAB_EMPTY_ENTRY && x != HTAB_DELETED_ENTRY)
149 /* Initialize ITER to point to the first referenced variable in the
150 referenced_vars hashtable, and return that variable. */
153 first_referenced_var (referenced_var_iterator *iter)
155 struct int_tree_map *itm;
156 itm = (struct int_tree_map *) first_htab_element (&iter->hti,
157 gimple_referenced_vars
164 /* Return true if we have hit the end of the referenced variables ITER is
165 iterating through. */
168 end_referenced_vars_p (referenced_var_iterator *iter)
170 return end_htab_p (&iter->hti);
173 /* Make ITER point to the next referenced_var in the referenced_var hashtable,
174 and return that variable. */
177 next_referenced_var (referenced_var_iterator *iter)
179 struct int_tree_map *itm;
180 itm = (struct int_tree_map *) next_htab_element (&iter->hti);
186 /* Fill up VEC with the variables in the referenced vars hashtable. */
189 fill_referenced_var_vec (VEC (tree, heap) **vec)
191 referenced_var_iterator rvi;
194 FOR_EACH_REFERENCED_VAR (var, rvi)
195 VEC_safe_push (tree, heap, *vec, var);
198 /* Return the variable annotation for T, which must be a _DECL node.
199 Return NULL if the variable annotation doesn't already exist. */
200 static inline var_ann_t
204 gcc_assert (DECL_P (t));
205 gcc_assert (TREE_CODE (t) != FUNCTION_DECL);
206 if (!MTAG_P (t) && (TREE_STATIC (t) || DECL_EXTERNAL (t)))
208 struct static_var_ann_d *sann
209 = ((struct static_var_ann_d *)
210 htab_find_with_hash (gimple_var_anns (cfun), t, DECL_UID (t)));
213 gcc_assert (sann->ann.common.type = VAR_ANN);
216 gcc_assert (!t->base.ann
217 || t->base.ann->common.type == VAR_ANN);
219 return (var_ann_t) t->base.ann;
222 /* Return the variable annotation for T, which must be a _DECL node.
223 Create the variable annotation if it doesn't exist. */
224 static inline var_ann_t
225 get_var_ann (tree var)
227 var_ann_t ann = var_ann (var);
228 return (ann) ? ann : create_var_ann (var);
231 /* Return the function annotation for T, which must be a FUNCTION_DECL node.
232 Return NULL if the function annotation doesn't already exist. */
233 static inline function_ann_t
234 function_ann (tree t)
237 gcc_assert (TREE_CODE (t) == FUNCTION_DECL);
238 gcc_assert (!t->base.ann
239 || t->base.ann->common.type == FUNCTION_ANN);
241 return (function_ann_t) t->base.ann;
244 /* Return the function annotation for T, which must be a FUNCTION_DECL node.
245 Create the function annotation if it doesn't exist. */
246 static inline function_ann_t
247 get_function_ann (tree var)
249 function_ann_t ann = function_ann (var);
250 gcc_assert (!var->base.ann || var->base.ann->common.type == FUNCTION_ANN);
251 return (ann) ? ann : create_function_ann (var);
254 /* Return true if T has a statement annotation attached to it. */
257 has_stmt_ann (tree t)
259 #ifdef ENABLE_CHECKING
260 gcc_assert (is_gimple_stmt (t));
262 return t->base.ann && t->base.ann->common.type == STMT_ANN;
265 /* Return the statement annotation for T, which must be a statement
266 node. Return NULL if the statement annotation doesn't exist. */
267 static inline stmt_ann_t
270 #ifdef ENABLE_CHECKING
271 gcc_assert (is_gimple_stmt (t));
273 gcc_assert (!t->base.ann || t->base.ann->common.type == STMT_ANN);
274 return (stmt_ann_t) t->base.ann;
277 /* Return the statement annotation for T, which must be a statement
278 node. Create the statement annotation if it doesn't exist. */
279 static inline stmt_ann_t
280 get_stmt_ann (tree stmt)
282 stmt_ann_t ann = stmt_ann (stmt);
283 return (ann) ? ann : create_stmt_ann (stmt);
286 /* Return the annotation type for annotation ANN. */
287 static inline enum tree_ann_type
288 ann_type (tree_ann_t ann)
290 return ann->common.type;
293 /* Return the basic block for statement T. */
294 static inline basic_block
299 if (TREE_CODE (t) == PHI_NODE)
303 return ann ? ann->bb : NULL;
306 /* Return the may_aliases bitmap for variable VAR, or NULL if it has
309 may_aliases (tree var)
311 return MTAG_ALIASES (var);
314 /* Return the line number for EXPR, or return -1 if we have no line
315 number information for it. */
317 get_lineno (tree expr)
319 if (expr == NULL_TREE)
322 if (TREE_CODE (expr) == COMPOUND_EXPR)
323 expr = TREE_OPERAND (expr, 0);
325 if (! EXPR_HAS_LOCATION (expr))
328 return EXPR_LINENO (expr);
331 /* Return the file name for EXPR, or return "???" if we have no
332 filename information. */
333 static inline const char *
334 get_filename (tree expr)
336 const char *filename;
337 if (expr == NULL_TREE)
340 if (TREE_CODE (expr) == COMPOUND_EXPR)
341 expr = TREE_OPERAND (expr, 0);
343 if (EXPR_HAS_LOCATION (expr) && (filename = EXPR_FILENAME (expr)))
349 /* Return true if T is a noreturn call. */
351 noreturn_call_p (tree t)
353 tree call = get_call_expr_in (t);
354 return call != 0 && (call_expr_flags (call) & ECF_NORETURN) != 0;
357 /* Mark statement T as modified. */
359 mark_stmt_modified (tree t)
362 if (TREE_CODE (t) == PHI_NODE)
367 ann = create_stmt_ann (t);
368 else if (noreturn_call_p (t) && cfun->gimple_df)
369 VEC_safe_push (tree, gc, MODIFIED_NORETURN_CALLS (cfun), t);
373 /* Mark statement T as modified, and update it. */
377 if (TREE_CODE (t) == PHI_NODE)
379 mark_stmt_modified (t);
380 update_stmt_operands (t);
384 update_stmt_if_modified (tree t)
386 if (stmt_modified_p (t))
387 update_stmt_operands (t);
390 /* Return true if T is marked as modified, false otherwise. */
392 stmt_modified_p (tree t)
394 stmt_ann_t ann = stmt_ann (t);
396 /* Note that if the statement doesn't yet have an annotation, we consider it
397 modified. This will force the next call to update_stmt_operands to scan
399 return ann ? ann->modified : true;
402 /* Delink an immediate_uses node from its chain. */
404 delink_imm_use (ssa_use_operand_t *linknode)
406 /* Return if this node is not in a list. */
407 if (linknode->prev == NULL)
410 linknode->prev->next = linknode->next;
411 linknode->next->prev = linknode->prev;
412 linknode->prev = NULL;
413 linknode->next = NULL;
416 /* Link ssa_imm_use node LINKNODE into the chain for LIST. */
418 link_imm_use_to_list (ssa_use_operand_t *linknode, ssa_use_operand_t *list)
420 /* Link the new node at the head of the list. If we are in the process of
421 traversing the list, we won't visit any new nodes added to it. */
422 linknode->prev = list;
423 linknode->next = list->next;
424 list->next->prev = linknode;
425 list->next = linknode;
428 /* Link ssa_imm_use node LINKNODE into the chain for DEF. */
430 link_imm_use (ssa_use_operand_t *linknode, tree def)
432 ssa_use_operand_t *root;
434 if (!def || TREE_CODE (def) != SSA_NAME)
435 linknode->prev = NULL;
438 root = &(SSA_NAME_IMM_USE_NODE (def));
439 #ifdef ENABLE_CHECKING
441 gcc_assert (*(linknode->use) == def);
443 link_imm_use_to_list (linknode, root);
447 /* Set the value of a use pointed to by USE to VAL. */
449 set_ssa_use_from_ptr (use_operand_p use, tree val)
451 delink_imm_use (use);
453 link_imm_use (use, val);
456 /* Link ssa_imm_use node LINKNODE into the chain for DEF, with use occurring
459 link_imm_use_stmt (ssa_use_operand_t *linknode, tree def, tree stmt)
462 link_imm_use (linknode, def);
464 link_imm_use (linknode, NULL);
465 linknode->stmt = stmt;
468 /* Relink a new node in place of an old node in the list. */
470 relink_imm_use (ssa_use_operand_t *node, ssa_use_operand_t *old)
472 /* The node one had better be in the same list. */
473 gcc_assert (*(old->use) == *(node->use));
474 node->prev = old->prev;
475 node->next = old->next;
478 old->prev->next = node;
479 old->next->prev = node;
480 /* Remove the old node from the list. */
485 /* Relink ssa_imm_use node LINKNODE into the chain for OLD, with use occurring
488 relink_imm_use_stmt (ssa_use_operand_t *linknode, ssa_use_operand_t *old, tree stmt)
491 relink_imm_use (linknode, old);
493 link_imm_use (linknode, NULL);
494 linknode->stmt = stmt;
498 /* Return true is IMM has reached the end of the immediate use list. */
500 end_readonly_imm_use_p (imm_use_iterator *imm)
502 return (imm->imm_use == imm->end_p);
505 /* Initialize iterator IMM to process the list for VAR. */
506 static inline use_operand_p
507 first_readonly_imm_use (imm_use_iterator *imm, tree var)
509 gcc_assert (TREE_CODE (var) == SSA_NAME);
511 imm->end_p = &(SSA_NAME_IMM_USE_NODE (var));
512 imm->imm_use = imm->end_p->next;
513 #ifdef ENABLE_CHECKING
514 imm->iter_node.next = imm->imm_use->next;
516 if (end_readonly_imm_use_p (imm))
517 return NULL_USE_OPERAND_P;
521 /* Bump IMM to the next use in the list. */
522 static inline use_operand_p
523 next_readonly_imm_use (imm_use_iterator *imm)
525 use_operand_p old = imm->imm_use;
527 #ifdef ENABLE_CHECKING
528 /* If this assertion fails, it indicates the 'next' pointer has changed
529 since we the last bump. This indicates that the list is being modified
530 via stmt changes, or SET_USE, or somesuch thing, and you need to be
531 using the SAFE version of the iterator. */
532 gcc_assert (imm->iter_node.next == old->next);
533 imm->iter_node.next = old->next->next;
536 imm->imm_use = old->next;
537 if (end_readonly_imm_use_p (imm))
542 /* Return true if VAR has no uses. */
544 has_zero_uses (tree var)
546 ssa_use_operand_t *ptr;
547 ptr = &(SSA_NAME_IMM_USE_NODE (var));
548 /* A single use means there is no items in the list. */
549 return (ptr == ptr->next);
552 /* Return true if VAR has a single use. */
554 has_single_use (tree var)
556 ssa_use_operand_t *ptr;
557 ptr = &(SSA_NAME_IMM_USE_NODE (var));
558 /* A single use means there is one item in the list. */
559 return (ptr != ptr->next && ptr == ptr->next->next);
563 /* If VAR has only a single immediate use, return true, and set USE_P and STMT
564 to the use pointer and stmt of occurrence. */
566 single_imm_use (tree var, use_operand_p *use_p, tree *stmt)
568 ssa_use_operand_t *ptr;
570 ptr = &(SSA_NAME_IMM_USE_NODE (var));
571 if (ptr != ptr->next && ptr == ptr->next->next)
574 *stmt = ptr->next->stmt;
577 *use_p = NULL_USE_OPERAND_P;
582 /* Return the number of immediate uses of VAR. */
583 static inline unsigned int
584 num_imm_uses (tree var)
586 ssa_use_operand_t *ptr, *start;
589 start = &(SSA_NAME_IMM_USE_NODE (var));
591 for (ptr = start->next; ptr != start; ptr = ptr->next)
597 /* Return the tree pointer to by USE. */
599 get_use_from_ptr (use_operand_p use)
604 /* Return the tree pointer to by DEF. */
606 get_def_from_ptr (def_operand_p def)
611 /* Return a def_operand_p pointer for the result of PHI. */
612 static inline def_operand_p
613 get_phi_result_ptr (tree phi)
615 return &(PHI_RESULT_TREE (phi));
618 /* Return a use_operand_p pointer for argument I of phinode PHI. */
619 static inline use_operand_p
620 get_phi_arg_def_ptr (tree phi, int i)
622 return &(PHI_ARG_IMM_USE_NODE (phi,i));
626 /* Return the bitmap of addresses taken by STMT, or NULL if it takes
629 addresses_taken (tree stmt)
631 stmt_ann_t ann = stmt_ann (stmt);
632 return ann ? ann->addresses_taken : NULL;
635 /* Return the PHI nodes for basic block BB, or NULL if there are no
638 phi_nodes (basic_block bb)
640 return bb->phi_nodes;
643 /* Set list of phi nodes of a basic block BB to L. */
646 set_phi_nodes (basic_block bb, tree l)
651 for (phi = l; phi; phi = PHI_CHAIN (phi))
652 set_bb_for_stmt (phi, bb);
655 /* Return the phi argument which contains the specified use. */
658 phi_arg_index_from_use (use_operand_p use)
660 struct phi_arg_d *element, *root;
664 /* Since the use is the first thing in a PHI argument element, we can
665 calculate its index based on casting it to an argument, and performing
666 pointer arithmetic. */
668 phi = USE_STMT (use);
669 gcc_assert (TREE_CODE (phi) == PHI_NODE);
671 element = (struct phi_arg_d *)use;
672 root = &(PHI_ARG_ELT (phi, 0));
673 index = element - root;
675 #ifdef ENABLE_CHECKING
676 /* Make sure the calculation doesn't have any leftover bytes. If it does,
677 then imm_use is likely not the first element in phi_arg_d. */
679 (((char *)element - (char *)root) % sizeof (struct phi_arg_d)) == 0);
680 gcc_assert (index >= 0 && index < PHI_ARG_CAPACITY (phi));
686 /* Mark VAR as used, so that it'll be preserved during rtl expansion. */
689 set_is_used (tree var)
691 var_ann_t ann = get_var_ann (var);
695 /* Return true if T is an executable statement. */
697 is_exec_stmt (tree t)
699 return (t && !IS_EMPTY_STMT (t) && t != error_mark_node);
703 /* Return true if this stmt can be the target of a control transfer stmt such
706 is_label_stmt (tree t)
709 switch (TREE_CODE (t))
713 case CASE_LABEL_EXPR:
721 /* Return true if T (assumed to be a DECL) is a global variable. */
724 is_global_var (tree t)
727 return (TREE_STATIC (t) || MTAG_GLOBAL (t));
729 return (TREE_STATIC (t) || DECL_EXTERNAL (t));
732 /* PHI nodes should contain only ssa_names and invariants. A test
733 for ssa_name is definitely simpler; don't let invalid contents
734 slip in in the meantime. */
737 phi_ssa_name_p (tree t)
739 if (TREE_CODE (t) == SSA_NAME)
741 #ifdef ENABLE_CHECKING
742 gcc_assert (is_gimple_min_invariant (t));
747 /* ----------------------------------------------------------------------- */
749 /* Return a block_stmt_iterator that points to beginning of basic
751 static inline block_stmt_iterator
752 bsi_start (basic_block bb)
754 block_stmt_iterator bsi;
756 bsi.tsi = tsi_start (bb->stmt_list);
759 gcc_assert (bb->index < NUM_FIXED_BLOCKS);
761 bsi.tsi.container = NULL;
767 /* Return a block statement iterator that points to the first non-label
768 statement in block BB. */
770 static inline block_stmt_iterator
771 bsi_after_labels (basic_block bb)
773 block_stmt_iterator bsi = bsi_start (bb);
775 while (!bsi_end_p (bsi) && TREE_CODE (bsi_stmt (bsi)) == LABEL_EXPR)
781 /* Return a block statement iterator that points to the end of basic
783 static inline block_stmt_iterator
784 bsi_last (basic_block bb)
786 block_stmt_iterator bsi;
788 bsi.tsi = tsi_last (bb->stmt_list);
791 gcc_assert (bb->index < NUM_FIXED_BLOCKS);
793 bsi.tsi.container = NULL;
799 /* Return true if block statement iterator I has reached the end of
802 bsi_end_p (block_stmt_iterator i)
804 return tsi_end_p (i.tsi);
807 /* Modify block statement iterator I so that it is at the next
808 statement in the basic block. */
810 bsi_next (block_stmt_iterator *i)
815 /* Modify block statement iterator I so that it is at the previous
816 statement in the basic block. */
818 bsi_prev (block_stmt_iterator *i)
823 /* Return the statement that block statement iterator I is currently
826 bsi_stmt (block_stmt_iterator i)
828 return tsi_stmt (i.tsi);
831 /* Return a pointer to the statement that block statement iterator I
834 bsi_stmt_ptr (block_stmt_iterator i)
836 return tsi_stmt_ptr (i.tsi);
839 /* Returns the loop of the statement STMT. */
841 static inline struct loop *
842 loop_containing_stmt (tree stmt)
844 basic_block bb = bb_for_stmt (stmt);
848 return bb->loop_father;
852 /* Return the memory partition tag associated with symbol SYM. */
855 memory_partition (tree sym)
859 /* MPTs belong to their own partition. */
860 if (TREE_CODE (sym) == MEMORY_PARTITION_TAG)
863 gcc_assert (!is_gimple_reg (sym));
864 tag = get_var_ann (sym)->mpt;
866 #if defined ENABLE_CHECKING
868 gcc_assert (TREE_CODE (tag) == MEMORY_PARTITION_TAG);
875 /* Set MPT to be the memory partition associated with symbol SYM. */
878 set_memory_partition (tree sym, tree mpt)
880 #if defined ENABLE_CHECKING
882 gcc_assert (TREE_CODE (mpt) == MEMORY_PARTITION_TAG
883 && !is_gimple_reg (sym));
885 var_ann (sym)->mpt = mpt;
888 bitmap_set_bit (MPT_SYMBOLS (mpt), DECL_UID (sym));
890 /* MPT inherits the call-clobbering attributes from SYM. */
891 if (is_call_clobbered (sym))
893 MTAG_GLOBAL (mpt) = 1;
894 mark_call_clobbered (mpt, ESCAPE_IS_GLOBAL);
899 /* Return true if NAME is a memory factoring SSA name (i.e., an SSA
900 name for a memory partition. */
903 factoring_name_p (tree name)
905 return TREE_CODE (SSA_NAME_VAR (name)) == MEMORY_PARTITION_TAG;
908 /* Return true if VAR is a clobbered by function calls. */
910 is_call_clobbered (tree var)
913 return var_ann (var)->call_clobbered;
915 return bitmap_bit_p (gimple_call_clobbered_vars (cfun), DECL_UID (var));
918 /* Mark variable VAR as being clobbered by function calls. */
920 mark_call_clobbered (tree var, unsigned int escape_type)
922 var_ann (var)->escape_mask |= escape_type;
924 var_ann (var)->call_clobbered = true;
925 bitmap_set_bit (gimple_call_clobbered_vars (cfun), DECL_UID (var));
928 /* Clear the call-clobbered attribute from variable VAR. */
930 clear_call_clobbered (tree var)
932 var_ann_t ann = var_ann (var);
933 ann->escape_mask = 0;
934 if (MTAG_P (var) && TREE_CODE (var) != STRUCT_FIELD_TAG)
935 MTAG_GLOBAL (var) = 0;
937 var_ann (var)->call_clobbered = false;
938 bitmap_clear_bit (gimple_call_clobbered_vars (cfun), DECL_UID (var));
941 /* Return the common annotation for T. Return NULL if the annotation
942 doesn't already exist. */
943 static inline tree_ann_common_t
944 tree_common_ann (tree t)
946 /* Watch out static variables with unshared annotations. */
947 if (DECL_P (t) && TREE_CODE (t) == VAR_DECL)
948 return &var_ann (t)->common;
949 return &t->base.ann->common;
952 /* Return a common annotation for T. Create the constant annotation if it
954 static inline tree_ann_common_t
955 get_tree_common_ann (tree t)
957 tree_ann_common_t ann = tree_common_ann (t);
958 return (ann) ? ann : create_tree_common_ann (t);
961 /* ----------------------------------------------------------------------- */
963 /* The following set of routines are used to iterator over various type of
966 /* Return true if PTR is finished iterating. */
968 op_iter_done (ssa_op_iter *ptr)
973 /* Get the next iterator use value for PTR. */
974 static inline use_operand_p
975 op_iter_next_use (ssa_op_iter *ptr)
978 #ifdef ENABLE_CHECKING
979 gcc_assert (ptr->iter_type == ssa_op_iter_use);
983 use_p = USE_OP_PTR (ptr->uses);
984 ptr->uses = ptr->uses->next;
989 use_p = VUSE_OP_PTR (ptr->vuses, ptr->vuse_index);
990 if (++(ptr->vuse_index) >= VUSE_NUM (ptr->vuses))
993 ptr->vuses = ptr->vuses->next;
999 use_p = VDEF_OP_PTR (ptr->mayuses, ptr->mayuse_index);
1000 if (++(ptr->mayuse_index) >= VDEF_NUM (ptr->mayuses))
1002 ptr->mayuse_index = 0;
1003 ptr->mayuses = ptr->mayuses->next;
1007 if (ptr->phi_i < ptr->num_phi)
1009 return PHI_ARG_DEF_PTR (ptr->phi_stmt, (ptr->phi_i)++);
1012 return NULL_USE_OPERAND_P;
1015 /* Get the next iterator def value for PTR. */
1016 static inline def_operand_p
1017 op_iter_next_def (ssa_op_iter *ptr)
1019 def_operand_p def_p;
1020 #ifdef ENABLE_CHECKING
1021 gcc_assert (ptr->iter_type == ssa_op_iter_def);
1025 def_p = DEF_OP_PTR (ptr->defs);
1026 ptr->defs = ptr->defs->next;
1031 def_p = VDEF_RESULT_PTR (ptr->vdefs);
1032 ptr->vdefs = ptr->vdefs->next;
1036 return NULL_DEF_OPERAND_P;
1039 /* Get the next iterator tree value for PTR. */
1041 op_iter_next_tree (ssa_op_iter *ptr)
1044 #ifdef ENABLE_CHECKING
1045 gcc_assert (ptr->iter_type == ssa_op_iter_tree);
1049 val = USE_OP (ptr->uses);
1050 ptr->uses = ptr->uses->next;
1055 val = VUSE_OP (ptr->vuses, ptr->vuse_index);
1056 if (++(ptr->vuse_index) >= VUSE_NUM (ptr->vuses))
1058 ptr->vuse_index = 0;
1059 ptr->vuses = ptr->vuses->next;
1065 val = VDEF_OP (ptr->mayuses, ptr->mayuse_index);
1066 if (++(ptr->mayuse_index) >= VDEF_NUM (ptr->mayuses))
1068 ptr->mayuse_index = 0;
1069 ptr->mayuses = ptr->mayuses->next;
1075 val = DEF_OP (ptr->defs);
1076 ptr->defs = ptr->defs->next;
1081 val = VDEF_RESULT (ptr->vdefs);
1082 ptr->vdefs = ptr->vdefs->next;
1092 /* This functions clears the iterator PTR, and marks it done. This is normally
1093 used to prevent warnings in the compile about might be uninitialized
1097 clear_and_done_ssa_iter (ssa_op_iter *ptr)
1103 ptr->mayuses = NULL;
1104 ptr->iter_type = ssa_op_iter_none;
1107 ptr->phi_stmt = NULL_TREE;
1109 ptr->vuse_index = 0;
1110 ptr->mayuse_index = 0;
1113 /* Initialize the iterator PTR to the virtual defs in STMT. */
1115 op_iter_init (ssa_op_iter *ptr, tree stmt, int flags)
1117 #ifdef ENABLE_CHECKING
1118 gcc_assert (stmt_ann (stmt));
1121 ptr->defs = (flags & SSA_OP_DEF) ? DEF_OPS (stmt) : NULL;
1122 ptr->uses = (flags & SSA_OP_USE) ? USE_OPS (stmt) : NULL;
1123 ptr->vuses = (flags & SSA_OP_VUSE) ? VUSE_OPS (stmt) : NULL;
1124 ptr->vdefs = (flags & SSA_OP_VDEF) ? VDEF_OPS (stmt) : NULL;
1125 ptr->mayuses = (flags & SSA_OP_VMAYUSE) ? VDEF_OPS (stmt) : NULL;
1130 ptr->phi_stmt = NULL_TREE;
1131 ptr->vuse_index = 0;
1132 ptr->mayuse_index = 0;
1135 /* Initialize iterator PTR to the use operands in STMT based on FLAGS. Return
1137 static inline use_operand_p
1138 op_iter_init_use (ssa_op_iter *ptr, tree stmt, int flags)
1140 gcc_assert ((flags & SSA_OP_ALL_DEFS) == 0);
1141 op_iter_init (ptr, stmt, flags);
1142 ptr->iter_type = ssa_op_iter_use;
1143 return op_iter_next_use (ptr);
1146 /* Initialize iterator PTR to the def operands in STMT based on FLAGS. Return
1148 static inline def_operand_p
1149 op_iter_init_def (ssa_op_iter *ptr, tree stmt, int flags)
1151 gcc_assert ((flags & SSA_OP_ALL_USES) == 0);
1152 op_iter_init (ptr, stmt, flags);
1153 ptr->iter_type = ssa_op_iter_def;
1154 return op_iter_next_def (ptr);
1157 /* Initialize iterator PTR to the operands in STMT based on FLAGS. Return
1158 the first operand as a tree. */
1160 op_iter_init_tree (ssa_op_iter *ptr, tree stmt, int flags)
1162 op_iter_init (ptr, stmt, flags);
1163 ptr->iter_type = ssa_op_iter_tree;
1164 return op_iter_next_tree (ptr);
1167 /* Get the next iterator mustdef value for PTR, returning the mustdef values in
1170 op_iter_next_vdef (vuse_vec_p *use, def_operand_p *def,
1173 #ifdef ENABLE_CHECKING
1174 gcc_assert (ptr->iter_type == ssa_op_iter_vdef);
1178 *def = VDEF_RESULT_PTR (ptr->mayuses);
1179 *use = VDEF_VECT (ptr->mayuses);
1180 ptr->mayuses = ptr->mayuses->next;
1184 *def = NULL_DEF_OPERAND_P;
1192 op_iter_next_mustdef (use_operand_p *use, def_operand_p *def,
1196 op_iter_next_vdef (&vp, def, ptr);
1199 gcc_assert (VUSE_VECT_NUM_ELEM (*vp) == 1);
1200 *use = VUSE_ELEMENT_PTR (*vp, 0);
1203 *use = NULL_USE_OPERAND_P;
1206 /* Initialize iterator PTR to the operands in STMT. Return the first operands
1209 op_iter_init_vdef (ssa_op_iter *ptr, tree stmt, vuse_vec_p *use,
1212 gcc_assert (TREE_CODE (stmt) != PHI_NODE);
1214 op_iter_init (ptr, stmt, SSA_OP_VMAYUSE);
1215 ptr->iter_type = ssa_op_iter_vdef;
1216 op_iter_next_vdef (use, def, ptr);
1220 /* If there is a single operand in STMT matching FLAGS, return it. Otherwise
1223 single_ssa_tree_operand (tree stmt, int flags)
1228 var = op_iter_init_tree (&iter, stmt, flags);
1229 if (op_iter_done (&iter))
1231 op_iter_next_tree (&iter);
1232 if (op_iter_done (&iter))
1238 /* If there is a single operand in STMT matching FLAGS, return it. Otherwise
1240 static inline use_operand_p
1241 single_ssa_use_operand (tree stmt, int flags)
1246 var = op_iter_init_use (&iter, stmt, flags);
1247 if (op_iter_done (&iter))
1248 return NULL_USE_OPERAND_P;
1249 op_iter_next_use (&iter);
1250 if (op_iter_done (&iter))
1252 return NULL_USE_OPERAND_P;
1257 /* If there is a single operand in STMT matching FLAGS, return it. Otherwise
1259 static inline def_operand_p
1260 single_ssa_def_operand (tree stmt, int flags)
1265 var = op_iter_init_def (&iter, stmt, flags);
1266 if (op_iter_done (&iter))
1267 return NULL_DEF_OPERAND_P;
1268 op_iter_next_def (&iter);
1269 if (op_iter_done (&iter))
1271 return NULL_DEF_OPERAND_P;
1275 /* Return true if there are zero operands in STMT matching the type
1278 zero_ssa_operands (tree stmt, int flags)
1282 op_iter_init_tree (&iter, stmt, flags);
1283 return op_iter_done (&iter);
1287 /* Return the number of operands matching FLAGS in STMT. */
1289 num_ssa_operands (tree stmt, int flags)
1295 FOR_EACH_SSA_TREE_OPERAND (t, stmt, iter, flags)
1301 /* Delink all immediate_use information for STMT. */
1303 delink_stmt_imm_use (tree stmt)
1306 use_operand_p use_p;
1308 if (ssa_operands_active ())
1309 FOR_EACH_SSA_USE_OPERAND (use_p, stmt, iter, SSA_OP_ALL_USES)
1310 delink_imm_use (use_p);
1314 /* This routine will compare all the operands matching FLAGS in STMT1 to those
1315 in STMT2. TRUE is returned if they are the same. STMTs can be NULL. */
1317 compare_ssa_operands_equal (tree stmt1, tree stmt2, int flags)
1319 ssa_op_iter iter1, iter2;
1320 tree op1 = NULL_TREE;
1321 tree op2 = NULL_TREE;
1327 look1 = stmt1 && stmt_ann (stmt1);
1328 look2 = stmt2 && stmt_ann (stmt2);
1332 op1 = op_iter_init_tree (&iter1, stmt1, flags);
1334 return op_iter_done (&iter1);
1337 clear_and_done_ssa_iter (&iter1);
1341 op2 = op_iter_init_tree (&iter2, stmt2, flags);
1343 return op_iter_done (&iter2);
1346 clear_and_done_ssa_iter (&iter2);
1348 while (!op_iter_done (&iter1) && !op_iter_done (&iter2))
1352 op1 = op_iter_next_tree (&iter1);
1353 op2 = op_iter_next_tree (&iter2);
1356 return (op_iter_done (&iter1) && op_iter_done (&iter2));
1360 /* If there is a single DEF in the PHI node which matches FLAG, return it.
1361 Otherwise return NULL_DEF_OPERAND_P. */
1363 single_phi_def (tree stmt, int flags)
1365 tree def = PHI_RESULT (stmt);
1366 if ((flags & SSA_OP_DEF) && is_gimple_reg (def))
1368 if ((flags & SSA_OP_VIRTUAL_DEFS) && !is_gimple_reg (def))
1373 /* Initialize the iterator PTR for uses matching FLAGS in PHI. FLAGS should
1374 be either SSA_OP_USES or SSA_OP_VIRTUAL_USES. */
1375 static inline use_operand_p
1376 op_iter_init_phiuse (ssa_op_iter *ptr, tree phi, int flags)
1378 tree phi_def = PHI_RESULT (phi);
1381 clear_and_done_ssa_iter (ptr);
1384 gcc_assert ((flags & (SSA_OP_USE | SSA_OP_VIRTUAL_USES)) != 0);
1386 comp = (is_gimple_reg (phi_def) ? SSA_OP_USE : SSA_OP_VIRTUAL_USES);
1388 /* If the PHI node doesn't the operand type we care about, we're done. */
1389 if ((flags & comp) == 0)
1392 return NULL_USE_OPERAND_P;
1395 ptr->phi_stmt = phi;
1396 ptr->num_phi = PHI_NUM_ARGS (phi);
1397 ptr->iter_type = ssa_op_iter_use;
1398 return op_iter_next_use (ptr);
1402 /* Start an iterator for a PHI definition. */
1404 static inline def_operand_p
1405 op_iter_init_phidef (ssa_op_iter *ptr, tree phi, int flags)
1407 tree phi_def = PHI_RESULT (phi);
1410 clear_and_done_ssa_iter (ptr);
1413 gcc_assert ((flags & (SSA_OP_DEF | SSA_OP_VIRTUAL_DEFS)) != 0);
1415 comp = (is_gimple_reg (phi_def) ? SSA_OP_DEF : SSA_OP_VIRTUAL_DEFS);
1417 /* If the PHI node doesn't the operand type we care about, we're done. */
1418 if ((flags & comp) == 0)
1421 return NULL_USE_OPERAND_P;
1424 ptr->iter_type = ssa_op_iter_def;
1425 /* The first call to op_iter_next_def will terminate the iterator since
1426 all the fields are NULL. Simply return the result here as the first and
1427 therefore only result. */
1428 return PHI_RESULT_PTR (phi);
1431 /* Return true is IMM has reached the end of the immediate use stmt list. */
1434 end_imm_use_stmt_p (imm_use_iterator *imm)
1436 return (imm->imm_use == imm->end_p);
1439 /* Finished the traverse of an immediate use stmt list IMM by removing the
1440 placeholder node from the list. */
1443 end_imm_use_stmt_traverse (imm_use_iterator *imm)
1445 delink_imm_use (&(imm->iter_node));
1448 /* Immediate use traversal of uses within a stmt require that all the
1449 uses on a stmt be sequentially listed. This routine is used to build up
1450 this sequential list by adding USE_P to the end of the current list
1451 currently delimited by HEAD and LAST_P. The new LAST_P value is
1454 static inline use_operand_p
1455 move_use_after_head (use_operand_p use_p, use_operand_p head,
1456 use_operand_p last_p)
1458 gcc_assert (USE_FROM_PTR (use_p) == USE_FROM_PTR (head));
1459 /* Skip head when we find it. */
1462 /* If use_p is already linked in after last_p, continue. */
1463 if (last_p->next == use_p)
1467 /* Delink from current location, and link in at last_p. */
1468 delink_imm_use (use_p);
1469 link_imm_use_to_list (use_p, last_p);
1477 /* This routine will relink all uses with the same stmt as HEAD into the list
1478 immediately following HEAD for iterator IMM. */
1481 link_use_stmts_after (use_operand_p head, imm_use_iterator *imm)
1483 use_operand_p use_p;
1484 use_operand_p last_p = head;
1485 tree head_stmt = USE_STMT (head);
1486 tree use = USE_FROM_PTR (head);
1487 ssa_op_iter op_iter;
1490 /* Only look at virtual or real uses, depending on the type of HEAD. */
1491 flag = (is_gimple_reg (use) ? SSA_OP_USE : SSA_OP_VIRTUAL_USES);
1493 if (TREE_CODE (head_stmt) == PHI_NODE)
1495 FOR_EACH_PHI_ARG (use_p, head_stmt, op_iter, flag)
1496 if (USE_FROM_PTR (use_p) == use)
1497 last_p = move_use_after_head (use_p, head, last_p);
1501 FOR_EACH_SSA_USE_OPERAND (use_p, head_stmt, op_iter, flag)
1502 if (USE_FROM_PTR (use_p) == use)
1503 last_p = move_use_after_head (use_p, head, last_p);
1505 /* LInk iter node in after last_p. */
1506 if (imm->iter_node.prev != NULL)
1507 delink_imm_use (&imm->iter_node);
1508 link_imm_use_to_list (&(imm->iter_node), last_p);
1511 /* Initialize IMM to traverse over uses of VAR. Return the first statement. */
1513 first_imm_use_stmt (imm_use_iterator *imm, tree var)
1515 gcc_assert (TREE_CODE (var) == SSA_NAME);
1517 imm->end_p = &(SSA_NAME_IMM_USE_NODE (var));
1518 imm->imm_use = imm->end_p->next;
1519 imm->next_imm_name = NULL_USE_OPERAND_P;
1521 /* iter_node is used as a marker within the immediate use list to indicate
1522 where the end of the current stmt's uses are. Initialize it to NULL
1523 stmt and use, which indicates a marker node. */
1524 imm->iter_node.prev = NULL_USE_OPERAND_P;
1525 imm->iter_node.next = NULL_USE_OPERAND_P;
1526 imm->iter_node.stmt = NULL_TREE;
1527 imm->iter_node.use = NULL_USE_OPERAND_P;
1529 if (end_imm_use_stmt_p (imm))
1532 link_use_stmts_after (imm->imm_use, imm);
1534 return USE_STMT (imm->imm_use);
1537 /* Bump IMM to the next stmt which has a use of var. */
1540 next_imm_use_stmt (imm_use_iterator *imm)
1542 imm->imm_use = imm->iter_node.next;
1543 if (end_imm_use_stmt_p (imm))
1545 if (imm->iter_node.prev != NULL)
1546 delink_imm_use (&imm->iter_node);
1550 link_use_stmts_after (imm->imm_use, imm);
1551 return USE_STMT (imm->imm_use);
1555 /* This routine will return the first use on the stmt IMM currently refers
1558 static inline use_operand_p
1559 first_imm_use_on_stmt (imm_use_iterator *imm)
1561 imm->next_imm_name = imm->imm_use->next;
1562 return imm->imm_use;
1565 /* Return TRUE if the last use on the stmt IMM refers to has been visited. */
1568 end_imm_use_on_stmt_p (imm_use_iterator *imm)
1570 return (imm->imm_use == &(imm->iter_node));
1573 /* Bump to the next use on the stmt IMM refers to, return NULL if done. */
1575 static inline use_operand_p
1576 next_imm_use_on_stmt (imm_use_iterator *imm)
1578 imm->imm_use = imm->next_imm_name;
1579 if (end_imm_use_on_stmt_p (imm))
1580 return NULL_USE_OPERAND_P;
1583 imm->next_imm_name = imm->imm_use->next;
1584 return imm->imm_use;
1588 /* Return true if VAR cannot be modified by the program. */
1591 unmodifiable_var_p (tree var)
1593 if (TREE_CODE (var) == SSA_NAME)
1594 var = SSA_NAME_VAR (var);
1597 return TREE_READONLY (var) && (TREE_STATIC (var) || MTAG_GLOBAL (var));
1599 return TREE_READONLY (var) && (TREE_STATIC (var) || DECL_EXTERNAL (var));
1602 /* Return true if REF, an ARRAY_REF, has an INDIRECT_REF somewhere in it. */
1605 array_ref_contains_indirect_ref (tree ref)
1607 gcc_assert (TREE_CODE (ref) == ARRAY_REF);
1610 ref = TREE_OPERAND (ref, 0);
1611 } while (handled_component_p (ref));
1613 return TREE_CODE (ref) == INDIRECT_REF;
1616 /* Return true if REF, a handled component reference, has an ARRAY_REF
1620 ref_contains_array_ref (tree ref)
1622 gcc_assert (handled_component_p (ref));
1625 if (TREE_CODE (ref) == ARRAY_REF)
1627 ref = TREE_OPERAND (ref, 0);
1628 } while (handled_component_p (ref));
1633 /* Given a variable VAR, lookup and return a pointer to the list of
1634 subvariables for it. */
1636 static inline subvar_t *
1637 lookup_subvars_for_var (tree var)
1639 var_ann_t ann = var_ann (var);
1641 return &ann->subvars;
1644 /* Given a variable VAR, return a linked list of subvariables for VAR, or
1645 NULL, if there are no subvariables. */
1647 static inline subvar_t
1648 get_subvars_for_var (tree var)
1652 gcc_assert (SSA_VAR_P (var));
1654 if (TREE_CODE (var) == SSA_NAME)
1655 subvars = *(lookup_subvars_for_var (SSA_NAME_VAR (var)));
1657 subvars = *(lookup_subvars_for_var (var));
1661 /* Return the subvariable of VAR at offset OFFSET. */
1664 get_subvar_at (tree var, unsigned HOST_WIDE_INT offset)
1668 for (sv = get_subvars_for_var (var); sv; sv = sv->next)
1669 if (SFT_OFFSET (sv->var) == offset)
1675 /* Return true if V is a tree that we can have subvars for.
1676 Normally, this is any aggregate type. Also complex
1677 types which are not gimple registers can have subvars. */
1680 var_can_have_subvars (tree v)
1682 /* Volatile variables should never have subvars. */
1683 if (TREE_THIS_VOLATILE (v))
1686 /* Non decls or memory tags can never have subvars. */
1687 if (!DECL_P (v) || MTAG_P (v))
1690 /* Aggregates can have subvars. */
1691 if (AGGREGATE_TYPE_P (TREE_TYPE (v)))
1694 /* Complex types variables which are not also a gimple register can
1696 if (TREE_CODE (TREE_TYPE (v)) == COMPLEX_TYPE
1697 && !DECL_GIMPLE_REG_P (v))
1704 /* Return true if OFFSET and SIZE define a range that overlaps with some
1705 portion of the range of SV, a subvar. If there was an exact overlap,
1706 *EXACT will be set to true upon return. */
1709 overlap_subvar (unsigned HOST_WIDE_INT offset, unsigned HOST_WIDE_INT size,
1710 tree sv, bool *exact)
1712 /* There are three possible cases of overlap.
1713 1. We can have an exact overlap, like so:
1714 |offset, offset + size |
1715 |sv->offset, sv->offset + sv->size |
1717 2. We can have offset starting after sv->offset, like so:
1719 |offset, offset + size |
1720 |sv->offset, sv->offset + sv->size |
1722 3. We can have offset starting before sv->offset, like so:
1724 |offset, offset + size |
1725 |sv->offset, sv->offset + sv->size|
1730 if (offset == SFT_OFFSET (sv) && size == SFT_SIZE (sv))
1736 else if (offset >= SFT_OFFSET (sv)
1737 && offset < (SFT_OFFSET (sv) + SFT_SIZE (sv)))
1741 else if (offset < SFT_OFFSET (sv)
1742 && (size > SFT_OFFSET (sv) - offset))
1750 /* Return the memory tag associated with symbol SYM. */
1753 symbol_mem_tag (tree sym)
1755 tree tag = get_var_ann (sym)->symbol_mem_tag;
1757 #if defined ENABLE_CHECKING
1759 gcc_assert (TREE_CODE (tag) == SYMBOL_MEMORY_TAG);
1766 /* Set the memory tag associated with symbol SYM. */
1769 set_symbol_mem_tag (tree sym, tree tag)
1771 #if defined ENABLE_CHECKING
1773 gcc_assert (TREE_CODE (tag) == SYMBOL_MEMORY_TAG);
1776 get_var_ann (sym)->symbol_mem_tag = tag;
1779 /* Get the value handle of EXPR. This is the only correct way to get
1780 the value handle for a "thing". If EXPR does not have a value
1781 handle associated, it returns NULL_TREE.
1782 NB: If EXPR is min_invariant, this function is *required* to return
1786 get_value_handle (tree expr)
1788 if (TREE_CODE (expr) == SSA_NAME)
1789 return SSA_NAME_VALUE (expr);
1790 else if (DECL_P (expr) || TREE_CODE (expr) == TREE_LIST
1791 || TREE_CODE (expr) == CONSTRUCTOR)
1793 tree_ann_common_t ann = tree_common_ann (expr);
1794 return ((ann) ? ann->value_handle : NULL_TREE);
1796 else if (is_gimple_min_invariant (expr))
1798 else if (EXPR_P (expr))
1800 tree_ann_common_t ann = tree_common_ann (expr);
1801 return ((ann) ? ann->value_handle : NULL_TREE);
1807 /* Accessor to tree-ssa-operands.c caches. */
1808 static inline struct ssa_operands *
1809 gimple_ssa_operands (struct function *fun)
1811 return &fun->gimple_df->ssa_operands;
1813 #endif /* _TREE_FLOW_INLINE_H */