1 /* Tree-dumping functionality for intermediate representation.
2 Copyright (C) 1999-2014 Free Software Foundation, Inc.
3 Written by Mark Mitchell <mark@codesourcery.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
23 #include "coretypes.h"
26 #include "splay-tree.h"
27 #include "filenames.h"
28 #include "tree-dump.h"
29 #include "langhooks.h"
30 #include "tree-iterator.h"
31 #include "tree-pretty-print.h"
34 #include "wide-int-print.h"
36 static unsigned int queue (dump_info_p
, const_tree
, int);
37 static void dump_index (dump_info_p
, unsigned int);
38 static void dequeue_and_dump (dump_info_p
);
39 static void dump_new_line (dump_info_p
);
40 static void dump_maybe_newline (dump_info_p
);
42 /* Add T to the end of the queue of nodes to dump. Returns the index
46 queue (dump_info_p di
, const_tree t
, int flags
)
52 /* Assign the next available index to T. */
55 /* Obtain a new queue node. */
59 di
->free_list
= dq
->next
;
62 dq
= XNEW (struct dump_queue
);
64 /* Create a new entry in the splay-tree. */
65 dni
= XNEW (struct dump_node_info
);
67 dni
->binfo_p
= ((flags
& DUMP_BINFO
) != 0);
68 dq
->node
= splay_tree_insert (di
->nodes
, (splay_tree_key
) t
,
69 (splay_tree_value
) dni
);
71 /* Add it to the end of the queue. */
76 di
->queue_end
->next
= dq
;
79 /* Return the index. */
84 dump_index (dump_info_p di
, unsigned int index
)
86 fprintf (di
->stream
, "@%-6u ", index
);
90 /* If T has not already been output, queue it for subsequent output.
91 FIELD is a string to print before printing the index. Then, the
92 index of T is printed. */
95 queue_and_dump_index (dump_info_p di
, const char *field
, const_tree t
, int flags
)
100 /* If there's no node, just return. This makes for fewer checks in
105 /* See if we've already queued or dumped this node. */
106 n
= splay_tree_lookup (di
->nodes
, (splay_tree_key
) t
);
108 index
= ((dump_node_info_p
) n
->value
)->index
;
110 /* If we haven't, add it to the queue. */
111 index
= queue (di
, t
, flags
);
113 /* Print the index of the node. */
114 dump_maybe_newline (di
);
115 fprintf (di
->stream
, "%-4s: ", field
);
117 dump_index (di
, index
);
120 /* Dump the type of T. */
123 queue_and_dump_type (dump_info_p di
, const_tree t
)
125 queue_and_dump_index (di
, "type", TREE_TYPE (t
), DUMP_NONE
);
128 /* Dump column control */
129 #define SOL_COLUMN 25 /* Start of line column. */
130 #define EOL_COLUMN 55 /* End of line column. */
131 #define COLUMN_ALIGNMENT 15 /* Alignment. */
133 /* Insert a new line in the dump output, and indent to an appropriate
134 place to start printing more fields. */
137 dump_new_line (dump_info_p di
)
139 fprintf (di
->stream
, "\n%*s", SOL_COLUMN
, "");
140 di
->column
= SOL_COLUMN
;
143 /* If necessary, insert a new line. */
146 dump_maybe_newline (dump_info_p di
)
150 /* See if we need a new line. */
151 if (di
->column
> EOL_COLUMN
)
153 /* See if we need any padding. */
154 else if ((extra
= (di
->column
- SOL_COLUMN
) % COLUMN_ALIGNMENT
) != 0)
156 fprintf (di
->stream
, "%*s", COLUMN_ALIGNMENT
- extra
, "");
157 di
->column
+= COLUMN_ALIGNMENT
- extra
;
161 /* Dump FUNCTION_DECL FN as tree dump PHASE. */
164 dump_function (int phase
, tree fn
)
169 stream
= dump_begin (phase
, &flags
);
172 dump_function_to_file (fn
, stream
, flags
);
173 dump_end (phase
, stream
);
177 /* Dump pointer PTR using FIELD to identify it. */
180 dump_pointer (dump_info_p di
, const char *field
, void *ptr
)
182 dump_maybe_newline (di
);
183 fprintf (di
->stream
, "%-4s: %-8" HOST_WIDE_INT_PRINT
"x ", field
,
184 (unsigned HOST_WIDE_INT
) (uintptr_t) ptr
);
188 /* Dump integer I using FIELD to identify it. */
191 dump_int (dump_info_p di
, const char *field
, int i
)
193 dump_maybe_newline (di
);
194 fprintf (di
->stream
, "%-4s: %-7d ", field
, i
);
198 /* Dump the floating point value R, using FIELD to identify it. */
201 dump_real (dump_info_p di
, const char *field
, const REAL_VALUE_TYPE
*r
)
204 real_to_decimal (buf
, r
, sizeof (buf
), 0, true);
205 dump_maybe_newline (di
);
206 fprintf (di
->stream
, "%-4s: %s ", field
, buf
);
207 di
->column
+= strlen (buf
) + 7;
210 /* Dump the fixed-point value F, using FIELD to identify it. */
213 dump_fixed (dump_info_p di
, const char *field
, const FIXED_VALUE_TYPE
*f
)
216 fixed_to_decimal (buf
, f
, sizeof (buf
));
217 dump_maybe_newline (di
);
218 fprintf (di
->stream
, "%-4s: %s ", field
, buf
);
219 di
->column
+= strlen (buf
) + 7;
223 /* Dump the string S. */
226 dump_string (dump_info_p di
, const char *string
)
228 dump_maybe_newline (di
);
229 fprintf (di
->stream
, "%-13s ", string
);
230 if (strlen (string
) > 13)
231 di
->column
+= strlen (string
) + 1;
236 /* Dump the string field S. */
239 dump_string_field (dump_info_p di
, const char *field
, const char *string
)
241 dump_maybe_newline (di
);
242 fprintf (di
->stream
, "%-4s: %-7s ", field
, string
);
243 if (strlen (string
) > 7)
244 di
->column
+= 6 + strlen (string
) + 1;
249 /* Dump the next node in the queue. */
252 dequeue_and_dump (dump_info_p di
)
256 dump_node_info_p dni
;
260 enum tree_code_class code_class
;
261 const char* code_name
;
263 /* Get the next node from the queue. */
267 dni
= (dump_node_info_p
) stn
->value
;
270 /* Remove the node from the queue, and put it on the free list. */
271 di
->queue
= dq
->next
;
274 dq
->next
= di
->free_list
;
277 /* Print the node index. */
278 dump_index (di
, index
);
279 /* And the type of node this is. */
283 code_name
= get_tree_code_name (TREE_CODE (t
));
284 fprintf (di
->stream
, "%-16s ", code_name
);
287 /* Figure out what kind of node this is. */
288 code
= TREE_CODE (t
);
289 code_class
= TREE_CODE_CLASS (code
);
291 /* Although BINFOs are TREE_VECs, we dump them specially so as to be
297 vec
<tree
, va_gc
> *accesses
= BINFO_BASE_ACCESSES (t
);
299 dump_child ("type", BINFO_TYPE (t
));
301 if (BINFO_VIRTUAL_P (t
))
302 dump_string_field (di
, "spec", "virt");
304 dump_int (di
, "bases", BINFO_N_BASE_BINFOS (t
));
305 for (ix
= 0; BINFO_BASE_ITERATE (t
, ix
, base
); ix
++)
307 tree access
= (accesses
? (*accesses
)[ix
] : access_public_node
);
308 const char *string
= NULL
;
310 if (access
== access_public_node
)
312 else if (access
== access_protected_node
)
314 else if (access
== access_private_node
)
319 dump_string_field (di
, "accs", string
);
320 queue_and_dump_index (di
, "binf", base
, DUMP_BINFO
);
326 /* We can knock off a bunch of expression nodes in exactly the same
328 if (IS_EXPR_CODE_CLASS (code_class
))
330 /* If we're dumping children, dump them now. */
331 queue_and_dump_type (di
, t
);
336 dump_child ("op 0", TREE_OPERAND (t
, 0));
341 dump_child ("op 0", TREE_OPERAND (t
, 0));
342 dump_child ("op 1", TREE_OPERAND (t
, 1));
349 /* These nodes are handled explicitly below. */
358 expanded_location xloc
;
359 /* All declarations have names. */
361 dump_child ("name", DECL_NAME (t
));
362 if (DECL_ASSEMBLER_NAME_SET_P (t
)
363 && DECL_ASSEMBLER_NAME (t
) != DECL_NAME (t
))
364 dump_child ("mngl", DECL_ASSEMBLER_NAME (t
));
365 if (DECL_ABSTRACT_ORIGIN (t
))
366 dump_child ("orig", DECL_ABSTRACT_ORIGIN (t
));
368 queue_and_dump_type (di
, t
);
369 dump_child ("scpe", DECL_CONTEXT (t
));
370 /* And a source position. */
371 xloc
= expand_location (DECL_SOURCE_LOCATION (t
));
374 const char *filename
= lbasename (xloc
.file
);
376 dump_maybe_newline (di
);
377 fprintf (di
->stream
, "srcp: %s:%-6d ", filename
,
379 di
->column
+= 6 + strlen (filename
) + 8;
381 /* And any declaration can be compiler-generated. */
382 if (CODE_CONTAINS_STRUCT (TREE_CODE (t
), TS_DECL_COMMON
)
383 && DECL_ARTIFICIAL (t
))
384 dump_string_field (di
, "note", "artificial");
385 if (DECL_CHAIN (t
) && !dump_flag (di
, TDF_SLIM
, NULL
))
386 dump_child ("chain", DECL_CHAIN (t
));
388 else if (code_class
== tcc_type
)
390 /* All types have qualifiers. */
391 int quals
= lang_hooks
.tree_dump
.type_quals (t
);
393 if (quals
!= TYPE_UNQUALIFIED
)
395 fprintf (di
->stream
, "qual: %c%c%c%c%c%c ",
396 (quals
& TYPE_QUAL_CONST
) ? 'c' : ' ',
397 (quals
& TYPE_QUAL_VOLATILE
) ? 'v' : ' ',
398 (quals
& TYPE_QUAL_RESTRICT
) ? 'r' : ' ',
399 (quals
& TYPE_QUAL_UPC_SHARED
) ? 's' : ' ',
400 (quals
& TYPE_QUAL_UPC_STRICT
) ? 't' : ' ',
401 (quals
& TYPE_QUAL_UPC_RELAXED
) ? 'x' : ' ');
405 /* All types have associated declarations. */
406 dump_child ("name", TYPE_NAME (t
));
408 /* All types have a main variant. */
409 if (TYPE_MAIN_VARIANT (t
) != t
)
410 dump_child ("unql", TYPE_MAIN_VARIANT (t
));
413 dump_child ("size", TYPE_SIZE (t
));
415 /* All types have alignments. */
416 dump_int (di
, "algn", TYPE_ALIGN (t
));
418 else if (code_class
== tcc_constant
)
419 /* All constants can have types. */
420 queue_and_dump_type (di
, t
);
422 /* Give the language-specific code a chance to print something. If
423 it's completely taken care of things, don't bother printing
424 anything more ourselves. */
425 if (lang_hooks
.tree_dump
.dump_tree (di
, t
))
428 /* Now handle the various kinds of nodes. */
433 case IDENTIFIER_NODE
:
434 dump_string_field (di
, "strg", IDENTIFIER_POINTER (t
));
435 dump_int (di
, "lngt", IDENTIFIER_LENGTH (t
));
439 dump_child ("purp", TREE_PURPOSE (t
));
440 dump_child ("valu", TREE_VALUE (t
));
441 dump_child ("chan", TREE_CHAIN (t
));
446 tree_stmt_iterator it
;
447 for (i
= 0, it
= tsi_start (t
); !tsi_end_p (it
); tsi_next (&it
), i
++)
450 sprintf (buffer
, "%u", i
);
451 dump_child (buffer
, tsi_stmt (it
));
457 dump_int (di
, "lngt", TREE_VEC_LENGTH (t
));
458 for (i
= 0; i
< TREE_VEC_LENGTH (t
); ++i
)
461 sprintf (buffer
, "%u", i
);
462 dump_child (buffer
, TREE_VEC_ELT (t
, i
));
468 dump_int (di
, "prec", TYPE_PRECISION (t
));
469 dump_string_field (di
, "sign", TYPE_UNSIGNED (t
) ? "unsigned": "signed");
470 dump_child ("min", TYPE_MIN_VALUE (t
));
471 dump_child ("max", TYPE_MAX_VALUE (t
));
473 if (code
== ENUMERAL_TYPE
)
474 dump_child ("csts", TYPE_VALUES (t
));
478 dump_int (di
, "prec", TYPE_PRECISION (t
));
481 case FIXED_POINT_TYPE
:
482 dump_int (di
, "prec", TYPE_PRECISION (t
));
483 dump_string_field (di
, "sign", TYPE_UNSIGNED (t
) ? "unsigned": "signed");
484 dump_string_field (di
, "saturating",
485 TYPE_SATURATING (t
) ? "saturating": "non-saturating");
489 dump_child ("ptd", TREE_TYPE (t
));
493 dump_child ("refd", TREE_TYPE (t
));
497 dump_child ("clas", TYPE_METHOD_BASETYPE (t
));
501 dump_child ("retn", TREE_TYPE (t
));
502 dump_child ("prms", TYPE_ARG_TYPES (t
));
506 dump_child ("elts", TREE_TYPE (t
));
507 dump_child ("domn", TYPE_DOMAIN (t
));
512 if (TREE_CODE (t
) == RECORD_TYPE
)
513 dump_string_field (di
, "tag", "struct");
515 dump_string_field (di
, "tag", "union");
517 dump_child ("flds", TYPE_FIELDS (t
));
518 dump_child ("fncs", TYPE_METHODS (t
));
519 queue_and_dump_index (di
, "binf", TYPE_BINFO (t
),
524 dump_child ("cnst", DECL_INITIAL (t
));
527 case DEBUG_EXPR_DECL
:
528 dump_int (di
, "-uid", DEBUG_TEMP_UID (t
));
535 if (TREE_CODE (t
) == PARM_DECL
)
536 dump_child ("argt", DECL_ARG_TYPE (t
));
538 dump_child ("init", DECL_INITIAL (t
));
539 dump_child ("size", DECL_SIZE (t
));
540 dump_int (di
, "algn", DECL_ALIGN (t
));
542 if (TREE_CODE (t
) == FIELD_DECL
)
544 if (DECL_FIELD_OFFSET (t
))
545 dump_child ("bpos", bit_position (t
));
547 else if (TREE_CODE (t
) == VAR_DECL
548 || TREE_CODE (t
) == PARM_DECL
)
550 dump_int (di
, "used", TREE_USED (t
));
551 if (DECL_REGISTER (t
))
552 dump_string_field (di
, "spec", "register");
557 dump_child ("args", DECL_ARGUMENTS (t
));
558 if (DECL_EXTERNAL (t
))
559 dump_string_field (di
, "body", "undefined");
561 dump_string_field (di
, "link", "extern");
563 dump_string_field (di
, "link", "static");
564 if (DECL_SAVED_TREE (t
) && !dump_flag (di
, TDF_SLIM
, t
))
565 dump_child ("body", DECL_SAVED_TREE (t
));
569 fprintf (di
->stream
, "int: ");
570 print_decs (t
, di
->stream
);
574 fprintf (di
->stream
, "strg: %-7s ", TREE_STRING_POINTER (t
));
575 dump_int (di
, "lngt", TREE_STRING_LENGTH (t
));
579 dump_real (di
, "valu", TREE_REAL_CST_PTR (t
));
583 dump_fixed (di
, "valu", TREE_FIXED_CST_PTR (t
));
589 case CLEANUP_POINT_EXPR
:
593 /* These nodes are unary, but do not have code class `1'. */
594 dump_child ("op 0", TREE_OPERAND (t
, 0));
597 case TRUTH_ANDIF_EXPR
:
598 case TRUTH_ORIF_EXPR
:
602 case PREDECREMENT_EXPR
:
603 case PREINCREMENT_EXPR
:
604 case POSTDECREMENT_EXPR
:
605 case POSTINCREMENT_EXPR
:
606 /* These nodes are binary, but do not have code class `2'. */
607 dump_child ("op 0", TREE_OPERAND (t
, 0));
608 dump_child ("op 1", TREE_OPERAND (t
, 1));
613 dump_child ("op 0", TREE_OPERAND (t
, 0));
614 dump_child ("op 1", TREE_OPERAND (t
, 1));
615 dump_child ("op 2", TREE_OPERAND (t
, 2));
619 case ARRAY_RANGE_REF
:
620 dump_child ("op 0", TREE_OPERAND (t
, 0));
621 dump_child ("op 1", TREE_OPERAND (t
, 1));
622 dump_child ("op 2", TREE_OPERAND (t
, 2));
623 dump_child ("op 3", TREE_OPERAND (t
, 3));
627 dump_child ("op 0", TREE_OPERAND (t
, 0));
628 dump_child ("op 1", TREE_OPERAND (t
, 1));
629 dump_child ("op 2", TREE_OPERAND (t
, 2));
632 case TRY_FINALLY_EXPR
:
633 dump_child ("op 0", TREE_OPERAND (t
, 0));
634 dump_child ("op 1", TREE_OPERAND (t
, 1));
641 call_expr_arg_iterator iter
;
642 dump_child ("fn", CALL_EXPR_FN (t
));
643 FOR_EACH_CALL_EXPR_ARG (arg
, iter
, t
)
646 sprintf (buffer
, "%u", i
);
647 dump_child (buffer
, arg
);
655 unsigned HOST_WIDE_INT cnt
;
657 dump_int (di
, "lngt", vec_safe_length (CONSTRUCTOR_ELTS (t
)));
658 FOR_EACH_CONSTRUCTOR_ELT (CONSTRUCTOR_ELTS (t
), cnt
, index
, value
)
660 dump_child ("idx", index
);
661 dump_child ("val", value
);
667 dump_child ("vars", TREE_OPERAND (t
, 0));
668 dump_child ("body", TREE_OPERAND (t
, 1));
672 dump_child ("body", TREE_OPERAND (t
, 0));
676 dump_child ("cond", TREE_OPERAND (t
, 0));
680 dump_child ("expr", TREE_OPERAND (t
, 0));
684 dump_child ("decl", TREE_OPERAND (t
, 0));
685 dump_child ("init", TREE_OPERAND (t
, 1));
686 dump_child ("clnp", TREE_OPERAND (t
, 2));
687 /* There really are two possible places the initializer can be.
688 After RTL expansion, the second operand is moved to the
689 position of the fourth operand, and the second operand
691 dump_child ("init", TREE_OPERAND (t
, 3));
694 case CASE_LABEL_EXPR
:
695 dump_child ("name", CASE_LABEL (t
));
698 dump_child ("low ", CASE_LOW (t
));
700 dump_child ("high", CASE_HIGH (t
));
704 dump_child ("name", TREE_OPERAND (t
,0));
707 dump_child ("labl", TREE_OPERAND (t
, 0));
710 dump_child ("cond", TREE_OPERAND (t
, 0));
711 dump_child ("body", TREE_OPERAND (t
, 1));
712 if (TREE_OPERAND (t
, 2))
714 dump_child ("labl", TREE_OPERAND (t
,2));
720 fprintf (di
->stream
, "%s\n", omp_clause_code_name
[OMP_CLAUSE_CODE (t
)]);
721 for (i
= 0; i
< omp_clause_num_ops
[OMP_CLAUSE_CODE (t
)]; i
++)
722 dump_child ("op: ", OMP_CLAUSE_OPERAND (t
, i
));
726 /* There are no additional fields to print. */
731 if (dump_flag (di
, TDF_ADDRESS
, NULL
))
732 dump_pointer (di
, "addr", (void *)t
);
734 /* Terminate the line. */
735 fprintf (di
->stream
, "\n");
738 /* Return nonzero if FLAG has been specified for the dump, and NODE
739 is not the root node of the dump. */
741 int dump_flag (dump_info_p di
, int flag
, const_tree node
)
743 return (di
->flags
& flag
) && (node
!= di
->node
);
746 /* Dump T, and all its children, on STREAM. */
749 dump_node (const_tree t
, int flags
, FILE *stream
)
753 dump_queue_p next_dq
;
755 /* Initialize the dump-information structure. */
764 di
.nodes
= splay_tree_new (splay_tree_compare_pointers
, 0,
765 (splay_tree_delete_value_fn
) &free
);
767 /* Queue up the first node. */
768 queue (&di
, t
, DUMP_NONE
);
770 /* Until the queue is empty, keep dumping nodes. */
772 dequeue_and_dump (&di
);
775 for (dq
= di
.free_list
; dq
; dq
= next_dq
)
780 splay_tree_delete (di
.nodes
);