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 struct int_tree_map *itm;
155 itm = (struct int_tree_map *) first_htab_element (&iter->hti,
156 gimple_referenced_vars
163 /* Return true if we have hit the end of the referenced variables ITER is
164 iterating through. */
167 end_referenced_vars_p (const referenced_var_iterator *iter)
169 return end_htab_p (&iter->hti);
172 /* Make ITER point to the next referenced_var in the referenced_var hashtable,
173 and return that variable. */
176 next_referenced_var (referenced_var_iterator *iter)
178 struct int_tree_map *itm;
179 itm = (struct int_tree_map *) next_htab_element (&iter->hti);
185 /* Fill up VEC with the variables in the referenced vars hashtable. */
188 fill_referenced_var_vec (VEC (tree, heap) **vec)
190 referenced_var_iterator rvi;
193 FOR_EACH_REFERENCED_VAR (var, rvi)
194 VEC_safe_push (tree, heap, *vec, var);
197 /* Return the variable annotation for T, which must be a _DECL node.
198 Return NULL if the variable annotation doesn't already exist. */
199 static inline var_ann_t
200 var_ann (const_tree t)
203 gcc_assert (DECL_P (t));
204 gcc_assert (TREE_CODE (t) != FUNCTION_DECL);
205 if (!MTAG_P (t) && (TREE_STATIC (t) || DECL_EXTERNAL (t)))
207 struct static_var_ann_d *sann
208 = ((struct static_var_ann_d *)
209 htab_find_with_hash (gimple_var_anns (cfun), t, DECL_UID (t)));
212 gcc_assert (sann->ann.common.type == VAR_ANN);
215 gcc_assert (!t->base.ann
216 || t->base.ann->common.type == VAR_ANN);
218 return (var_ann_t) t->base.ann;
221 /* Return the variable annotation for T, which must be a _DECL node.
222 Create the variable annotation if it doesn't exist. */
223 static inline var_ann_t
224 get_var_ann (tree var)
226 var_ann_t ann = var_ann (var);
227 return (ann) ? ann : create_var_ann (var);
230 /* Return the function annotation for T, which must be a FUNCTION_DECL node.
231 Return NULL if the function annotation doesn't already exist. */
232 static inline function_ann_t
233 function_ann (const_tree t)
236 gcc_assert (TREE_CODE (t) == FUNCTION_DECL);
237 gcc_assert (!t->base.ann
238 || t->base.ann->common.type == FUNCTION_ANN);
240 return (function_ann_t) t->base.ann;
243 /* Return the function annotation for T, which must be a FUNCTION_DECL node.
244 Create the function annotation if it doesn't exist. */
245 static inline function_ann_t
246 get_function_ann (tree var)
248 function_ann_t ann = function_ann (var);
249 gcc_assert (!var->base.ann || var->base.ann->common.type == FUNCTION_ANN);
250 return (ann) ? ann : create_function_ann (var);
253 /* Return true if T has a statement annotation attached to it. */
256 has_stmt_ann (tree t)
258 #ifdef ENABLE_CHECKING
259 gcc_assert (is_gimple_stmt (t));
261 return t->base.ann && t->base.ann->common.type == STMT_ANN;
264 /* Return the statement annotation for T, which must be a statement
265 node. Return NULL if the statement annotation doesn't exist. */
266 static inline stmt_ann_t
269 #ifdef ENABLE_CHECKING
270 gcc_assert (is_gimple_stmt (t));
272 gcc_assert (!t->base.ann || t->base.ann->common.type == STMT_ANN);
273 return (stmt_ann_t) t->base.ann;
276 /* Return the statement annotation for T, which must be a statement
277 node. Create the statement annotation if it doesn't exist. */
278 static inline stmt_ann_t
279 get_stmt_ann (tree stmt)
281 stmt_ann_t ann = stmt_ann (stmt);
282 return (ann) ? ann : create_stmt_ann (stmt);
285 /* Return the annotation type for annotation ANN. */
286 static inline enum tree_ann_type
287 ann_type (tree_ann_t ann)
289 return ann->common.type;
292 /* Return the basic block for statement T. */
293 static inline basic_block
298 if (TREE_CODE (t) == PHI_NODE)
302 return ann ? ann->bb : NULL;
305 /* Return the may_aliases bitmap for variable VAR, or NULL if it has
308 may_aliases (const_tree var)
310 return MTAG_ALIASES (var);
313 /* Return the line number for EXPR, or return -1 if we have no line
314 number information for it. */
316 get_lineno (tree expr)
318 if (expr == NULL_TREE)
321 if (TREE_CODE (expr) == COMPOUND_EXPR)
322 expr = TREE_OPERAND (expr, 0);
324 if (! EXPR_HAS_LOCATION (expr))
327 return EXPR_LINENO (expr);
330 /* Return the file name for EXPR, or return "???" if we have no
331 filename information. */
332 static inline const char *
333 get_filename (tree expr)
335 const char *filename;
336 if (expr == NULL_TREE)
339 if (TREE_CODE (expr) == COMPOUND_EXPR)
340 expr = TREE_OPERAND (expr, 0);
342 if (EXPR_HAS_LOCATION (expr) && (filename = EXPR_FILENAME (expr)))
348 /* Return true if T is a noreturn call. */
350 noreturn_call_p (tree t)
352 tree call = get_call_expr_in (t);
353 return call != 0 && (call_expr_flags (call) & ECF_NORETURN) != 0;
356 /* Mark statement T as modified. */
358 mark_stmt_modified (tree t)
361 if (TREE_CODE (t) == PHI_NODE)
366 ann = create_stmt_ann (t);
367 else if (noreturn_call_p (t) && cfun->gimple_df)
368 VEC_safe_push (tree, gc, MODIFIED_NORETURN_CALLS (cfun), t);
372 /* Mark statement T as modified, and update it. */
376 if (TREE_CODE (t) == PHI_NODE)
378 mark_stmt_modified (t);
379 update_stmt_operands (t);
383 update_stmt_if_modified (tree t)
385 if (stmt_modified_p (t))
386 update_stmt_operands (t);
389 /* Return true if T is marked as modified, false otherwise. */
391 stmt_modified_p (tree t)
393 stmt_ann_t ann = stmt_ann (t);
395 /* Note that if the statement doesn't yet have an annotation, we consider it
396 modified. This will force the next call to update_stmt_operands to scan
398 return ann ? ann->modified : true;
401 /* Delink an immediate_uses node from its chain. */
403 delink_imm_use (ssa_use_operand_t *linknode)
405 /* Return if this node is not in a list. */
406 if (linknode->prev == NULL)
409 linknode->prev->next = linknode->next;
410 linknode->next->prev = linknode->prev;
411 linknode->prev = NULL;
412 linknode->next = NULL;
415 /* Link ssa_imm_use node LINKNODE into the chain for LIST. */
417 link_imm_use_to_list (ssa_use_operand_t *linknode, ssa_use_operand_t *list)
419 /* Link the new node at the head of the list. If we are in the process of
420 traversing the list, we won't visit any new nodes added to it. */
421 linknode->prev = list;
422 linknode->next = list->next;
423 list->next->prev = linknode;
424 list->next = linknode;
427 /* Link ssa_imm_use node LINKNODE into the chain for DEF. */
429 link_imm_use (ssa_use_operand_t *linknode, tree def)
431 ssa_use_operand_t *root;
433 if (!def || TREE_CODE (def) != SSA_NAME)
434 linknode->prev = NULL;
437 root = &(SSA_NAME_IMM_USE_NODE (def));
438 #ifdef ENABLE_CHECKING
440 gcc_assert (*(linknode->use) == def);
442 link_imm_use_to_list (linknode, root);
446 /* Set the value of a use pointed to by USE to VAL. */
448 set_ssa_use_from_ptr (use_operand_p use, tree val)
450 delink_imm_use (use);
452 link_imm_use (use, val);
455 /* Link ssa_imm_use node LINKNODE into the chain for DEF, with use occurring
458 link_imm_use_stmt (ssa_use_operand_t *linknode, tree def, tree stmt)
461 link_imm_use (linknode, def);
463 link_imm_use (linknode, NULL);
464 linknode->stmt = stmt;
467 /* Relink a new node in place of an old node in the list. */
469 relink_imm_use (ssa_use_operand_t *node, ssa_use_operand_t *old)
471 /* The node one had better be in the same list. */
472 gcc_assert (*(old->use) == *(node->use));
473 node->prev = old->prev;
474 node->next = old->next;
477 old->prev->next = node;
478 old->next->prev = node;
479 /* Remove the old node from the list. */
484 /* Relink ssa_imm_use node LINKNODE into the chain for OLD, with use occurring
487 relink_imm_use_stmt (ssa_use_operand_t *linknode, ssa_use_operand_t *old, tree stmt)
490 relink_imm_use (linknode, old);
492 link_imm_use (linknode, NULL);
493 linknode->stmt = stmt;
497 /* Return true is IMM has reached the end of the immediate use list. */
499 end_readonly_imm_use_p (const imm_use_iterator *imm)
501 return (imm->imm_use == imm->end_p);
504 /* Initialize iterator IMM to process the list for VAR. */
505 static inline use_operand_p
506 first_readonly_imm_use (imm_use_iterator *imm, tree var)
508 gcc_assert (TREE_CODE (var) == SSA_NAME);
510 imm->end_p = &(SSA_NAME_IMM_USE_NODE (var));
511 imm->imm_use = imm->end_p->next;
512 #ifdef ENABLE_CHECKING
513 imm->iter_node.next = imm->imm_use->next;
515 if (end_readonly_imm_use_p (imm))
516 return NULL_USE_OPERAND_P;
520 /* Bump IMM to the next use in the list. */
521 static inline use_operand_p
522 next_readonly_imm_use (imm_use_iterator *imm)
524 use_operand_p old = imm->imm_use;
526 #ifdef ENABLE_CHECKING
527 /* If this assertion fails, it indicates the 'next' pointer has changed
528 since we the last bump. This indicates that the list is being modified
529 via stmt changes, or SET_USE, or somesuch thing, and you need to be
530 using the SAFE version of the iterator. */
531 gcc_assert (imm->iter_node.next == old->next);
532 imm->iter_node.next = old->next->next;
535 imm->imm_use = old->next;
536 if (end_readonly_imm_use_p (imm))
541 /* Return true if VAR has no uses. */
543 has_zero_uses (const_tree var)
545 const ssa_use_operand_t *const ptr = &(SSA_NAME_IMM_USE_NODE (var));
546 /* A single use means there is no items in the list. */
547 return (ptr == ptr->next);
550 /* Return true if VAR has a single use. */
552 has_single_use (const_tree var)
554 const ssa_use_operand_t *const ptr = &(SSA_NAME_IMM_USE_NODE (var));
555 /* A single use means there is one item in the list. */
556 return (ptr != ptr->next && ptr == ptr->next->next);
560 /* If VAR has only a single immediate use, return true, and set USE_P and STMT
561 to the use pointer and stmt of occurrence. */
563 single_imm_use (const_tree var, use_operand_p *use_p, tree *stmt)
565 const ssa_use_operand_t *const ptr = &(SSA_NAME_IMM_USE_NODE (var));
566 if (ptr != ptr->next && ptr == ptr->next->next)
569 *stmt = ptr->next->stmt;
572 *use_p = NULL_USE_OPERAND_P;
577 /* Return the number of immediate uses of VAR. */
578 static inline unsigned int
579 num_imm_uses (const_tree var)
581 const ssa_use_operand_t *const start = &(SSA_NAME_IMM_USE_NODE (var));
582 const ssa_use_operand_t *ptr;
583 unsigned int num = 0;
585 for (ptr = start->next; ptr != start; ptr = ptr->next)
591 /* Return the tree pointer to by USE. */
593 get_use_from_ptr (use_operand_p use)
598 /* Return the tree pointer to by DEF. */
600 get_def_from_ptr (def_operand_p def)
605 /* Return a def_operand_p pointer for the result of PHI. */
606 static inline def_operand_p
607 get_phi_result_ptr (tree phi)
609 return &(PHI_RESULT_TREE (phi));
612 /* Return a use_operand_p pointer for argument I of phinode PHI. */
613 static inline use_operand_p
614 get_phi_arg_def_ptr (tree phi, int i)
616 return &(PHI_ARG_IMM_USE_NODE (phi,i));
620 /* Return the bitmap of addresses taken by STMT, or NULL if it takes
623 addresses_taken (tree stmt)
625 stmt_ann_t ann = stmt_ann (stmt);
626 return ann ? ann->addresses_taken : NULL;
629 /* Return the PHI nodes for basic block BB, or NULL if there are no
632 phi_nodes (basic_block bb)
634 gcc_assert (!(bb->flags & BB_RTL));
637 return bb->il.tree->phi_nodes;
640 /* Return pointer to the list of PHI nodes for basic block BB. */
643 phi_nodes_ptr (basic_block bb)
645 gcc_assert (!(bb->flags & BB_RTL));
646 return &bb->il.tree->phi_nodes;
649 /* Set list of phi nodes of a basic block BB to L. */
652 set_phi_nodes (basic_block bb, tree l)
656 gcc_assert (!(bb->flags & BB_RTL));
657 bb->il.tree->phi_nodes = l;
658 for (phi = l; phi; phi = PHI_CHAIN (phi))
659 set_bb_for_stmt (phi, bb);
662 /* Return the phi argument which contains the specified use. */
665 phi_arg_index_from_use (use_operand_p use)
667 struct phi_arg_d *element, *root;
671 /* Since the use is the first thing in a PHI argument element, we can
672 calculate its index based on casting it to an argument, and performing
673 pointer arithmetic. */
675 phi = USE_STMT (use);
676 gcc_assert (TREE_CODE (phi) == PHI_NODE);
678 element = (struct phi_arg_d *)use;
679 root = &(PHI_ARG_ELT (phi, 0));
680 index = element - root;
682 #ifdef ENABLE_CHECKING
683 /* Make sure the calculation doesn't have any leftover bytes. If it does,
684 then imm_use is likely not the first element in phi_arg_d. */
686 (((char *)element - (char *)root) % sizeof (struct phi_arg_d)) == 0);
687 gcc_assert (index >= 0 && index < PHI_ARG_CAPACITY (phi));
693 /* Mark VAR as used, so that it'll be preserved during rtl expansion. */
696 set_is_used (tree var)
698 var_ann_t ann = get_var_ann (var);
702 /* Return true if T is an executable statement. */
704 is_exec_stmt (const_tree t)
706 return (t && !IS_EMPTY_STMT (t) && t != error_mark_node);
710 /* Return true if this stmt can be the target of a control transfer stmt such
713 is_label_stmt (const_tree t)
716 switch (TREE_CODE (t))
720 case CASE_LABEL_EXPR:
728 /* Return true if T (assumed to be a DECL) is a global variable. */
731 is_global_var (const_tree t)
734 return (TREE_STATIC (t) || MTAG_GLOBAL (t));
736 return (TREE_STATIC (t) || DECL_EXTERNAL (t));
739 /* PHI nodes should contain only ssa_names and invariants. A test
740 for ssa_name is definitely simpler; don't let invalid contents
741 slip in in the meantime. */
744 phi_ssa_name_p (const_tree t)
746 if (TREE_CODE (t) == SSA_NAME)
748 #ifdef ENABLE_CHECKING
749 gcc_assert (is_gimple_min_invariant (t));
754 /* ----------------------------------------------------------------------- */
756 /* Returns the list of statements in BB. */
759 bb_stmt_list (basic_block bb)
761 gcc_assert (!(bb->flags & BB_RTL));
762 return bb->il.tree->stmt_list;
765 /* Sets the list of statements in BB to LIST. */
768 set_bb_stmt_list (basic_block bb, tree list)
770 gcc_assert (!(bb->flags & BB_RTL));
771 bb->il.tree->stmt_list = list;
774 /* Return a block_stmt_iterator that points to beginning of basic
776 static inline block_stmt_iterator
777 bsi_start (basic_block bb)
779 block_stmt_iterator bsi;
780 if (bb->index < NUM_FIXED_BLOCKS)
783 bsi.tsi.container = NULL;
786 bsi.tsi = tsi_start (bb_stmt_list (bb));
791 /* Return a block statement iterator that points to the first non-label
792 statement in block BB. */
794 static inline block_stmt_iterator
795 bsi_after_labels (basic_block bb)
797 block_stmt_iterator bsi = bsi_start (bb);
799 while (!bsi_end_p (bsi) && TREE_CODE (bsi_stmt (bsi)) == LABEL_EXPR)
805 /* Return a block statement iterator that points to the end of basic
807 static inline block_stmt_iterator
808 bsi_last (basic_block bb)
810 block_stmt_iterator bsi;
812 if (bb->index < NUM_FIXED_BLOCKS)
815 bsi.tsi.container = NULL;
818 bsi.tsi = tsi_last (bb_stmt_list (bb));
823 /* Return true if block statement iterator I has reached the end of
826 bsi_end_p (block_stmt_iterator i)
828 return tsi_end_p (i.tsi);
831 /* Modify block statement iterator I so that it is at the next
832 statement in the basic block. */
834 bsi_next (block_stmt_iterator *i)
839 /* Modify block statement iterator I so that it is at the previous
840 statement in the basic block. */
842 bsi_prev (block_stmt_iterator *i)
847 /* Return the statement that block statement iterator I is currently
850 bsi_stmt (block_stmt_iterator i)
852 return tsi_stmt (i.tsi);
855 /* Return a pointer to the statement that block statement iterator I
858 bsi_stmt_ptr (block_stmt_iterator i)
860 return tsi_stmt_ptr (i.tsi);
863 /* Returns the loop of the statement STMT. */
865 static inline struct loop *
866 loop_containing_stmt (tree stmt)
868 basic_block bb = bb_for_stmt (stmt);
872 return bb->loop_father;
876 /* Return the memory partition tag associated with symbol SYM. */
879 memory_partition (tree sym)
883 /* MPTs belong to their own partition. */
884 if (TREE_CODE (sym) == MEMORY_PARTITION_TAG)
887 gcc_assert (!is_gimple_reg (sym));
888 tag = get_var_ann (sym)->mpt;
890 #if defined ENABLE_CHECKING
892 gcc_assert (TREE_CODE (tag) == MEMORY_PARTITION_TAG);
898 /* Return true if NAME is a memory factoring SSA name (i.e., an SSA
899 name for a memory partition. */
902 factoring_name_p (const_tree name)
904 return TREE_CODE (SSA_NAME_VAR (name)) == MEMORY_PARTITION_TAG;
907 /* Return true if VAR is a clobbered by function calls. */
909 is_call_clobbered (const_tree var)
912 return var_ann (var)->call_clobbered;
914 return bitmap_bit_p (gimple_call_clobbered_vars (cfun), DECL_UID (var));
917 /* Mark variable VAR as being clobbered by function calls. */
919 mark_call_clobbered (tree var, unsigned int escape_type)
921 var_ann (var)->escape_mask |= escape_type;
923 var_ann (var)->call_clobbered = true;
924 bitmap_set_bit (gimple_call_clobbered_vars (cfun), DECL_UID (var));
927 /* Clear the call-clobbered attribute from variable VAR. */
929 clear_call_clobbered (tree var)
931 var_ann_t ann = var_ann (var);
932 ann->escape_mask = 0;
933 if (MTAG_P (var) && TREE_CODE (var) != STRUCT_FIELD_TAG)
934 MTAG_GLOBAL (var) = 0;
936 var_ann (var)->call_clobbered = false;
937 bitmap_clear_bit (gimple_call_clobbered_vars (cfun), DECL_UID (var));
940 /* Return the common annotation for T. Return NULL if the annotation
941 doesn't already exist. */
942 static inline tree_ann_common_t
943 tree_common_ann (const_tree t)
945 /* Watch out static variables with unshared annotations. */
946 if (DECL_P (t) && TREE_CODE (t) == VAR_DECL)
947 return &var_ann (t)->common;
948 return &t->base.ann->common;
951 /* Return a common annotation for T. Create the constant annotation if it
953 static inline tree_ann_common_t
954 get_tree_common_ann (tree t)
956 tree_ann_common_t ann = tree_common_ann (t);
957 return (ann) ? ann : create_tree_common_ann (t);
960 /* ----------------------------------------------------------------------- */
962 /* The following set of routines are used to iterator over various type of
965 /* Return true if PTR is finished iterating. */
967 op_iter_done (const ssa_op_iter *ptr)
972 /* Get the next iterator use value for PTR. */
973 static inline use_operand_p
974 op_iter_next_use (ssa_op_iter *ptr)
977 #ifdef ENABLE_CHECKING
978 gcc_assert (ptr->iter_type == ssa_op_iter_use);
982 use_p = USE_OP_PTR (ptr->uses);
983 ptr->uses = ptr->uses->next;
988 use_p = VUSE_OP_PTR (ptr->vuses, ptr->vuse_index);
989 if (++(ptr->vuse_index) >= VUSE_NUM (ptr->vuses))
992 ptr->vuses = ptr->vuses->next;
998 use_p = VDEF_OP_PTR (ptr->mayuses, ptr->mayuse_index);
999 if (++(ptr->mayuse_index) >= VDEF_NUM (ptr->mayuses))
1001 ptr->mayuse_index = 0;
1002 ptr->mayuses = ptr->mayuses->next;
1006 if (ptr->phi_i < ptr->num_phi)
1008 return PHI_ARG_DEF_PTR (ptr->phi_stmt, (ptr->phi_i)++);
1011 return NULL_USE_OPERAND_P;
1014 /* Get the next iterator def value for PTR. */
1015 static inline def_operand_p
1016 op_iter_next_def (ssa_op_iter *ptr)
1018 def_operand_p def_p;
1019 #ifdef ENABLE_CHECKING
1020 gcc_assert (ptr->iter_type == ssa_op_iter_def);
1024 def_p = DEF_OP_PTR (ptr->defs);
1025 ptr->defs = ptr->defs->next;
1030 def_p = VDEF_RESULT_PTR (ptr->vdefs);
1031 ptr->vdefs = ptr->vdefs->next;
1035 return NULL_DEF_OPERAND_P;
1038 /* Get the next iterator tree value for PTR. */
1040 op_iter_next_tree (ssa_op_iter *ptr)
1043 #ifdef ENABLE_CHECKING
1044 gcc_assert (ptr->iter_type == ssa_op_iter_tree);
1048 val = USE_OP (ptr->uses);
1049 ptr->uses = ptr->uses->next;
1054 val = VUSE_OP (ptr->vuses, ptr->vuse_index);
1055 if (++(ptr->vuse_index) >= VUSE_NUM (ptr->vuses))
1057 ptr->vuse_index = 0;
1058 ptr->vuses = ptr->vuses->next;
1064 val = VDEF_OP (ptr->mayuses, ptr->mayuse_index);
1065 if (++(ptr->mayuse_index) >= VDEF_NUM (ptr->mayuses))
1067 ptr->mayuse_index = 0;
1068 ptr->mayuses = ptr->mayuses->next;
1074 val = DEF_OP (ptr->defs);
1075 ptr->defs = ptr->defs->next;
1080 val = VDEF_RESULT (ptr->vdefs);
1081 ptr->vdefs = ptr->vdefs->next;
1091 /* This functions clears the iterator PTR, and marks it done. This is normally
1092 used to prevent warnings in the compile about might be uninitialized
1096 clear_and_done_ssa_iter (ssa_op_iter *ptr)
1102 ptr->mayuses = NULL;
1103 ptr->iter_type = ssa_op_iter_none;
1106 ptr->phi_stmt = NULL_TREE;
1108 ptr->vuse_index = 0;
1109 ptr->mayuse_index = 0;
1112 /* Initialize the iterator PTR to the virtual defs in STMT. */
1114 op_iter_init (ssa_op_iter *ptr, tree stmt, int flags)
1116 #ifdef ENABLE_CHECKING
1117 gcc_assert (stmt_ann (stmt));
1120 ptr->defs = (flags & SSA_OP_DEF) ? DEF_OPS (stmt) : NULL;
1121 ptr->uses = (flags & SSA_OP_USE) ? USE_OPS (stmt) : NULL;
1122 ptr->vuses = (flags & SSA_OP_VUSE) ? VUSE_OPS (stmt) : NULL;
1123 ptr->vdefs = (flags & SSA_OP_VDEF) ? VDEF_OPS (stmt) : NULL;
1124 ptr->mayuses = (flags & SSA_OP_VMAYUSE) ? VDEF_OPS (stmt) : NULL;
1129 ptr->phi_stmt = NULL_TREE;
1130 ptr->vuse_index = 0;
1131 ptr->mayuse_index = 0;
1134 /* Initialize iterator PTR to the use operands in STMT based on FLAGS. Return
1136 static inline use_operand_p
1137 op_iter_init_use (ssa_op_iter *ptr, tree stmt, int flags)
1139 gcc_assert ((flags & SSA_OP_ALL_DEFS) == 0);
1140 op_iter_init (ptr, stmt, flags);
1141 ptr->iter_type = ssa_op_iter_use;
1142 return op_iter_next_use (ptr);
1145 /* Initialize iterator PTR to the def operands in STMT based on FLAGS. Return
1147 static inline def_operand_p
1148 op_iter_init_def (ssa_op_iter *ptr, tree stmt, int flags)
1150 gcc_assert ((flags & SSA_OP_ALL_USES) == 0);
1151 op_iter_init (ptr, stmt, flags);
1152 ptr->iter_type = ssa_op_iter_def;
1153 return op_iter_next_def (ptr);
1156 /* Initialize iterator PTR to the operands in STMT based on FLAGS. Return
1157 the first operand as a tree. */
1159 op_iter_init_tree (ssa_op_iter *ptr, tree stmt, int flags)
1161 op_iter_init (ptr, stmt, flags);
1162 ptr->iter_type = ssa_op_iter_tree;
1163 return op_iter_next_tree (ptr);
1166 /* Get the next iterator mustdef value for PTR, returning the mustdef values in
1169 op_iter_next_vdef (vuse_vec_p *use, def_operand_p *def,
1172 #ifdef ENABLE_CHECKING
1173 gcc_assert (ptr->iter_type == ssa_op_iter_vdef);
1177 *def = VDEF_RESULT_PTR (ptr->mayuses);
1178 *use = VDEF_VECT (ptr->mayuses);
1179 ptr->mayuses = ptr->mayuses->next;
1183 *def = NULL_DEF_OPERAND_P;
1191 op_iter_next_mustdef (use_operand_p *use, def_operand_p *def,
1195 op_iter_next_vdef (&vp, def, ptr);
1198 gcc_assert (VUSE_VECT_NUM_ELEM (*vp) == 1);
1199 *use = VUSE_ELEMENT_PTR (*vp, 0);
1202 *use = NULL_USE_OPERAND_P;
1205 /* Initialize iterator PTR to the operands in STMT. Return the first operands
1208 op_iter_init_vdef (ssa_op_iter *ptr, tree stmt, vuse_vec_p *use,
1211 gcc_assert (TREE_CODE (stmt) != PHI_NODE);
1213 op_iter_init (ptr, stmt, SSA_OP_VMAYUSE);
1214 ptr->iter_type = ssa_op_iter_vdef;
1215 op_iter_next_vdef (use, def, ptr);
1219 /* If there is a single operand in STMT matching FLAGS, return it. Otherwise
1222 single_ssa_tree_operand (tree stmt, int flags)
1227 var = op_iter_init_tree (&iter, stmt, flags);
1228 if (op_iter_done (&iter))
1230 op_iter_next_tree (&iter);
1231 if (op_iter_done (&iter))
1237 /* If there is a single operand in STMT matching FLAGS, return it. Otherwise
1239 static inline use_operand_p
1240 single_ssa_use_operand (tree stmt, int flags)
1245 var = op_iter_init_use (&iter, stmt, flags);
1246 if (op_iter_done (&iter))
1247 return NULL_USE_OPERAND_P;
1248 op_iter_next_use (&iter);
1249 if (op_iter_done (&iter))
1251 return NULL_USE_OPERAND_P;
1256 /* If there is a single operand in STMT matching FLAGS, return it. Otherwise
1258 static inline def_operand_p
1259 single_ssa_def_operand (tree stmt, int flags)
1264 var = op_iter_init_def (&iter, stmt, flags);
1265 if (op_iter_done (&iter))
1266 return NULL_DEF_OPERAND_P;
1267 op_iter_next_def (&iter);
1268 if (op_iter_done (&iter))
1270 return NULL_DEF_OPERAND_P;
1274 /* Return true if there are zero operands in STMT matching the type
1277 zero_ssa_operands (tree stmt, int flags)
1281 op_iter_init_tree (&iter, stmt, flags);
1282 return op_iter_done (&iter);
1286 /* Return the number of operands matching FLAGS in STMT. */
1288 num_ssa_operands (tree stmt, int flags)
1294 FOR_EACH_SSA_TREE_OPERAND (t, stmt, iter, flags)
1300 /* Delink all immediate_use information for STMT. */
1302 delink_stmt_imm_use (tree stmt)
1305 use_operand_p use_p;
1307 if (ssa_operands_active ())
1308 FOR_EACH_SSA_USE_OPERAND (use_p, stmt, iter, SSA_OP_ALL_USES)
1309 delink_imm_use (use_p);
1313 /* This routine will compare all the operands matching FLAGS in STMT1 to those
1314 in STMT2. TRUE is returned if they are the same. STMTs can be NULL. */
1316 compare_ssa_operands_equal (tree stmt1, tree stmt2, int flags)
1318 ssa_op_iter iter1, iter2;
1319 tree op1 = NULL_TREE;
1320 tree op2 = NULL_TREE;
1326 look1 = stmt1 && stmt_ann (stmt1);
1327 look2 = stmt2 && stmt_ann (stmt2);
1331 op1 = op_iter_init_tree (&iter1, stmt1, flags);
1333 return op_iter_done (&iter1);
1336 clear_and_done_ssa_iter (&iter1);
1340 op2 = op_iter_init_tree (&iter2, stmt2, flags);
1342 return op_iter_done (&iter2);
1345 clear_and_done_ssa_iter (&iter2);
1347 while (!op_iter_done (&iter1) && !op_iter_done (&iter2))
1351 op1 = op_iter_next_tree (&iter1);
1352 op2 = op_iter_next_tree (&iter2);
1355 return (op_iter_done (&iter1) && op_iter_done (&iter2));
1359 /* If there is a single DEF in the PHI node which matches FLAG, return it.
1360 Otherwise return NULL_DEF_OPERAND_P. */
1362 single_phi_def (tree stmt, int flags)
1364 tree def = PHI_RESULT (stmt);
1365 if ((flags & SSA_OP_DEF) && is_gimple_reg (def))
1367 if ((flags & SSA_OP_VIRTUAL_DEFS) && !is_gimple_reg (def))
1372 /* Initialize the iterator PTR for uses matching FLAGS in PHI. FLAGS should
1373 be either SSA_OP_USES or SSA_OP_VIRTUAL_USES. */
1374 static inline use_operand_p
1375 op_iter_init_phiuse (ssa_op_iter *ptr, tree phi, int flags)
1377 tree phi_def = PHI_RESULT (phi);
1380 clear_and_done_ssa_iter (ptr);
1383 gcc_assert ((flags & (SSA_OP_USE | SSA_OP_VIRTUAL_USES)) != 0);
1385 comp = (is_gimple_reg (phi_def) ? SSA_OP_USE : SSA_OP_VIRTUAL_USES);
1387 /* If the PHI node doesn't the operand type we care about, we're done. */
1388 if ((flags & comp) == 0)
1391 return NULL_USE_OPERAND_P;
1394 ptr->phi_stmt = phi;
1395 ptr->num_phi = PHI_NUM_ARGS (phi);
1396 ptr->iter_type = ssa_op_iter_use;
1397 return op_iter_next_use (ptr);
1401 /* Start an iterator for a PHI definition. */
1403 static inline def_operand_p
1404 op_iter_init_phidef (ssa_op_iter *ptr, tree phi, int flags)
1406 tree phi_def = PHI_RESULT (phi);
1409 clear_and_done_ssa_iter (ptr);
1412 gcc_assert ((flags & (SSA_OP_DEF | SSA_OP_VIRTUAL_DEFS)) != 0);
1414 comp = (is_gimple_reg (phi_def) ? SSA_OP_DEF : SSA_OP_VIRTUAL_DEFS);
1416 /* If the PHI node doesn't the operand type we care about, we're done. */
1417 if ((flags & comp) == 0)
1420 return NULL_USE_OPERAND_P;
1423 ptr->iter_type = ssa_op_iter_def;
1424 /* The first call to op_iter_next_def will terminate the iterator since
1425 all the fields are NULL. Simply return the result here as the first and
1426 therefore only result. */
1427 return PHI_RESULT_PTR (phi);
1430 /* Return true is IMM has reached the end of the immediate use stmt list. */
1433 end_imm_use_stmt_p (const imm_use_iterator *imm)
1435 return (imm->imm_use == imm->end_p);
1438 /* Finished the traverse of an immediate use stmt list IMM by removing the
1439 placeholder node from the list. */
1442 end_imm_use_stmt_traverse (imm_use_iterator *imm)
1444 delink_imm_use (&(imm->iter_node));
1447 /* Immediate use traversal of uses within a stmt require that all the
1448 uses on a stmt be sequentially listed. This routine is used to build up
1449 this sequential list by adding USE_P to the end of the current list
1450 currently delimited by HEAD and LAST_P. The new LAST_P value is
1453 static inline use_operand_p
1454 move_use_after_head (use_operand_p use_p, use_operand_p head,
1455 use_operand_p last_p)
1457 gcc_assert (USE_FROM_PTR (use_p) == USE_FROM_PTR (head));
1458 /* Skip head when we find it. */
1461 /* If use_p is already linked in after last_p, continue. */
1462 if (last_p->next == use_p)
1466 /* Delink from current location, and link in at last_p. */
1467 delink_imm_use (use_p);
1468 link_imm_use_to_list (use_p, last_p);
1476 /* This routine will relink all uses with the same stmt as HEAD into the list
1477 immediately following HEAD for iterator IMM. */
1480 link_use_stmts_after (use_operand_p head, imm_use_iterator *imm)
1482 use_operand_p use_p;
1483 use_operand_p last_p = head;
1484 tree head_stmt = USE_STMT (head);
1485 tree use = USE_FROM_PTR (head);
1486 ssa_op_iter op_iter;
1489 /* Only look at virtual or real uses, depending on the type of HEAD. */
1490 flag = (is_gimple_reg (use) ? SSA_OP_USE : SSA_OP_VIRTUAL_USES);
1492 if (TREE_CODE (head_stmt) == PHI_NODE)
1494 FOR_EACH_PHI_ARG (use_p, head_stmt, op_iter, flag)
1495 if (USE_FROM_PTR (use_p) == use)
1496 last_p = move_use_after_head (use_p, head, last_p);
1500 FOR_EACH_SSA_USE_OPERAND (use_p, head_stmt, op_iter, flag)
1501 if (USE_FROM_PTR (use_p) == use)
1502 last_p = move_use_after_head (use_p, head, last_p);
1504 /* LInk iter node in after last_p. */
1505 if (imm->iter_node.prev != NULL)
1506 delink_imm_use (&imm->iter_node);
1507 link_imm_use_to_list (&(imm->iter_node), last_p);
1510 /* Initialize IMM to traverse over uses of VAR. Return the first statement. */
1512 first_imm_use_stmt (imm_use_iterator *imm, tree var)
1514 gcc_assert (TREE_CODE (var) == SSA_NAME);
1516 imm->end_p = &(SSA_NAME_IMM_USE_NODE (var));
1517 imm->imm_use = imm->end_p->next;
1518 imm->next_imm_name = NULL_USE_OPERAND_P;
1520 /* iter_node is used as a marker within the immediate use list to indicate
1521 where the end of the current stmt's uses are. Initialize it to NULL
1522 stmt and use, which indicates a marker node. */
1523 imm->iter_node.prev = NULL_USE_OPERAND_P;
1524 imm->iter_node.next = NULL_USE_OPERAND_P;
1525 imm->iter_node.stmt = NULL_TREE;
1526 imm->iter_node.use = NULL_USE_OPERAND_P;
1528 if (end_imm_use_stmt_p (imm))
1531 link_use_stmts_after (imm->imm_use, imm);
1533 return USE_STMT (imm->imm_use);
1536 /* Bump IMM to the next stmt which has a use of var. */
1539 next_imm_use_stmt (imm_use_iterator *imm)
1541 imm->imm_use = imm->iter_node.next;
1542 if (end_imm_use_stmt_p (imm))
1544 if (imm->iter_node.prev != NULL)
1545 delink_imm_use (&imm->iter_node);
1549 link_use_stmts_after (imm->imm_use, imm);
1550 return USE_STMT (imm->imm_use);
1554 /* This routine will return the first use on the stmt IMM currently refers
1557 static inline use_operand_p
1558 first_imm_use_on_stmt (imm_use_iterator *imm)
1560 imm->next_imm_name = imm->imm_use->next;
1561 return imm->imm_use;
1564 /* Return TRUE if the last use on the stmt IMM refers to has been visited. */
1567 end_imm_use_on_stmt_p (const imm_use_iterator *imm)
1569 return (imm->imm_use == &(imm->iter_node));
1572 /* Bump to the next use on the stmt IMM refers to, return NULL if done. */
1574 static inline use_operand_p
1575 next_imm_use_on_stmt (imm_use_iterator *imm)
1577 imm->imm_use = imm->next_imm_name;
1578 if (end_imm_use_on_stmt_p (imm))
1579 return NULL_USE_OPERAND_P;
1582 imm->next_imm_name = imm->imm_use->next;
1583 return imm->imm_use;
1587 /* Return true if VAR cannot be modified by the program. */
1590 unmodifiable_var_p (const_tree var)
1592 if (TREE_CODE (var) == SSA_NAME)
1593 var = SSA_NAME_VAR (var);
1596 return TREE_READONLY (var) && (TREE_STATIC (var) || MTAG_GLOBAL (var));
1598 return TREE_READONLY (var) && (TREE_STATIC (var) || DECL_EXTERNAL (var));
1601 /* Return true if REF, an ARRAY_REF, has an INDIRECT_REF somewhere in it. */
1604 array_ref_contains_indirect_ref (const_tree ref)
1606 gcc_assert (TREE_CODE (ref) == ARRAY_REF);
1609 ref = TREE_OPERAND (ref, 0);
1610 } while (handled_component_p (ref));
1612 return TREE_CODE (ref) == INDIRECT_REF;
1615 /* Return true if REF, a handled component reference, has an ARRAY_REF
1619 ref_contains_array_ref (const_tree ref)
1621 gcc_assert (handled_component_p (ref));
1624 if (TREE_CODE (ref) == ARRAY_REF)
1626 ref = TREE_OPERAND (ref, 0);
1627 } while (handled_component_p (ref));
1632 /* Given a variable VAR, lookup and return a pointer to the list of
1633 subvariables for it. */
1635 static inline subvar_t *
1636 lookup_subvars_for_var (const_tree var)
1638 var_ann_t ann = var_ann (var);
1640 return &ann->subvars;
1643 /* Given a variable VAR, return a linked list of subvariables for VAR, or
1644 NULL, if there are no subvariables. */
1646 static inline subvar_t
1647 get_subvars_for_var (tree var)
1651 gcc_assert (SSA_VAR_P (var));
1653 if (TREE_CODE (var) == SSA_NAME)
1654 subvars = *(lookup_subvars_for_var (SSA_NAME_VAR (var)));
1656 subvars = *(lookup_subvars_for_var (var));
1660 /* Return the subvariable of VAR at offset OFFSET. */
1663 get_subvar_at (tree var, unsigned HOST_WIDE_INT offset)
1667 for (sv = get_subvars_for_var (var); sv; sv = sv->next)
1668 if (SFT_OFFSET (sv->var) == offset)
1674 /* Return true if V is a tree that we can have subvars for.
1675 Normally, this is any aggregate type. Also complex
1676 types which are not gimple registers can have subvars. */
1679 var_can_have_subvars (const_tree v)
1681 /* Volatile variables should never have subvars. */
1682 if (TREE_THIS_VOLATILE (v))
1685 /* Non decls or memory tags can never have subvars. */
1686 if (!DECL_P (v) || MTAG_P (v))
1689 /* Aggregates can have subvars. */
1690 if (AGGREGATE_TYPE_P (TREE_TYPE (v)))
1693 /* Complex types variables which are not also a gimple register can
1695 if (TREE_CODE (TREE_TYPE (v)) == COMPLEX_TYPE
1696 && !DECL_GIMPLE_REG_P (v))
1703 /* Return true if OFFSET and SIZE define a range that overlaps with some
1704 portion of the range of SV, a subvar. If there was an exact overlap,
1705 *EXACT will be set to true upon return. */
1708 overlap_subvar (unsigned HOST_WIDE_INT offset, unsigned HOST_WIDE_INT size,
1709 const_tree sv, bool *exact)
1711 /* There are three possible cases of overlap.
1712 1. We can have an exact overlap, like so:
1713 |offset, offset + size |
1714 |sv->offset, sv->offset + sv->size |
1716 2. We can have offset starting after sv->offset, like so:
1718 |offset, offset + size |
1719 |sv->offset, sv->offset + sv->size |
1721 3. We can have offset starting before sv->offset, like so:
1723 |offset, offset + size |
1724 |sv->offset, sv->offset + sv->size|
1729 if (offset == SFT_OFFSET (sv) && size == SFT_SIZE (sv))
1735 else if (offset >= SFT_OFFSET (sv)
1736 && offset < (SFT_OFFSET (sv) + SFT_SIZE (sv)))
1740 else if (offset < SFT_OFFSET (sv)
1741 && (size > SFT_OFFSET (sv) - offset))
1749 /* Return the memory tag associated with symbol SYM. */
1752 symbol_mem_tag (tree sym)
1754 tree tag = get_var_ann (sym)->symbol_mem_tag;
1756 #if defined ENABLE_CHECKING
1758 gcc_assert (TREE_CODE (tag) == SYMBOL_MEMORY_TAG);
1765 /* Set the memory tag associated with symbol SYM. */
1768 set_symbol_mem_tag (tree sym, tree tag)
1770 #if defined ENABLE_CHECKING
1772 gcc_assert (TREE_CODE (tag) == SYMBOL_MEMORY_TAG);
1775 get_var_ann (sym)->symbol_mem_tag = tag;
1778 /* Get the value handle of EXPR. This is the only correct way to get
1779 the value handle for a "thing". If EXPR does not have a value
1780 handle associated, it returns NULL_TREE.
1781 NB: If EXPR is min_invariant, this function is *required* to return
1785 get_value_handle (tree expr)
1787 if (TREE_CODE (expr) == SSA_NAME)
1788 return SSA_NAME_VALUE (expr);
1789 else if (DECL_P (expr) || TREE_CODE (expr) == TREE_LIST
1790 || TREE_CODE (expr) == CONSTRUCTOR)
1792 tree_ann_common_t ann = tree_common_ann (expr);
1793 return ((ann) ? ann->value_handle : NULL_TREE);
1795 else if (is_gimple_min_invariant (expr))
1797 else if (EXPR_P (expr))
1799 tree_ann_common_t ann = tree_common_ann (expr);
1800 return ((ann) ? ann->value_handle : NULL_TREE);
1806 /* Accessor to tree-ssa-operands.c caches. */
1807 static inline struct ssa_operands *
1808 gimple_ssa_operands (const struct function *fun)
1810 return &fun->gimple_df->ssa_operands;
1813 /* Map describing reference statistics for function FN. */
1814 static inline struct mem_ref_stats_d *
1815 gimple_mem_ref_stats (const struct function *fn)
1817 return &fn->gimple_df->mem_ref_stats;
1819 #endif /* _TREE_FLOW_INLINE_H */