1 /* Infrastructure for tracking user variable locations and values
2 throughout compilation.
3 Copyright (C) 2010-2013 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 if (REG_P (XEXP (x
, 0)) && REGNO (XEXP (x
, 0)) < FIRST_PSEUDO_REGISTER
)
79 if (shared_const_p (x
))
84 mem_mode
= GET_MODE (x
);
89 gcc_assert (mem_mode
!= VOIDmode
&& mem_mode
!= BLKmode
);
90 return gen_rtx_PLUS (GET_MODE (x
),
91 cleanup_auto_inc_dec (XEXP (x
, 0), mem_mode
),
92 GEN_INT (code
== PRE_INC
93 ? GET_MODE_SIZE (mem_mode
)
94 : -GET_MODE_SIZE (mem_mode
)));
100 return cleanup_auto_inc_dec (code
== PRE_MODIFY
101 ? XEXP (x
, 1) : XEXP (x
, 0),
108 /* Copy the various flags, fields, and other information. We assume
109 that all fields need copying, and then clear the fields that should
110 not be copied. That is the sensible default behavior, and forces
111 us to explicitly document why we are *not* copying a flag. */
112 x
= shallow_copy_rtx (x
);
114 /* We do not copy the USED flag, which is used as a mark bit during
115 walks over the RTL. */
116 RTX_FLAG (x
, used
) = 0;
118 /* We do not copy FRAME_RELATED for INSNs. */
120 RTX_FLAG (x
, frame_related
) = 0;
122 fmt
= GET_RTX_FORMAT (code
);
123 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
125 XEXP (x
, i
) = cleanup_auto_inc_dec (XEXP (x
, i
), mem_mode
);
126 else if (fmt
[i
] == 'E' || fmt
[i
] == 'V')
129 XVEC (x
, i
) = rtvec_alloc (XVECLEN (x
, i
));
130 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
132 = cleanup_auto_inc_dec (XVECEXP (src
, i
, j
), mem_mode
);
135 #else /* !AUTO_INC_DEC */
137 #endif /* !AUTO_INC_DEC */
142 /* Auxiliary data structure for propagate_for_debug_stmt. */
144 struct rtx_subst_pair
150 /* DATA points to an rtx_subst_pair. Return the value that should be
154 propagate_for_debug_subst (rtx from
, const_rtx old_rtx
, void *data
)
156 struct rtx_subst_pair
*pair
= (struct rtx_subst_pair
*)data
;
158 if (!rtx_equal_p (from
, old_rtx
))
162 pair
->adjusted
= true;
163 pair
->to
= cleanup_auto_inc_dec (pair
->to
, VOIDmode
);
164 pair
->to
= make_compound_operation (pair
->to
, SET
);
167 return copy_rtx (pair
->to
);
170 /* Replace all the occurrences of DEST with SRC in DEBUG_INSNs between INSN
171 and LAST, not including INSN, but including LAST. Also stop at the end
172 of THIS_BASIC_BLOCK. */
175 propagate_for_debug (rtx insn
, rtx last
, rtx dest
, rtx src
,
176 basic_block this_basic_block
)
178 rtx next
, loc
, end
= NEXT_INSN (BB_END (this_basic_block
));
179 rtx (*saved_rtl_hook_no_emit
) (enum machine_mode
, rtx
);
181 struct rtx_subst_pair p
;
185 next
= NEXT_INSN (insn
);
186 last
= NEXT_INSN (last
);
187 saved_rtl_hook_no_emit
= rtl_hooks
.gen_lowpart_no_emit
;
188 rtl_hooks
.gen_lowpart_no_emit
= gen_lowpart_for_debug
;
189 while (next
!= last
&& next
!= end
)
192 next
= NEXT_INSN (insn
);
193 if (DEBUG_INSN_P (insn
))
195 loc
= simplify_replace_fn_rtx (INSN_VAR_LOCATION_LOC (insn
),
196 dest
, propagate_for_debug_subst
, &p
);
197 if (loc
== INSN_VAR_LOCATION_LOC (insn
))
199 INSN_VAR_LOCATION_LOC (insn
) = loc
;
200 df_insn_rescan (insn
);
203 rtl_hooks
.gen_lowpart_no_emit
= saved_rtl_hook_no_emit
;
206 /* Initialize DEBUG to an empty list, and clear USED, if given. */
209 dead_debug_global_init (struct dead_debug_global
*debug
, bitmap used
)
216 /* Initialize DEBUG to an empty list, and clear USED, if given. Link
217 back to GLOBAL, if given, and bring in used bits from it. */
220 dead_debug_local_init (struct dead_debug_local
*debug
, bitmap used
,
221 struct dead_debug_global
*global
)
223 if (!used
&& global
&& global
->used
)
224 used
= BITMAP_ALLOC (NULL
);
227 debug
->global
= global
;
229 debug
->to_rescan
= NULL
;
233 if (global
&& global
->used
)
234 bitmap_copy (used
, global
->used
);
240 /* Locate the entry for REG in GLOBAL->htab. */
242 static dead_debug_global_entry
*
243 dead_debug_global_find (struct dead_debug_global
*global
, rtx reg
)
245 dead_debug_global_entry temp_entry
;
246 temp_entry
.reg
= reg
;
248 dead_debug_global_entry
*entry
= global
->htab
.find (&temp_entry
);
249 gcc_checking_assert (entry
&& entry
->reg
== temp_entry
.reg
);
254 /* Insert an entry mapping REG to DTEMP in GLOBAL->htab. */
256 static dead_debug_global_entry
*
257 dead_debug_global_insert (struct dead_debug_global
*global
, rtx reg
, rtx dtemp
)
259 dead_debug_global_entry temp_entry
;
260 temp_entry
.reg
= reg
;
261 temp_entry
.dtemp
= dtemp
;
263 if (!global
->htab
.is_created ())
264 global
->htab
.create (31);
266 dead_debug_global_entry
**slot
= global
->htab
.find_slot (&temp_entry
, INSERT
);
267 gcc_checking_assert (!*slot
);
268 *slot
= XNEW (dead_debug_global_entry
);
273 /* If UREGNO, referenced by USE, is a pseudo marked as used in GLOBAL,
274 replace it with with a USE of the debug temp recorded for it, and
275 return TRUE. Otherwise, just return FALSE.
277 If PTO_RESCAN is given, instead of rescanning modified INSNs right
278 away, add their UIDs to the bitmap, allocating one of *PTO_RESCAN
282 dead_debug_global_replace_temp (struct dead_debug_global
*global
,
283 df_ref use
, unsigned int uregno
,
286 if (!global
|| uregno
< FIRST_PSEUDO_REGISTER
288 || !REG_P (*DF_REF_REAL_LOC (use
))
289 || REGNO (*DF_REF_REAL_LOC (use
)) != uregno
290 || !bitmap_bit_p (global
->used
, uregno
))
293 dead_debug_global_entry
*entry
294 = dead_debug_global_find (global
, *DF_REF_REAL_LOC (use
));
295 gcc_checking_assert (GET_CODE (entry
->reg
) == REG
296 && REGNO (entry
->reg
) == uregno
);
301 *DF_REF_REAL_LOC (use
) = entry
->dtemp
;
303 df_insn_rescan (DF_REF_INSN (use
));
307 *pto_rescan
= BITMAP_ALLOC (NULL
);
308 bitmap_set_bit (*pto_rescan
, INSN_UID (DF_REF_INSN (use
)));
314 /* Reset all debug uses in HEAD, and clear DEBUG->to_rescan bits of
315 each reset insn. DEBUG is not otherwise modified. If HEAD is
316 DEBUG->head, DEBUG->head will be set to NULL at the end.
317 Otherwise, entries from DEBUG->head that pertain to reset insns
318 will be removed, and only then rescanned. */
321 dead_debug_reset_uses (struct dead_debug_local
*debug
,
322 struct dead_debug_use
*head
)
324 bool got_head
= (debug
->head
== head
);
326 struct dead_debug_use
**tailp
= &debug
->head
;
327 struct dead_debug_use
*cur
;
334 rescan
= BITMAP_ALLOC (NULL
);
338 struct dead_debug_use
*next
= head
->next
;
341 insn
= DF_REF_INSN (head
->use
);
342 if (!next
|| DF_REF_INSN (next
->use
) != insn
)
344 INSN_VAR_LOCATION_LOC (insn
) = gen_rtx_UNKNOWN_VAR_LOC ();
346 df_insn_rescan_debug_internal (insn
);
348 bitmap_set_bit (rescan
, INSN_UID (insn
));
349 if (debug
->to_rescan
)
350 bitmap_clear_bit (debug
->to_rescan
, INSN_UID (insn
));
362 while ((cur
= *tailp
))
363 if (bitmap_bit_p (rescan
, INSN_UID (DF_REF_INSN (cur
->use
))))
371 EXECUTE_IF_SET_IN_BITMAP (rescan
, 0, uid
, bi
)
373 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
375 df_insn_rescan_debug_internal (insn_info
->insn
);
378 BITMAP_FREE (rescan
);
381 /* Promote pending local uses of pseudos in DEBUG to global
382 substitutions. Uses of non-pseudos are left alone for
386 dead_debug_promote_uses (struct dead_debug_local
*debug
)
388 for (struct dead_debug_use
*head
= debug
->head
, **headp
= &debug
->head
;
391 rtx reg
= *DF_REF_REAL_LOC (head
->use
);
393 dead_debug_global_entry
*entry
;
395 if (GET_CODE (reg
) != REG
396 || REGNO (reg
) < FIRST_PSEUDO_REGISTER
)
402 if (!debug
->global
->used
)
403 debug
->global
->used
= BITMAP_ALLOC (NULL
);
405 bool added
= bitmap_set_bit (debug
->global
->used
, REGNO (reg
));
406 gcc_checking_assert (added
);
408 entry
= dead_debug_global_insert (debug
->global
, reg
,
409 make_debug_expr_from_rtl (reg
));
411 gcc_checking_assert (entry
->dtemp
);
413 /* Tentatively remove the USE from the list. */
416 if (!debug
->to_rescan
)
417 debug
->to_rescan
= BITMAP_ALLOC (NULL
);
419 for (ref
= DF_REG_USE_CHAIN (REGNO (reg
)); ref
;
420 ref
= DF_REF_NEXT_REG (ref
))
421 if (DEBUG_INSN_P (DF_REF_INSN (ref
)))
423 if (!dead_debug_global_replace_temp (debug
->global
, ref
,
427 rtx insn
= DF_REF_INSN (ref
);
428 INSN_VAR_LOCATION_LOC (insn
) = gen_rtx_UNKNOWN_VAR_LOC ();
429 bitmap_set_bit (debug
->to_rescan
, INSN_UID (insn
));
433 for (ref
= DF_REG_DEF_CHAIN (REGNO (reg
)); ref
;
434 ref
= DF_REF_NEXT_REG (ref
))
435 if (!dead_debug_insert_temp (debug
, REGNO (reg
), DF_REF_INSN (ref
),
436 DEBUG_TEMP_BEFORE_WITH_VALUE
))
439 bind
= gen_rtx_VAR_LOCATION (GET_MODE (reg
),
440 DEBUG_EXPR_TREE_DECL (entry
->dtemp
),
441 gen_rtx_UNKNOWN_VAR_LOC (),
442 VAR_INIT_STATUS_INITIALIZED
);
443 rtx insn
= emit_debug_insn_before (bind
, DF_REF_INSN (ref
));
444 bitmap_set_bit (debug
->to_rescan
, INSN_UID (insn
));
452 /* Reset all debug insns with pending uses. Release the bitmap in it,
453 unless it is USED. USED must be the same bitmap passed to
454 dead_debug_local_init. */
457 dead_debug_local_finish (struct dead_debug_local
*debug
, bitmap used
)
460 dead_debug_promote_uses (debug
);
462 if (debug
->used
!= used
)
463 BITMAP_FREE (debug
->used
);
465 dead_debug_reset_uses (debug
, debug
->head
);
467 if (debug
->to_rescan
)
472 EXECUTE_IF_SET_IN_BITMAP (debug
->to_rescan
, 0, uid
, bi
)
474 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
476 df_insn_rescan (insn_info
->insn
);
478 BITMAP_FREE (debug
->to_rescan
);
482 /* Release GLOBAL->used unless it is the same as USED. Release the
483 mapping hash table if it was initialized. */
486 dead_debug_global_finish (struct dead_debug_global
*global
, bitmap used
)
488 if (global
->used
!= used
)
489 BITMAP_FREE (global
->used
);
491 if (global
->htab
.is_created ())
492 global
->htab
.dispose ();
495 /* Add USE to DEBUG, or substitute it right away if it's a pseudo in
496 the global substitution list. USE must be a dead reference to
497 UREGNO in a debug insn. Create a bitmap for DEBUG as needed. */
500 dead_debug_add (struct dead_debug_local
*debug
, df_ref use
, unsigned int uregno
)
502 if (dead_debug_global_replace_temp (debug
->global
, use
, uregno
,
506 struct dead_debug_use
*newddu
= XNEW (struct dead_debug_use
);
509 newddu
->next
= debug
->head
;
510 debug
->head
= newddu
;
513 debug
->used
= BITMAP_ALLOC (NULL
);
515 /* ??? If we dealt with split multi-registers below, we should set
516 all registers for the used mode in case of hardware
518 bitmap_set_bit (debug
->used
, uregno
);
521 /* If UREGNO is referenced by any entry in DEBUG, emit a debug insn
522 before or after INSN (depending on WHERE), that binds a (possibly
523 global) debug temp to the widest-mode use of UREGNO, if WHERE is
524 *_WITH_REG, or the value stored in UREGNO by INSN otherwise, and
525 replace all uses of UREGNO in DEBUG with uses of the debug temp.
526 INSN must be where UREGNO dies, if WHERE is *_BEFORE_*, or where it
527 is set otherwise. Return the number of debug insns emitted. */
530 dead_debug_insert_temp (struct dead_debug_local
*debug
, unsigned int uregno
,
531 rtx insn
, enum debug_temp_where where
)
533 struct dead_debug_use
**tailp
= &debug
->head
;
534 struct dead_debug_use
*cur
;
535 struct dead_debug_use
*uses
= NULL
;
536 struct dead_debug_use
**usesp
= &uses
;
546 global
= (debug
->global
&& debug
->global
->used
547 && bitmap_bit_p (debug
->global
->used
, uregno
));
549 if (!global
&& !bitmap_clear_bit (debug
->used
, uregno
))
552 /* Move all uses of uregno from debug->head to uses, setting mode to
553 the widest referenced mode. */
554 while ((cur
= *tailp
))
556 if (DF_REF_REGNO (cur
->use
) == uregno
)
558 /* If this loc has been changed e.g. to debug_expr already
559 as part of a multi-register use, just drop it. */
560 if (!REG_P (*DF_REF_REAL_LOC (cur
->use
)))
571 || (GET_MODE_BITSIZE (GET_MODE (reg
))
572 < GET_MODE_BITSIZE (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)))))
573 reg
= *DF_REF_REAL_LOC (cur
->use
);
576 tailp
= &(*tailp
)->next
;
579 /* We may have dangling bits in debug->used for registers that were part
580 of a multi-register use, one component of which has been reset. */
583 gcc_checking_assert (!uses
);
591 reg
= regno_reg_rtx
[uregno
];
592 dead_debug_global_entry
*entry
593 = dead_debug_global_find (debug
->global
, reg
);
594 gcc_checking_assert (entry
->reg
== reg
);
600 gcc_checking_assert (uses
|| global
);
603 /* Recover the expression INSN stores in REG. */
604 if (where
== DEBUG_TEMP_BEFORE_WITH_VALUE
)
606 rtx set
= single_set (insn
);
611 dest
= SET_DEST (set
);
613 /* Lose if the REG-setting insn is a CALL. */
614 if (GET_CODE (src
) == CALL
)
626 /* ??? Should we try to extract it from a PARALLEL? */
629 /* Cool, it's the same REG, we can use SRC. */
630 else if (dest
== reg
)
631 breg
= cleanup_auto_inc_dec (src
, VOIDmode
);
632 else if (REG_P (dest
))
634 /* Hmm... Something's fishy, we should be setting REG here. */
635 if (REGNO (dest
) != REGNO (reg
))
637 /* If we're not overwriting all the hardware registers that
638 setting REG in its mode would, we won't know what to bind
639 the debug temp to. ??? We could bind the debug_expr to a
640 CONCAT or PARALLEL with the split multi-registers, and
641 replace them as we found the corresponding sets. */
642 else if (REGNO (reg
) < FIRST_PSEUDO_REGISTER
643 && (hard_regno_nregs
[REGNO (reg
)][GET_MODE (reg
)]
644 != hard_regno_nregs
[REGNO (reg
)][GET_MODE (dest
)]))
646 /* Ok, it's the same (hardware) REG, but with a different
647 mode, so SUBREG it. */
649 breg
= lowpart_subreg (GET_MODE (reg
),
650 cleanup_auto_inc_dec (src
, VOIDmode
),
653 else if (GET_CODE (dest
) == SUBREG
)
655 /* We should be setting REG here. Lose. */
656 if (REGNO (SUBREG_REG (dest
)) != REGNO (reg
))
658 /* Lose if we're setting something other than the lowpart of
660 else if (!subreg_lowpart_p (dest
))
662 /* If we're not overwriting all the hardware registers that
663 setting REG in its mode would, we won't know what to bind
664 the debug temp to. */
665 else if (REGNO (reg
) < FIRST_PSEUDO_REGISTER
666 && (hard_regno_nregs
[REGNO (reg
)][GET_MODE (reg
)]
667 != hard_regno_nregs
[REGNO (reg
)][GET_MODE (dest
)]))
669 /* Yay, we can use SRC, just adjust its mode. */
671 breg
= lowpart_subreg (GET_MODE (reg
),
672 cleanup_auto_inc_dec (src
, VOIDmode
),
675 /* Oh well, we're out of luck. */
679 /* We couldn't figure out the value stored in REG, so reset all
680 of its pending debug uses. */
683 dead_debug_reset_uses (debug
, uses
);
688 /* If there's a single (debug) use of an otherwise unused REG, and
689 the debug use is not part of a larger expression, then it
690 probably doesn't make sense to introduce a new debug temp. */
691 if (where
== DEBUG_TEMP_AFTER_WITH_REG
&& !uses
->next
)
693 rtx next
= DF_REF_INSN (uses
->use
);
695 if (DEBUG_INSN_P (next
) && reg
== INSN_VAR_LOCATION_LOC (next
))
703 /* Create DEBUG_EXPR (and DEBUG_EXPR_DECL). */
704 dval
= make_debug_expr_from_rtl (reg
);
706 /* Emit a debug bind insn before the insn in which reg dies. */
707 bind
= gen_rtx_VAR_LOCATION (GET_MODE (reg
),
708 DEBUG_EXPR_TREE_DECL (dval
), breg
,
709 VAR_INIT_STATUS_INITIALIZED
);
711 if (where
== DEBUG_TEMP_AFTER_WITH_REG
712 || where
== DEBUG_TEMP_AFTER_WITH_REG_FORCE
)
713 bind
= emit_debug_insn_after (bind
, insn
);
715 bind
= emit_debug_insn_before (bind
, insn
);
716 if (debug
->to_rescan
== NULL
)
717 debug
->to_rescan
= BITMAP_ALLOC (NULL
);
718 bitmap_set_bit (debug
->to_rescan
, INSN_UID (bind
));
720 /* Adjust all uses. */
723 if (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)) == GET_MODE (reg
))
724 *DF_REF_REAL_LOC (cur
->use
) = dval
;
726 *DF_REF_REAL_LOC (cur
->use
)
727 = gen_lowpart_SUBREG (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)), dval
);
728 /* ??? Should we simplify subreg of subreg? */
729 bitmap_set_bit (debug
->to_rescan
, INSN_UID (DF_REF_INSN (cur
->use
)));