4 * Common Trace Format Metadata Visitor (XML dump).
6 * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35 #include <babeltrace/babeltrace-internal.h>
36 #include <babeltrace/list.h>
37 #include "ctf-scanner.h"
38 #include "ctf-parser.h"
41 #define fprintf_dbg(fd, fmt, args...) fprintf(fd, "%s: " fmt, __func__, ## args)
44 void print_tabs(FILE *fd
, int depth
)
48 for (i
= 0; i
< depth
; i
++)
53 int ctf_visitor_print_unary_expression(FILE *fd
, int depth
, struct ctf_node
*node
)
57 switch (node
->u
.unary_expression
.link
) {
58 case UNARY_LINK_UNKNOWN
:
61 print_tabs(fd
, depth
);
62 fprintf(fd
, "<dotlink/>\n");
65 print_tabs(fd
, depth
);
66 fprintf(fd
, "<arrowlink/>\n");
69 print_tabs(fd
, depth
);
70 fprintf(fd
, "<dotdotdot/>\n");
73 fprintf(stderr
, "[error] %s: unknown expression link type %d\n", __func__
,
74 (int) node
->u
.unary_expression
.link
);
78 switch (node
->u
.unary_expression
.type
) {
80 print_tabs(fd
, depth
);
81 fprintf(fd
, "<unary_expression value=");
82 fprintf(fd
, "\"%s\"", node
->u
.unary_expression
.u
.string
);
85 case UNARY_SIGNED_CONSTANT
:
86 print_tabs(fd
, depth
);
87 fprintf(fd
, "<unary_expression value=\"");
88 fprintf(fd
, "%" PRId64
, node
->u
.unary_expression
.u
.signed_constant
);
89 fprintf(fd
, "\" />\n");
91 case UNARY_UNSIGNED_CONSTANT
:
92 print_tabs(fd
, depth
);
93 fprintf(fd
, "<unary_expression value=\"");
94 fprintf(fd
, "%" PRIu64
, node
->u
.unary_expression
.u
.signed_constant
);
95 fprintf(fd
, "\" />\n");
98 print_tabs(fd
, depth
);
99 fprintf(fd
, "<unary_expression_sbrac>\n");
100 ret
= ctf_visitor_print_unary_expression(fd
, depth
+ 1,
101 node
->u
.unary_expression
.u
.sbrac_exp
);
104 print_tabs(fd
, depth
);
105 fprintf(fd
, "</unary_expression_sbrac>\n");
110 fprintf(stderr
, "[error] %s: unknown expression type %d\n", __func__
,
111 (int) node
->u
.unary_expression
.type
);
118 int ctf_visitor_print_type_specifier_list(FILE *fd
, int depth
, struct ctf_node
*node
)
120 struct ctf_node
*iter
;
123 print_tabs(fd
, depth
);
124 fprintf(fd
, "<type_specifier_list>\n");
125 bt_list_for_each_entry(iter
, &node
->u
.type_specifier_list
.head
, siblings
) {
126 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
130 print_tabs(fd
, depth
);
131 fprintf(fd
, "</type_specifier_list>\n");
136 int ctf_visitor_print_type_specifier(FILE *fd
, int depth
, struct ctf_node
*node
)
139 print_tabs(fd
, depth
);
141 switch (node
->u
.type_specifier
.type
) {
148 case TYPESPEC_DOUBLE
:
149 case TYPESPEC_SIGNED
:
150 case TYPESPEC_UNSIGNED
:
152 case TYPESPEC_COMPLEX
:
153 case TYPESPEC_IMAGINARY
:
155 case TYPESPEC_ID_TYPE
:
156 fprintf(fd
, "<type_specifier type=\"");
158 case TYPESPEC_FLOATING_POINT
:
159 case TYPESPEC_INTEGER
:
160 case TYPESPEC_STRING
:
161 case TYPESPEC_STRUCT
:
162 case TYPESPEC_VARIANT
:
164 fprintf(fd
, "<type_specifier>\n");
167 case TYPESPEC_UNKNOWN
:
169 fprintf(stderr
, "[error] %s: unknown type specifier %d\n", __func__
,
170 (int) node
->u
.type_specifier
.type
);
174 switch (node
->u
.type_specifier
.type
) {
182 fprintf(fd
, "short");
191 fprintf(fd
, "float");
193 case TYPESPEC_DOUBLE
:
194 fprintf(fd
, "double");
196 case TYPESPEC_SIGNED
:
197 fprintf(fd
, "signed");
199 case TYPESPEC_UNSIGNED
:
200 fprintf(fd
, "unsigned");
205 case TYPESPEC_COMPLEX
:
206 fprintf(fd
, "_Complex");
208 case TYPESPEC_IMAGINARY
:
209 fprintf(fd
, "_Imaginary");
212 fprintf(fd
, "const");
214 case TYPESPEC_ID_TYPE
:
215 fprintf(fd
, "%s", node
->u
.type_specifier
.id_type
);
217 case TYPESPEC_FLOATING_POINT
:
218 case TYPESPEC_INTEGER
:
219 case TYPESPEC_STRING
:
220 case TYPESPEC_STRUCT
:
221 case TYPESPEC_VARIANT
:
223 ret
= ctf_visitor_print_xml(fd
, depth
, node
->u
.type_specifier
.node
);
227 case TYPESPEC_UNKNOWN
:
229 fprintf(stderr
, "[error] %s: unknown type specifier %d\n", __func__
,
230 (int) node
->u
.type_specifier
.type
);
234 switch (node
->u
.type_specifier
.type
) {
241 case TYPESPEC_DOUBLE
:
242 case TYPESPEC_SIGNED
:
243 case TYPESPEC_UNSIGNED
:
245 case TYPESPEC_COMPLEX
:
246 case TYPESPEC_IMAGINARY
:
248 case TYPESPEC_ID_TYPE
:
249 fprintf(fd
, "\"/>\n");
251 case TYPESPEC_FLOATING_POINT
:
252 case TYPESPEC_INTEGER
:
253 case TYPESPEC_STRING
:
254 case TYPESPEC_STRUCT
:
255 case TYPESPEC_VARIANT
:
258 print_tabs(fd
, depth
);
259 fprintf(fd
, "</type_specifier>\n");
261 case TYPESPEC_UNKNOWN
:
263 fprintf(stderr
, "[error] %s: unknown type specifier %d\n", __func__
,
264 (int) node
->u
.type_specifier
.type
);
272 int ctf_visitor_print_type_declarator(FILE *fd
, int depth
, struct ctf_node
*node
)
275 struct ctf_node
*iter
;
277 print_tabs(fd
, depth
);
278 fprintf(fd
, "<type_declarator>\n");
281 if (!bt_list_empty(&node
->u
.type_declarator
.pointers
)) {
282 print_tabs(fd
, depth
);
283 fprintf(fd
, "<pointers>\n");
284 bt_list_for_each_entry(iter
, &node
->u
.type_declarator
.pointers
,
286 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
290 print_tabs(fd
, depth
);
291 fprintf(fd
, "</pointers>\n");
294 switch (node
->u
.type_declarator
.type
) {
296 if (node
->u
.type_declarator
.u
.id
) {
297 print_tabs(fd
, depth
);
298 fprintf(fd
, "<id name=\"");
299 fprintf(fd
, "%s", node
->u
.type_declarator
.u
.id
);
300 fprintf(fd
, "\" />\n");
304 if (node
->u
.type_declarator
.u
.nested
.type_declarator
) {
305 print_tabs(fd
, depth
);
306 fprintf(fd
, "<type_declarator>\n");
307 ret
= ctf_visitor_print_xml(fd
, depth
+ 1,
308 node
->u
.type_declarator
.u
.nested
.type_declarator
);
311 print_tabs(fd
, depth
);
312 fprintf(fd
, "</type_declarator>\n");
314 if (node
->u
.type_declarator
.u
.nested
.abstract_array
) {
315 print_tabs(fd
, depth
);
316 fprintf(fd
, "<length>\n");
317 print_tabs(fd
, depth
);
318 fprintf(fd
, "</length>\n");
319 } else if (!bt_list_empty(&node
->u
.type_declarator
.u
.nested
.length
)) {
320 print_tabs(fd
, depth
);
321 fprintf(fd
, "<length>\n");
322 bt_list_for_each_entry(iter
, &node
->u
.type_declarator
.u
.nested
.length
,
324 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
328 print_tabs(fd
, depth
);
329 fprintf(fd
, "</length>\n");
331 if (node
->u
.type_declarator
.bitfield_len
) {
332 print_tabs(fd
, depth
);
333 fprintf(fd
, "<bitfield_len>\n");
334 ret
= ctf_visitor_print_xml(fd
, depth
+ 1,
335 node
->u
.type_declarator
.bitfield_len
);
338 print_tabs(fd
, depth
);
339 fprintf(fd
, "</bitfield_len>\n");
342 case TYPEDEC_UNKNOWN
:
344 fprintf(stderr
, "[error] %s: unknown type declarator %d\n", __func__
,
345 (int) node
->u
.type_declarator
.type
);
350 print_tabs(fd
, depth
);
351 fprintf(fd
, "</type_declarator>\n");
355 int ctf_visitor_print_xml(FILE *fd
, int depth
, struct ctf_node
*node
)
358 struct ctf_node
*iter
;
363 switch (node
->type
) {
365 print_tabs(fd
, depth
);
366 fprintf(fd
, "<root>\n");
367 bt_list_for_each_entry(iter
, &node
->u
.root
.declaration_list
,
369 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
373 bt_list_for_each_entry(iter
, &node
->u
.root
.trace
, siblings
) {
374 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
378 bt_list_for_each_entry(iter
, &node
->u
.root
.stream
, siblings
) {
379 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
383 bt_list_for_each_entry(iter
, &node
->u
.root
.event
, siblings
) {
384 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
388 print_tabs(fd
, depth
);
389 fprintf(fd
, "</root>\n");
393 print_tabs(fd
, depth
);
394 fprintf(fd
, "<event>\n");
395 bt_list_for_each_entry(iter
, &node
->u
.event
.declaration_list
, siblings
) {
396 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
400 print_tabs(fd
, depth
);
401 fprintf(fd
, "</event>\n");
404 print_tabs(fd
, depth
);
405 fprintf(fd
, "<stream>\n");
406 bt_list_for_each_entry(iter
, &node
->u
.stream
.declaration_list
, siblings
) {
407 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
411 print_tabs(fd
, depth
);
412 fprintf(fd
, "</stream>\n");
415 print_tabs(fd
, depth
);
416 fprintf(fd
, "<env>\n");
417 bt_list_for_each_entry(iter
, &node
->u
.env
.declaration_list
, siblings
) {
418 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
422 print_tabs(fd
, depth
);
423 fprintf(fd
, "</env>\n");
426 print_tabs(fd
, depth
);
427 fprintf(fd
, "<trace>\n");
428 bt_list_for_each_entry(iter
, &node
->u
.trace
.declaration_list
, siblings
) {
429 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
433 print_tabs(fd
, depth
);
434 fprintf(fd
, "</trace>\n");
437 print_tabs(fd
, depth
);
438 fprintf(fd
, "<clock>\n");
439 bt_list_for_each_entry(iter
, &node
->u
.clock
.declaration_list
, siblings
) {
440 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
444 print_tabs(fd
, depth
);
445 fprintf(fd
, "</clock>\n");
448 print_tabs(fd
, depth
);
449 fprintf(fd
, "<callsite>\n");
450 bt_list_for_each_entry(iter
, &node
->u
.callsite
.declaration_list
, siblings
) {
451 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
455 print_tabs(fd
, depth
);
456 fprintf(fd
, "</callsite>\n");
460 case NODE_CTF_EXPRESSION
:
461 print_tabs(fd
, depth
);
462 fprintf(fd
, "<ctf_expression>\n");
464 print_tabs(fd
, depth
);
465 fprintf(fd
, "<left>\n");
466 bt_list_for_each_entry(iter
, &node
->u
.ctf_expression
.left
, siblings
) {
467 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
472 print_tabs(fd
, depth
);
473 fprintf(fd
, "</left>\n");
475 print_tabs(fd
, depth
);
476 fprintf(fd
, "<right>\n");
477 bt_list_for_each_entry(iter
, &node
->u
.ctf_expression
.right
, siblings
) {
478 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
482 print_tabs(fd
, depth
);
483 fprintf(fd
, "</right>\n");
485 print_tabs(fd
, depth
);
486 fprintf(fd
, "</ctf_expression>\n");
488 case NODE_UNARY_EXPRESSION
:
489 return ctf_visitor_print_unary_expression(fd
, depth
, node
);
492 print_tabs(fd
, depth
);
493 fprintf(fd
, "<typedef>\n");
495 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, node
->u
._typedef
.type_specifier_list
);
499 print_tabs(fd
, depth
);
500 fprintf(fd
, "<type_declarator_list>\n");
501 bt_list_for_each_entry(iter
, &node
->u
._typedef
.type_declarators
, siblings
) {
502 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
506 print_tabs(fd
, depth
);
507 fprintf(fd
, "</type_declarator_list>\n");
509 print_tabs(fd
, depth
);
510 fprintf(fd
, "</typedef>\n");
512 case NODE_TYPEALIAS_TARGET
:
513 print_tabs(fd
, depth
);
514 fprintf(fd
, "<target>\n");
517 ret
= ctf_visitor_print_xml(fd
, depth
, node
->u
.typealias_target
.type_specifier_list
);
521 print_tabs(fd
, depth
);
522 fprintf(fd
, "<type_declarator_list>\n");
523 bt_list_for_each_entry(iter
, &node
->u
.typealias_target
.type_declarators
, siblings
) {
524 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
528 print_tabs(fd
, depth
);
529 fprintf(fd
, "</type_declarator_list>\n");
532 print_tabs(fd
, depth
);
533 fprintf(fd
, "</target>\n");
535 case NODE_TYPEALIAS_ALIAS
:
536 print_tabs(fd
, depth
);
537 fprintf(fd
, "<alias>\n");
540 ret
= ctf_visitor_print_xml(fd
, depth
, node
->u
.typealias_alias
.type_specifier_list
);
544 print_tabs(fd
, depth
);
545 fprintf(fd
, "<type_declarator_list>\n");
546 bt_list_for_each_entry(iter
, &node
->u
.typealias_alias
.type_declarators
, siblings
) {
547 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
551 print_tabs(fd
, depth
);
552 fprintf(fd
, "</type_declarator_list>\n");
555 print_tabs(fd
, depth
);
556 fprintf(fd
, "</alias>\n");
559 print_tabs(fd
, depth
);
560 fprintf(fd
, "<typealias>\n");
561 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, node
->u
.typealias
.target
);
564 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, node
->u
.typealias
.alias
);
567 print_tabs(fd
, depth
);
568 fprintf(fd
, "</typealias>\n");
571 case NODE_TYPE_SPECIFIER_LIST
:
572 ret
= ctf_visitor_print_type_specifier_list(fd
, depth
, node
);
577 case NODE_TYPE_SPECIFIER
:
578 ret
= ctf_visitor_print_type_specifier(fd
, depth
, node
);
583 print_tabs(fd
, depth
);
584 if (node
->u
.pointer
.const_qualifier
)
585 fprintf(fd
, "<const_pointer />\n");
587 fprintf(fd
, "<pointer />\n");
589 case NODE_TYPE_DECLARATOR
:
590 ret
= ctf_visitor_print_type_declarator(fd
, depth
, node
);
595 case NODE_FLOATING_POINT
:
596 print_tabs(fd
, depth
);
597 fprintf(fd
, "<floating_point>\n");
598 bt_list_for_each_entry(iter
, &node
->u
.floating_point
.expressions
, siblings
) {
599 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
603 print_tabs(fd
, depth
);
604 fprintf(fd
, "</floating_point>\n");
607 print_tabs(fd
, depth
);
608 fprintf(fd
, "<integer>\n");
609 bt_list_for_each_entry(iter
, &node
->u
.integer
.expressions
, siblings
) {
610 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
614 print_tabs(fd
, depth
);
615 fprintf(fd
, "</integer>\n");
618 print_tabs(fd
, depth
);
619 fprintf(fd
, "<string>\n");
620 bt_list_for_each_entry(iter
, &node
->u
.string
.expressions
, siblings
) {
621 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
625 print_tabs(fd
, depth
);
626 fprintf(fd
, "</string>\n");
628 case NODE_ENUMERATOR
:
629 print_tabs(fd
, depth
);
630 fprintf(fd
, "<enumerator");
631 if (node
->u
.enumerator
.id
)
632 fprintf(fd
, " id=\"%s\"", node
->u
.enumerator
.id
);
634 bt_list_for_each_entry(iter
, &node
->u
.enumerator
.values
, siblings
) {
635 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
639 print_tabs(fd
, depth
);
640 fprintf(fd
, "</enumerator>\n");
643 print_tabs(fd
, depth
);
644 if (node
->u
._struct
.name
)
645 fprintf(fd
, "<enum name=\"%s\">\n",
646 node
->u
._enum
.enum_id
);
648 fprintf(fd
, "<enum >\n");
651 if (node
->u
._enum
.container_type
) {
652 print_tabs(fd
, depth
);
653 fprintf(fd
, "<container_type>\n");
654 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, node
->u
._enum
.container_type
);
657 print_tabs(fd
, depth
);
658 fprintf(fd
, "</container_type>\n");
661 print_tabs(fd
, depth
);
662 fprintf(fd
, "<enumerator_list>\n");
663 bt_list_for_each_entry(iter
, &node
->u
._enum
.enumerator_list
, siblings
) {
664 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
668 print_tabs(fd
, depth
);
669 fprintf(fd
, "</enumerator_list>\n");
672 print_tabs(fd
, depth
);
673 fprintf(fd
, "</enum>\n");
675 case NODE_STRUCT_OR_VARIANT_DECLARATION
:
676 ret
= ctf_visitor_print_xml(fd
, depth
,
677 node
->u
.struct_or_variant_declaration
.type_specifier_list
);
681 print_tabs(fd
, depth
);
682 fprintf(fd
, "<type_declarator_list>\n");
683 bt_list_for_each_entry(iter
, &node
->u
.struct_or_variant_declaration
.type_declarators
, siblings
) {
684 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
688 print_tabs(fd
, depth
);
689 fprintf(fd
, "</type_declarator_list>\n");
692 print_tabs(fd
, depth
);
693 fprintf(fd
, "<variant");
694 if (node
->u
.variant
.name
)
695 fprintf(fd
, " name=\"%s\"", node
->u
.variant
.name
);
696 if (node
->u
.variant
.choice
)
697 fprintf(fd
, " choice=\"%s\"", node
->u
.variant
.choice
);
699 bt_list_for_each_entry(iter
, &node
->u
.variant
.declaration_list
, siblings
) {
700 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
704 print_tabs(fd
, depth
);
705 fprintf(fd
, "</variant>\n");
708 print_tabs(fd
, depth
);
709 if (node
->u
._struct
.name
)
710 fprintf(fd
, "<struct name=\"%s\">\n",
711 node
->u
._struct
.name
);
713 fprintf(fd
, "<struct>\n");
714 bt_list_for_each_entry(iter
, &node
->u
._struct
.declaration_list
, siblings
) {
715 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
719 print_tabs(fd
, depth
);
720 fprintf(fd
, "</struct>\n");
721 if (!bt_list_empty(&node
->u
._struct
.min_align
)) {
722 print_tabs(fd
, depth
);
723 fprintf(fd
, "<align>\n");
724 bt_list_for_each_entry(iter
, &node
->u
._struct
.min_align
, siblings
) {
725 ret
= ctf_visitor_print_xml(fd
, depth
+ 1, iter
);
729 print_tabs(fd
, depth
);
730 fprintf(fd
, "</align>\n");
736 fprintf(stderr
, "[error] %s: unknown node type %d\n", __func__
,