1 /* Infrastructure for tracking user variable locations and values
2 throughout compilation.
3 Copyright (C) 2010-2014 Free Software Foundation, Inc.
4 Contributed by Alexandre Oliva <aoliva@redhat.com>.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
24 #include "coretypes.h"
32 /* gen_lowpart_no_emit hook implementation for DEBUG_INSNs. In DEBUG_INSNs,
33 all lowpart SUBREGs are valid, despite what the machine requires for
37 gen_lowpart_for_debug (enum machine_mode mode
, rtx x
)
39 rtx result
= gen_lowpart_if_possible (mode
, x
);
43 if (GET_MODE (x
) != VOIDmode
)
44 return gen_rtx_raw_SUBREG (mode
, x
,
45 subreg_lowpart_offset (mode
, GET_MODE (x
)));
50 /* Replace auto-increment addressing modes with explicit operations to access
51 the same addresses without modifying the corresponding registers. */
54 cleanup_auto_inc_dec (rtx src
, enum machine_mode mem_mode ATTRIBUTE_UNUSED
)
58 const RTX_CODE code
= GET_CODE (x
);
71 /* SCRATCH must be shared because they represent distinct values. */
74 /* Share clobbers of hard registers (like cc0), but do not share pseudo reg
75 clobbers or clobbers of hard registers that originated as pseudos.
76 This is needed to allow safe register renaming. */
77 if (REG_P (XEXP (x
, 0)) && REGNO (XEXP (x
, 0)) < FIRST_PSEUDO_REGISTER
78 && ORIGINAL_REGNO (XEXP (x
, 0)) == REGNO (XEXP (x
, 0)))
83 if (shared_const_p (x
))
88 mem_mode
= GET_MODE (x
);
93 gcc_assert (mem_mode
!= VOIDmode
&& mem_mode
!= BLKmode
);
94 return gen_rtx_PLUS (GET_MODE (x
),
95 cleanup_auto_inc_dec (XEXP (x
, 0), mem_mode
),
96 gen_int_mode (code
== PRE_INC
97 ? GET_MODE_SIZE (mem_mode
)
98 : -GET_MODE_SIZE (mem_mode
),
105 return cleanup_auto_inc_dec (code
== PRE_MODIFY
106 ? XEXP (x
, 1) : XEXP (x
, 0),
113 /* Copy the various flags, fields, and other information. We assume
114 that all fields need copying, and then clear the fields that should
115 not be copied. That is the sensible default behavior, and forces
116 us to explicitly document why we are *not* copying a flag. */
117 x
= shallow_copy_rtx (x
);
119 /* We do not copy the USED flag, which is used as a mark bit during
120 walks over the RTL. */
121 RTX_FLAG (x
, used
) = 0;
123 /* We do not copy FRAME_RELATED for INSNs. */
125 RTX_FLAG (x
, frame_related
) = 0;
127 fmt
= GET_RTX_FORMAT (code
);
128 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
130 XEXP (x
, i
) = cleanup_auto_inc_dec (XEXP (x
, i
), mem_mode
);
131 else if (fmt
[i
] == 'E' || fmt
[i
] == 'V')
134 XVEC (x
, i
) = rtvec_alloc (XVECLEN (x
, i
));
135 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
137 = cleanup_auto_inc_dec (XVECEXP (src
, i
, j
), mem_mode
);
140 #else /* !AUTO_INC_DEC */
142 #endif /* !AUTO_INC_DEC */
147 /* Auxiliary data structure for propagate_for_debug_stmt. */
149 struct rtx_subst_pair
155 /* DATA points to an rtx_subst_pair. Return the value that should be
159 propagate_for_debug_subst (rtx from
, const_rtx old_rtx
, void *data
)
161 struct rtx_subst_pair
*pair
= (struct rtx_subst_pair
*)data
;
163 if (!rtx_equal_p (from
, old_rtx
))
167 pair
->adjusted
= true;
168 pair
->to
= cleanup_auto_inc_dec (pair
->to
, VOIDmode
);
169 pair
->to
= make_compound_operation (pair
->to
, SET
);
172 return copy_rtx (pair
->to
);
175 /* Replace all the occurrences of DEST with SRC in DEBUG_INSNs between INSN
176 and LAST, not including INSN, but including LAST. Also stop at the end
177 of THIS_BASIC_BLOCK. */
180 propagate_for_debug (rtx_insn
*insn
, rtx_insn
*last
, rtx dest
, rtx src
,
181 basic_block this_basic_block
)
183 rtx_insn
*next
, *end
= NEXT_INSN (BB_END (this_basic_block
));
185 rtx (*saved_rtl_hook_no_emit
) (enum machine_mode
, rtx
);
187 struct rtx_subst_pair p
;
191 next
= NEXT_INSN (insn
);
192 last
= NEXT_INSN (last
);
193 saved_rtl_hook_no_emit
= rtl_hooks
.gen_lowpart_no_emit
;
194 rtl_hooks
.gen_lowpart_no_emit
= gen_lowpart_for_debug
;
195 while (next
!= last
&& next
!= end
)
198 next
= NEXT_INSN (insn
);
199 if (DEBUG_INSN_P (insn
))
201 loc
= simplify_replace_fn_rtx (INSN_VAR_LOCATION_LOC (insn
),
202 dest
, propagate_for_debug_subst
, &p
);
203 if (loc
== INSN_VAR_LOCATION_LOC (insn
))
205 INSN_VAR_LOCATION_LOC (insn
) = loc
;
206 df_insn_rescan (insn
);
209 rtl_hooks
.gen_lowpart_no_emit
= saved_rtl_hook_no_emit
;
212 /* Initialize DEBUG to an empty list, and clear USED, if given. */
215 dead_debug_global_init (struct dead_debug_global
*debug
, bitmap used
)
223 /* Initialize DEBUG to an empty list, and clear USED, if given. Link
224 back to GLOBAL, if given, and bring in used bits from it. */
227 dead_debug_local_init (struct dead_debug_local
*debug
, bitmap used
,
228 struct dead_debug_global
*global
)
230 if (!used
&& global
&& global
->used
)
231 used
= BITMAP_ALLOC (NULL
);
234 debug
->global
= global
;
236 debug
->to_rescan
= NULL
;
240 if (global
&& global
->used
)
241 bitmap_copy (used
, global
->used
);
247 /* Locate the entry for REG in GLOBAL->htab. */
249 static dead_debug_global_entry
*
250 dead_debug_global_find (struct dead_debug_global
*global
, rtx reg
)
252 dead_debug_global_entry temp_entry
;
253 temp_entry
.reg
= reg
;
255 dead_debug_global_entry
*entry
= global
->htab
->find (&temp_entry
);
256 gcc_checking_assert (entry
&& entry
->reg
== temp_entry
.reg
);
261 /* Insert an entry mapping REG to DTEMP in GLOBAL->htab. */
263 static dead_debug_global_entry
*
264 dead_debug_global_insert (struct dead_debug_global
*global
, rtx reg
, rtx dtemp
)
266 dead_debug_global_entry temp_entry
;
267 temp_entry
.reg
= reg
;
268 temp_entry
.dtemp
= dtemp
;
271 global
->htab
= new hash_table
<dead_debug_hash_descr
> (31);
273 dead_debug_global_entry
**slot
= global
->htab
->find_slot (&temp_entry
,
275 gcc_checking_assert (!*slot
);
276 *slot
= XNEW (dead_debug_global_entry
);
281 /* If UREGNO, referenced by USE, is a pseudo marked as used in GLOBAL,
282 replace it with with a USE of the debug temp recorded for it, and
283 return TRUE. Otherwise, just return FALSE.
285 If PTO_RESCAN is given, instead of rescanning modified INSNs right
286 away, add their UIDs to the bitmap, allocating one of *PTO_RESCAN
290 dead_debug_global_replace_temp (struct dead_debug_global
*global
,
291 df_ref use
, unsigned int uregno
,
294 if (!global
|| uregno
< FIRST_PSEUDO_REGISTER
296 || !REG_P (*DF_REF_REAL_LOC (use
))
297 || REGNO (*DF_REF_REAL_LOC (use
)) != uregno
298 || !bitmap_bit_p (global
->used
, uregno
))
301 dead_debug_global_entry
*entry
302 = dead_debug_global_find (global
, *DF_REF_REAL_LOC (use
));
303 gcc_checking_assert (GET_CODE (entry
->reg
) == REG
304 && REGNO (entry
->reg
) == uregno
);
309 *DF_REF_REAL_LOC (use
) = entry
->dtemp
;
311 df_insn_rescan (DF_REF_INSN (use
));
315 *pto_rescan
= BITMAP_ALLOC (NULL
);
316 bitmap_set_bit (*pto_rescan
, INSN_UID (DF_REF_INSN (use
)));
322 /* Reset all debug uses in HEAD, and clear DEBUG->to_rescan bits of
323 each reset insn. DEBUG is not otherwise modified. If HEAD is
324 DEBUG->head, DEBUG->head will be set to NULL at the end.
325 Otherwise, entries from DEBUG->head that pertain to reset insns
326 will be removed, and only then rescanned. */
329 dead_debug_reset_uses (struct dead_debug_local
*debug
,
330 struct dead_debug_use
*head
)
332 bool got_head
= (debug
->head
== head
);
334 struct dead_debug_use
**tailp
= &debug
->head
;
335 struct dead_debug_use
*cur
;
342 rescan
= BITMAP_ALLOC (NULL
);
346 struct dead_debug_use
*next
= head
->next
;
349 insn
= DF_REF_INSN (head
->use
);
350 if (!next
|| DF_REF_INSN (next
->use
) != insn
)
352 INSN_VAR_LOCATION_LOC (insn
) = gen_rtx_UNKNOWN_VAR_LOC ();
354 df_insn_rescan_debug_internal (insn
);
356 bitmap_set_bit (rescan
, INSN_UID (insn
));
357 if (debug
->to_rescan
)
358 bitmap_clear_bit (debug
->to_rescan
, INSN_UID (insn
));
370 while ((cur
= *tailp
))
371 if (bitmap_bit_p (rescan
, INSN_UID (DF_REF_INSN (cur
->use
))))
379 EXECUTE_IF_SET_IN_BITMAP (rescan
, 0, uid
, bi
)
381 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
383 df_insn_rescan_debug_internal (insn_info
->insn
);
386 BITMAP_FREE (rescan
);
389 /* Promote pending local uses of pseudos in DEBUG to global
390 substitutions. Uses of non-pseudos are left alone for
394 dead_debug_promote_uses (struct dead_debug_local
*debug
)
396 for (struct dead_debug_use
*head
= debug
->head
, **headp
= &debug
->head
;
399 rtx reg
= *DF_REF_REAL_LOC (head
->use
);
401 dead_debug_global_entry
*entry
;
403 if (GET_CODE (reg
) != REG
404 || REGNO (reg
) < FIRST_PSEUDO_REGISTER
)
410 if (!debug
->global
->used
)
411 debug
->global
->used
= BITMAP_ALLOC (NULL
);
413 bool added
= bitmap_set_bit (debug
->global
->used
, REGNO (reg
));
414 gcc_checking_assert (added
);
416 entry
= dead_debug_global_insert (debug
->global
, reg
,
417 make_debug_expr_from_rtl (reg
));
419 gcc_checking_assert (entry
->dtemp
);
421 /* Tentatively remove the USE from the list. */
424 if (!debug
->to_rescan
)
425 debug
->to_rescan
= BITMAP_ALLOC (NULL
);
427 for (ref
= DF_REG_USE_CHAIN (REGNO (reg
)); ref
;
428 ref
= DF_REF_NEXT_REG (ref
))
429 if (DEBUG_INSN_P (DF_REF_INSN (ref
)))
431 if (!dead_debug_global_replace_temp (debug
->global
, ref
,
435 rtx_insn
*insn
= DF_REF_INSN (ref
);
436 INSN_VAR_LOCATION_LOC (insn
) = gen_rtx_UNKNOWN_VAR_LOC ();
437 bitmap_set_bit (debug
->to_rescan
, INSN_UID (insn
));
441 for (ref
= DF_REG_DEF_CHAIN (REGNO (reg
)); ref
;
442 ref
= DF_REF_NEXT_REG (ref
))
443 if (!dead_debug_insert_temp (debug
, REGNO (reg
), DF_REF_INSN (ref
),
444 DEBUG_TEMP_BEFORE_WITH_VALUE
))
447 bind
= gen_rtx_VAR_LOCATION (GET_MODE (reg
),
448 DEBUG_EXPR_TREE_DECL (entry
->dtemp
),
449 gen_rtx_UNKNOWN_VAR_LOC (),
450 VAR_INIT_STATUS_INITIALIZED
);
451 rtx_insn
*insn
= emit_debug_insn_before (bind
, DF_REF_INSN (ref
));
452 bitmap_set_bit (debug
->to_rescan
, INSN_UID (insn
));
460 /* Reset all debug insns with pending uses. Release the bitmap in it,
461 unless it is USED. USED must be the same bitmap passed to
462 dead_debug_local_init. */
465 dead_debug_local_finish (struct dead_debug_local
*debug
, bitmap used
)
468 dead_debug_promote_uses (debug
);
470 if (debug
->used
!= used
)
471 BITMAP_FREE (debug
->used
);
473 dead_debug_reset_uses (debug
, debug
->head
);
475 if (debug
->to_rescan
)
480 EXECUTE_IF_SET_IN_BITMAP (debug
->to_rescan
, 0, uid
, bi
)
482 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
484 df_insn_rescan (insn_info
->insn
);
486 BITMAP_FREE (debug
->to_rescan
);
490 /* Release GLOBAL->used unless it is the same as USED. Release the
491 mapping hash table if it was initialized. */
494 dead_debug_global_finish (struct dead_debug_global
*global
, bitmap used
)
496 if (global
->used
!= used
)
497 BITMAP_FREE (global
->used
);
503 /* Add USE to DEBUG, or substitute it right away if it's a pseudo in
504 the global substitution list. USE must be a dead reference to
505 UREGNO in a debug insn. Create a bitmap for DEBUG as needed. */
508 dead_debug_add (struct dead_debug_local
*debug
, df_ref use
, unsigned int uregno
)
510 if (dead_debug_global_replace_temp (debug
->global
, use
, uregno
,
514 struct dead_debug_use
*newddu
= XNEW (struct dead_debug_use
);
517 newddu
->next
= debug
->head
;
518 debug
->head
= newddu
;
521 debug
->used
= BITMAP_ALLOC (NULL
);
523 /* ??? If we dealt with split multi-registers below, we should set
524 all registers for the used mode in case of hardware
526 bitmap_set_bit (debug
->used
, uregno
);
529 /* If UREGNO is referenced by any entry in DEBUG, emit a debug insn
530 before or after INSN (depending on WHERE), that binds a (possibly
531 global) debug temp to the widest-mode use of UREGNO, if WHERE is
532 *_WITH_REG, or the value stored in UREGNO by INSN otherwise, and
533 replace all uses of UREGNO in DEBUG with uses of the debug temp.
534 INSN must be where UREGNO dies, if WHERE is *_BEFORE_*, or where it
535 is set otherwise. Return the number of debug insns emitted. */
538 dead_debug_insert_temp (struct dead_debug_local
*debug
, unsigned int uregno
,
539 rtx_insn
*insn
, enum debug_temp_where where
)
541 struct dead_debug_use
**tailp
= &debug
->head
;
542 struct dead_debug_use
*cur
;
543 struct dead_debug_use
*uses
= NULL
;
544 struct dead_debug_use
**usesp
= &uses
;
554 global
= (debug
->global
&& debug
->global
->used
555 && bitmap_bit_p (debug
->global
->used
, uregno
));
557 if (!global
&& !bitmap_clear_bit (debug
->used
, uregno
))
560 /* Move all uses of uregno from debug->head to uses, setting mode to
561 the widest referenced mode. */
562 while ((cur
= *tailp
))
564 if (DF_REF_REGNO (cur
->use
) == uregno
)
566 /* If this loc has been changed e.g. to debug_expr already
567 as part of a multi-register use, just drop it. */
568 if (!REG_P (*DF_REF_REAL_LOC (cur
->use
)))
579 || (GET_MODE_BITSIZE (GET_MODE (reg
))
580 < GET_MODE_BITSIZE (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)))))
581 reg
= *DF_REF_REAL_LOC (cur
->use
);
584 tailp
= &(*tailp
)->next
;
587 /* We may have dangling bits in debug->used for registers that were part
588 of a multi-register use, one component of which has been reset. */
591 gcc_checking_assert (!uses
);
599 reg
= regno_reg_rtx
[uregno
];
600 dead_debug_global_entry
*entry
601 = dead_debug_global_find (debug
->global
, reg
);
602 gcc_checking_assert (entry
->reg
== reg
);
608 gcc_checking_assert (uses
|| global
);
611 /* Recover the expression INSN stores in REG. */
612 if (where
== DEBUG_TEMP_BEFORE_WITH_VALUE
)
614 rtx set
= single_set (insn
);
619 dest
= SET_DEST (set
);
621 /* Lose if the REG-setting insn is a CALL. */
622 if (GET_CODE (src
) == CALL
)
634 /* ??? Should we try to extract it from a PARALLEL? */
637 /* Cool, it's the same REG, we can use SRC. */
638 else if (dest
== reg
)
639 breg
= cleanup_auto_inc_dec (src
, VOIDmode
);
640 else if (REG_P (dest
))
642 /* Hmm... Something's fishy, we should be setting REG here. */
643 if (REGNO (dest
) != REGNO (reg
))
645 /* If we're not overwriting all the hardware registers that
646 setting REG in its mode would, we won't know what to bind
647 the debug temp to. ??? We could bind the debug_expr to a
648 CONCAT or PARALLEL with the split multi-registers, and
649 replace them as we found the corresponding sets. */
650 else if (REGNO (reg
) < FIRST_PSEUDO_REGISTER
651 && (hard_regno_nregs
[REGNO (reg
)][GET_MODE (reg
)]
652 != hard_regno_nregs
[REGNO (reg
)][GET_MODE (dest
)]))
654 /* Ok, it's the same (hardware) REG, but with a different
655 mode, so SUBREG it. */
657 breg
= lowpart_subreg (GET_MODE (reg
),
658 cleanup_auto_inc_dec (src
, VOIDmode
),
661 else if (GET_CODE (dest
) == SUBREG
)
663 /* We should be setting REG here. Lose. */
664 if (REGNO (SUBREG_REG (dest
)) != REGNO (reg
))
666 /* Lose if we're setting something other than the lowpart of
668 else if (!subreg_lowpart_p (dest
))
670 /* If we're not overwriting all the hardware registers that
671 setting REG in its mode would, we won't know what to bind
672 the debug temp to. */
673 else if (REGNO (reg
) < FIRST_PSEUDO_REGISTER
674 && (hard_regno_nregs
[REGNO (reg
)][GET_MODE (reg
)]
675 != hard_regno_nregs
[REGNO (reg
)][GET_MODE (dest
)]))
677 /* Yay, we can use SRC, just adjust its mode. */
679 breg
= lowpart_subreg (GET_MODE (reg
),
680 cleanup_auto_inc_dec (src
, VOIDmode
),
683 /* Oh well, we're out of luck. */
687 /* We couldn't figure out the value stored in REG, so reset all
688 of its pending debug uses. */
691 dead_debug_reset_uses (debug
, uses
);
696 /* If there's a single (debug) use of an otherwise unused REG, and
697 the debug use is not part of a larger expression, then it
698 probably doesn't make sense to introduce a new debug temp. */
699 if (where
== DEBUG_TEMP_AFTER_WITH_REG
&& !uses
->next
)
701 rtx_insn
*next
= DF_REF_INSN (uses
->use
);
703 if (DEBUG_INSN_P (next
) && reg
== INSN_VAR_LOCATION_LOC (next
))
711 /* Create DEBUG_EXPR (and DEBUG_EXPR_DECL). */
712 dval
= make_debug_expr_from_rtl (reg
);
714 /* Emit a debug bind insn before the insn in which reg dies. */
715 bind
= gen_rtx_VAR_LOCATION (GET_MODE (reg
),
716 DEBUG_EXPR_TREE_DECL (dval
), breg
,
717 VAR_INIT_STATUS_INITIALIZED
);
719 if (where
== DEBUG_TEMP_AFTER_WITH_REG
720 || where
== DEBUG_TEMP_AFTER_WITH_REG_FORCE
)
721 bind
= emit_debug_insn_after (bind
, insn
);
723 bind
= emit_debug_insn_before (bind
, insn
);
724 if (debug
->to_rescan
== NULL
)
725 debug
->to_rescan
= BITMAP_ALLOC (NULL
);
726 bitmap_set_bit (debug
->to_rescan
, INSN_UID (bind
));
728 /* Adjust all uses. */
731 if (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)) == GET_MODE (reg
))
732 *DF_REF_REAL_LOC (cur
->use
) = dval
;
734 *DF_REF_REAL_LOC (cur
->use
)
735 = gen_lowpart_SUBREG (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)), dval
);
736 /* ??? Should we simplify subreg of subreg? */
737 bitmap_set_bit (debug
->to_rescan
, INSN_UID (DF_REF_INSN (cur
->use
)));