OSDN Git Service

enable SH libgloss build
[pf3gnuchains/gcc-fork.git] / gcc / tree-dump.c
1 /* Tree-dumping functionality for intermediate representation.
2    Copyright (C) 1999, 2000, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
3    Free Software Foundation, Inc.
4    Written by Mark Mitchell <mark@codesourcery.com>
5
6 This file is part of GCC.
7
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
11 version.
12
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
16 for more details.
17
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/>.  */
21
22 #include "config.h"
23 #include "system.h"
24 #include "coretypes.h"
25 #include "tm.h"
26 #include "tree.h"
27 #include "splay-tree.h"
28 #include "diagnostic.h"
29 #include "toplev.h"
30 #include "tree-dump.h"
31 #include "tree-pass.h"
32 #include "langhooks.h"
33 #include "tree-iterator.h"
34 #include "real.h"
35 #include "fixed-value.h"
36
37 static unsigned int queue (dump_info_p, const_tree, int);
38 static void dump_index (dump_info_p, unsigned int);
39 static void dequeue_and_dump (dump_info_p);
40 static void dump_new_line (dump_info_p);
41 static void dump_maybe_newline (dump_info_p);
42
43 /* Add T to the end of the queue of nodes to dump.  Returns the index
44    assigned to T.  */
45
46 static unsigned int
47 queue (dump_info_p di, const_tree t, int flags)
48 {
49   dump_queue_p dq;
50   dump_node_info_p dni;
51   unsigned int index;
52
53   /* Assign the next available index to T.  */
54   index = ++di->index;
55
56   /* Obtain a new queue node.  */
57   if (di->free_list)
58     {
59       dq = di->free_list;
60       di->free_list = dq->next;
61     }
62   else
63     dq = XNEW (struct dump_queue);
64
65   /* Create a new entry in the splay-tree.  */
66   dni = XNEW (struct dump_node_info);
67   dni->index = index;
68   dni->binfo_p = ((flags & DUMP_BINFO) != 0);
69   dq->node = splay_tree_insert (di->nodes, (splay_tree_key) t,
70                                 (splay_tree_value) dni);
71
72   /* Add it to the end of the queue.  */
73   dq->next = 0;
74   if (!di->queue_end)
75     di->queue = dq;
76   else
77     di->queue_end->next = dq;
78   di->queue_end = dq;
79
80   /* Return the index.  */
81   return index;
82 }
83
84 static void
85 dump_index (dump_info_p di, unsigned int index)
86 {
87   fprintf (di->stream, "@%-6u ", index);
88   di->column += 8;
89 }
90
91 /* If T has not already been output, queue it for subsequent output.
92    FIELD is a string to print before printing the index.  Then, the
93    index of T is printed.  */
94
95 void
96 queue_and_dump_index (dump_info_p di, const char *field, const_tree t, int flags)
97 {
98   unsigned int index;
99   splay_tree_node n;
100
101   /* If there's no node, just return.  This makes for fewer checks in
102      our callers.  */
103   if (!t)
104     return;
105
106   /* See if we've already queued or dumped this node.  */
107   n = splay_tree_lookup (di->nodes, (splay_tree_key) t);
108   if (n)
109     index = ((dump_node_info_p) n->value)->index;
110   else
111     /* If we haven't, add it to the queue.  */
112     index = queue (di, t, flags);
113
114   /* Print the index of the node.  */
115   dump_maybe_newline (di);
116   fprintf (di->stream, "%-4s: ", field);
117   di->column += 6;
118   dump_index (di, index);
119 }
120
121 /* Dump the type of T.  */
122
123 void
124 queue_and_dump_type (dump_info_p di, const_tree t)
125 {
126   queue_and_dump_index (di, "type", TREE_TYPE (t), DUMP_NONE);
127 }
128
129 /* Dump column control */
130 #define SOL_COLUMN 25           /* Start of line column.  */
131 #define EOL_COLUMN 55           /* End of line column.  */
132 #define COLUMN_ALIGNMENT 15     /* Alignment.  */
133
134 /* Insert a new line in the dump output, and indent to an appropriate
135    place to start printing more fields.  */
136
137 static void
138 dump_new_line (dump_info_p di)
139 {
140   fprintf (di->stream, "\n%*s", SOL_COLUMN, "");
141   di->column = SOL_COLUMN;
142 }
143
144 /* If necessary, insert a new line.  */
145
146 static void
147 dump_maybe_newline (dump_info_p di)
148 {
149   int extra;
150
151   /* See if we need a new line.  */
152   if (di->column > EOL_COLUMN)
153     dump_new_line (di);
154   /* See if we need any padding.  */
155   else if ((extra = (di->column - SOL_COLUMN) % COLUMN_ALIGNMENT) != 0)
156     {
157       fprintf (di->stream, "%*s", COLUMN_ALIGNMENT - extra, "");
158       di->column += COLUMN_ALIGNMENT - extra;
159     }
160 }
161
162 /* Dump pointer PTR using FIELD to identify it.  */
163
164 void
165 dump_pointer (dump_info_p di, const char *field, void *ptr)
166 {
167   dump_maybe_newline (di);
168   fprintf (di->stream, "%-4s: %-8lx ", field, (unsigned long) ptr);
169   di->column += 15;
170 }
171
172 /* Dump integer I using FIELD to identify it.  */
173
174 void
175 dump_int (dump_info_p di, const char *field, int i)
176 {
177   dump_maybe_newline (di);
178   fprintf (di->stream, "%-4s: %-7d ", field, i);
179   di->column += 14;
180 }
181
182 /* Dump the floating point value R, using FIELD to identify it.  */
183
184 static void
185 dump_real (dump_info_p di, const char *field, const REAL_VALUE_TYPE *r)
186 {
187   char buf[32];
188   real_to_decimal (buf, r, sizeof (buf), 0, true);
189   dump_maybe_newline (di);
190   fprintf (di->stream, "%-4s: %s ", field, buf);
191   di->column += strlen (buf) + 7;
192 }
193
194 /* Dump the fixed-point value F, using FIELD to identify it.  */
195
196 static void
197 dump_fixed (dump_info_p di, const char *field, const FIXED_VALUE_TYPE *f)
198 {
199   char buf[32];
200   fixed_to_decimal (buf, f, sizeof (buf));
201   dump_maybe_newline (di);
202   fprintf (di->stream, "%-4s: %s ", field, buf);
203   di->column += strlen (buf) + 7;
204 }
205
206
207 /* Dump the string S.  */
208
209 void
210 dump_string (dump_info_p di, const char *string)
211 {
212   dump_maybe_newline (di);
213   fprintf (di->stream, "%-13s ", string);
214   if (strlen (string) > 13)
215     di->column += strlen (string) + 1;
216   else
217     di->column += 14;
218 }
219
220 /* Dump the string field S.  */
221
222 void
223 dump_string_field (dump_info_p di, const char *field, const char *string)
224 {
225   dump_maybe_newline (di);
226   fprintf (di->stream, "%-4s: %-7s ", field, string);
227   if (strlen (string) > 7)
228     di->column += 6 + strlen (string) + 1;
229   else
230     di->column += 14;
231 }
232
233 /* Dump the next node in the queue.  */
234
235 static void
236 dequeue_and_dump (dump_info_p di)
237 {
238   dump_queue_p dq;
239   splay_tree_node stn;
240   dump_node_info_p dni;
241   tree t;
242   unsigned int index;
243   enum tree_code code;
244   enum tree_code_class code_class;
245   const char* code_name;
246
247   /* Get the next node from the queue.  */
248   dq = di->queue;
249   stn = dq->node;
250   t = (tree) stn->key;
251   dni = (dump_node_info_p) stn->value;
252   index = dni->index;
253
254   /* Remove the node from the queue, and put it on the free list.  */
255   di->queue = dq->next;
256   if (!di->queue)
257     di->queue_end = 0;
258   dq->next = di->free_list;
259   di->free_list = dq;
260
261   /* Print the node index.  */
262   dump_index (di, index);
263   /* And the type of node this is.  */
264   if (dni->binfo_p)
265     code_name = "binfo";
266   else
267     code_name = tree_code_name[(int) TREE_CODE (t)];
268   fprintf (di->stream, "%-16s ", code_name);
269   di->column = 25;
270
271   /* Figure out what kind of node this is.  */
272   code = TREE_CODE (t);
273   code_class = TREE_CODE_CLASS (code);
274
275   /* Although BINFOs are TREE_VECs, we dump them specially so as to be
276      more informative.  */
277   if (dni->binfo_p)
278     {
279       unsigned ix;
280       tree base;
281       VEC(tree,gc) *accesses = BINFO_BASE_ACCESSES (t);
282
283       dump_child ("type", BINFO_TYPE (t));
284
285       if (BINFO_VIRTUAL_P (t))
286         dump_string_field (di, "spec", "virt");
287
288       dump_int (di, "bases", BINFO_N_BASE_BINFOS (t));
289       for (ix = 0; BINFO_BASE_ITERATE (t, ix, base); ix++)
290         {
291           tree access = (accesses ? VEC_index (tree, accesses, ix)
292                          : access_public_node);
293           const char *string = NULL;
294
295           if (access == access_public_node)
296             string = "pub";
297           else if (access == access_protected_node)
298             string = "prot";
299           else if (access == access_private_node)
300             string = "priv";
301           else
302             gcc_unreachable ();
303
304           dump_string_field (di, "accs", string);
305           queue_and_dump_index (di, "binf", base, DUMP_BINFO);
306         }
307
308       goto done;
309     }
310
311   /* We can knock off a bunch of expression nodes in exactly the same
312      way.  */
313   if (IS_EXPR_CODE_CLASS (code_class))
314     {
315       /* If we're dumping children, dump them now.  */
316       queue_and_dump_type (di, t);
317
318       switch (code_class)
319         {
320         case tcc_unary:
321           dump_child ("op 0", TREE_OPERAND (t, 0));
322           break;
323
324         case tcc_binary:
325         case tcc_comparison:
326           dump_child ("op 0", TREE_OPERAND (t, 0));
327           dump_child ("op 1", TREE_OPERAND (t, 1));
328           break;
329
330         case tcc_expression:
331         case tcc_reference:
332         case tcc_statement:
333         case tcc_vl_exp:
334           /* These nodes are handled explicitly below.  */
335           break;
336
337         default:
338           gcc_unreachable ();
339         }
340     }
341   else if (DECL_P (t))
342     {
343       expanded_location xloc;
344       /* All declarations have names.  */
345       if (DECL_NAME (t))
346         dump_child ("name", DECL_NAME (t));
347       if (DECL_ASSEMBLER_NAME_SET_P (t)
348           && DECL_ASSEMBLER_NAME (t) != DECL_NAME (t))
349         dump_child ("mngl", DECL_ASSEMBLER_NAME (t));
350       if (DECL_ABSTRACT_ORIGIN (t))
351         dump_child ("orig", DECL_ABSTRACT_ORIGIN (t));
352       /* And types.  */
353       queue_and_dump_type (di, t);
354       dump_child ("scpe", DECL_CONTEXT (t));
355       /* And a source position.  */
356       xloc = expand_location (DECL_SOURCE_LOCATION (t));
357       if (xloc.file)
358         {
359           const char *filename = strrchr (xloc.file, '/');
360           if (!filename)
361             filename = xloc.file;
362           else
363             /* Skip the slash.  */
364             ++filename;
365
366           dump_maybe_newline (di);
367           fprintf (di->stream, "srcp: %s:%-6d ", filename,
368                    xloc.line);
369           di->column += 6 + strlen (filename) + 8;
370         }
371       /* And any declaration can be compiler-generated.  */
372       if (CODE_CONTAINS_STRUCT (TREE_CODE (t), TS_DECL_COMMON)
373           && DECL_ARTIFICIAL (t))
374         dump_string_field (di, "note", "artificial");
375       if (TREE_CHAIN (t) && !dump_flag (di, TDF_SLIM, NULL))
376         dump_child ("chan", TREE_CHAIN (t));
377     }
378   else if (code_class == tcc_type)
379     {
380       /* All types have qualifiers.  */
381       int quals = lang_hooks.tree_dump.type_quals (t);
382
383       if (quals != TYPE_UNQUALIFIED)
384         {
385           fprintf (di->stream, "qual: %c%c%c     ",
386                    (quals & TYPE_QUAL_CONST) ? 'c' : ' ',
387                    (quals & TYPE_QUAL_VOLATILE) ? 'v' : ' ',
388                    (quals & TYPE_QUAL_RESTRICT) ? 'r' : ' ');
389           di->column += 14;
390         }
391
392       /* All types have associated declarations.  */
393       dump_child ("name", TYPE_NAME (t));
394
395       /* All types have a main variant.  */
396       if (TYPE_MAIN_VARIANT (t) != t)
397         dump_child ("unql", TYPE_MAIN_VARIANT (t));
398
399       /* And sizes.  */
400       dump_child ("size", TYPE_SIZE (t));
401
402       /* All types have alignments.  */
403       dump_int (di, "algn", TYPE_ALIGN (t));
404     }
405   else if (code_class == tcc_constant)
406     /* All constants can have types.  */
407     queue_and_dump_type (di, t);
408
409   /* Give the language-specific code a chance to print something.  If
410      it's completely taken care of things, don't bother printing
411      anything more ourselves.  */
412   if (lang_hooks.tree_dump.dump_tree (di, t))
413     goto done;
414
415   /* Now handle the various kinds of nodes.  */
416   switch (code)
417     {
418       int i;
419
420     case IDENTIFIER_NODE:
421       dump_string_field (di, "strg", IDENTIFIER_POINTER (t));
422       dump_int (di, "lngt", IDENTIFIER_LENGTH (t));
423       break;
424
425     case TREE_LIST:
426       dump_child ("purp", TREE_PURPOSE (t));
427       dump_child ("valu", TREE_VALUE (t));
428       dump_child ("chan", TREE_CHAIN (t));
429       break;
430
431     case STATEMENT_LIST:
432       {
433         tree_stmt_iterator it;
434         for (i = 0, it = tsi_start (t); !tsi_end_p (it); tsi_next (&it), i++)
435           {
436             char buffer[32];
437             sprintf (buffer, "%u", i);
438             dump_child (buffer, tsi_stmt (it));
439           }
440       }
441       break;
442
443     case TREE_VEC:
444       dump_int (di, "lngt", TREE_VEC_LENGTH (t));
445       for (i = 0; i < TREE_VEC_LENGTH (t); ++i)
446         {
447           char buffer[32];
448           sprintf (buffer, "%u", i);
449           dump_child (buffer, TREE_VEC_ELT (t, i));
450         }
451       break;
452
453     case INTEGER_TYPE:
454     case ENUMERAL_TYPE:
455       dump_int (di, "prec", TYPE_PRECISION (t));
456       dump_string_field (di, "sign", TYPE_UNSIGNED (t) ? "unsigned": "signed");
457       dump_child ("min", TYPE_MIN_VALUE (t));
458       dump_child ("max", TYPE_MAX_VALUE (t));
459
460       if (code == ENUMERAL_TYPE)
461         dump_child ("csts", TYPE_VALUES (t));
462       break;
463
464     case REAL_TYPE:
465       dump_int (di, "prec", TYPE_PRECISION (t));
466       break;
467
468     case FIXED_POINT_TYPE:
469       dump_int (di, "prec", TYPE_PRECISION (t));
470       dump_string_field (di, "sign", TYPE_UNSIGNED (t) ? "unsigned": "signed");
471       dump_string_field (di, "saturating",
472                          TYPE_SATURATING (t) ? "saturating": "non-saturating");
473       break;
474
475     case POINTER_TYPE:
476       dump_child ("ptd", TREE_TYPE (t));
477       break;
478
479     case REFERENCE_TYPE:
480       dump_child ("refd", TREE_TYPE (t));
481       break;
482
483     case METHOD_TYPE:
484       dump_child ("clas", TYPE_METHOD_BASETYPE (t));
485       /* Fall through.  */
486
487     case FUNCTION_TYPE:
488       dump_child ("retn", TREE_TYPE (t));
489       dump_child ("prms", TYPE_ARG_TYPES (t));
490       break;
491
492     case ARRAY_TYPE:
493       dump_child ("elts", TREE_TYPE (t));
494       dump_child ("domn", TYPE_DOMAIN (t));
495       break;
496
497     case RECORD_TYPE:
498     case UNION_TYPE:
499       if (TREE_CODE (t) == RECORD_TYPE)
500         dump_string_field (di, "tag", "struct");
501       else
502         dump_string_field (di, "tag", "union");
503
504       dump_child ("flds", TYPE_FIELDS (t));
505       dump_child ("fncs", TYPE_METHODS (t));
506       queue_and_dump_index (di, "binf", TYPE_BINFO (t),
507                             DUMP_BINFO);
508       break;
509
510     case CONST_DECL:
511       dump_child ("cnst", DECL_INITIAL (t));
512       break;
513
514     case VAR_DECL:
515     case PARM_DECL:
516     case FIELD_DECL:
517     case RESULT_DECL:
518       if (TREE_CODE (t) == PARM_DECL)
519         dump_child ("argt", DECL_ARG_TYPE (t));
520       else
521         dump_child ("init", DECL_INITIAL (t));
522       dump_child ("size", DECL_SIZE (t));
523       dump_int (di, "algn", DECL_ALIGN (t));
524
525       if (TREE_CODE (t) == FIELD_DECL)
526         {
527           if (DECL_FIELD_OFFSET (t))
528             dump_child ("bpos", bit_position (t));
529         }
530       else if (TREE_CODE (t) == VAR_DECL
531                || TREE_CODE (t) == PARM_DECL)
532         {
533           dump_int (di, "used", TREE_USED (t));
534           if (DECL_REGISTER (t))
535             dump_string_field (di, "spec", "register");
536         }
537       break;
538
539     case FUNCTION_DECL:
540       dump_child ("args", DECL_ARGUMENTS (t));
541       if (DECL_EXTERNAL (t))
542         dump_string_field (di, "body", "undefined");
543       if (TREE_PUBLIC (t))
544         dump_string_field (di, "link", "extern");
545       else
546         dump_string_field (di, "link", "static");
547       if (DECL_SAVED_TREE (t) && !dump_flag (di, TDF_SLIM, t))
548         dump_child ("body", DECL_SAVED_TREE (t));
549       break;
550
551     case INTEGER_CST:
552       if (TREE_INT_CST_HIGH (t))
553         dump_int (di, "high", TREE_INT_CST_HIGH (t));
554       dump_int (di, "low", TREE_INT_CST_LOW (t));
555       break;
556
557     case STRING_CST:
558       fprintf (di->stream, "strg: %-7s ", TREE_STRING_POINTER (t));
559       dump_int (di, "lngt", TREE_STRING_LENGTH (t));
560       break;
561
562     case REAL_CST:
563       dump_real (di, "valu", TREE_REAL_CST_PTR (t));
564       break;
565
566     case FIXED_CST:
567       dump_fixed (di, "valu", TREE_FIXED_CST_PTR (t));
568       break;
569
570     case TRUTH_NOT_EXPR:
571     case ADDR_EXPR:
572     case INDIRECT_REF:
573     case ALIGN_INDIRECT_REF:
574     case MISALIGNED_INDIRECT_REF:
575     case CLEANUP_POINT_EXPR:
576     case SAVE_EXPR:
577     case REALPART_EXPR:
578     case IMAGPART_EXPR:
579       /* These nodes are unary, but do not have code class `1'.  */
580       dump_child ("op 0", TREE_OPERAND (t, 0));
581       break;
582
583     case TRUTH_ANDIF_EXPR:
584     case TRUTH_ORIF_EXPR:
585     case INIT_EXPR:
586     case MODIFY_EXPR:
587     case COMPOUND_EXPR:
588     case PREDECREMENT_EXPR:
589     case PREINCREMENT_EXPR:
590     case POSTDECREMENT_EXPR:
591     case POSTINCREMENT_EXPR:
592       /* These nodes are binary, but do not have code class `2'.  */
593       dump_child ("op 0", TREE_OPERAND (t, 0));
594       dump_child ("op 1", TREE_OPERAND (t, 1));
595       break;
596
597     case COMPONENT_REF:
598       dump_child ("op 0", TREE_OPERAND (t, 0));
599       dump_child ("op 1", TREE_OPERAND (t, 1));
600       dump_child ("op 2", TREE_OPERAND (t, 2));
601       break;
602
603     case ARRAY_REF:
604     case ARRAY_RANGE_REF:
605       dump_child ("op 0", TREE_OPERAND (t, 0));
606       dump_child ("op 1", TREE_OPERAND (t, 1));
607       dump_child ("op 2", TREE_OPERAND (t, 2));
608       dump_child ("op 3", TREE_OPERAND (t, 3));
609       break;
610
611     case COND_EXPR:
612       dump_child ("op 0", TREE_OPERAND (t, 0));
613       dump_child ("op 1", TREE_OPERAND (t, 1));
614       dump_child ("op 2", TREE_OPERAND (t, 2));
615       break;
616
617     case TRY_FINALLY_EXPR:
618       dump_child ("op 0", TREE_OPERAND (t, 0));
619       dump_child ("op 1", TREE_OPERAND (t, 1));
620       break;
621
622     case CALL_EXPR:
623       {
624         int i = 0;
625         tree arg;
626         call_expr_arg_iterator iter;
627         dump_child ("fn", CALL_EXPR_FN (t));
628         FOR_EACH_CALL_EXPR_ARG (arg, iter, t)
629           {
630             char buffer[32];
631             sprintf (buffer, "%u", i);
632             dump_child (buffer, arg);
633             i++;
634           }
635       }
636       break;
637
638     case CONSTRUCTOR:
639       {
640         unsigned HOST_WIDE_INT cnt;
641         tree index, value;
642         dump_int (di, "lngt", VEC_length (constructor_elt,
643                                           CONSTRUCTOR_ELTS (t)));
644         FOR_EACH_CONSTRUCTOR_ELT (CONSTRUCTOR_ELTS (t), cnt, index, value)
645           {
646             dump_child ("idx", index);
647             dump_child ("val", value);
648           }
649       }
650       break;
651
652     case BIND_EXPR:
653       dump_child ("vars", TREE_OPERAND (t, 0));
654       dump_child ("body", TREE_OPERAND (t, 1));
655       break;
656
657     case LOOP_EXPR:
658       dump_child ("body", TREE_OPERAND (t, 0));
659       break;
660
661     case EXIT_EXPR:
662       dump_child ("cond", TREE_OPERAND (t, 0));
663       break;
664
665     case RETURN_EXPR:
666       dump_child ("expr", TREE_OPERAND (t, 0));
667       break;
668
669     case TARGET_EXPR:
670       dump_child ("decl", TREE_OPERAND (t, 0));
671       dump_child ("init", TREE_OPERAND (t, 1));
672       dump_child ("clnp", TREE_OPERAND (t, 2));
673       /* There really are two possible places the initializer can be.
674          After RTL expansion, the second operand is moved to the
675          position of the fourth operand, and the second operand
676          becomes NULL.  */
677       dump_child ("init", TREE_OPERAND (t, 3));
678       break;
679
680     case CASE_LABEL_EXPR:
681       dump_child ("name", CASE_LABEL (t));
682       if (CASE_LOW (t))
683         {
684           dump_child ("low ", CASE_LOW (t));
685           if (CASE_HIGH (t))
686             dump_child ("high", CASE_HIGH (t));
687         }
688       break;
689     case LABEL_EXPR:
690       dump_child ("name", TREE_OPERAND (t,0));
691       break;
692     case GOTO_EXPR:
693       dump_child ("labl", TREE_OPERAND (t, 0));
694       break;
695     case SWITCH_EXPR:
696       dump_child ("cond", TREE_OPERAND (t, 0));
697       dump_child ("body", TREE_OPERAND (t, 1));
698       if (TREE_OPERAND (t, 2))
699         {
700           dump_child ("labl", TREE_OPERAND (t,2));
701         }
702       break;
703     case OMP_CLAUSE:
704       {
705         int i;
706         fprintf (di->stream, "%s\n", omp_clause_code_name[OMP_CLAUSE_CODE (t)]);
707         for (i = 0; i < omp_clause_num_ops[OMP_CLAUSE_CODE (t)]; i++)
708           dump_child ("op: ", OMP_CLAUSE_OPERAND (t, i));
709       }
710       break;
711     default:
712       /* There are no additional fields to print.  */
713       break;
714     }
715
716  done:
717   if (dump_flag (di, TDF_ADDRESS, NULL))
718     dump_pointer (di, "addr", (void *)t);
719
720   /* Terminate the line.  */
721   fprintf (di->stream, "\n");
722 }
723
724 /* Return nonzero if FLAG has been specified for the dump, and NODE
725    is not the root node of the dump.  */
726
727 int dump_flag (dump_info_p di, int flag, const_tree node)
728 {
729   return (di->flags & flag) && (node != di->node);
730 }
731
732 /* Dump T, and all its children, on STREAM.  */
733
734 void
735 dump_node (const_tree t, int flags, FILE *stream)
736 {
737   struct dump_info di;
738   dump_queue_p dq;
739   dump_queue_p next_dq;
740
741   /* Initialize the dump-information structure.  */
742   di.stream = stream;
743   di.index = 0;
744   di.column = 0;
745   di.queue = 0;
746   di.queue_end = 0;
747   di.free_list = 0;
748   di.flags = flags;
749   di.node = t;
750   di.nodes = splay_tree_new (splay_tree_compare_pointers, 0,
751                              (splay_tree_delete_value_fn) &free);
752
753   /* Queue up the first node.  */
754   queue (&di, t, DUMP_NONE);
755
756   /* Until the queue is empty, keep dumping nodes.  */
757   while (di.queue)
758     dequeue_and_dump (&di);
759
760   /* Now, clean up.  */
761   for (dq = di.free_list; dq; dq = next_dq)
762     {
763       next_dq = dq->next;
764       free (dq);
765     }
766   splay_tree_delete (di.nodes);
767 }
768 \f
769
770 /* Table of tree dump switches. This must be consistent with the
771    tree_dump_index enumeration in tree-pass.h.  */
772 static struct dump_file_info dump_files[TDI_end] =
773 {
774   {NULL, NULL, NULL, 0, 0, 0},
775   {".cgraph", "ipa-cgraph", NULL, TDF_IPA, 0,  0},
776   {".tu", "translation-unit", NULL, TDF_TREE, 0, 1},
777   {".class", "class-hierarchy", NULL, TDF_TREE, 0, 2},
778   {".original", "tree-original", NULL, TDF_TREE, 0, 3},
779   {".gimple", "tree-gimple", NULL, TDF_TREE, 0, 4},
780   {".nested", "tree-nested", NULL, TDF_TREE, 0, 5},
781   {".vcg", "tree-vcg", NULL, TDF_TREE, 0, 6},
782 #define FIRST_AUTO_NUMBERED_DUMP 7
783
784   {NULL, "tree-all", NULL, TDF_TREE, 0, 0},
785   {NULL, "rtl-all", NULL, TDF_RTL, 0, 0},
786   {NULL, "ipa-all", NULL, TDF_IPA, 0, 0},
787 };
788
789 /* Dynamically registered tree dump files and switches.  */
790 static struct dump_file_info *extra_dump_files;
791 static size_t extra_dump_files_in_use;
792 static size_t extra_dump_files_alloced;
793
794 /* Define a name->number mapping for a dump flag value.  */
795 struct dump_option_value_info
796 {
797   const char *const name;       /* the name of the value */
798   const int value;              /* the value of the name */
799 };
800
801 /* Table of dump options. This must be consistent with the TDF_* flags
802    in tree.h */
803 static const struct dump_option_value_info dump_options[] =
804 {
805   {"address", TDF_ADDRESS},
806   {"asmname", TDF_ASMNAME},
807   {"slim", TDF_SLIM},
808   {"raw", TDF_RAW},
809   {"graph", TDF_GRAPH},
810   {"details", TDF_DETAILS},
811   {"stats", TDF_STATS},
812   {"blocks", TDF_BLOCKS},
813   {"vops", TDF_VOPS},
814   {"lineno", TDF_LINENO},
815   {"uid", TDF_UID},
816   {"stmtaddr", TDF_STMTADDR},
817   {"memsyms", TDF_MEMSYMS},
818   {"verbose", TDF_VERBOSE},
819   {"eh", TDF_EH},
820   {"all", ~(TDF_RAW | TDF_SLIM | TDF_LINENO | TDF_TREE | TDF_RTL | TDF_IPA 
821             | TDF_STMTADDR | TDF_GRAPH | TDF_DIAGNOSTIC | TDF_VERBOSE
822             | TDF_RHS_ONLY)},
823   {NULL, 0}
824 };
825
826 unsigned int
827 dump_register (const char *suffix, const char *swtch, const char *glob,
828                int flags)
829 {
830   static int next_dump = FIRST_AUTO_NUMBERED_DUMP;
831   int num = next_dump++;
832
833   size_t count = extra_dump_files_in_use++;
834
835   if (count >= extra_dump_files_alloced)
836     {
837       if (extra_dump_files_alloced == 0)
838         extra_dump_files_alloced = 32;
839       else
840         extra_dump_files_alloced *= 2;
841       extra_dump_files = XRESIZEVEC (struct dump_file_info,
842                                      extra_dump_files,
843                                      extra_dump_files_alloced);
844     }
845
846   memset (&extra_dump_files[count], 0, sizeof (struct dump_file_info));
847   extra_dump_files[count].suffix = suffix;
848   extra_dump_files[count].swtch = swtch;
849   extra_dump_files[count].glob = glob;
850   extra_dump_files[count].flags = flags;
851   extra_dump_files[count].num = num;
852
853   return count + TDI_end;
854 }
855
856
857 /* Return the dump_file_info for the given phase.  */
858
859 struct dump_file_info *
860 get_dump_file_info (int phase)
861 {
862   if (phase < TDI_end)
863     return &dump_files[phase];
864   else if ((size_t) (phase - TDI_end) >= extra_dump_files_in_use)
865     return NULL;
866   else
867     return extra_dump_files + (phase - TDI_end);
868 }
869
870
871 /* Return the name of the dump file for the given phase.
872    If the dump is not enabled, returns NULL.  */
873
874 char *
875 get_dump_file_name (int phase)
876 {
877   char dump_id[10];
878   struct dump_file_info *dfi;
879
880   if (phase == TDI_none)
881     return NULL;
882
883   dfi = get_dump_file_info (phase);
884   if (dfi->state == 0)
885     return NULL;
886
887   if (dfi->num < 0)
888     dump_id[0] = '\0';
889   else
890     {
891       char suffix;
892       if (dfi->flags & TDF_TREE)
893         suffix = 't';
894       else if (dfi->flags & TDF_IPA)
895         suffix = 'i';
896       else
897         suffix = 'r';
898
899       if (snprintf (dump_id, sizeof (dump_id), ".%03d%c", dfi->num, suffix) < 0)
900         dump_id[0] = '\0';
901     }
902
903   return concat (dump_base_name, dump_id, dfi->suffix, NULL);
904 }
905
906 /* Begin a tree dump for PHASE. Stores any user supplied flag in
907    *FLAG_PTR and returns a stream to write to. If the dump is not
908    enabled, returns NULL.
909    Multiple calls will reopen and append to the dump file.  */
910
911 FILE *
912 dump_begin (int phase, int *flag_ptr)
913 {
914   char *name;
915   struct dump_file_info *dfi;
916   FILE *stream;
917
918   if (phase == TDI_none || !dump_enabled_p (phase))
919     return NULL;
920
921   name = get_dump_file_name (phase);
922   dfi = get_dump_file_info (phase);
923   stream = fopen (name, dfi->state < 0 ? "w" : "a");
924   if (!stream)
925     error ("could not open dump file %qs: %s", name, strerror (errno));
926   else
927     dfi->state = 1;
928   free (name);
929
930   if (flag_ptr)
931     *flag_ptr = dfi->flags;
932
933   return stream;
934 }
935
936 /* Returns nonzero if tree dump PHASE is enabled.  If PHASE is
937    TDI_tree_all, return nonzero if any dump is enabled.  */
938
939 int
940 dump_enabled_p (int phase)
941 {
942   if (phase == TDI_tree_all)
943     {
944       size_t i;
945       for (i = TDI_none + 1; i < (size_t) TDI_end; i++)
946         if (dump_files[i].state)
947           return 1;
948       for (i = 0; i < extra_dump_files_in_use; i++)
949         if (extra_dump_files[i].state)
950           return 1;
951       return 0;
952     }
953   else
954     {
955       struct dump_file_info *dfi = get_dump_file_info (phase);
956       return dfi->state;
957     }
958 }
959
960 /* Returns nonzero if tree dump PHASE has been initialized.  */
961
962 int
963 dump_initialized_p (int phase)
964 {
965   struct dump_file_info *dfi = get_dump_file_info (phase);
966   return dfi->state > 0;
967 }
968
969 /* Returns the switch name of PHASE.  */
970
971 const char *
972 dump_flag_name (int phase)
973 {
974   struct dump_file_info *dfi = get_dump_file_info (phase);
975   return dfi->swtch;
976 }
977
978 /* Finish a tree dump for PHASE. STREAM is the stream created by
979    dump_begin.  */
980
981 void
982 dump_end (int phase ATTRIBUTE_UNUSED, FILE *stream)
983 {
984   fclose (stream);
985 }
986
987 /* Enable all tree dumps.  Return number of enabled tree dumps.  */
988
989 static int
990 dump_enable_all (int flags)
991 {
992   int ir_dump_type = (flags & (TDF_TREE | TDF_RTL | TDF_IPA));
993   int n = 0;
994   size_t i;
995
996   for (i = TDI_none + 1; i < (size_t) TDI_end; i++)
997     if ((dump_files[i].flags & ir_dump_type))
998       {
999         dump_files[i].state = -1;
1000         dump_files[i].flags |= flags;
1001         n++;
1002       }
1003
1004   for (i = 0; i < extra_dump_files_in_use; i++)
1005     if ((extra_dump_files[i].flags & ir_dump_type))
1006       {
1007         extra_dump_files[i].state = -1;
1008         extra_dump_files[i].flags |= flags;
1009         n++;
1010       }
1011
1012   return n;
1013 }
1014
1015 /* Parse ARG as a dump switch. Return nonzero if it is, and store the
1016    relevant details in the dump_files array.  */
1017
1018 static int
1019 dump_switch_p_1 (const char *arg, struct dump_file_info *dfi, bool doglob)
1020 {
1021   const char *option_value;
1022   const char *ptr;
1023   int flags;
1024   
1025   if (doglob && !dfi->glob)
1026     return 0;
1027
1028   option_value = skip_leading_substring (arg, doglob ? dfi->glob : dfi->swtch);
1029   if (!option_value)
1030     return 0;
1031
1032   if (*option_value && *option_value != '-')
1033     return 0;
1034
1035   ptr = option_value;
1036   flags = 0;
1037
1038   while (*ptr)
1039     {
1040       const struct dump_option_value_info *option_ptr;
1041       const char *end_ptr;
1042       unsigned length;
1043
1044       while (*ptr == '-')
1045         ptr++;
1046       end_ptr = strchr (ptr, '-');
1047       if (!end_ptr)
1048         end_ptr = ptr + strlen (ptr);
1049       length = end_ptr - ptr;
1050
1051       for (option_ptr = dump_options; option_ptr->name; option_ptr++)
1052         if (strlen (option_ptr->name) == length
1053             && !memcmp (option_ptr->name, ptr, length))
1054           {
1055             flags |= option_ptr->value;
1056             goto found;
1057           }
1058       warning (0, "ignoring unknown option %q.*s in %<-fdump-%s%>",
1059                length, ptr, dfi->swtch);
1060     found:;
1061       ptr = end_ptr;
1062     }
1063
1064   dfi->state = -1;
1065   dfi->flags |= flags;
1066
1067   /* Process -fdump-tree-all and -fdump-rtl-all, by enabling all the
1068      known dumps.  */
1069   if (dfi->suffix == NULL)
1070     dump_enable_all (dfi->flags);
1071
1072   return 1;
1073 }
1074
1075 int
1076 dump_switch_p (const char *arg)
1077 {
1078   size_t i;
1079   int any = 0;
1080
1081   for (i = TDI_none + 1; i != TDI_end; i++)
1082     any |= dump_switch_p_1 (arg, &dump_files[i], false);
1083
1084   /* Don't glob if we got a hit already */
1085   if (!any)
1086     for (i = TDI_none + 1; i != TDI_end; i++)
1087       any |= dump_switch_p_1 (arg, &dump_files[i], true);
1088
1089   for (i = 0; i < extra_dump_files_in_use; i++)
1090     any |= dump_switch_p_1 (arg, &extra_dump_files[i], false);
1091   
1092   if (!any)
1093     for (i = 0; i < extra_dump_files_in_use; i++)
1094       any |= dump_switch_p_1 (arg, &extra_dump_files[i], true);
1095
1096
1097   return any;
1098 }
1099
1100 /* Dump FUNCTION_DECL FN as tree dump PHASE.  */
1101
1102 void
1103 dump_function (int phase, tree fn)
1104 {
1105   FILE *stream;
1106   int flags;
1107
1108   stream = dump_begin (phase, &flags);
1109   if (stream)
1110     {
1111       dump_function_to_file (fn, stream, flags);
1112       dump_end (phase, stream);
1113     }
1114 }
1115
1116 bool
1117 enable_rtl_dump_file (void)
1118 {
1119   return dump_enable_all (TDF_RTL | TDF_DETAILS | TDF_BLOCKS) > 0;
1120 }