1 /* Infrastructure for tracking user variable locations and values
2 throughout compilation.
3 Copyright (C) 2010-2016 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"
33 /* gen_lowpart_no_emit hook implementation for DEBUG_INSNs. In DEBUG_INSNs,
34 all lowpart SUBREGs are valid, despite what the machine requires for
38 gen_lowpart_for_debug (machine_mode mode
, rtx x
)
40 rtx result
= gen_lowpart_if_possible (mode
, x
);
44 if (GET_MODE (x
) != VOIDmode
)
45 return gen_rtx_raw_SUBREG (mode
, x
,
46 subreg_lowpart_offset (mode
, GET_MODE (x
)));
51 /* Replace auto-increment addressing modes with explicit operations to access
52 the same addresses without modifying the corresponding registers. */
55 cleanup_auto_inc_dec (rtx src
, machine_mode mem_mode ATTRIBUTE_UNUSED
)
61 const RTX_CODE code
= GET_CODE (x
);
74 /* SCRATCH must be shared because they represent distinct values. */
77 /* Share clobbers of hard registers (like cc0), but do not share pseudo reg
78 clobbers or clobbers of hard registers that originated as pseudos.
79 This is needed to allow safe register renaming. */
80 if (REG_P (XEXP (x
, 0)) && REGNO (XEXP (x
, 0)) < FIRST_PSEUDO_REGISTER
81 && ORIGINAL_REGNO (XEXP (x
, 0)) == REGNO (XEXP (x
, 0)))
86 if (shared_const_p (x
))
91 mem_mode
= GET_MODE (x
);
96 gcc_assert (mem_mode
!= VOIDmode
&& mem_mode
!= BLKmode
);
97 return gen_rtx_PLUS (GET_MODE (x
),
98 cleanup_auto_inc_dec (XEXP (x
, 0), mem_mode
),
99 gen_int_mode (code
== PRE_INC
100 ? GET_MODE_SIZE (mem_mode
)
101 : -GET_MODE_SIZE (mem_mode
),
108 return cleanup_auto_inc_dec (code
== PRE_MODIFY
109 ? XEXP (x
, 1) : XEXP (x
, 0),
116 /* Copy the various flags, fields, and other information. We assume
117 that all fields need copying, and then clear the fields that should
118 not be copied. That is the sensible default behavior, and forces
119 us to explicitly document why we are *not* copying a flag. */
120 x
= shallow_copy_rtx (x
);
122 /* We do not copy the USED flag, which is used as a mark bit during
123 walks over the RTL. */
124 RTX_FLAG (x
, used
) = 0;
126 /* We do not copy FRAME_RELATED for INSNs. */
128 RTX_FLAG (x
, frame_related
) = 0;
130 fmt
= GET_RTX_FORMAT (code
);
131 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
133 XEXP (x
, i
) = cleanup_auto_inc_dec (XEXP (x
, i
), mem_mode
);
134 else if (fmt
[i
] == 'E' || fmt
[i
] == 'V')
137 XVEC (x
, i
) = rtvec_alloc (XVECLEN (x
, i
));
138 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
140 = cleanup_auto_inc_dec (XVECEXP (src
, i
, j
), mem_mode
);
146 /* Auxiliary data structure for propagate_for_debug_stmt. */
148 struct rtx_subst_pair
154 /* DATA points to an rtx_subst_pair. Return the value that should be
158 propagate_for_debug_subst (rtx from
, const_rtx old_rtx
, void *data
)
160 struct rtx_subst_pair
*pair
= (struct rtx_subst_pair
*)data
;
162 if (!rtx_equal_p (from
, old_rtx
))
166 pair
->adjusted
= true;
167 pair
->to
= cleanup_auto_inc_dec (pair
->to
, VOIDmode
);
168 pair
->to
= make_compound_operation (pair
->to
, SET
);
171 return copy_rtx (pair
->to
);
174 /* Replace all the occurrences of DEST with SRC in DEBUG_INSNs between INSN
175 and LAST, not including INSN, but including LAST. Also stop at the end
176 of THIS_BASIC_BLOCK. */
179 propagate_for_debug (rtx_insn
*insn
, rtx_insn
*last
, rtx dest
, rtx src
,
180 basic_block this_basic_block
)
182 rtx_insn
*next
, *end
= NEXT_INSN (BB_END (this_basic_block
));
184 rtx (*saved_rtl_hook_no_emit
) (machine_mode
, rtx
);
186 struct rtx_subst_pair p
;
190 next
= NEXT_INSN (insn
);
191 last
= NEXT_INSN (last
);
192 saved_rtl_hook_no_emit
= rtl_hooks
.gen_lowpart_no_emit
;
193 rtl_hooks
.gen_lowpart_no_emit
= gen_lowpart_for_debug
;
194 while (next
!= last
&& next
!= end
)
197 next
= NEXT_INSN (insn
);
198 if (DEBUG_INSN_P (insn
))
200 loc
= simplify_replace_fn_rtx (INSN_VAR_LOCATION_LOC (insn
),
201 dest
, propagate_for_debug_subst
, &p
);
202 if (loc
== INSN_VAR_LOCATION_LOC (insn
))
204 INSN_VAR_LOCATION_LOC (insn
) = loc
;
205 df_insn_rescan (insn
);
208 rtl_hooks
.gen_lowpart_no_emit
= saved_rtl_hook_no_emit
;
211 /* Initialize DEBUG to an empty list, and clear USED, if given. */
214 dead_debug_global_init (struct dead_debug_global
*debug
, bitmap used
)
222 /* Initialize DEBUG to an empty list, and clear USED, if given. Link
223 back to GLOBAL, if given, and bring in used bits from it. */
226 dead_debug_local_init (struct dead_debug_local
*debug
, bitmap used
,
227 struct dead_debug_global
*global
)
229 if (!used
&& global
&& global
->used
)
230 used
= BITMAP_ALLOC (NULL
);
233 debug
->global
= global
;
235 debug
->to_rescan
= NULL
;
239 if (global
&& global
->used
)
240 bitmap_copy (used
, global
->used
);
246 /* Locate the entry for REG in GLOBAL->htab. */
248 static dead_debug_global_entry
*
249 dead_debug_global_find (struct dead_debug_global
*global
, rtx reg
)
251 dead_debug_global_entry temp_entry
;
252 temp_entry
.reg
= reg
;
254 dead_debug_global_entry
*entry
= global
->htab
->find (&temp_entry
);
255 gcc_checking_assert (entry
&& entry
->reg
== temp_entry
.reg
);
260 /* Insert an entry mapping REG to DTEMP in GLOBAL->htab. */
262 static dead_debug_global_entry
*
263 dead_debug_global_insert (struct dead_debug_global
*global
, rtx reg
, rtx dtemp
)
265 dead_debug_global_entry temp_entry
;
266 temp_entry
.reg
= reg
;
267 temp_entry
.dtemp
= dtemp
;
270 global
->htab
= new hash_table
<dead_debug_hash_descr
> (31);
272 dead_debug_global_entry
**slot
= global
->htab
->find_slot (&temp_entry
,
274 gcc_checking_assert (!*slot
);
275 *slot
= XNEW (dead_debug_global_entry
);
280 /* If UREGNO, referenced by USE, is a pseudo marked as used in GLOBAL,
281 replace it with a USE of the debug temp recorded for it, and
282 return TRUE. Otherwise, just return FALSE.
284 If PTO_RESCAN is given, instead of rescanning modified INSNs right
285 away, add their UIDs to the bitmap, allocating one of *PTO_RESCAN
289 dead_debug_global_replace_temp (struct dead_debug_global
*global
,
290 df_ref use
, unsigned int uregno
,
293 if (!global
|| uregno
< FIRST_PSEUDO_REGISTER
295 || !REG_P (*DF_REF_REAL_LOC (use
))
296 || REGNO (*DF_REF_REAL_LOC (use
)) != uregno
297 || !bitmap_bit_p (global
->used
, uregno
))
300 dead_debug_global_entry
*entry
301 = dead_debug_global_find (global
, *DF_REF_REAL_LOC (use
));
302 gcc_checking_assert (GET_CODE (entry
->reg
) == REG
303 && REGNO (entry
->reg
) == uregno
);
308 *DF_REF_REAL_LOC (use
) = entry
->dtemp
;
310 df_insn_rescan (DF_REF_INSN (use
));
314 *pto_rescan
= BITMAP_ALLOC (NULL
);
315 bitmap_set_bit (*pto_rescan
, INSN_UID (DF_REF_INSN (use
)));
321 /* Reset all debug uses in HEAD, and clear DEBUG->to_rescan bits of
322 each reset insn. DEBUG is not otherwise modified. If HEAD is
323 DEBUG->head, DEBUG->head will be set to NULL at the end.
324 Otherwise, entries from DEBUG->head that pertain to reset insns
325 will be removed, and only then rescanned. */
328 dead_debug_reset_uses (struct dead_debug_local
*debug
,
329 struct dead_debug_use
*head
)
331 bool got_head
= (debug
->head
== head
);
333 struct dead_debug_use
**tailp
= &debug
->head
;
334 struct dead_debug_use
*cur
;
341 rescan
= BITMAP_ALLOC (NULL
);
345 struct dead_debug_use
*next
= head
->next
;
348 insn
= DF_REF_INSN (head
->use
);
349 if (!next
|| DF_REF_INSN (next
->use
) != insn
)
351 INSN_VAR_LOCATION_LOC (insn
) = gen_rtx_UNKNOWN_VAR_LOC ();
353 df_insn_rescan_debug_internal (insn
);
355 bitmap_set_bit (rescan
, INSN_UID (insn
));
356 if (debug
->to_rescan
)
357 bitmap_clear_bit (debug
->to_rescan
, INSN_UID (insn
));
369 while ((cur
= *tailp
))
370 if (bitmap_bit_p (rescan
, INSN_UID (DF_REF_INSN (cur
->use
))))
378 EXECUTE_IF_SET_IN_BITMAP (rescan
, 0, uid
, bi
)
380 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
382 df_insn_rescan_debug_internal (insn_info
->insn
);
385 BITMAP_FREE (rescan
);
388 /* Promote pending local uses of pseudos in DEBUG to global
389 substitutions. Uses of non-pseudos are left alone for
393 dead_debug_promote_uses (struct dead_debug_local
*debug
)
395 for (struct dead_debug_use
*head
= debug
->head
, **headp
= &debug
->head
;
398 rtx reg
= *DF_REF_REAL_LOC (head
->use
);
400 dead_debug_global_entry
*entry
;
402 if (GET_CODE (reg
) != REG
403 || REGNO (reg
) < FIRST_PSEUDO_REGISTER
)
409 if (!debug
->global
->used
)
410 debug
->global
->used
= BITMAP_ALLOC (NULL
);
412 bool added
= bitmap_set_bit (debug
->global
->used
, REGNO (reg
));
413 gcc_checking_assert (added
);
415 entry
= dead_debug_global_insert (debug
->global
, reg
,
416 make_debug_expr_from_rtl (reg
));
418 gcc_checking_assert (entry
->dtemp
);
420 /* Tentatively remove the USE from the list. */
423 if (!debug
->to_rescan
)
424 debug
->to_rescan
= BITMAP_ALLOC (NULL
);
426 for (ref
= DF_REG_USE_CHAIN (REGNO (reg
)); ref
;
427 ref
= DF_REF_NEXT_REG (ref
))
428 if (DEBUG_INSN_P (DF_REF_INSN (ref
)))
430 if (!dead_debug_global_replace_temp (debug
->global
, ref
,
434 rtx_insn
*insn
= DF_REF_INSN (ref
);
435 INSN_VAR_LOCATION_LOC (insn
) = gen_rtx_UNKNOWN_VAR_LOC ();
436 bitmap_set_bit (debug
->to_rescan
, INSN_UID (insn
));
440 for (ref
= DF_REG_DEF_CHAIN (REGNO (reg
)); ref
;
441 ref
= DF_REF_NEXT_REG (ref
))
442 if (!dead_debug_insert_temp (debug
, REGNO (reg
), DF_REF_INSN (ref
),
443 DEBUG_TEMP_BEFORE_WITH_VALUE
))
446 bind
= gen_rtx_VAR_LOCATION (GET_MODE (reg
),
447 DEBUG_EXPR_TREE_DECL (entry
->dtemp
),
448 gen_rtx_UNKNOWN_VAR_LOC (),
449 VAR_INIT_STATUS_INITIALIZED
);
450 rtx_insn
*insn
= emit_debug_insn_before (bind
, DF_REF_INSN (ref
));
451 bitmap_set_bit (debug
->to_rescan
, INSN_UID (insn
));
459 /* Reset all debug insns with pending uses. Release the bitmap in it,
460 unless it is USED. USED must be the same bitmap passed to
461 dead_debug_local_init. */
464 dead_debug_local_finish (struct dead_debug_local
*debug
, bitmap used
)
467 dead_debug_promote_uses (debug
);
469 if (debug
->used
!= used
)
470 BITMAP_FREE (debug
->used
);
472 dead_debug_reset_uses (debug
, debug
->head
);
474 if (debug
->to_rescan
)
479 EXECUTE_IF_SET_IN_BITMAP (debug
->to_rescan
, 0, uid
, bi
)
481 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
483 df_insn_rescan (insn_info
->insn
);
485 BITMAP_FREE (debug
->to_rescan
);
489 /* Release GLOBAL->used unless it is the same as USED. Release the
490 mapping hash table if it was initialized. */
493 dead_debug_global_finish (struct dead_debug_global
*global
, bitmap used
)
495 if (global
->used
!= used
)
496 BITMAP_FREE (global
->used
);
502 /* Add USE to DEBUG, or substitute it right away if it's a pseudo in
503 the global substitution list. USE must be a dead reference to
504 UREGNO in a debug insn. Create a bitmap for DEBUG as needed. */
507 dead_debug_add (struct dead_debug_local
*debug
, df_ref use
, unsigned int uregno
)
509 if (dead_debug_global_replace_temp (debug
->global
, use
, uregno
,
513 struct dead_debug_use
*newddu
= XNEW (struct dead_debug_use
);
516 newddu
->next
= debug
->head
;
517 debug
->head
= newddu
;
520 debug
->used
= BITMAP_ALLOC (NULL
);
522 /* ??? If we dealt with split multi-registers below, we should set
523 all registers for the used mode in case of hardware
525 bitmap_set_bit (debug
->used
, uregno
);
528 /* Like lowpart_subreg, but if a subreg is not valid for machine, force
529 it anyway - for use in debug insns. */
532 debug_lowpart_subreg (machine_mode outer_mode
, rtx expr
,
533 machine_mode inner_mode
)
535 if (inner_mode
== VOIDmode
)
536 inner_mode
= GET_MODE (expr
);
537 int offset
= subreg_lowpart_offset (outer_mode
, inner_mode
);
538 rtx ret
= simplify_gen_subreg (outer_mode
, expr
, inner_mode
, offset
);
541 return gen_rtx_raw_SUBREG (outer_mode
, expr
, offset
);
544 /* If UREGNO is referenced by any entry in DEBUG, emit a debug insn
545 before or after INSN (depending on WHERE), that binds a (possibly
546 global) debug temp to the widest-mode use of UREGNO, if WHERE is
547 *_WITH_REG, or the value stored in UREGNO by INSN otherwise, and
548 replace all uses of UREGNO in DEBUG with uses of the debug temp.
549 INSN must be where UREGNO dies, if WHERE is *_BEFORE_*, or where it
550 is set otherwise. Return the number of debug insns emitted. */
553 dead_debug_insert_temp (struct dead_debug_local
*debug
, unsigned int uregno
,
554 rtx_insn
*insn
, enum debug_temp_where where
)
556 struct dead_debug_use
**tailp
= &debug
->head
;
557 struct dead_debug_use
*cur
;
558 struct dead_debug_use
*uses
= NULL
;
559 struct dead_debug_use
**usesp
= &uses
;
569 global
= (debug
->global
&& debug
->global
->used
570 && bitmap_bit_p (debug
->global
->used
, uregno
));
572 if (!global
&& !bitmap_clear_bit (debug
->used
, uregno
))
575 /* Move all uses of uregno from debug->head to uses, setting mode to
576 the widest referenced mode. */
577 while ((cur
= *tailp
))
579 if (DF_REF_REGNO (cur
->use
) == uregno
)
581 /* If this loc has been changed e.g. to debug_expr already
582 as part of a multi-register use, just drop it. */
583 if (!REG_P (*DF_REF_REAL_LOC (cur
->use
)))
594 || (GET_MODE_BITSIZE (GET_MODE (reg
))
595 < GET_MODE_BITSIZE (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)))))
596 reg
= *DF_REF_REAL_LOC (cur
->use
);
599 tailp
= &(*tailp
)->next
;
602 /* We may have dangling bits in debug->used for registers that were part
603 of a multi-register use, one component of which has been reset. */
606 gcc_checking_assert (!uses
);
614 reg
= regno_reg_rtx
[uregno
];
615 dead_debug_global_entry
*entry
616 = dead_debug_global_find (debug
->global
, reg
);
617 gcc_checking_assert (entry
->reg
== reg
);
623 gcc_checking_assert (uses
|| global
);
626 /* Recover the expression INSN stores in REG. */
627 if (where
== DEBUG_TEMP_BEFORE_WITH_VALUE
)
629 rtx set
= single_set (insn
);
634 dest
= SET_DEST (set
);
636 /* Lose if the REG-setting insn is a CALL. */
637 if (GET_CODE (src
) == CALL
)
649 /* ??? Should we try to extract it from a PARALLEL? */
652 /* Cool, it's the same REG, we can use SRC. */
653 else if (dest
== reg
)
654 breg
= cleanup_auto_inc_dec (src
, VOIDmode
);
655 else if (REG_P (dest
))
657 /* Hmm... Something's fishy, we should be setting REG here. */
658 if (REGNO (dest
) != REGNO (reg
))
660 /* If we're not overwriting all the hardware registers that
661 setting REG in its mode would, we won't know what to bind
662 the debug temp to. ??? We could bind the debug_expr to a
663 CONCAT or PARALLEL with the split multi-registers, and
664 replace them as we found the corresponding sets. */
665 else if (REG_NREGS (reg
) != REG_NREGS (dest
))
667 /* Ok, it's the same (hardware) REG, but with a different
668 mode, so SUBREG it. */
670 breg
= debug_lowpart_subreg (GET_MODE (reg
),
671 cleanup_auto_inc_dec (src
, VOIDmode
),
674 else if (GET_CODE (dest
) == SUBREG
)
676 /* We should be setting REG here. Lose. */
677 if (REGNO (SUBREG_REG (dest
)) != REGNO (reg
))
679 /* Lose if we're setting something other than the lowpart of
681 else if (!subreg_lowpart_p (dest
))
683 /* If we're not overwriting all the hardware registers that
684 setting REG in its mode would, we won't know what to bind
685 the debug temp to. */
686 else if (REGNO (reg
) < FIRST_PSEUDO_REGISTER
688 != hard_regno_nregs
[REGNO (reg
)][GET_MODE (dest
)]))
690 /* Yay, we can use SRC, just adjust its mode. */
692 breg
= debug_lowpart_subreg (GET_MODE (reg
),
693 cleanup_auto_inc_dec (src
, VOIDmode
),
696 /* Oh well, we're out of luck. */
700 /* We couldn't figure out the value stored in REG, so reset all
701 of its pending debug uses. */
704 dead_debug_reset_uses (debug
, uses
);
709 /* If there's a single (debug) use of an otherwise unused REG, and
710 the debug use is not part of a larger expression, then it
711 probably doesn't make sense to introduce a new debug temp. */
712 if (where
== DEBUG_TEMP_AFTER_WITH_REG
&& !uses
->next
)
714 rtx_insn
*next
= DF_REF_INSN (uses
->use
);
716 if (DEBUG_INSN_P (next
) && reg
== INSN_VAR_LOCATION_LOC (next
))
724 /* Create DEBUG_EXPR (and DEBUG_EXPR_DECL). */
725 dval
= make_debug_expr_from_rtl (reg
);
727 /* Emit a debug bind insn before the insn in which reg dies. */
728 bind
= gen_rtx_VAR_LOCATION (GET_MODE (reg
),
729 DEBUG_EXPR_TREE_DECL (dval
), breg
,
730 VAR_INIT_STATUS_INITIALIZED
);
732 if (where
== DEBUG_TEMP_AFTER_WITH_REG
733 || where
== DEBUG_TEMP_AFTER_WITH_REG_FORCE
)
734 bind
= emit_debug_insn_after (bind
, insn
);
736 bind
= emit_debug_insn_before (bind
, insn
);
737 if (debug
->to_rescan
== NULL
)
738 debug
->to_rescan
= BITMAP_ALLOC (NULL
);
739 bitmap_set_bit (debug
->to_rescan
, INSN_UID (bind
));
741 /* Adjust all uses. */
744 if (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)) == GET_MODE (reg
))
745 *DF_REF_REAL_LOC (cur
->use
) = dval
;
747 *DF_REF_REAL_LOC (cur
->use
)
748 = debug_lowpart_subreg (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)), dval
,
750 /* ??? Should we simplify subreg of subreg? */
751 bitmap_set_bit (debug
->to_rescan
, INSN_UID (DF_REF_INSN (cur
->use
)));