1 /* Infrastructure for tracking user variable locations and values
2 throughout compilation.
3 Copyright (C) 2010, 2011, 2012 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 /* Replace auto-increment addressing modes with explicit operations to access
33 the same addresses without modifying the corresponding registers. */
36 cleanup_auto_inc_dec (rtx src
, enum machine_mode mem_mode ATTRIBUTE_UNUSED
)
40 const RTX_CODE code
= GET_CODE (x
);
53 /* SCRATCH must be shared because they represent distinct values. */
56 if (REG_P (XEXP (x
, 0)) && REGNO (XEXP (x
, 0)) < FIRST_PSEUDO_REGISTER
)
61 if (shared_const_p (x
))
66 mem_mode
= GET_MODE (x
);
71 gcc_assert (mem_mode
!= VOIDmode
&& mem_mode
!= BLKmode
);
72 return gen_rtx_PLUS (GET_MODE (x
),
73 cleanup_auto_inc_dec (XEXP (x
, 0), mem_mode
),
74 GEN_INT (code
== PRE_INC
75 ? GET_MODE_SIZE (mem_mode
)
76 : -GET_MODE_SIZE (mem_mode
)));
82 return cleanup_auto_inc_dec (code
== PRE_MODIFY
83 ? XEXP (x
, 1) : XEXP (x
, 0),
90 /* Copy the various flags, fields, and other information. We assume
91 that all fields need copying, and then clear the fields that should
92 not be copied. That is the sensible default behavior, and forces
93 us to explicitly document why we are *not* copying a flag. */
94 x
= shallow_copy_rtx (x
);
96 /* We do not copy the USED flag, which is used as a mark bit during
97 walks over the RTL. */
98 RTX_FLAG (x
, used
) = 0;
100 /* We do not copy FRAME_RELATED for INSNs. */
102 RTX_FLAG (x
, frame_related
) = 0;
104 fmt
= GET_RTX_FORMAT (code
);
105 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
107 XEXP (x
, i
) = cleanup_auto_inc_dec (XEXP (x
, i
), mem_mode
);
108 else if (fmt
[i
] == 'E' || fmt
[i
] == 'V')
111 XVEC (x
, i
) = rtvec_alloc (XVECLEN (x
, i
));
112 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
114 = cleanup_auto_inc_dec (XVECEXP (src
, i
, j
), mem_mode
);
117 #else /* !AUTO_INC_DEC */
119 #endif /* !AUTO_INC_DEC */
124 /* Auxiliary data structure for propagate_for_debug_stmt. */
126 struct rtx_subst_pair
132 /* DATA points to an rtx_subst_pair. Return the value that should be
136 propagate_for_debug_subst (rtx from
, const_rtx old_rtx
, void *data
)
138 struct rtx_subst_pair
*pair
= (struct rtx_subst_pair
*)data
;
140 if (!rtx_equal_p (from
, old_rtx
))
144 pair
->adjusted
= true;
145 pair
->to
= cleanup_auto_inc_dec (pair
->to
, VOIDmode
);
146 pair
->to
= make_compound_operation (pair
->to
, SET
);
149 return copy_rtx (pair
->to
);
152 /* Replace all the occurrences of DEST with SRC in DEBUG_INSNs between INSN
153 and LAST, not including INSN, but including LAST. Also stop at the end
154 of THIS_BASIC_BLOCK. */
157 propagate_for_debug (rtx insn
, rtx last
, rtx dest
, rtx src
,
158 basic_block this_basic_block
)
160 rtx next
, loc
, end
= NEXT_INSN (BB_END (this_basic_block
));
162 struct rtx_subst_pair p
;
166 next
= NEXT_INSN (insn
);
167 last
= NEXT_INSN (last
);
168 while (next
!= last
&& next
!= end
)
171 next
= NEXT_INSN (insn
);
172 if (DEBUG_INSN_P (insn
))
174 loc
= simplify_replace_fn_rtx (INSN_VAR_LOCATION_LOC (insn
),
175 dest
, propagate_for_debug_subst
, &p
);
176 if (loc
== INSN_VAR_LOCATION_LOC (insn
))
178 INSN_VAR_LOCATION_LOC (insn
) = loc
;
179 df_insn_rescan (insn
);
184 /* Initialize DEBUG to an empty list, and clear USED, if given. */
187 dead_debug_global_init (struct dead_debug_global
*debug
, bitmap used
)
194 /* Initialize DEBUG to an empty list, and clear USED, if given. Link
195 back to GLOBAL, if given, and bring in used bits from it. */
198 dead_debug_local_init (struct dead_debug_local
*debug
, bitmap used
,
199 struct dead_debug_global
*global
)
201 if (!used
&& global
&& global
->used
)
202 used
= BITMAP_ALLOC (NULL
);
205 debug
->global
= global
;
207 debug
->to_rescan
= NULL
;
211 if (global
&& global
->used
)
212 bitmap_copy (used
, global
->used
);
218 /* Locate the entry for REG in GLOBAL->htab. */
220 static dead_debug_global_entry
*
221 dead_debug_global_find (struct dead_debug_global
*global
, rtx reg
)
223 dead_debug_global_entry temp_entry
;
224 temp_entry
.reg
= reg
;
226 dead_debug_global_entry
*entry
= global
->htab
.find (&temp_entry
);
227 gcc_checking_assert (entry
&& entry
->reg
== temp_entry
.reg
);
228 gcc_checking_assert (entry
->dtemp
);
233 /* Insert an entry mapping REG to DTEMP in GLOBAL->htab. */
236 dead_debug_global_insert (struct dead_debug_global
*global
, rtx reg
, rtx dtemp
)
238 dead_debug_global_entry temp_entry
;
239 temp_entry
.reg
= reg
;
240 temp_entry
.dtemp
= dtemp
;
242 if (!global
->htab
.is_created ())
243 global
->htab
.create (31);
245 dead_debug_global_entry
**slot
= global
->htab
.find_slot (&temp_entry
, INSERT
);
246 gcc_checking_assert (!*slot
);
247 *slot
= XNEW (dead_debug_global_entry
);
251 /* If UREGNO, referenced by USE, is a pseudo marked as used in GLOBAL,
252 replace it with with a USE of the debug temp recorded for it, and
253 return TRUE. Otherwise, just return FALSE.
255 If PTO_RESCAN is given, instead of rescanning modified INSNs right
256 away, add their UIDs to the bitmap, allocating one of *PTO_RESCAN
260 dead_debug_global_replace_temp (struct dead_debug_global
*global
,
261 df_ref use
, unsigned int uregno
,
264 if (!global
|| uregno
< FIRST_PSEUDO_REGISTER
266 || !bitmap_bit_p (global
->used
, uregno
))
269 gcc_checking_assert (REGNO (*DF_REF_REAL_LOC (use
)) == uregno
);
271 dead_debug_global_entry
*entry
272 = dead_debug_global_find (global
, *DF_REF_REAL_LOC (use
));
273 gcc_checking_assert (GET_CODE (entry
->reg
) == REG
274 && REGNO (entry
->reg
) == uregno
);
276 *DF_REF_REAL_LOC (use
) = entry
->dtemp
;
278 df_insn_rescan (DF_REF_INSN (use
));
282 *pto_rescan
= BITMAP_ALLOC (NULL
);
283 bitmap_set_bit (*pto_rescan
, INSN_UID (DF_REF_INSN (use
)));
289 /* Reset all debug uses in HEAD, and clear DEBUG->to_rescan bits of
290 each reset insn. DEBUG is not otherwise modified. If HEAD is
291 DEBUG->head, DEBUG->head will be set to NULL at the end.
292 Otherwise, entries from DEBUG->head that pertain to reset insns
293 will be removed, and only then rescanned. */
296 dead_debug_reset_uses (struct dead_debug_local
*debug
,
297 struct dead_debug_use
*head
)
299 bool got_head
= (debug
->head
== head
);
301 struct dead_debug_use
**tailp
= &debug
->head
;
302 struct dead_debug_use
*cur
;
309 rescan
= BITMAP_ALLOC (NULL
);
313 struct dead_debug_use
*next
= head
->next
;
316 insn
= DF_REF_INSN (head
->use
);
317 if (!next
|| DF_REF_INSN (next
->use
) != insn
)
319 INSN_VAR_LOCATION_LOC (insn
) = gen_rtx_UNKNOWN_VAR_LOC ();
321 df_insn_rescan_debug_internal (insn
);
323 bitmap_set_bit (rescan
, INSN_UID (insn
));
324 if (debug
->to_rescan
)
325 bitmap_clear_bit (debug
->to_rescan
, INSN_UID (insn
));
337 while ((cur
= *tailp
))
338 if (bitmap_bit_p (rescan
, INSN_UID (DF_REF_INSN (cur
->use
))))
346 EXECUTE_IF_SET_IN_BITMAP (rescan
, 0, uid
, bi
)
348 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
350 df_insn_rescan_debug_internal (insn_info
->insn
);
353 BITMAP_FREE (rescan
);
356 /* Promote pending local uses of pseudos in DEBUG to global
357 substitutions. Uses of non-pseudos are left alone for
361 dead_debug_promote_uses (struct dead_debug_local
*debug
)
363 for (struct dead_debug_use
*head
= debug
->head
, **headp
= &debug
->head
;
366 rtx reg
= *DF_REF_REAL_LOC (head
->use
);
368 if (GET_CODE (reg
) != REG
369 || REGNO (reg
) < FIRST_PSEUDO_REGISTER
)
375 if (!debug
->global
->used
)
376 debug
->global
->used
= BITMAP_ALLOC (NULL
);
378 if (bitmap_set_bit (debug
->global
->used
, REGNO (reg
)))
379 dead_debug_global_insert (debug
->global
, reg
,
380 make_debug_expr_from_rtl (reg
));
382 if (!dead_debug_global_replace_temp (debug
->global
, head
->use
,
383 REGNO (reg
), &debug
->to_rescan
))
394 /* Reset all debug insns with pending uses. Release the bitmap in it,
395 unless it is USED. USED must be the same bitmap passed to
396 dead_debug_local_init. */
399 dead_debug_local_finish (struct dead_debug_local
*debug
, bitmap used
)
401 if (debug
->used
!= used
)
402 BITMAP_FREE (debug
->used
);
405 dead_debug_promote_uses (debug
);
407 dead_debug_reset_uses (debug
, debug
->head
);
409 if (debug
->to_rescan
)
414 EXECUTE_IF_SET_IN_BITMAP (debug
->to_rescan
, 0, uid
, bi
)
416 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
418 df_insn_rescan (insn_info
->insn
);
420 BITMAP_FREE (debug
->to_rescan
);
424 /* Release GLOBAL->used unless it is the same as USED. Release the
425 mapping hash table if it was initialized. */
428 dead_debug_global_finish (struct dead_debug_global
*global
, bitmap used
)
430 if (global
->used
!= used
)
431 BITMAP_FREE (global
->used
);
433 if (global
->htab
.is_created ())
434 global
->htab
.dispose ();
437 /* Add USE to DEBUG, or substitute it right away if it's a pseudo in
438 the global substitution list. USE must be a dead reference to
439 UREGNO in a debug insn. Create a bitmap for DEBUG as needed. */
442 dead_debug_add (struct dead_debug_local
*debug
, df_ref use
, unsigned int uregno
)
444 if (dead_debug_global_replace_temp (debug
->global
, use
, uregno
,
448 struct dead_debug_use
*newddu
= XNEW (struct dead_debug_use
);
451 newddu
->next
= debug
->head
;
452 debug
->head
= newddu
;
455 debug
->used
= BITMAP_ALLOC (NULL
);
457 /* ??? If we dealt with split multi-registers below, we should set
458 all registers for the used mode in case of hardware
460 bitmap_set_bit (debug
->used
, uregno
);
463 /* If UREGNO is referenced by any entry in DEBUG, emit a debug insn
464 before or after INSN (depending on WHERE), that binds a (possibly
465 global) debug temp to the widest-mode use of UREGNO, if WHERE is
466 *_WITH_REG, or the value stored in UREGNO by INSN otherwise, and
467 replace all uses of UREGNO in DEBUG with uses of the debug temp.
468 INSN must be where UREGNO dies, if WHERE is *_BEFORE_*, or where it
469 is set otherwise. Return the number of debug insns emitted. */
472 dead_debug_insert_temp (struct dead_debug_local
*debug
, unsigned int uregno
,
473 rtx insn
, enum debug_temp_where where
)
475 struct dead_debug_use
**tailp
= &debug
->head
;
476 struct dead_debug_use
*cur
;
477 struct dead_debug_use
*uses
= NULL
;
478 struct dead_debug_use
**usesp
= &uses
;
488 global
= (debug
->global
&& debug
->global
->used
489 && bitmap_bit_p (debug
->global
->used
, uregno
));
491 if (!global
&& !bitmap_clear_bit (debug
->used
, uregno
))
494 /* Move all uses of uregno from debug->head to uses, setting mode to
495 the widest referenced mode. */
496 while ((cur
= *tailp
))
498 if (DF_REF_REGNO (cur
->use
) == uregno
)
500 /* If this loc has been changed e.g. to debug_expr already
501 as part of a multi-register use, just drop it. */
502 if (!REG_P (*DF_REF_REAL_LOC (cur
->use
)))
513 || (GET_MODE_BITSIZE (GET_MODE (reg
))
514 < GET_MODE_BITSIZE (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)))))
515 reg
= *DF_REF_REAL_LOC (cur
->use
);
518 tailp
= &(*tailp
)->next
;
521 /* We may have dangling bits in debug->used for registers that were part
522 of a multi-register use, one component of which has been reset. */
525 gcc_checking_assert (!uses
);
533 reg
= regno_reg_rtx
[uregno
];
534 dead_debug_global_entry
*entry
535 = dead_debug_global_find (debug
->global
, reg
);
536 gcc_checking_assert (entry
->reg
== reg
);
540 gcc_checking_assert (uses
|| global
);
543 /* Recover the expression INSN stores in REG. */
544 if (where
== DEBUG_TEMP_BEFORE_WITH_VALUE
)
546 rtx set
= single_set (insn
);
551 dest
= SET_DEST (set
);
553 /* Lose if the REG-setting insn is a CALL. */
554 if (GET_CODE (src
) == CALL
)
566 /* ??? Should we try to extract it from a PARALLEL? */
569 /* Cool, it's the same REG, we can use SRC. */
570 else if (dest
== reg
)
571 breg
= cleanup_auto_inc_dec (src
, VOIDmode
);
572 else if (REG_P (dest
))
574 /* Hmm... Something's fishy, we should be setting REG here. */
575 if (REGNO (dest
) != REGNO (reg
))
577 /* If we're not overwriting all the hardware registers that
578 setting REG in its mode would, we won't know what to bind
579 the debug temp to. ??? We could bind the debug_expr to a
580 CONCAT or PARALLEL with the split multi-registers, and
581 replace them as we found the corresponding sets. */
582 else if (REGNO (reg
) < FIRST_PSEUDO_REGISTER
583 && (hard_regno_nregs
[REGNO (reg
)][GET_MODE (reg
)]
584 != hard_regno_nregs
[REGNO (reg
)][GET_MODE (dest
)]))
586 /* Ok, it's the same (hardware) REG, but with a different
587 mode, so SUBREG it. */
589 breg
= lowpart_subreg (GET_MODE (reg
),
590 cleanup_auto_inc_dec (src
, VOIDmode
),
593 else if (GET_CODE (dest
) == SUBREG
)
595 /* We should be setting REG here. Lose. */
596 if (REGNO (SUBREG_REG (dest
)) != REGNO (reg
))
598 /* Lose if we're setting something other than the lowpart of
600 else if (!subreg_lowpart_p (dest
))
602 /* If we're not overwriting all the hardware registers that
603 setting REG in its mode would, we won't know what to bind
604 the debug temp to. */
605 else if (REGNO (reg
) < FIRST_PSEUDO_REGISTER
606 && (hard_regno_nregs
[REGNO (reg
)][GET_MODE (reg
)]
607 != hard_regno_nregs
[REGNO (reg
)][GET_MODE (dest
)]))
609 /* Yay, we can use SRC, just adjust its mode. */
611 breg
= lowpart_subreg (GET_MODE (reg
),
612 cleanup_auto_inc_dec (src
, VOIDmode
),
615 /* Oh well, we're out of luck. */
619 /* We couldn't figure out the value stored in REG, so reset all
620 of its pending debug uses. */
623 dead_debug_reset_uses (debug
, uses
);
628 /* If there's a single (debug) use of an otherwise unused REG, and
629 the debug use is not part of a larger expression, then it
630 probably doesn't make sense to introduce a new debug temp. */
631 if (where
== DEBUG_TEMP_AFTER_WITH_REG
&& !uses
->next
)
633 rtx next
= DF_REF_INSN (uses
->use
);
635 if (DEBUG_INSN_P (next
) && reg
== INSN_VAR_LOCATION_LOC (next
))
643 /* Create DEBUG_EXPR (and DEBUG_EXPR_DECL). */
644 dval
= make_debug_expr_from_rtl (reg
);
646 /* Emit a debug bind insn before the insn in which reg dies. */
647 bind
= gen_rtx_VAR_LOCATION (GET_MODE (reg
),
648 DEBUG_EXPR_TREE_DECL (dval
), breg
,
649 VAR_INIT_STATUS_INITIALIZED
);
651 if (where
== DEBUG_TEMP_AFTER_WITH_REG
)
652 bind
= emit_debug_insn_after (bind
, insn
);
654 bind
= emit_debug_insn_before (bind
, insn
);
655 df_insn_rescan (bind
);
657 /* Adjust all uses. */
660 if (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)) == GET_MODE (reg
))
661 *DF_REF_REAL_LOC (cur
->use
) = dval
;
663 *DF_REF_REAL_LOC (cur
->use
)
664 = gen_lowpart_SUBREG (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)), dval
);
665 /* ??? Should we simplify subreg of subreg? */
666 if (debug
->to_rescan
== NULL
)
667 debug
->to_rescan
= BITMAP_ALLOC (NULL
);
668 bitmap_set_bit (debug
->to_rescan
, INSN_UID (DF_REF_INSN (cur
->use
)));