1 /* Infrastructure for tracking user variable locations and values
2 throughout compilation.
3 Copyright (C) 2010-2015 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"
28 #include "basic-block.h"
33 #include "hard-reg-set.h"
39 /* gen_lowpart_no_emit hook implementation for DEBUG_INSNs. In DEBUG_INSNs,
40 all lowpart SUBREGs are valid, despite what the machine requires for
44 gen_lowpart_for_debug (machine_mode mode
, rtx x
)
46 rtx result
= gen_lowpart_if_possible (mode
, x
);
50 if (GET_MODE (x
) != VOIDmode
)
51 return gen_rtx_raw_SUBREG (mode
, x
,
52 subreg_lowpart_offset (mode
, GET_MODE (x
)));
57 /* Replace auto-increment addressing modes with explicit operations to access
58 the same addresses without modifying the corresponding registers. */
61 cleanup_auto_inc_dec (rtx src
, machine_mode mem_mode ATTRIBUTE_UNUSED
)
65 const RTX_CODE code
= GET_CODE (x
);
78 /* SCRATCH must be shared because they represent distinct values. */
81 /* Share clobbers of hard registers (like cc0), but do not share pseudo reg
82 clobbers or clobbers of hard registers that originated as pseudos.
83 This is needed to allow safe register renaming. */
84 if (REG_P (XEXP (x
, 0)) && REGNO (XEXP (x
, 0)) < FIRST_PSEUDO_REGISTER
85 && ORIGINAL_REGNO (XEXP (x
, 0)) == REGNO (XEXP (x
, 0)))
90 if (shared_const_p (x
))
95 mem_mode
= GET_MODE (x
);
100 gcc_assert (mem_mode
!= VOIDmode
&& mem_mode
!= BLKmode
);
101 return gen_rtx_PLUS (GET_MODE (x
),
102 cleanup_auto_inc_dec (XEXP (x
, 0), mem_mode
),
103 gen_int_mode (code
== PRE_INC
104 ? GET_MODE_SIZE (mem_mode
)
105 : -GET_MODE_SIZE (mem_mode
),
112 return cleanup_auto_inc_dec (code
== PRE_MODIFY
113 ? XEXP (x
, 1) : XEXP (x
, 0),
120 /* Copy the various flags, fields, and other information. We assume
121 that all fields need copying, and then clear the fields that should
122 not be copied. That is the sensible default behavior, and forces
123 us to explicitly document why we are *not* copying a flag. */
124 x
= shallow_copy_rtx (x
);
126 /* We do not copy the USED flag, which is used as a mark bit during
127 walks over the RTL. */
128 RTX_FLAG (x
, used
) = 0;
130 /* We do not copy FRAME_RELATED for INSNs. */
132 RTX_FLAG (x
, frame_related
) = 0;
134 fmt
= GET_RTX_FORMAT (code
);
135 for (i
= GET_RTX_LENGTH (code
) - 1; i
>= 0; i
--)
137 XEXP (x
, i
) = cleanup_auto_inc_dec (XEXP (x
, i
), mem_mode
);
138 else if (fmt
[i
] == 'E' || fmt
[i
] == 'V')
141 XVEC (x
, i
) = rtvec_alloc (XVECLEN (x
, i
));
142 for (j
= 0; j
< XVECLEN (x
, i
); j
++)
144 = cleanup_auto_inc_dec (XVECEXP (src
, i
, j
), mem_mode
);
147 #else /* !AUTO_INC_DEC */
149 #endif /* !AUTO_INC_DEC */
154 /* Auxiliary data structure for propagate_for_debug_stmt. */
156 struct rtx_subst_pair
162 /* DATA points to an rtx_subst_pair. Return the value that should be
166 propagate_for_debug_subst (rtx from
, const_rtx old_rtx
, void *data
)
168 struct rtx_subst_pair
*pair
= (struct rtx_subst_pair
*)data
;
170 if (!rtx_equal_p (from
, old_rtx
))
174 pair
->adjusted
= true;
175 pair
->to
= cleanup_auto_inc_dec (pair
->to
, VOIDmode
);
176 pair
->to
= make_compound_operation (pair
->to
, SET
);
179 return copy_rtx (pair
->to
);
182 /* Replace all the occurrences of DEST with SRC in DEBUG_INSNs between INSN
183 and LAST, not including INSN, but including LAST. Also stop at the end
184 of THIS_BASIC_BLOCK. */
187 propagate_for_debug (rtx_insn
*insn
, rtx_insn
*last
, rtx dest
, rtx src
,
188 basic_block this_basic_block
)
190 rtx_insn
*next
, *end
= NEXT_INSN (BB_END (this_basic_block
));
192 rtx (*saved_rtl_hook_no_emit
) (machine_mode
, rtx
);
194 struct rtx_subst_pair p
;
198 next
= NEXT_INSN (insn
);
199 last
= NEXT_INSN (last
);
200 saved_rtl_hook_no_emit
= rtl_hooks
.gen_lowpart_no_emit
;
201 rtl_hooks
.gen_lowpart_no_emit
= gen_lowpart_for_debug
;
202 while (next
!= last
&& next
!= end
)
205 next
= NEXT_INSN (insn
);
206 if (DEBUG_INSN_P (insn
))
208 loc
= simplify_replace_fn_rtx (INSN_VAR_LOCATION_LOC (insn
),
209 dest
, propagate_for_debug_subst
, &p
);
210 if (loc
== INSN_VAR_LOCATION_LOC (insn
))
212 INSN_VAR_LOCATION_LOC (insn
) = loc
;
213 df_insn_rescan (insn
);
216 rtl_hooks
.gen_lowpart_no_emit
= saved_rtl_hook_no_emit
;
219 /* Initialize DEBUG to an empty list, and clear USED, if given. */
222 dead_debug_global_init (struct dead_debug_global
*debug
, bitmap used
)
230 /* Initialize DEBUG to an empty list, and clear USED, if given. Link
231 back to GLOBAL, if given, and bring in used bits from it. */
234 dead_debug_local_init (struct dead_debug_local
*debug
, bitmap used
,
235 struct dead_debug_global
*global
)
237 if (!used
&& global
&& global
->used
)
238 used
= BITMAP_ALLOC (NULL
);
241 debug
->global
= global
;
243 debug
->to_rescan
= NULL
;
247 if (global
&& global
->used
)
248 bitmap_copy (used
, global
->used
);
254 /* Locate the entry for REG in GLOBAL->htab. */
256 static dead_debug_global_entry
*
257 dead_debug_global_find (struct dead_debug_global
*global
, rtx reg
)
259 dead_debug_global_entry temp_entry
;
260 temp_entry
.reg
= reg
;
262 dead_debug_global_entry
*entry
= global
->htab
->find (&temp_entry
);
263 gcc_checking_assert (entry
&& entry
->reg
== temp_entry
.reg
);
268 /* Insert an entry mapping REG to DTEMP in GLOBAL->htab. */
270 static dead_debug_global_entry
*
271 dead_debug_global_insert (struct dead_debug_global
*global
, rtx reg
, rtx dtemp
)
273 dead_debug_global_entry temp_entry
;
274 temp_entry
.reg
= reg
;
275 temp_entry
.dtemp
= dtemp
;
278 global
->htab
= new hash_table
<dead_debug_hash_descr
> (31);
280 dead_debug_global_entry
**slot
= global
->htab
->find_slot (&temp_entry
,
282 gcc_checking_assert (!*slot
);
283 *slot
= XNEW (dead_debug_global_entry
);
288 /* If UREGNO, referenced by USE, is a pseudo marked as used in GLOBAL,
289 replace it with with a USE of the debug temp recorded for it, and
290 return TRUE. Otherwise, just return FALSE.
292 If PTO_RESCAN is given, instead of rescanning modified INSNs right
293 away, add their UIDs to the bitmap, allocating one of *PTO_RESCAN
297 dead_debug_global_replace_temp (struct dead_debug_global
*global
,
298 df_ref use
, unsigned int uregno
,
301 if (!global
|| uregno
< FIRST_PSEUDO_REGISTER
303 || !REG_P (*DF_REF_REAL_LOC (use
))
304 || REGNO (*DF_REF_REAL_LOC (use
)) != uregno
305 || !bitmap_bit_p (global
->used
, uregno
))
308 dead_debug_global_entry
*entry
309 = dead_debug_global_find (global
, *DF_REF_REAL_LOC (use
));
310 gcc_checking_assert (GET_CODE (entry
->reg
) == REG
311 && REGNO (entry
->reg
) == uregno
);
316 *DF_REF_REAL_LOC (use
) = entry
->dtemp
;
318 df_insn_rescan (DF_REF_INSN (use
));
322 *pto_rescan
= BITMAP_ALLOC (NULL
);
323 bitmap_set_bit (*pto_rescan
, INSN_UID (DF_REF_INSN (use
)));
329 /* Reset all debug uses in HEAD, and clear DEBUG->to_rescan bits of
330 each reset insn. DEBUG is not otherwise modified. If HEAD is
331 DEBUG->head, DEBUG->head will be set to NULL at the end.
332 Otherwise, entries from DEBUG->head that pertain to reset insns
333 will be removed, and only then rescanned. */
336 dead_debug_reset_uses (struct dead_debug_local
*debug
,
337 struct dead_debug_use
*head
)
339 bool got_head
= (debug
->head
== head
);
341 struct dead_debug_use
**tailp
= &debug
->head
;
342 struct dead_debug_use
*cur
;
349 rescan
= BITMAP_ALLOC (NULL
);
353 struct dead_debug_use
*next
= head
->next
;
356 insn
= DF_REF_INSN (head
->use
);
357 if (!next
|| DF_REF_INSN (next
->use
) != insn
)
359 INSN_VAR_LOCATION_LOC (insn
) = gen_rtx_UNKNOWN_VAR_LOC ();
361 df_insn_rescan_debug_internal (insn
);
363 bitmap_set_bit (rescan
, INSN_UID (insn
));
364 if (debug
->to_rescan
)
365 bitmap_clear_bit (debug
->to_rescan
, INSN_UID (insn
));
377 while ((cur
= *tailp
))
378 if (bitmap_bit_p (rescan
, INSN_UID (DF_REF_INSN (cur
->use
))))
386 EXECUTE_IF_SET_IN_BITMAP (rescan
, 0, uid
, bi
)
388 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
390 df_insn_rescan_debug_internal (insn_info
->insn
);
393 BITMAP_FREE (rescan
);
396 /* Promote pending local uses of pseudos in DEBUG to global
397 substitutions. Uses of non-pseudos are left alone for
401 dead_debug_promote_uses (struct dead_debug_local
*debug
)
403 for (struct dead_debug_use
*head
= debug
->head
, **headp
= &debug
->head
;
406 rtx reg
= *DF_REF_REAL_LOC (head
->use
);
408 dead_debug_global_entry
*entry
;
410 if (GET_CODE (reg
) != REG
411 || REGNO (reg
) < FIRST_PSEUDO_REGISTER
)
417 if (!debug
->global
->used
)
418 debug
->global
->used
= BITMAP_ALLOC (NULL
);
420 bool added
= bitmap_set_bit (debug
->global
->used
, REGNO (reg
));
421 gcc_checking_assert (added
);
423 entry
= dead_debug_global_insert (debug
->global
, reg
,
424 make_debug_expr_from_rtl (reg
));
426 gcc_checking_assert (entry
->dtemp
);
428 /* Tentatively remove the USE from the list. */
431 if (!debug
->to_rescan
)
432 debug
->to_rescan
= BITMAP_ALLOC (NULL
);
434 for (ref
= DF_REG_USE_CHAIN (REGNO (reg
)); ref
;
435 ref
= DF_REF_NEXT_REG (ref
))
436 if (DEBUG_INSN_P (DF_REF_INSN (ref
)))
438 if (!dead_debug_global_replace_temp (debug
->global
, ref
,
442 rtx_insn
*insn
= DF_REF_INSN (ref
);
443 INSN_VAR_LOCATION_LOC (insn
) = gen_rtx_UNKNOWN_VAR_LOC ();
444 bitmap_set_bit (debug
->to_rescan
, INSN_UID (insn
));
448 for (ref
= DF_REG_DEF_CHAIN (REGNO (reg
)); ref
;
449 ref
= DF_REF_NEXT_REG (ref
))
450 if (!dead_debug_insert_temp (debug
, REGNO (reg
), DF_REF_INSN (ref
),
451 DEBUG_TEMP_BEFORE_WITH_VALUE
))
454 bind
= gen_rtx_VAR_LOCATION (GET_MODE (reg
),
455 DEBUG_EXPR_TREE_DECL (entry
->dtemp
),
456 gen_rtx_UNKNOWN_VAR_LOC (),
457 VAR_INIT_STATUS_INITIALIZED
);
458 rtx_insn
*insn
= emit_debug_insn_before (bind
, DF_REF_INSN (ref
));
459 bitmap_set_bit (debug
->to_rescan
, INSN_UID (insn
));
467 /* Reset all debug insns with pending uses. Release the bitmap in it,
468 unless it is USED. USED must be the same bitmap passed to
469 dead_debug_local_init. */
472 dead_debug_local_finish (struct dead_debug_local
*debug
, bitmap used
)
475 dead_debug_promote_uses (debug
);
477 if (debug
->used
!= used
)
478 BITMAP_FREE (debug
->used
);
480 dead_debug_reset_uses (debug
, debug
->head
);
482 if (debug
->to_rescan
)
487 EXECUTE_IF_SET_IN_BITMAP (debug
->to_rescan
, 0, uid
, bi
)
489 struct df_insn_info
*insn_info
= DF_INSN_UID_SAFE_GET (uid
);
491 df_insn_rescan (insn_info
->insn
);
493 BITMAP_FREE (debug
->to_rescan
);
497 /* Release GLOBAL->used unless it is the same as USED. Release the
498 mapping hash table if it was initialized. */
501 dead_debug_global_finish (struct dead_debug_global
*global
, bitmap used
)
503 if (global
->used
!= used
)
504 BITMAP_FREE (global
->used
);
510 /* Add USE to DEBUG, or substitute it right away if it's a pseudo in
511 the global substitution list. USE must be a dead reference to
512 UREGNO in a debug insn. Create a bitmap for DEBUG as needed. */
515 dead_debug_add (struct dead_debug_local
*debug
, df_ref use
, unsigned int uregno
)
517 if (dead_debug_global_replace_temp (debug
->global
, use
, uregno
,
521 struct dead_debug_use
*newddu
= XNEW (struct dead_debug_use
);
524 newddu
->next
= debug
->head
;
525 debug
->head
= newddu
;
528 debug
->used
= BITMAP_ALLOC (NULL
);
530 /* ??? If we dealt with split multi-registers below, we should set
531 all registers for the used mode in case of hardware
533 bitmap_set_bit (debug
->used
, uregno
);
536 /* Like lowpart_subreg, but if a subreg is not valid for machine, force
537 it anyway - for use in debug insns. */
540 debug_lowpart_subreg (machine_mode outer_mode
, rtx expr
,
541 machine_mode inner_mode
)
543 if (inner_mode
== VOIDmode
)
544 inner_mode
= GET_MODE (expr
);
545 int offset
= subreg_lowpart_offset (outer_mode
, inner_mode
);
546 rtx ret
= simplify_gen_subreg (outer_mode
, expr
, inner_mode
, offset
);
549 return gen_rtx_raw_SUBREG (outer_mode
, expr
, offset
);
552 /* If UREGNO is referenced by any entry in DEBUG, emit a debug insn
553 before or after INSN (depending on WHERE), that binds a (possibly
554 global) debug temp to the widest-mode use of UREGNO, if WHERE is
555 *_WITH_REG, or the value stored in UREGNO by INSN otherwise, and
556 replace all uses of UREGNO in DEBUG with uses of the debug temp.
557 INSN must be where UREGNO dies, if WHERE is *_BEFORE_*, or where it
558 is set otherwise. Return the number of debug insns emitted. */
561 dead_debug_insert_temp (struct dead_debug_local
*debug
, unsigned int uregno
,
562 rtx_insn
*insn
, enum debug_temp_where where
)
564 struct dead_debug_use
**tailp
= &debug
->head
;
565 struct dead_debug_use
*cur
;
566 struct dead_debug_use
*uses
= NULL
;
567 struct dead_debug_use
**usesp
= &uses
;
577 global
= (debug
->global
&& debug
->global
->used
578 && bitmap_bit_p (debug
->global
->used
, uregno
));
580 if (!global
&& !bitmap_clear_bit (debug
->used
, uregno
))
583 /* Move all uses of uregno from debug->head to uses, setting mode to
584 the widest referenced mode. */
585 while ((cur
= *tailp
))
587 if (DF_REF_REGNO (cur
->use
) == uregno
)
589 /* If this loc has been changed e.g. to debug_expr already
590 as part of a multi-register use, just drop it. */
591 if (!REG_P (*DF_REF_REAL_LOC (cur
->use
)))
602 || (GET_MODE_BITSIZE (GET_MODE (reg
))
603 < GET_MODE_BITSIZE (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)))))
604 reg
= *DF_REF_REAL_LOC (cur
->use
);
607 tailp
= &(*tailp
)->next
;
610 /* We may have dangling bits in debug->used for registers that were part
611 of a multi-register use, one component of which has been reset. */
614 gcc_checking_assert (!uses
);
622 reg
= regno_reg_rtx
[uregno
];
623 dead_debug_global_entry
*entry
624 = dead_debug_global_find (debug
->global
, reg
);
625 gcc_checking_assert (entry
->reg
== reg
);
631 gcc_checking_assert (uses
|| global
);
634 /* Recover the expression INSN stores in REG. */
635 if (where
== DEBUG_TEMP_BEFORE_WITH_VALUE
)
637 rtx set
= single_set (insn
);
642 dest
= SET_DEST (set
);
644 /* Lose if the REG-setting insn is a CALL. */
645 if (GET_CODE (src
) == CALL
)
657 /* ??? Should we try to extract it from a PARALLEL? */
660 /* Cool, it's the same REG, we can use SRC. */
661 else if (dest
== reg
)
662 breg
= cleanup_auto_inc_dec (src
, VOIDmode
);
663 else if (REG_P (dest
))
665 /* Hmm... Something's fishy, we should be setting REG here. */
666 if (REGNO (dest
) != REGNO (reg
))
668 /* If we're not overwriting all the hardware registers that
669 setting REG in its mode would, we won't know what to bind
670 the debug temp to. ??? We could bind the debug_expr to a
671 CONCAT or PARALLEL with the split multi-registers, and
672 replace them as we found the corresponding sets. */
673 else if (REG_NREGS (reg
) != REG_NREGS (dest
))
675 /* Ok, it's the same (hardware) REG, but with a different
676 mode, so SUBREG it. */
678 breg
= debug_lowpart_subreg (GET_MODE (reg
),
679 cleanup_auto_inc_dec (src
, VOIDmode
),
682 else if (GET_CODE (dest
) == SUBREG
)
684 /* We should be setting REG here. Lose. */
685 if (REGNO (SUBREG_REG (dest
)) != REGNO (reg
))
687 /* Lose if we're setting something other than the lowpart of
689 else if (!subreg_lowpart_p (dest
))
691 /* If we're not overwriting all the hardware registers that
692 setting REG in its mode would, we won't know what to bind
693 the debug temp to. */
694 else if (REGNO (reg
) < FIRST_PSEUDO_REGISTER
696 != hard_regno_nregs
[REGNO (reg
)][GET_MODE (dest
)]))
698 /* Yay, we can use SRC, just adjust its mode. */
700 breg
= debug_lowpart_subreg (GET_MODE (reg
),
701 cleanup_auto_inc_dec (src
, VOIDmode
),
704 /* Oh well, we're out of luck. */
708 /* We couldn't figure out the value stored in REG, so reset all
709 of its pending debug uses. */
712 dead_debug_reset_uses (debug
, uses
);
717 /* If there's a single (debug) use of an otherwise unused REG, and
718 the debug use is not part of a larger expression, then it
719 probably doesn't make sense to introduce a new debug temp. */
720 if (where
== DEBUG_TEMP_AFTER_WITH_REG
&& !uses
->next
)
722 rtx_insn
*next
= DF_REF_INSN (uses
->use
);
724 if (DEBUG_INSN_P (next
) && reg
== INSN_VAR_LOCATION_LOC (next
))
732 /* Create DEBUG_EXPR (and DEBUG_EXPR_DECL). */
733 dval
= make_debug_expr_from_rtl (reg
);
735 /* Emit a debug bind insn before the insn in which reg dies. */
736 bind
= gen_rtx_VAR_LOCATION (GET_MODE (reg
),
737 DEBUG_EXPR_TREE_DECL (dval
), breg
,
738 VAR_INIT_STATUS_INITIALIZED
);
740 if (where
== DEBUG_TEMP_AFTER_WITH_REG
741 || where
== DEBUG_TEMP_AFTER_WITH_REG_FORCE
)
742 bind
= emit_debug_insn_after (bind
, insn
);
744 bind
= emit_debug_insn_before (bind
, insn
);
745 if (debug
->to_rescan
== NULL
)
746 debug
->to_rescan
= BITMAP_ALLOC (NULL
);
747 bitmap_set_bit (debug
->to_rescan
, INSN_UID (bind
));
749 /* Adjust all uses. */
752 if (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)) == GET_MODE (reg
))
753 *DF_REF_REAL_LOC (cur
->use
) = dval
;
755 *DF_REF_REAL_LOC (cur
->use
)
756 = debug_lowpart_subreg (GET_MODE (*DF_REF_REAL_LOC (cur
->use
)), dval
,
758 /* ??? Should we simplify subreg of subreg? */
759 bitmap_set_bit (debug
->to_rescan
, INSN_UID (DF_REF_INSN (cur
->use
)));