1 /* read-rtl-function.c - Reader for RTL function dumps
2 Copyright (C) 2016-2021 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
22 #include "coretypes.h"
25 #include "diagnostic.h"
29 #include "stringpool.h"
33 #include "basic-block.h"
38 #include "tree-pass.h"
41 #include "read-rtl-function.h"
43 #include "selftest-rtl.h"
45 #include "function-abi.h"
48 class function_reader
;
51 /* Edges are recorded when parsing the "insn-chain" directive,
52 and created at the end when all the blocks ought to exist.
53 This struct records an "edge-from" or "edge-to" directive seen
54 at LOC, which will be turned into an actual CFG edge once
55 the "insn-chain" is fully parsed. */
60 deferred_edge (file_location loc
, int src_bb_idx
, int dest_bb_idx
, int flags
)
61 : m_loc (loc
), m_src_bb_idx (src_bb_idx
), m_dest_bb_idx (dest_bb_idx
),
71 /* Subclass of rtx_reader for reading function dumps. */
73 class function_reader
: public rtx_reader
79 /* Overridden vfuncs of class md_reader. */
80 void handle_unknown_directive (file_location
, const char *) FINAL OVERRIDE
;
82 /* Overridden vfuncs of class rtx_reader. */
83 rtx
read_rtx_operand (rtx x
, int idx
) FINAL OVERRIDE
;
84 void handle_any_trailing_information (rtx x
) FINAL OVERRIDE
;
85 rtx
postprocess (rtx
) FINAL OVERRIDE
;
86 const char *finalize_string (char *stringbuf
) FINAL OVERRIDE
;
88 rtx_insn
**get_insn_by_uid (int uid
);
89 tree
parse_mem_expr (const char *desc
);
92 void parse_function ();
93 void create_function ();
95 void parse_insn_chain ();
98 void parse_edge (basic_block block
, bool from
);
99 rtx_insn
*parse_insn (file_location loc
, const char *name
);
100 void parse_cfg (file_location loc
);
101 void parse_crtl (file_location loc
);
102 void create_edges ();
104 int parse_enum_value (int num_values
, const char *const *strings
);
106 void read_rtx_operand_u (rtx x
, int idx
);
107 void read_rtx_operand_i_or_n (rtx x
, int idx
, char format_char
);
108 rtx
read_rtx_operand_r (rtx x
);
109 rtx
extra_parsing_for_operand_code_0 (rtx x
, int idx
);
111 void add_fixup_insn_uid (file_location loc
, rtx insn
, int operand_idx
,
114 void add_fixup_note_insn_basic_block (file_location loc
, rtx insn
,
115 int operand_idx
, int bb_idx
);
117 void add_fixup_source_location (file_location loc
, rtx_insn
*insn
,
118 const char *filename
, int lineno
, int colno
);
120 void add_fixup_expr (file_location loc
, rtx x
,
123 rtx
consolidate_singletons (rtx x
);
125 void maybe_read_location (rtx_insn
*insn
);
127 void handle_insn_uids ();
128 void apply_fixups ();
131 struct uid_hash
: int_hash
<int, -1, -2> {};
132 hash_map
<uid_hash
, rtx_insn
*> m_insns_by_uid
;
133 auto_vec
<fixup
*> m_fixups
;
134 rtx_insn
*m_first_insn
;
135 auto_vec
<tree
> m_fake_scope
;
137 bool m_have_crtl_directive
;
138 basic_block m_bb_to_insert_after
;
139 auto_vec
<deferred_edge
> m_deferred_edges
;
140 int m_highest_bb_idx
;
143 /* Abstract base class for recording post-processing steps that must be
144 done after reading a .rtl file. */
149 /* Constructor for a fixup at LOC affecting X. */
150 fixup (file_location loc
, rtx x
)
151 : m_loc (loc
), m_rtx (x
)
155 virtual void apply (function_reader
*reader
) const = 0;
162 /* An abstract subclass of fixup for post-processing steps that
163 act on a specific operand of a specific instruction. */
165 class operand_fixup
: public fixup
168 /* Constructor for a fixup at LOC affecting INSN's operand
169 with index OPERAND_IDX. */
170 operand_fixup (file_location loc
, rtx insn
, int operand_idx
)
171 : fixup (loc
, insn
), m_operand_idx (operand_idx
)
178 /* A concrete subclass of operand_fixup: fixup an rtx_insn *
179 field based on an integer UID. */
181 class fixup_insn_uid
: public operand_fixup
184 /* Constructor for a fixup at LOC affecting INSN's operand
185 with index OPERAND_IDX. Record INSN_UID as the uid. */
186 fixup_insn_uid (file_location loc
, rtx insn
, int operand_idx
, int insn_uid
)
187 : operand_fixup (loc
, insn
, operand_idx
),
188 m_insn_uid (insn_uid
)
191 void apply (function_reader
*reader
) const;
197 /* A concrete subclass of operand_fixup: fix up a
198 NOTE_INSN_BASIC_BLOCK based on an integer block ID. */
200 class fixup_note_insn_basic_block
: public operand_fixup
203 fixup_note_insn_basic_block (file_location loc
, rtx insn
, int operand_idx
,
205 : operand_fixup (loc
, insn
, operand_idx
),
209 void apply (function_reader
*reader
) const;
215 /* A concrete subclass of fixup (not operand_fixup): fix up
216 the expr of an rtx (REG or MEM) based on a textual dump. */
218 class fixup_expr
: public fixup
221 fixup_expr (file_location loc
, rtx x
, const char *desc
)
223 m_desc (xstrdup (desc
))
226 ~fixup_expr () { free (m_desc
); }
228 void apply (function_reader
*reader
) const;
234 /* Return a textual description of the operand of INSN with
235 index OPERAND_IDX. */
238 get_operand_name (rtx insn
, int operand_idx
)
240 gcc_assert (is_a
<rtx_insn
*> (insn
));
252 /* Fixup an rtx_insn * field based on an integer UID, as read by READER. */
255 fixup_insn_uid::apply (function_reader
*reader
) const
257 rtx_insn
**insn_from_uid
= reader
->get_insn_by_uid (m_insn_uid
);
259 XEXP (m_rtx
, m_operand_idx
) = *insn_from_uid
;
262 const char *op_name
= get_operand_name (m_rtx
, m_operand_idx
);
265 "insn with UID %i not found for operand %i (`%s') of insn %i",
266 m_insn_uid
, m_operand_idx
, op_name
, INSN_UID (m_rtx
));
269 "insn with UID %i not found for operand %i of insn %i",
270 m_insn_uid
, m_operand_idx
, INSN_UID (m_rtx
));
274 /* Fix up a NOTE_INSN_BASIC_BLOCK based on an integer block ID. */
277 fixup_note_insn_basic_block::apply (function_reader
*) const
279 basic_block bb
= BASIC_BLOCK_FOR_FN (cfun
, m_bb_idx
);
281 NOTE_BASIC_BLOCK (m_rtx
) = bb
;
284 /* Fix up the expr of an rtx (REG or MEM) based on a textual dump
288 fixup_expr::apply (function_reader
*reader
) const
290 tree expr
= reader
->parse_mem_expr (m_desc
);
291 switch (GET_CODE (m_rtx
))
294 set_reg_attrs_for_decl_rtl (expr
, m_rtx
);
297 set_mem_expr (m_rtx
, expr
);
304 /* Strip trailing whitespace from DESC. */
307 strip_trailing_whitespace (char *desc
)
309 char *terminator
= desc
+ strlen (desc
);
310 while (desc
< terminator
)
313 if (ISSPACE (*terminator
))
320 /* Return the numeric value n for GET_NOTE_INSN_NAME (n) for STRING,
321 or fail if STRING isn't recognized. */
324 parse_note_insn_name (const char *string
)
326 for (int i
= 0; i
< NOTE_INSN_MAX
; i
++)
327 if (strcmp (string
, GET_NOTE_INSN_NAME (i
)) == 0)
329 fatal_with_file_and_line ("unrecognized NOTE_INSN name: `%s'", string
);
332 /* Return the register number for NAME, or return -1 if it isn't
336 lookup_reg_by_dump_name (const char *name
)
338 for (int i
= 0; i
< FIRST_PSEUDO_REGISTER
; i
++)
340 && ! strcmp (name
, reg_names
[i
]))
343 /* Also lookup virtuals. */
344 if (!strcmp (name
, "virtual-incoming-args"))
345 return VIRTUAL_INCOMING_ARGS_REGNUM
;
346 if (!strcmp (name
, "virtual-stack-vars"))
347 return VIRTUAL_STACK_VARS_REGNUM
;
348 if (!strcmp (name
, "virtual-stack-dynamic"))
349 return VIRTUAL_STACK_DYNAMIC_REGNUM
;
350 if (!strcmp (name
, "virtual-outgoing-args"))
351 return VIRTUAL_OUTGOING_ARGS_REGNUM
;
352 if (!strcmp (name
, "virtual-cfa"))
353 return VIRTUAL_CFA_REGNUM
;
354 if (!strcmp (name
, "virtual-preferred-stack-boundary"))
355 return VIRTUAL_PREFERRED_STACK_BOUNDARY_REGNUM
;
356 /* TODO: handle "virtual-reg-%d". */
358 /* In compact mode, pseudos are printed with '< and '>' wrapping the regno,
359 offseting it by (LAST_VIRTUAL_REGISTER + 1), so that the
360 first non-virtual pseudo is dumped as "<0>". */
361 if (name
[0] == '<' && name
[strlen (name
) - 1] == '>')
363 int dump_num
= atoi (name
+ 1);
364 return dump_num
+ LAST_VIRTUAL_REGISTER
+ 1;
371 /* class function_reader : public rtx_reader */
373 /* function_reader's constructor. */
375 function_reader::function_reader ()
379 m_have_crtl_directive (false),
380 m_bb_to_insert_after (NULL
),
381 m_highest_bb_idx (EXIT_BLOCK
)
385 /* function_reader's destructor. */
387 function_reader::~function_reader ()
391 FOR_EACH_VEC_ELT (m_fixups
, i
, f
)
397 /* Implementation of rtx_reader::handle_unknown_directive,
398 for parsing the remainder of a directive with name NAME
401 Require a top-level "function" directive, as emitted by
402 print_rtx_function, and parse it. */
405 function_reader::handle_unknown_directive (file_location start_loc
,
408 if (strcmp (name
, "function"))
409 fatal_at (start_loc
, "expected 'function'");
412 error ("%<__RTL%> function cannot be compiled with %<-flto%>");
417 /* Parse the output of print_rtx_function (or hand-written data in the
418 same format), having already parsed the "(function" heading, and
419 finishing immediately before the final ")".
421 The "param" and "crtl" clauses are optional. */
424 function_reader::parse_function ()
426 m_name
= xstrdup (read_string (0));
432 int c
= read_skip_spaces ();
440 file_location loc
= get_current_location ();
441 struct md_name directive
;
442 read_name (&directive
);
443 if (strcmp (directive
.string
, "param") == 0)
445 else if (strcmp (directive
.string
, "insn-chain") == 0)
447 else if (strcmp (directive
.string
, "crtl") == 0)
450 fatal_with_file_and_line ("unrecognized directive: %s",
458 /* Rebuild the JUMP_LABEL field of any JUMP_INSNs in the chain, and the
459 LABEL_NUSES of any CODE_LABELs.
461 This has to happen after apply_fixups, since only after then do
462 LABEL_REFs have their label_ref_label set up. */
463 rebuild_jump_labels (get_insns ());
465 crtl
->init_stack_alignment ();
468 /* Set up state for the function *before* fixups are applied.
470 Create "cfun" and a decl for the function.
471 By default, every function decl is hardcoded as
472 int test_1 (int i, int j, int k);
473 Set up various other state:
474 - the cfg and basic blocks (edges are created later, *after* fixups
476 - add the function to the callgraph. */
479 function_reader::create_function ()
481 /* We start in cfgrtl mode, rather than cfglayout mode. */
482 rtl_register_cfg_hooks ();
484 /* When run from selftests or "rtl1", cfun is NULL.
485 When run from "cc1" for a C function tagged with __RTL, cfun is the
489 tree fn_name
= get_identifier (m_name
? m_name
: "test_1");
490 tree int_type
= integer_type_node
;
491 tree return_type
= int_type
;
492 tree arg_types
[3] = {int_type
, int_type
, int_type
};
493 tree fn_type
= build_function_type_array (return_type
, 3, arg_types
);
494 tree fndecl
= build_decl (UNKNOWN_LOCATION
, FUNCTION_DECL
, fn_name
, fn_type
);
495 tree resdecl
= build_decl (UNKNOWN_LOCATION
, RESULT_DECL
, NULL_TREE
,
497 DECL_ARTIFICIAL (resdecl
) = 1;
498 DECL_IGNORED_P (resdecl
) = 1;
499 DECL_RESULT (fndecl
) = resdecl
;
500 allocate_struct_function (fndecl
, false);
501 /* This sets cfun. */
502 current_function_decl
= fndecl
;
506 gcc_assert (current_function_decl
);
507 tree fndecl
= current_function_decl
;
509 /* Mark this function as being specified as __RTL. */
510 cfun
->curr_properties
|= PROP_rtl
;
512 /* cc1 normally inits DECL_INITIAL (fndecl) to be error_mark_node.
513 Create a dummy block for it. */
514 DECL_INITIAL (fndecl
) = make_node (BLOCK
);
516 cfun
->curr_properties
= (PROP_cfg
| PROP_rtl
);
518 /* Do we need this to force cgraphunit.c to output the function? */
519 DECL_EXTERNAL (fndecl
) = 0;
520 DECL_PRESERVE_P (fndecl
) = 1;
523 cgraph_node::finalize_function (fndecl
, false);
525 /* Create bare-bones cfg. This creates the entry and exit blocks. */
526 init_empty_tree_cfg_for_function (cfun
);
527 ENTRY_BLOCK_PTR_FOR_FN (cfun
)->flags
|= BB_RTL
;
528 EXIT_BLOCK_PTR_FOR_FN (cfun
)->flags
|= BB_RTL
;
529 init_rtl_bb_info (ENTRY_BLOCK_PTR_FOR_FN (cfun
));
530 init_rtl_bb_info (EXIT_BLOCK_PTR_FOR_FN (cfun
));
531 m_bb_to_insert_after
= ENTRY_BLOCK_PTR_FOR_FN (cfun
);
535 /* Look within the params of FNDECL for a param named NAME.
536 Return NULL_TREE if one isn't found. */
539 find_param_by_name (tree fndecl
, const char *name
)
541 for (tree arg
= DECL_ARGUMENTS (fndecl
); arg
; arg
= TREE_CHAIN (arg
))
542 if (id_equal (DECL_NAME (arg
), name
))
547 /* Parse the content of a "param" directive, having already parsed the
548 "(param". Consume the trailing ')'. */
551 function_reader::parse_param ()
553 require_char_ws ('"');
554 file_location loc
= get_current_location ();
555 char *name
= read_quoted_string ();
557 /* Lookup param by name. */
558 tree t_param
= find_param_by_name (cfun
->decl
, name
);
560 fatal_at (loc
, "param not found: %s", name
);
562 /* Parse DECL_RTL. */
563 require_char_ws ('(');
564 require_word_ws ("DECL_RTL");
565 DECL_WRTL_CHECK (t_param
)->decl_with_rtl
.rtl
= parse_rtx ();
566 require_char_ws (')');
568 /* Parse DECL_RTL_INCOMING. */
569 require_char_ws ('(');
570 require_word_ws ("DECL_RTL_INCOMING");
571 DECL_INCOMING_RTL (t_param
) = parse_rtx ();
572 require_char_ws (')');
574 require_char_ws (')');
577 /* Parse zero or more child insn elements within an
578 "insn-chain" element. Consume the trailing ')'. */
581 function_reader::parse_insn_chain ()
585 int c
= read_skip_spaces ();
586 file_location loc
= get_current_location ();
591 struct md_name directive
;
592 read_name (&directive
);
593 if (strcmp (directive
.string
, "block") == 0)
596 parse_insn (loc
, directive
.string
);
599 fatal_at (loc
, "expected '(' or ')'");
605 /* Parse zero or more child directives (edges and insns) within a
606 "block" directive, having already parsed the "(block " heading.
607 Consume the trailing ')'. */
610 function_reader::parse_block ()
612 /* Parse the index value from the dump. This will be an integer;
613 we don't support "entry" or "exit" here (unlike for edges). */
616 int bb_idx
= atoi (name
.string
);
618 /* The term "index" has two meanings for basic blocks in a CFG:
619 (a) the "index" field within struct basic_block_def.
620 (b) the index of a basic_block within the cfg's x_basic_block_info
621 vector, as accessed via BASIC_BLOCK_FOR_FN.
623 These can get out-of-sync when basic blocks are optimized away.
624 They get back in sync by "compact_blocks".
625 We reconstruct cfun->cfg->x_basic_block_info->m_vecdata with NULL
626 values in it for any missing basic blocks, so that (a) == (b) for
627 all of the blocks we create. The doubly-linked list of basic
628 blocks (next_bb/prev_bb) skips over these "holes". */
630 if (m_highest_bb_idx
< bb_idx
)
631 m_highest_bb_idx
= bb_idx
;
633 size_t new_size
= m_highest_bb_idx
+ 1;
634 if (basic_block_info_for_fn (cfun
)->length () < new_size
)
635 vec_safe_grow_cleared (basic_block_info_for_fn (cfun
), new_size
, true);
637 last_basic_block_for_fn (cfun
) = new_size
;
639 /* Create the basic block.
641 We can't call create_basic_block and use the regular RTL block-creation
642 hooks, since this creates NOTE_INSN_BASIC_BLOCK instances. We don't
643 want to do that; we want to use the notes we were provided with. */
644 basic_block bb
= alloc_block ();
645 init_rtl_bb_info (bb
);
647 bb
->flags
= BB_NEW
| BB_RTL
;
648 link_block (bb
, m_bb_to_insert_after
);
649 m_bb_to_insert_after
= bb
;
651 n_basic_blocks_for_fn (cfun
)++;
652 SET_BASIC_BLOCK_FOR_FN (cfun
, bb_idx
, bb
);
653 BB_SET_PARTITION (bb
, BB_UNPARTITIONED
);
655 /* Handle insns, edge-from and edge-to directives. */
658 int c
= read_skip_spaces ();
659 file_location loc
= get_current_location ();
664 struct md_name directive
;
665 read_name (&directive
);
666 if (strcmp (directive
.string
, "edge-from") == 0)
667 parse_edge (bb
, true);
668 else if (strcmp (directive
.string
, "edge-to") == 0)
669 parse_edge (bb
, false);
672 rtx_insn
*insn
= parse_insn (loc
, directive
.string
);
673 set_block_for_insn (insn
, bb
);
680 fatal_at (loc
, "expected '(' or ')'");
684 /* Subroutine of function_reader::parse_edge.
685 Parse a basic block index, handling "entry" and "exit". */
688 function_reader::parse_bb_idx ()
692 if (strcmp (name
.string
, "entry") == 0)
694 if (strcmp (name
.string
, "exit") == 0)
696 return atoi (name
.string
);
699 /* Subroutine of parse_edge_flags.
700 Parse TOK, a token such as "FALLTHRU", converting to the flag value.
701 Issue an error if the token is unrecognized. */
704 parse_edge_flag_token (const char *tok
)
706 #define DEF_EDGE_FLAG(NAME,IDX) \
708 if (strcmp (tok, #NAME) == 0) \
709 return EDGE_##NAME; \
711 #include "cfg-flags.def"
713 error ("unrecognized edge flag: %qs", tok
);
717 /* Subroutine of function_reader::parse_edge.
718 Parse STR and convert to a flag value (or issue an error).
719 The parser uses strtok and hence modifiers STR in-place. */
722 parse_edge_flags (char *str
)
726 char *tok
= strtok (str
, "| ");
729 result
|= parse_edge_flag_token (tok
);
730 tok
= strtok (NULL
, "| ");
736 /* Parse an "edge-from" or "edge-to" directive within the "block"
737 directive for BLOCK, having already parsed the "(edge" heading.
738 Consume the final ")". Record the edge within m_deferred_edges.
739 FROM is true for an "edge-from" directive, false for an "edge-to"
743 function_reader::parse_edge (basic_block block
, bool from
)
746 int this_bb_idx
= block
->index
;
747 file_location loc
= get_current_location ();
748 int other_bb_idx
= parse_bb_idx ();
750 /* "(edge-from 2)" means src = 2, dest = this_bb_idx, whereas
751 "(edge-to 3)" means src = this_bb_idx, dest = 3. */
752 int src_idx
= from
? other_bb_idx
: this_bb_idx
;
753 int dest_idx
= from
? this_bb_idx
: other_bb_idx
;
755 /* Optional "(flags)". */
757 int c
= read_skip_spaces ();
760 require_word_ws ("flags");
761 require_char_ws ('"');
762 char *str
= read_quoted_string ();
763 flags
= parse_edge_flags (str
);
764 require_char_ws (')');
769 require_char_ws (')');
771 /* This BB already exists, but the other BB might not yet.
772 For now, save the edges, and create them at the end of insn-chain
774 /* For now, only process the (edge-from) to this BB, and (edge-to)
775 that go to the exit block.
776 FIXME: we don't yet verify that the edge-from and edge-to directives
778 if (from
|| dest_idx
== EXIT_BLOCK
)
779 m_deferred_edges
.safe_push (deferred_edge (loc
, src_idx
, dest_idx
, flags
));
782 /* Parse an rtx instruction, having parsed the opening and parenthesis, and
783 name NAME, seen at START_LOC, by calling read_rtx_code, calling
784 set_first_insn and set_last_insn as appropriate, and
785 adding the insn to the insn chain.
786 Consume the trailing ')'. */
789 function_reader::parse_insn (file_location start_loc
, const char *name
)
791 rtx x
= read_rtx_code (name
);
793 fatal_at (start_loc
, "expected insn type; got '%s'", name
);
794 rtx_insn
*insn
= dyn_cast
<rtx_insn
*> (x
);
796 fatal_at (start_loc
, "expected insn type; got '%s'", name
);
798 /* Consume the trailing ')'. */
799 require_char_ws (')');
801 rtx_insn
*last_insn
= get_last_insn ();
803 /* Add "insn" to the insn chain. */
806 gcc_assert (NEXT_INSN (last_insn
) == NULL
);
807 SET_NEXT_INSN (last_insn
) = insn
;
809 SET_PREV_INSN (insn
) = last_insn
;
811 /* Add it to the sequence. */
812 set_last_insn (insn
);
816 set_first_insn (insn
);
819 if (rtx_code_label
*label
= dyn_cast
<rtx_code_label
*> (insn
))
820 maybe_set_max_label_num (label
);
825 /* Postprocessing subroutine for parse_insn_chain: all the basic blocks
826 should have been created by now; create the edges that were seen. */
829 function_reader::create_edges ()
833 FOR_EACH_VEC_ELT (m_deferred_edges
, i
, de
)
835 /* The BBs should already have been created by parse_block. */
836 basic_block src
= BASIC_BLOCK_FOR_FN (cfun
, de
->m_src_bb_idx
);
838 fatal_at (de
->m_loc
, "error: block index %i not found",
840 basic_block dst
= BASIC_BLOCK_FOR_FN (cfun
, de
->m_dest_bb_idx
);
842 fatal_at (de
->m_loc
, "error: block with index %i not found",
844 unchecked_make_edge (src
, dst
, de
->m_flags
);
848 /* Parse a "crtl" directive, having already parsed the "(crtl" heading
850 Consume the final ")". */
853 function_reader::parse_crtl (file_location loc
)
855 if (m_have_crtl_directive
)
856 error_at (loc
, "more than one 'crtl' directive");
857 m_have_crtl_directive
= true;
860 require_char_ws ('(');
861 require_word_ws ("return_rtx");
862 crtl
->return_rtx
= parse_rtx ();
863 require_char_ws (')');
865 require_char_ws (')');
868 /* Parse operand IDX of X, returning X, or an equivalent rtx
869 expression (for consolidating singletons).
870 This is an overridden implementation of rtx_reader::read_rtx_operand for
871 function_reader, handling various extra data printed by print_rtx,
872 and sometimes calling the base class implementation. */
875 function_reader::read_rtx_operand (rtx x
, int idx
)
877 RTX_CODE code
= GET_CODE (x
);
878 const char *format_ptr
= GET_RTX_FORMAT (code
);
879 const char format_char
= format_ptr
[idx
];
882 /* Override the regular parser for some format codes. */
886 if (idx
== 7 && CALL_P (x
))
888 m_in_call_function_usage
= true;
889 return rtx_reader::read_rtx_operand (x
, idx
);
890 m_in_call_function_usage
= false;
893 return rtx_reader::read_rtx_operand (x
, idx
);
897 read_rtx_operand_u (x
, idx
);
898 /* Don't run regular parser for 'u'. */
903 read_rtx_operand_i_or_n (x
, idx
, format_char
);
904 /* Don't run regular parser for these codes. */
908 gcc_assert (is_compact ());
909 /* Compact mode doesn't store BBs. */
910 /* Don't run regular parser. */
914 /* Don't run regular parser for 'r'. */
915 return read_rtx_operand_r (x
);
921 /* Call base class implementation. */
922 x
= rtx_reader::read_rtx_operand (x
, idx
);
924 /* Handle any additional parsing needed to handle what the dump
929 x
= extra_parsing_for_operand_code_0 (x
, idx
);
935 /* Strip away the redundant hex dump of the value. */
936 require_char_ws ('[');
938 require_char_ws (']');
949 /* Parse operand IDX of X, of code 'u', when reading function dumps.
951 The RTL file recorded the ID of an insn (or 0 for NULL); we
952 must store this as a pointer, but the insn might not have
953 been loaded yet. Store the ID away for now, via a fixup. */
956 function_reader::read_rtx_operand_u (rtx x
, int idx
)
958 /* In compact mode, the PREV/NEXT insn uids are not dumped, so skip
959 the "uu" when reading. */
960 if (is_compact () && GET_CODE (x
) != LABEL_REF
)
964 file_location loc
= read_name (&name
);
965 int insn_id
= atoi (name
.string
);
967 add_fixup_insn_uid (loc
, x
, idx
, insn_id
);
970 /* Read a name, looking for a match against a string found in array
971 STRINGS of size NUM_VALUES.
972 Return the index of the matched string, or emit an error. */
975 function_reader::parse_enum_value (int num_values
, const char *const *strings
)
979 for (int i
= 0; i
< num_values
; i
++)
981 if (strcmp (name
.string
, strings
[i
]) == 0)
984 error ("unrecognized enum value: %qs", name
.string
);
988 /* Parse operand IDX of X, of code 'i' or 'n' (as specified by FORMAT_CHAR).
989 Special-cased handling of these, for reading function dumps. */
992 function_reader::read_rtx_operand_i_or_n (rtx x
, int idx
,
995 /* Handle some of the extra information that print_rtx
996 can write out for these cases. */
997 /* print_rtx only writes out operand 5 for notes
998 for NOTE_KIND values NOTE_INSN_DELETED_LABEL
999 and NOTE_INSN_DELETED_DEBUG_LABEL. */
1000 if (idx
== 5 && NOTE_P (x
))
1003 if (idx
== 4 && INSN_P (x
))
1005 maybe_read_location (as_a
<rtx_insn
*> (x
));
1009 /* INSN_CODEs aren't printed in compact mode, so don't attempt to
1013 && &INSN_CODE (x
) == &XINT (x
, idx
))
1019 /* Handle UNSPEC and UNSPEC_VOLATILE's operand 1. */
1020 #if !defined(GENERATOR_FILE) && NUM_UNSPECV_VALUES > 0
1022 && GET_CODE (x
) == UNSPEC_VOLATILE
)
1025 = parse_enum_value (NUM_UNSPECV_VALUES
, unspecv_strings
);
1029 #if !defined(GENERATOR_FILE) && NUM_UNSPEC_VALUES > 0
1031 && (GET_CODE (x
) == UNSPEC
1032 || GET_CODE (x
) == UNSPEC_VOLATILE
))
1035 = parse_enum_value (NUM_UNSPEC_VALUES
, unspec_strings
);
1040 struct md_name name
;
1043 if (format_char
== 'n')
1044 value
= parse_note_insn_name (name
.string
);
1046 value
= atoi (name
.string
);
1047 XINT (x
, idx
) = value
;
1050 /* Parse the 'r' operand of X, returning X, or an equivalent rtx
1051 expression (for consolidating singletons).
1052 Special-cased handling of code 'r' for reading function dumps. */
1055 function_reader::read_rtx_operand_r (rtx x
)
1057 struct md_name name
;
1058 file_location loc
= read_name (&name
);
1059 int regno
= lookup_reg_by_dump_name (name
.string
);
1061 fatal_at (loc
, "unrecognized register: '%s'", name
.string
);
1063 set_regno_raw (x
, regno
, 1);
1065 /* Consolidate singletons. */
1066 x
= consolidate_singletons (x
);
1068 ORIGINAL_REGNO (x
) = regno
;
1070 /* Parse extra stuff at end of 'r'.
1071 We may have zero, one, or two sections marked by square
1073 int ch
= read_skip_spaces ();
1074 bool expect_original_regno
= false;
1077 file_location loc
= get_current_location ();
1078 char *desc
= read_until ("]", true);
1079 strip_trailing_whitespace (desc
);
1080 const char *desc_start
= desc
;
1081 /* If ORIGINAL_REGNO (rtx) != regno, we will have:
1082 "orig:%i", ORIGINAL_REGNO (rtx).
1083 Consume it, we don't set ORIGINAL_REGNO, since we can
1084 get that from the 2nd copy later. */
1085 if (startswith (desc
, "orig:"))
1087 expect_original_regno
= true;
1089 /* Skip to any whitespace following the integer. */
1090 const char *space
= strchr (desc_start
, ' ');
1092 desc_start
= space
+ 1;
1094 /* Any remaining text may be the REG_EXPR. Alternatively we have
1095 no REG_ATTRS, and instead we have ORIGINAL_REGNO. */
1096 if (ISDIGIT (*desc_start
))
1098 /* Assume we have ORIGINAL_REGNO. */
1099 ORIGINAL_REGNO (x
) = atoi (desc_start
);
1103 /* Assume we have REG_EXPR. */
1104 add_fixup_expr (loc
, x
, desc_start
);
1110 if (expect_original_regno
)
1112 require_char_ws ('[');
1113 char *desc
= read_until ("]", true);
1114 ORIGINAL_REGNO (x
) = atoi (desc
);
1121 /* Additional parsing for format code '0' in dumps, handling a variety
1122 of special-cases in print_rtx, when parsing operand IDX of X.
1123 Return X, or possibly a reallocated copy of X. */
1126 function_reader::extra_parsing_for_operand_code_0 (rtx x
, int idx
)
1128 RTX_CODE code
= GET_CODE (x
);
1130 struct md_name name
;
1132 if (idx
== 1 && code
== SYMBOL_REF
)
1134 /* Possibly wrote " [flags %#x]", SYMBOL_REF_FLAGS (in_rtx). */
1135 c
= read_skip_spaces ();
1138 file_location loc
= read_name (&name
);
1139 if (strcmp (name
.string
, "flags"))
1140 error_at (loc
, "was expecting `%s'", "flags");
1142 SYMBOL_REF_FLAGS (x
) = strtol (name
.string
, NULL
, 16);
1144 /* The standard RTX_CODE_SIZE (SYMBOL_REF) used when allocating
1145 x doesn't have space for the block_symbol information, so
1146 we must reallocate it if this flag is set. */
1147 if (SYMBOL_REF_HAS_BLOCK_INFO_P (x
))
1149 /* Emulate the allocation normally done by
1150 varasm.c:create_block_symbol. */
1151 unsigned int size
= RTX_HDR_SIZE
+ sizeof (struct block_symbol
);
1152 rtx new_x
= (rtx
) ggc_internal_alloc (size
);
1154 /* Copy data over from the smaller SYMBOL_REF. */
1155 memcpy (new_x
, x
, RTX_CODE_SIZE (SYMBOL_REF
));
1158 /* We can't reconstruct SYMBOL_REF_BLOCK; set it to NULL. */
1159 SYMBOL_REF_BLOCK (x
) = NULL
;
1161 /* Zero the offset. */
1162 SYMBOL_REF_BLOCK_OFFSET (x
) = 0;
1170 /* If X had a non-NULL SYMBOL_REF_DECL,
1171 rtx_writer::print_rtx_operand_code_0 would have dumped it
1172 using print_node_brief.
1173 Skip the content for now. */
1174 c
= read_skip_spaces ();
1179 char ch
= read_char ();
1187 else if (idx
== 3 && code
== NOTE
)
1189 /* Note-specific data appears for operand 3, which annoyingly
1190 is before the enum specifying which kind of note we have
1192 c
= read_skip_spaces ();
1195 /* Possibly data for a NOTE_INSN_BASIC_BLOCK, of the form:
1197 file_location bb_loc
= read_name (&name
);
1198 if (strcmp (name
.string
, "bb"))
1199 error_at (bb_loc
, "was expecting `%s'", "bb");
1201 int bb_idx
= atoi (name
.string
);
1202 add_fixup_note_insn_basic_block (bb_loc
, x
, idx
,
1204 require_char_ws (']');
1213 /* Implementation of rtx_reader::handle_any_trailing_information.
1214 Handle the various additional information that print-rtl.c can
1215 write after the regular fields, when parsing X. */
1218 function_reader::handle_any_trailing_information (rtx x
)
1220 struct md_name name
;
1222 switch (GET_CODE (x
))
1227 require_char_ws ('[');
1229 set_mem_alias_set (x
, atoi (name
.string
));
1230 /* We have either a MEM_EXPR, or a space. */
1231 if (peek_char () != ' ')
1233 file_location loc
= get_current_location ();
1234 char *desc
= read_until (" +", false);
1235 add_fixup_expr (loc
, consolidate_singletons (x
), desc
);
1241 /* We may optionally have '+' for MEM_OFFSET_KNOWN_P. */
1242 ch
= read_skip_spaces ();
1246 set_mem_offset (x
, atoi (name
.string
));
1251 /* Handle optional " S" for MEM_SIZE. */
1252 ch
= read_skip_spaces ();
1256 set_mem_size (x
, atoi (name
.string
));
1261 /* Handle optional " A" for MEM_ALIGN. */
1262 ch
= read_skip_spaces ();
1263 if (ch
== 'A' && peek_char () != 'S')
1266 set_mem_align (x
, atoi (name
.string
));
1271 /* Handle optional " AS" for MEM_ADDR_SPACE. */
1272 ch
= read_skip_spaces ();
1273 if (ch
== 'A' && peek_char () == 'S')
1277 set_mem_addr_space (x
, atoi (name
.string
));
1287 /* Assume that LABEL_NUSES was not dumped. */
1288 /* TODO: parse LABEL_KIND. */
1289 /* For now, skip until closing ')'. */
1292 char ch
= read_char ();
1307 /* Parse a tree dump for a MEM_EXPR in DESC and turn it back into a tree.
1308 We handle "<retval>" and param names within cfun, but for anything else
1309 we "cheat" by building a global VAR_DECL of type "int" with that name
1310 (returning the same global for a name if we see the same name more
1314 function_reader::parse_mem_expr (const char *desc
)
1316 tree fndecl
= cfun
->decl
;
1318 if (strcmp (desc
, "<retval>") == 0)
1319 return DECL_RESULT (fndecl
);
1321 tree param
= find_param_by_name (fndecl
, desc
);
1325 /* Search within decls we already created.
1326 FIXME: use a hash rather than linear search. */
1329 FOR_EACH_VEC_ELT (m_fake_scope
, i
, t
)
1330 if (id_equal (DECL_NAME (t
), desc
))
1333 /* Not found? Create it.
1334 This allows mimicking of real data but avoids having to specify
1335 e.g. names of locals, params etc.
1336 Though this way we don't know if we have a PARM_DECL vs a VAR_DECL,
1337 and we don't know the types. Fake it by making everything be
1338 a VAR_DECL of "int" type. */
1339 t
= build_decl (UNKNOWN_LOCATION
, VAR_DECL
,
1340 get_identifier (desc
),
1342 m_fake_scope
.safe_push (t
);
1346 /* Record that at LOC we saw an insn uid INSN_UID for the operand with index
1347 OPERAND_IDX within INSN, so that the pointer value can be fixed up in
1348 later post-processing. */
1351 function_reader::add_fixup_insn_uid (file_location loc
, rtx insn
, int operand_idx
,
1354 m_fixups
.safe_push (new fixup_insn_uid (loc
, insn
, operand_idx
, insn_uid
));
1357 /* Record that at LOC we saw an basic block index BB_IDX for the operand with index
1358 OPERAND_IDX within INSN, so that the pointer value can be fixed up in
1359 later post-processing. */
1362 function_reader::add_fixup_note_insn_basic_block (file_location loc
, rtx insn
,
1363 int operand_idx
, int bb_idx
)
1365 m_fixups
.safe_push (new fixup_note_insn_basic_block (loc
, insn
, operand_idx
,
1369 /* Placeholder hook for recording source location information seen in a dump.
1370 This is empty for now. */
1373 function_reader::add_fixup_source_location (file_location
, rtx_insn
*,
1374 const char *, int, int)
1378 /* Record that at LOC we saw textual description DESC of the MEM_EXPR or REG_EXPR
1379 of INSN, so that the fields can be fixed up in later post-processing. */
1382 function_reader::add_fixup_expr (file_location loc
, rtx insn
,
1386 /* Fail early if the RTL reader erroneously hands us an int. */
1387 gcc_assert (!ISDIGIT (desc
[0]));
1389 m_fixups
.safe_push (new fixup_expr (loc
, insn
, desc
));
1392 /* Helper function for consolidate_reg. Return the global rtx for
1393 the register with regno REGNO. */
1396 lookup_global_register (int regno
)
1398 /* We can't use a switch here, as some of the REGNUMs might not be constants
1399 for some targets. */
1400 if (regno
== STACK_POINTER_REGNUM
)
1401 return stack_pointer_rtx
;
1402 else if (regno
== FRAME_POINTER_REGNUM
)
1403 return frame_pointer_rtx
;
1404 else if (regno
== HARD_FRAME_POINTER_REGNUM
)
1405 return hard_frame_pointer_rtx
;
1406 else if (regno
== ARG_POINTER_REGNUM
)
1407 return arg_pointer_rtx
;
1408 else if (regno
== VIRTUAL_INCOMING_ARGS_REGNUM
)
1409 return virtual_incoming_args_rtx
;
1410 else if (regno
== VIRTUAL_STACK_VARS_REGNUM
)
1411 return virtual_stack_vars_rtx
;
1412 else if (regno
== VIRTUAL_STACK_DYNAMIC_REGNUM
)
1413 return virtual_stack_dynamic_rtx
;
1414 else if (regno
== VIRTUAL_OUTGOING_ARGS_REGNUM
)
1415 return virtual_outgoing_args_rtx
;
1416 else if (regno
== VIRTUAL_CFA_REGNUM
)
1417 return virtual_cfa_rtx
;
1418 else if (regno
== VIRTUAL_PREFERRED_STACK_BOUNDARY_REGNUM
)
1419 return virtual_preferred_stack_boundary_rtx
;
1420 #ifdef return_ADDRESS_POINTER_REGNUM
1421 else if (regno
== RETURN_ADDRESS_POINTER_REGNUM
)
1422 return return_address_pointer_rtx
;
1428 /* Ensure that the backend can cope with a REG with regno REGNO.
1429 Normally REG instances are created by gen_reg_rtx which updates
1430 regno_reg_rtx, growing it as necessary.
1431 The REG instances created from the dumpfile weren't created this
1432 way, so we need to manually update regno_reg_rtx. */
1435 ensure_regno (int regno
)
1437 if (reg_rtx_no
< regno
+ 1)
1438 reg_rtx_no
= regno
+ 1;
1440 crtl
->emit
.ensure_regno_capacity ();
1441 gcc_assert (regno
< crtl
->emit
.regno_pointer_align_length
);
1444 /* Helper function for consolidate_singletons, for handling REG instances.
1445 Given REG instance X of some regno, return the singleton rtx for that
1446 regno, if it exists, or X. */
1449 consolidate_reg (rtx x
)
1451 gcc_assert (GET_CODE (x
) == REG
);
1453 unsigned int regno
= REGNO (x
);
1455 ensure_regno (regno
);
1457 /* Some register numbers have their rtx created in init_emit_regs
1458 e.g. stack_pointer_rtx for STACK_POINTER_REGNUM.
1459 Consolidate on this. */
1460 rtx global_reg
= lookup_global_register (regno
);
1464 /* Populate regno_reg_rtx if necessary. */
1465 if (regno_reg_rtx
[regno
] == NULL
)
1466 regno_reg_rtx
[regno
] = x
;
1468 gcc_assert (GET_CODE (regno_reg_rtx
[regno
]) == REG
);
1469 gcc_assert (REGNO (regno_reg_rtx
[regno
]) == regno
);
1470 if (GET_MODE (x
) == GET_MODE (regno_reg_rtx
[regno
]))
1471 return regno_reg_rtx
[regno
];
1476 /* When reading RTL function dumps, we must consolidate some
1477 rtx so that we use singletons where singletons are expected
1478 (e.g. we don't want multiple "(const_int 0 [0])" rtx, since
1479 these are tested via pointer equality against const0_rtx.
1481 Return the equivalent singleton rtx for X, if any, otherwise X. */
1484 function_reader::consolidate_singletons (rtx x
)
1489 switch (GET_CODE (x
))
1491 case PC
: return pc_rtx
;
1492 case RETURN
: return ret_rtx
;
1493 case SIMPLE_RETURN
: return simple_return_rtx
;
1496 return consolidate_reg (x
);
1499 return gen_rtx_CONST_INT (GET_MODE (x
), INTVAL (x
));
1508 /* Parse an rtx directive, including both the opening/closing parentheses,
1512 function_reader::parse_rtx ()
1514 require_char_ws ('(');
1515 struct md_name directive
;
1516 read_name (&directive
);
1518 = consolidate_singletons (read_rtx_code (directive
.string
));
1519 require_char_ws (')');
1524 /* Implementation of rtx_reader::postprocess for reading function dumps.
1525 Return the equivalent singleton rtx for X, if any, otherwise X. */
1528 function_reader::postprocess (rtx x
)
1530 return consolidate_singletons (x
);
1533 /* Implementation of rtx_reader::finalize_string for reading function dumps.
1534 Make a GC-managed copy of STRINGBUF. */
1537 function_reader::finalize_string (char *stringbuf
)
1539 return ggc_strdup (stringbuf
);
1542 /* Attempt to parse optional location information for insn INSN, as
1543 potentially written out by rtx_writer::print_rtx_operand_code_i.
1544 We look for a quoted string followed by a colon. */
1547 function_reader::maybe_read_location (rtx_insn
*insn
)
1549 file_location loc
= get_current_location ();
1551 /* Attempt to parse a quoted string. */
1552 int ch
= read_skip_spaces ();
1555 char *filename
= read_quoted_string ();
1557 struct md_name line_num
;
1558 read_name (&line_num
);
1561 int ch
= read_char ();
1564 struct md_name column_num
;
1565 read_name (&column_num
);
1566 column
= atoi (column_num
.string
);
1570 add_fixup_source_location (loc
, insn
, filename
,
1571 atoi (line_num
.string
),
1578 /* Postprocessing subroutine of function_reader::parse_function.
1579 Populate m_insns_by_uid. */
1582 function_reader::handle_insn_uids ()
1584 /* Locate the currently assigned INSN_UID values, storing
1585 them in m_insns_by_uid. */
1587 for (rtx_insn
*insn
= get_insns (); insn
; insn
= NEXT_INSN (insn
))
1589 if (m_insns_by_uid
.get (INSN_UID (insn
)))
1590 error ("duplicate insn UID: %i", INSN_UID (insn
));
1591 m_insns_by_uid
.put (INSN_UID (insn
), insn
);
1592 if (INSN_UID (insn
) > max_uid
)
1593 max_uid
= INSN_UID (insn
);
1596 /* Ensure x_cur_insn_uid is 1 more than the biggest insn UID seen.
1597 This is normally updated by the various make_*insn_raw functions. */
1598 crtl
->emit
.x_cur_insn_uid
= max_uid
+ 1;
1601 /* Apply all of the recorded fixups. */
1604 function_reader::apply_fixups ()
1608 FOR_EACH_VEC_ELT (m_fixups
, i
, f
)
1612 /* Given a UID value, try to locate a pointer to the corresponding
1613 rtx_insn *, or NULL if it can't be found. */
1616 function_reader::get_insn_by_uid (int uid
)
1618 return m_insns_by_uid
.get (uid
);
1621 /* Run the RTL dump parser, parsing a dump located at PATH.
1622 Return true iff the file was successfully parsed. */
1625 read_rtl_function_body (const char *path
)
1628 crtl
->abi
= &default_function_abi
;
1630 init_varasm_status ();
1632 function_reader reader
;
1633 if (!reader
.read_file (path
))
1639 /* Run the RTL dump parser on the range of lines between START_LOC and
1640 END_LOC (including those lines). */
1643 read_rtl_function_body_from_file_range (location_t start_loc
,
1646 expanded_location exploc_start
= expand_location (start_loc
);
1647 expanded_location exploc_end
= expand_location (end_loc
);
1649 if (exploc_start
.file
!= exploc_end
.file
)
1651 error_at (end_loc
, "start/end of RTL fragment are in different files");
1654 if (exploc_start
.line
>= exploc_end
.line
)
1657 "start of RTL fragment must be on an earlier line than end");
1662 crtl
->abi
= &fndecl_abi (cfun
->decl
).base_abi ();
1664 init_varasm_status ();
1666 function_reader reader
;
1667 if (!reader
.read_file_fragment (exploc_start
.file
, exploc_start
.line
,
1668 exploc_end
.line
- 1))
1676 namespace selftest
{
1678 /* Verify that parse_edge_flags works. */
1683 /* parse_edge_flags modifies its input (due to strtok), so we must make
1684 a copy of the literals. */
1685 #define ASSERT_PARSE_EDGE_FLAGS(EXPECTED, STR) \
1687 char *str = xstrdup (STR); \
1688 ASSERT_EQ (EXPECTED, parse_edge_flags (str)); \
1692 ASSERT_PARSE_EDGE_FLAGS (0, "");
1693 ASSERT_PARSE_EDGE_FLAGS (EDGE_FALLTHRU
, "FALLTHRU");
1694 ASSERT_PARSE_EDGE_FLAGS (EDGE_ABNORMAL_CALL
, "ABNORMAL_CALL");
1695 ASSERT_PARSE_EDGE_FLAGS (EDGE_ABNORMAL
| EDGE_ABNORMAL_CALL
,
1696 "ABNORMAL | ABNORMAL_CALL");
1698 #undef ASSERT_PARSE_EDGE_FLAGS
1701 /* Verify that lookup_reg_by_dump_name works. */
1704 test_parsing_regnos ()
1706 ASSERT_EQ (-1, lookup_reg_by_dump_name ("this is not a register"));
1708 /* Verify lookup of virtual registers. */
1709 ASSERT_EQ (VIRTUAL_INCOMING_ARGS_REGNUM
,
1710 lookup_reg_by_dump_name ("virtual-incoming-args"));
1711 ASSERT_EQ (VIRTUAL_STACK_VARS_REGNUM
,
1712 lookup_reg_by_dump_name ("virtual-stack-vars"));
1713 ASSERT_EQ (VIRTUAL_STACK_DYNAMIC_REGNUM
,
1714 lookup_reg_by_dump_name ("virtual-stack-dynamic"));
1715 ASSERT_EQ (VIRTUAL_OUTGOING_ARGS_REGNUM
,
1716 lookup_reg_by_dump_name ("virtual-outgoing-args"));
1717 ASSERT_EQ (VIRTUAL_CFA_REGNUM
,
1718 lookup_reg_by_dump_name ("virtual-cfa"));
1719 ASSERT_EQ (VIRTUAL_PREFERRED_STACK_BOUNDARY_REGNUM
,
1720 lookup_reg_by_dump_name ("virtual-preferred-stack-boundary"));
1722 /* Verify lookup of non-virtual pseudos. */
1723 ASSERT_EQ (LAST_VIRTUAL_REGISTER
+ 1, lookup_reg_by_dump_name ("<0>"));
1724 ASSERT_EQ (LAST_VIRTUAL_REGISTER
+ 2, lookup_reg_by_dump_name ("<1>"));
1727 /* Verify that edge E is as expected, with the src and dest basic blocks
1728 having indices EXPECTED_SRC_IDX and EXPECTED_DEST_IDX respectively, and
1729 the edge having flags equal to EXPECTED_FLAGS.
1730 Use LOC as the effective location when reporting failures. */
1733 assert_edge_at (const location
&loc
, edge e
, int expected_src_idx
,
1734 int expected_dest_idx
, int expected_flags
)
1736 ASSERT_EQ_AT (loc
, expected_src_idx
, e
->src
->index
);
1737 ASSERT_EQ_AT (loc
, expected_dest_idx
, e
->dest
->index
);
1738 ASSERT_EQ_AT (loc
, expected_flags
, e
->flags
);
1741 /* Verify that edge EDGE is as expected, with the src and dest basic blocks
1742 having indices EXPECTED_SRC_IDX and EXPECTED_DEST_IDX respectively, and
1743 the edge having flags equal to EXPECTED_FLAGS. */
1745 #define ASSERT_EDGE(EDGE, EXPECTED_SRC_IDX, EXPECTED_DEST_IDX, \
1747 assert_edge_at (SELFTEST_LOCATION, EDGE, EXPECTED_SRC_IDX, \
1748 EXPECTED_DEST_IDX, EXPECTED_FLAGS)
1750 /* Verify that we can load RTL dumps. */
1753 test_loading_dump_fragment_1 ()
1755 // TODO: filter on target?
1756 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("asr_div1.rtl"));
1758 /* Verify that the insns were loaded correctly. */
1759 rtx_insn
*insn_1
= get_insns ();
1760 ASSERT_TRUE (insn_1
);
1761 ASSERT_EQ (1, INSN_UID (insn_1
));
1762 ASSERT_EQ (INSN
, GET_CODE (insn_1
));
1763 ASSERT_EQ (SET
, GET_CODE (PATTERN (insn_1
)));
1764 ASSERT_EQ (NULL
, PREV_INSN (insn_1
));
1766 rtx_insn
*insn_2
= NEXT_INSN (insn_1
);
1767 ASSERT_TRUE (insn_2
);
1768 ASSERT_EQ (2, INSN_UID (insn_2
));
1769 ASSERT_EQ (INSN
, GET_CODE (insn_2
));
1770 ASSERT_EQ (insn_1
, PREV_INSN (insn_2
));
1771 ASSERT_EQ (NULL
, NEXT_INSN (insn_2
));
1773 /* Verify that registers were loaded correctly. */
1774 rtx insn_1_dest
= SET_DEST (PATTERN (insn_1
));
1775 ASSERT_EQ (REG
, GET_CODE (insn_1_dest
));
1776 ASSERT_EQ ((LAST_VIRTUAL_REGISTER
+ 1) + 2, REGNO (insn_1_dest
));
1777 rtx insn_1_src
= SET_SRC (PATTERN (insn_1
));
1778 ASSERT_EQ (LSHIFTRT
, GET_CODE (insn_1_src
));
1779 rtx reg
= XEXP (insn_1_src
, 0);
1780 ASSERT_EQ (REG
, GET_CODE (reg
));
1781 ASSERT_EQ (LAST_VIRTUAL_REGISTER
+ 1, REGNO (reg
));
1783 /* Verify that get_insn_by_uid works. */
1784 ASSERT_EQ (insn_1
, get_insn_by_uid (1));
1785 ASSERT_EQ (insn_2
, get_insn_by_uid (2));
1787 /* Verify that basic blocks were created. */
1788 ASSERT_EQ (2, BLOCK_FOR_INSN (insn_1
)->index
);
1789 ASSERT_EQ (2, BLOCK_FOR_INSN (insn_2
)->index
);
1791 /* Verify that the CFG was recreated. */
1793 verify_three_block_rtl_cfg (cfun
);
1794 basic_block bb2
= BASIC_BLOCK_FOR_FN (cfun
, 2);
1795 ASSERT_TRUE (bb2
!= NULL
);
1796 ASSERT_EQ (BB_RTL
, bb2
->flags
& BB_RTL
);
1797 ASSERT_EQ (2, bb2
->index
);
1798 ASSERT_EQ (insn_1
, BB_HEAD (bb2
));
1799 ASSERT_EQ (insn_2
, BB_END (bb2
));
1802 /* Verify loading another RTL dump. */
1805 test_loading_dump_fragment_2 ()
1807 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("simple-cse.rtl"));
1809 rtx_insn
*insn_1
= get_insn_by_uid (1);
1810 rtx_insn
*insn_2
= get_insn_by_uid (2);
1811 rtx_insn
*insn_3
= get_insn_by_uid (3);
1813 rtx set1
= single_set (insn_1
);
1814 ASSERT_NE (NULL
, set1
);
1815 rtx set2
= single_set (insn_2
);
1816 ASSERT_NE (NULL
, set2
);
1817 rtx set3
= single_set (insn_3
);
1818 ASSERT_NE (NULL
, set3
);
1820 rtx src1
= SET_SRC (set1
);
1821 ASSERT_EQ (PLUS
, GET_CODE (src1
));
1823 rtx src2
= SET_SRC (set2
);
1824 ASSERT_EQ (PLUS
, GET_CODE (src2
));
1826 /* Both src1 and src2 refer to "(reg:SI %0)".
1827 Verify that we have pointer equality. */
1828 rtx lhs1
= XEXP (src1
, 0);
1829 rtx lhs2
= XEXP (src2
, 0);
1830 ASSERT_EQ (lhs1
, lhs2
);
1832 /* Verify that the CFG was recreated. */
1834 verify_three_block_rtl_cfg (cfun
);
1837 /* Verify that CODE_LABEL insns are loaded correctly. */
1840 test_loading_labels ()
1842 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("example-labels.rtl"));
1844 rtx_insn
*insn_100
= get_insn_by_uid (100);
1845 ASSERT_EQ (CODE_LABEL
, GET_CODE (insn_100
));
1846 ASSERT_EQ (100, INSN_UID (insn_100
));
1847 ASSERT_EQ (NULL
, LABEL_NAME (insn_100
));
1848 ASSERT_EQ (0, LABEL_NUSES (insn_100
));
1849 ASSERT_EQ (30, CODE_LABEL_NUMBER (insn_100
));
1851 rtx_insn
*insn_200
= get_insn_by_uid (200);
1852 ASSERT_EQ (CODE_LABEL
, GET_CODE (insn_200
));
1853 ASSERT_EQ (200, INSN_UID (insn_200
));
1854 ASSERT_STREQ ("some_label_name", LABEL_NAME (insn_200
));
1855 ASSERT_EQ (0, LABEL_NUSES (insn_200
));
1856 ASSERT_EQ (40, CODE_LABEL_NUMBER (insn_200
));
1858 /* Ensure that the presence of CODE_LABEL_NUMBER == 40
1859 means that the next label num to be handed out will be 41. */
1860 ASSERT_EQ (41, max_label_num ());
1862 /* Ensure that label names read from a dump are GC-managed
1863 and are found through the insn. */
1864 forcibly_ggc_collect ();
1865 ASSERT_TRUE (ggc_marked_p (insn_200
));
1866 ASSERT_TRUE (ggc_marked_p (LABEL_NAME (insn_200
)));
1869 /* Verify that the loader copes with an insn with a mode. */
1872 test_loading_insn_with_mode ()
1874 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("insn-with-mode.rtl"));
1875 rtx_insn
*insn
= get_insns ();
1876 ASSERT_EQ (INSN
, GET_CODE (insn
));
1878 /* Verify that the "TI" mode was set from "insn:TI". */
1879 ASSERT_EQ (TImode
, GET_MODE (insn
));
1882 /* Verify that the loader copes with a jump_insn to a label_ref. */
1885 test_loading_jump_to_label_ref ()
1887 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("jump-to-label-ref.rtl"));
1889 rtx_insn
*jump_insn
= get_insn_by_uid (1);
1890 ASSERT_EQ (JUMP_INSN
, GET_CODE (jump_insn
));
1892 rtx_insn
*barrier
= get_insn_by_uid (2);
1893 ASSERT_EQ (BARRIER
, GET_CODE (barrier
));
1895 rtx_insn
*code_label
= get_insn_by_uid (100);
1896 ASSERT_EQ (CODE_LABEL
, GET_CODE (code_label
));
1898 /* Verify the jump_insn. */
1899 ASSERT_EQ (4, BLOCK_FOR_INSN (jump_insn
)->index
);
1900 ASSERT_EQ (SET
, GET_CODE (PATTERN (jump_insn
)));
1901 /* Ensure that the "(pc)" is using the global singleton. */
1902 ASSERT_RTX_PTR_EQ (pc_rtx
, SET_DEST (PATTERN (jump_insn
)));
1903 rtx label_ref
= SET_SRC (PATTERN (jump_insn
));
1904 ASSERT_EQ (LABEL_REF
, GET_CODE (label_ref
));
1905 ASSERT_EQ (code_label
, label_ref_label (label_ref
));
1906 ASSERT_EQ (code_label
, JUMP_LABEL (jump_insn
));
1908 /* Verify the code_label. */
1909 ASSERT_EQ (5, BLOCK_FOR_INSN (code_label
)->index
);
1910 ASSERT_EQ (NULL
, LABEL_NAME (code_label
));
1911 ASSERT_EQ (1, LABEL_NUSES (code_label
));
1913 /* Verify the generated CFG. */
1915 /* Locate blocks. */
1916 basic_block entry
= ENTRY_BLOCK_PTR_FOR_FN (cfun
);
1917 ASSERT_TRUE (entry
!= NULL
);
1918 ASSERT_EQ (ENTRY_BLOCK
, entry
->index
);
1920 basic_block exit
= EXIT_BLOCK_PTR_FOR_FN (cfun
);
1921 ASSERT_TRUE (exit
!= NULL
);
1922 ASSERT_EQ (EXIT_BLOCK
, exit
->index
);
1924 basic_block bb4
= (*cfun
->cfg
->x_basic_block_info
)[4];
1925 basic_block bb5
= (*cfun
->cfg
->x_basic_block_info
)[5];
1926 ASSERT_EQ (4, bb4
->index
);
1927 ASSERT_EQ (5, bb5
->index
);
1930 ASSERT_EQ (NULL
, entry
->preds
);
1931 ASSERT_EQ (1, entry
->succs
->length ());
1932 ASSERT_EDGE ((*entry
->succs
)[0], 0, 4, EDGE_FALLTHRU
);
1935 ASSERT_EQ (1, bb4
->preds
->length ());
1936 ASSERT_EDGE ((*bb4
->preds
)[0], 0, 4, EDGE_FALLTHRU
);
1937 ASSERT_EQ (1, bb4
->succs
->length ());
1938 ASSERT_EDGE ((*bb4
->succs
)[0], 4, 5, 0x0);
1941 ASSERT_EQ (1, bb5
->preds
->length ());
1942 ASSERT_EDGE ((*bb5
->preds
)[0], 4, 5, 0x0);
1943 ASSERT_EQ (1, bb5
->succs
->length ());
1944 ASSERT_EDGE ((*bb5
->succs
)[0], 5, 1, EDGE_FALLTHRU
);
1947 ASSERT_EQ (1, exit
->preds
->length ());
1948 ASSERT_EDGE ((*exit
->preds
)[0], 5, 1, EDGE_FALLTHRU
);
1949 ASSERT_EQ (NULL
, exit
->succs
);
1952 /* Verify that the loader copes with a jump_insn to a label_ref
1956 test_loading_jump_to_return ()
1958 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("jump-to-return.rtl"));
1960 rtx_insn
*jump_insn
= get_insn_by_uid (1);
1961 ASSERT_EQ (JUMP_INSN
, GET_CODE (jump_insn
));
1962 ASSERT_RTX_PTR_EQ (ret_rtx
, JUMP_LABEL (jump_insn
));
1965 /* Verify that the loader copes with a jump_insn to a label_ref
1966 marked "simple_return". */
1969 test_loading_jump_to_simple_return ()
1971 rtl_dump_test
t (SELFTEST_LOCATION
,
1972 locate_file ("jump-to-simple-return.rtl"));
1974 rtx_insn
*jump_insn
= get_insn_by_uid (1);
1975 ASSERT_EQ (JUMP_INSN
, GET_CODE (jump_insn
));
1976 ASSERT_RTX_PTR_EQ (simple_return_rtx
, JUMP_LABEL (jump_insn
));
1979 /* Verify that the loader copes with a NOTE_INSN_BASIC_BLOCK. */
1982 test_loading_note_insn_basic_block ()
1984 rtl_dump_test
t (SELFTEST_LOCATION
,
1985 locate_file ("note_insn_basic_block.rtl"));
1987 rtx_insn
*note
= get_insn_by_uid (1);
1988 ASSERT_EQ (NOTE
, GET_CODE (note
));
1989 ASSERT_EQ (2, BLOCK_FOR_INSN (note
)->index
);
1991 ASSERT_EQ (NOTE_INSN_BASIC_BLOCK
, NOTE_KIND (note
));
1992 ASSERT_EQ (2, NOTE_BASIC_BLOCK (note
)->index
);
1993 ASSERT_EQ (BASIC_BLOCK_FOR_FN (cfun
, 2), NOTE_BASIC_BLOCK (note
));
1996 /* Verify that the loader copes with a NOTE_INSN_DELETED. */
1999 test_loading_note_insn_deleted ()
2001 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("note-insn-deleted.rtl"));
2003 rtx_insn
*note
= get_insn_by_uid (1);
2004 ASSERT_EQ (NOTE
, GET_CODE (note
));
2005 ASSERT_EQ (NOTE_INSN_DELETED
, NOTE_KIND (note
));
2008 /* Verify that the const_int values are consolidated, since
2009 pointer equality corresponds to value equality.
2010 TODO: do this for all in CASE_CONST_UNIQUE. */
2013 test_loading_const_int ()
2015 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("const-int.rtl"));
2017 /* Verify that const_int values below MAX_SAVED_CONST_INT use
2018 the global values. */
2019 ASSERT_EQ (const0_rtx
, SET_SRC (PATTERN (get_insn_by_uid (1))));
2020 ASSERT_EQ (const1_rtx
, SET_SRC (PATTERN (get_insn_by_uid (2))));
2021 ASSERT_EQ (constm1_rtx
, SET_SRC (PATTERN (get_insn_by_uid (3))));
2023 /* Verify that other const_int values are consolidated. */
2024 rtx int256
= gen_rtx_CONST_INT (SImode
, 256);
2025 ASSERT_EQ (int256
, SET_SRC (PATTERN (get_insn_by_uid (4))));
2028 /* Verify that the loader copes with a SYMBOL_REF. */
2031 test_loading_symbol_ref ()
2033 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("symbol-ref.rtl"));
2035 rtx_insn
*insn
= get_insns ();
2037 rtx high
= SET_SRC (PATTERN (insn
));
2038 ASSERT_EQ (HIGH
, GET_CODE (high
));
2040 rtx symbol_ref
= XEXP (high
, 0);
2041 ASSERT_EQ (SYMBOL_REF
, GET_CODE (symbol_ref
));
2043 /* Verify that "[flags 0xc0]" was parsed. */
2044 ASSERT_EQ (0xc0, SYMBOL_REF_FLAGS (symbol_ref
));
2045 /* TODO: we don't yet load SYMBOL_REF_DECL. */
2048 /* Verify that the loader can rebuild a CFG. */
2053 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("cfg-test.rtl"));
2055 ASSERT_STREQ ("cfg_test", IDENTIFIER_POINTER (DECL_NAME (cfun
->decl
)));
2059 ASSERT_TRUE (cfun
->cfg
!= NULL
);
2060 ASSERT_EQ (6, n_basic_blocks_for_fn (cfun
));
2061 ASSERT_EQ (6, n_edges_for_fn (cfun
));
2063 /* The "fake" basic blocks. */
2064 basic_block entry
= ENTRY_BLOCK_PTR_FOR_FN (cfun
);
2065 ASSERT_TRUE (entry
!= NULL
);
2066 ASSERT_EQ (ENTRY_BLOCK
, entry
->index
);
2068 basic_block exit
= EXIT_BLOCK_PTR_FOR_FN (cfun
);
2069 ASSERT_TRUE (exit
!= NULL
);
2070 ASSERT_EQ (EXIT_BLOCK
, exit
->index
);
2072 /* The "real" basic blocks. */
2073 basic_block bb2
= (*cfun
->cfg
->x_basic_block_info
)[2];
2074 basic_block bb3
= (*cfun
->cfg
->x_basic_block_info
)[3];
2075 basic_block bb4
= (*cfun
->cfg
->x_basic_block_info
)[4];
2076 basic_block bb5
= (*cfun
->cfg
->x_basic_block_info
)[5];
2078 ASSERT_EQ (2, bb2
->index
);
2079 ASSERT_EQ (3, bb3
->index
);
2080 ASSERT_EQ (4, bb4
->index
);
2081 ASSERT_EQ (5, bb5
->index
);
2083 /* Verify connectivity. */
2086 ASSERT_EQ (NULL
, entry
->preds
);
2087 ASSERT_EQ (1, entry
->succs
->length ());
2088 ASSERT_EDGE ((*entry
->succs
)[0], 0, 2, EDGE_FALLTHRU
);
2091 ASSERT_EQ (1, bb2
->preds
->length ());
2092 ASSERT_EDGE ((*bb2
->preds
)[0], 0, 2, EDGE_FALLTHRU
);
2093 ASSERT_EQ (2, bb2
->succs
->length ());
2094 ASSERT_EDGE ((*bb2
->succs
)[0], 2, 3, EDGE_TRUE_VALUE
);
2095 ASSERT_EDGE ((*bb2
->succs
)[1], 2, 4, EDGE_FALSE_VALUE
);
2098 ASSERT_EQ (1, bb3
->preds
->length ());
2099 ASSERT_EDGE ((*bb3
->preds
)[0], 2, 3, EDGE_TRUE_VALUE
);
2100 ASSERT_EQ (1, bb3
->succs
->length ());
2101 ASSERT_EDGE ((*bb3
->succs
)[0], 3, 5, EDGE_FALLTHRU
);
2104 ASSERT_EQ (1, bb4
->preds
->length ());
2105 ASSERT_EDGE ((*bb4
->preds
)[0], 2, 4, EDGE_FALSE_VALUE
);
2106 ASSERT_EQ (1, bb4
->succs
->length ());
2107 ASSERT_EDGE ((*bb4
->succs
)[0], 4, 5, EDGE_FALLTHRU
);
2110 ASSERT_EQ (2, bb5
->preds
->length ());
2111 ASSERT_EDGE ((*bb5
->preds
)[0], 3, 5, EDGE_FALLTHRU
);
2112 ASSERT_EDGE ((*bb5
->preds
)[1], 4, 5, EDGE_FALLTHRU
);
2113 ASSERT_EQ (1, bb5
->succs
->length ());
2114 ASSERT_EDGE ((*bb5
->succs
)[0], 5, 1, EDGE_FALLTHRU
);
2117 ASSERT_EQ (1, exit
->preds
->length ());
2118 ASSERT_EDGE ((*exit
->preds
)[0], 5, 1, EDGE_FALLTHRU
);
2119 ASSERT_EQ (NULL
, exit
->succs
);
2122 /* Verify that the loader copes with sparse block indices.
2123 This testcase loads a file with a "(block 42)". */
2126 test_loading_bb_index ()
2128 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("bb-index.rtl"));
2130 ASSERT_STREQ ("test_bb_index", IDENTIFIER_POINTER (DECL_NAME (cfun
->decl
)));
2134 ASSERT_TRUE (cfun
->cfg
!= NULL
);
2135 ASSERT_EQ (3, n_basic_blocks_for_fn (cfun
));
2136 ASSERT_EQ (43, basic_block_info_for_fn (cfun
)->length ());
2137 ASSERT_EQ (2, n_edges_for_fn (cfun
));
2139 ASSERT_EQ (NULL
, (*cfun
->cfg
->x_basic_block_info
)[41]);
2140 basic_block bb42
= (*cfun
->cfg
->x_basic_block_info
)[42];
2141 ASSERT_NE (NULL
, bb42
);
2142 ASSERT_EQ (42, bb42
->index
);
2145 /* Verify that function_reader::handle_any_trailing_information correctly
2146 parses all the possible items emitted for a MEM. */
2151 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("mem.rtl"));
2153 ASSERT_STREQ ("test_mem", IDENTIFIER_POINTER (DECL_NAME (cfun
->decl
)));
2156 /* Verify parsing of "[42 i+17 S8 A128 AS5]". */
2157 rtx_insn
*insn_1
= get_insn_by_uid (1);
2158 rtx set1
= single_set (insn_1
);
2159 rtx mem1
= SET_DEST (set1
);
2160 ASSERT_EQ (42, MEM_ALIAS_SET (mem1
));
2162 ASSERT_TRUE (MEM_OFFSET_KNOWN_P (mem1
));
2163 ASSERT_KNOWN_EQ (17, MEM_OFFSET (mem1
));
2165 ASSERT_KNOWN_EQ (8, MEM_SIZE (mem1
));
2167 ASSERT_EQ (128, MEM_ALIGN (mem1
));
2169 ASSERT_EQ (5, MEM_ADDR_SPACE (mem1
));
2171 /* Verify parsing of "43 i+18 S9 AS6"
2172 (an address space without an alignment). */
2173 rtx_insn
*insn_2
= get_insn_by_uid (2);
2174 rtx set2
= single_set (insn_2
);
2175 rtx mem2
= SET_DEST (set2
);
2176 ASSERT_EQ (43, MEM_ALIAS_SET (mem2
));
2178 ASSERT_TRUE (MEM_OFFSET_KNOWN_P (mem2
));
2179 ASSERT_KNOWN_EQ (18, MEM_OFFSET (mem2
));
2181 ASSERT_KNOWN_EQ (9, MEM_SIZE (mem2
));
2183 ASSERT_EQ (6, MEM_ADDR_SPACE (mem2
));
2186 /* Verify that "repeated xN" is read correctly. */
2189 test_loading_repeat ()
2191 rtl_dump_test
t (SELFTEST_LOCATION
, locate_file ("repeat.rtl"));
2193 rtx_insn
*insn_1
= get_insn_by_uid (1);
2194 ASSERT_EQ (PARALLEL
, GET_CODE (PATTERN (insn_1
)));
2195 ASSERT_EQ (64, XVECLEN (PATTERN (insn_1
), 0));
2196 for (int i
= 0; i
< 64; i
++)
2197 ASSERT_EQ (const0_rtx
, XVECEXP (PATTERN (insn_1
), 0, i
));
2200 /* Run all of the selftests within this file. */
2203 read_rtl_function_c_tests ()
2206 test_parsing_regnos ();
2207 test_loading_dump_fragment_1 ();
2208 test_loading_dump_fragment_2 ();
2209 test_loading_labels ();
2210 test_loading_insn_with_mode ();
2211 test_loading_jump_to_label_ref ();
2212 test_loading_jump_to_return ();
2213 test_loading_jump_to_simple_return ();
2214 test_loading_note_insn_basic_block ();
2215 test_loading_note_insn_deleted ();
2216 test_loading_const_int ();
2217 test_loading_symbol_ref ();
2218 test_loading_cfg ();
2219 test_loading_bb_index ();
2220 test_loading_mem ();
2221 test_loading_repeat ();
2224 } // namespace selftest
2226 #endif /* #if CHECKING_P */