2 * BabelTrace - Common Trace Format (CTF)
4 * CTF Text Format registration.
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/format.h>
30 #include <babeltrace/ctf-text/types.h>
31 #include <babeltrace/ctf/metadata.h>
32 #include <babeltrace/babeltrace-internal.h>
33 #include <babeltrace/ctf/events-internal.h>
34 #include <babeltrace/trace-debug-info.h>
38 #include <sys/types.h>
46 #define NSEC_PER_SEC 1000000000ULL
48 int opt_all_field_names
,
49 opt_scope_field_names
,
50 opt_header_field_names
,
51 opt_context_field_names
,
52 opt_payload_field_names
,
55 opt_trace_domain_field
,
56 opt_trace_procname_field
,
58 opt_trace_hostname_field
,
59 opt_trace_default_fields
= 1,
64 opt_debug_info_full_path
;
74 BT_LOGLEVEL_EMERG
= 0,
75 BT_LOGLEVEL_ALERT
= 1,
78 BT_LOGLEVEL_WARNING
= 4,
79 BT_LOGLEVEL_NOTICE
= 5,
81 BT_LOGLEVEL_DEBUG_SYSTEM
= 7,
82 BT_LOGLEVEL_DEBUG_PROGRAM
= 8,
83 BT_LOGLEVEL_DEBUG_PROCESS
= 9,
84 BT_LOGLEVEL_DEBUG_MODULE
= 10,
85 BT_LOGLEVEL_DEBUG_UNIT
= 11,
86 BT_LOGLEVEL_DEBUG_FUNCTION
= 12,
87 BT_LOGLEVEL_DEBUG_LINE
= 13,
88 BT_LOGLEVEL_DEBUG
= 14,
92 struct bt_trace_descriptor
*ctf_text_open_trace(const char *path
, int flags
,
93 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
94 int whence
), FILE *metadata_fp
);
96 int ctf_text_close_trace(struct bt_trace_descriptor
*descriptor
);
99 rw_dispatch write_dispatch_table
[] = {
100 [ CTF_TYPE_INTEGER
] = ctf_text_integer_write
,
101 [ CTF_TYPE_FLOAT
] = ctf_text_float_write
,
102 [ CTF_TYPE_ENUM
] = ctf_text_enum_write
,
103 [ CTF_TYPE_STRING
] = ctf_text_string_write
,
104 [ CTF_TYPE_STRUCT
] = ctf_text_struct_write
,
105 [ CTF_TYPE_VARIANT
] = ctf_text_variant_write
,
106 [ CTF_TYPE_ARRAY
] = ctf_text_array_write
,
107 [ CTF_TYPE_SEQUENCE
] = ctf_text_sequence_write
,
111 struct bt_format ctf_text_format
= {
112 .open_trace
= ctf_text_open_trace
,
113 .close_trace
= ctf_text_close_trace
,
116 static GQuark Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN
,
117 Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END
,
118 Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED
,
119 Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE
,
120 Q_STREAM_PACKET_CONTEXT_PACKET_SIZE
,
121 Q_STREAM_PACKET_CONTEXT_PACKET_SEQ_NUM
;
124 void __attribute__((constructor
)) init_quarks(void)
126 Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN
= g_quark_from_static_string("stream.packet.context.timestamp_begin");
127 Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END
= g_quark_from_static_string("stream.packet.context.timestamp_end");
128 Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED
= g_quark_from_static_string("stream.packet.context.events_discarded");
129 Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE
= g_quark_from_static_string("stream.packet.context.content_size");
130 Q_STREAM_PACKET_CONTEXT_PACKET_SIZE
= g_quark_from_static_string("stream.packet.context.packet_size");
131 Q_STREAM_PACKET_CONTEXT_PACKET_SEQ_NUM
= g_quark_from_static_string("stream.packet.context.packet_seq_num");
135 struct ctf_callsite_dups
*ctf_trace_callsite_lookup(struct ctf_trace
*trace
,
136 GQuark callsite_name
)
138 return g_hash_table_lookup(trace
->callsites
,
139 (gpointer
) (unsigned long) callsite_name
);
142 int print_field(struct bt_definition
*definition
)
144 /* Print all fields in verbose mode */
145 if (babeltrace_verbose
)
148 /* Filter out part of the packet context */
149 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN
)
151 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END
)
153 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED
)
155 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE
)
157 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_PACKET_SIZE
)
159 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_PACKET_SEQ_NUM
)
166 void set_field_names_print(struct ctf_text_stream_pos
*pos
, enum field_item item
)
170 if (opt_all_field_names
|| opt_scope_field_names
)
171 pos
->print_names
= 1;
173 pos
->print_names
= 0;
176 if (opt_all_field_names
|| opt_header_field_names
)
177 pos
->print_names
= 1;
179 pos
->print_names
= 0;
182 if (opt_all_field_names
|| opt_context_field_names
)
183 pos
->print_names
= 1;
185 pos
->print_names
= 0;
188 if (opt_all_field_names
|| opt_payload_field_names
)
189 pos
->print_names
= 1;
191 pos
->print_names
= 0;
200 const char *print_loglevel(int value
)
205 case BT_LOGLEVEL_EMERG
:
206 return "TRACE_EMERG";
207 case BT_LOGLEVEL_ALERT
:
208 return "TRACE_ALERT";
209 case BT_LOGLEVEL_CRIT
:
211 case BT_LOGLEVEL_ERR
:
213 case BT_LOGLEVEL_WARNING
:
214 return "TRACE_WARNING";
215 case BT_LOGLEVEL_NOTICE
:
216 return "TRACE_NOTICE";
217 case BT_LOGLEVEL_INFO
:
219 case BT_LOGLEVEL_DEBUG_SYSTEM
:
220 return "TRACE_DEBUG_SYSTEM";
221 case BT_LOGLEVEL_DEBUG_PROGRAM
:
222 return "TRACE_DEBUG_PROGRAM";
223 case BT_LOGLEVEL_DEBUG_PROCESS
:
224 return "TRACE_DEBUG_PROCESS";
225 case BT_LOGLEVEL_DEBUG_MODULE
:
226 return "TRACE_DEBUG_MODULE";
227 case BT_LOGLEVEL_DEBUG_UNIT
:
228 return "TRACE_DEBUG_UNIT";
229 case BT_LOGLEVEL_DEBUG_FUNCTION
:
230 return "TRACE_DEBUG_FUNCTION";
231 case BT_LOGLEVEL_DEBUG_LINE
:
232 return "TRACE_DEBUG_LINE";
233 case BT_LOGLEVEL_DEBUG
:
234 return "TRACE_DEBUG";
236 return "<<UNKNOWN>>";
241 int ctf_text_write_event(struct bt_stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
243 struct ctf_text_stream_pos
*pos
=
244 container_of(ppos
, struct ctf_text_stream_pos
, parent
);
245 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
247 struct ctf_event_declaration
*event_class
;
248 struct ctf_event_definition
*event
;
253 id
= stream
->event_id
;
255 if (id
>= stream_class
->events_by_id
->len
) {
256 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
259 event
= g_ptr_array_index(stream
->events_by_id
, id
);
261 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
264 event_class
= g_ptr_array_index(stream_class
->events_by_id
, id
);
266 fprintf(stderr
, "[error] Event class id %" PRIu64
" is unknown.\n", id
);
270 handle_debug_info_event(stream_class
, event
);
272 if (stream
->has_timestamp
) {
273 set_field_names_print(pos
, ITEM_HEADER
);
274 if (pos
->print_names
)
275 fprintf(pos
->fp
, "timestamp = ");
277 fprintf(pos
->fp
, "[");
278 if (opt_clock_cycles
) {
279 ctf_print_timestamp(pos
->fp
, stream
, stream
->cycles_timestamp
);
281 ctf_print_timestamp(pos
->fp
, stream
, stream
->real_timestamp
);
283 if (!pos
->print_names
)
284 fprintf(pos
->fp
, "]");
286 if (pos
->print_names
)
287 fprintf(pos
->fp
, ", ");
289 fprintf(pos
->fp
, " ");
291 if (opt_delta_field
&& stream
->has_timestamp
) {
292 uint64_t delta
, delta_sec
, delta_nsec
;
294 set_field_names_print(pos
, ITEM_HEADER
);
295 if (pos
->print_names
)
296 fprintf(pos
->fp
, "delta = ");
298 fprintf(pos
->fp
, "(");
299 if (pos
->last_real_timestamp
!= -1ULL) {
300 delta
= stream
->real_timestamp
- pos
->last_real_timestamp
;
301 delta_sec
= delta
/ NSEC_PER_SEC
;
302 delta_nsec
= delta
% NSEC_PER_SEC
;
303 fprintf(pos
->fp
, "+%" PRIu64
".%09" PRIu64
,
304 delta_sec
, delta_nsec
);
306 fprintf(pos
->fp
, "+?.?????????");
308 if (!pos
->print_names
)
309 fprintf(pos
->fp
, ")");
311 if (pos
->print_names
)
312 fprintf(pos
->fp
, ", ");
314 fprintf(pos
->fp
, " ");
315 pos
->last_real_timestamp
= stream
->real_timestamp
;
316 pos
->last_cycles_timestamp
= stream
->cycles_timestamp
;
319 if ((opt_trace_field
|| opt_all_fields
) && stream_class
->trace
->parent
.path
[0] != '\0') {
320 set_field_names_print(pos
, ITEM_HEADER
);
321 if (pos
->print_names
) {
322 fprintf(pos
->fp
, "trace = ");
324 fprintf(pos
->fp
, "%s", stream_class
->trace
->parent
.path
);
325 if (pos
->print_names
)
326 fprintf(pos
->fp
, ", ");
328 fprintf(pos
->fp
, " ");
330 if ((opt_trace_hostname_field
|| opt_all_fields
|| opt_trace_default_fields
)
331 && stream_class
->trace
->env
.hostname
[0] != '\0') {
332 set_field_names_print(pos
, ITEM_HEADER
);
333 if (pos
->print_names
) {
334 fprintf(pos
->fp
, "trace:hostname = ");
336 fprintf(pos
->fp
, "%s", stream_class
->trace
->env
.hostname
);
337 if (pos
->print_names
)
338 fprintf(pos
->fp
, ", ");
341 if ((opt_trace_domain_field
|| opt_all_fields
) && stream_class
->trace
->env
.domain
[0] != '\0') {
342 set_field_names_print(pos
, ITEM_HEADER
);
343 if (pos
->print_names
) {
344 fprintf(pos
->fp
, "trace:domain = ");
345 } else if (dom_print
) {
346 fprintf(pos
->fp
, ":");
348 fprintf(pos
->fp
, "%s", stream_class
->trace
->env
.domain
);
349 if (pos
->print_names
)
350 fprintf(pos
->fp
, ", ");
353 if ((opt_trace_procname_field
|| opt_all_fields
|| opt_trace_default_fields
)
354 && stream_class
->trace
->env
.procname
[0] != '\0') {
355 set_field_names_print(pos
, ITEM_HEADER
);
356 if (pos
->print_names
) {
357 fprintf(pos
->fp
, "trace:procname = ");
358 } else if (dom_print
) {
359 fprintf(pos
->fp
, ":");
361 fprintf(pos
->fp
, "%s", stream_class
->trace
->env
.procname
);
362 if (pos
->print_names
)
363 fprintf(pos
->fp
, ", ");
366 if ((opt_trace_vpid_field
|| opt_all_fields
|| opt_trace_default_fields
)
367 && stream_class
->trace
->env
.vpid
!= -1) {
368 set_field_names_print(pos
, ITEM_HEADER
);
369 if (pos
->print_names
) {
370 fprintf(pos
->fp
, "trace:vpid = ");
371 } else if (dom_print
) {
372 fprintf(pos
->fp
, ":");
374 fprintf(pos
->fp
, "%d", stream_class
->trace
->env
.vpid
);
375 if (pos
->print_names
)
376 fprintf(pos
->fp
, ", ");
379 if ((opt_loglevel_field
|| opt_all_fields
) && event_class
->loglevel
!= -1) {
380 set_field_names_print(pos
, ITEM_HEADER
);
381 if (pos
->print_names
) {
382 fprintf(pos
->fp
, "loglevel = ");
383 } else if (dom_print
) {
384 fprintf(pos
->fp
, ":");
386 fprintf(pos
->fp
, "%s (%d)",
387 print_loglevel(event_class
->loglevel
),
388 event_class
->loglevel
);
389 if (pos
->print_names
)
390 fprintf(pos
->fp
, ", ");
393 if ((opt_emf_field
|| opt_all_fields
) && event_class
->model_emf_uri
) {
394 set_field_names_print(pos
, ITEM_HEADER
);
395 if (pos
->print_names
) {
396 fprintf(pos
->fp
, "model.emf.uri = ");
397 } else if (dom_print
) {
398 fprintf(pos
->fp
, ":");
400 fprintf(pos
->fp
, "\"%s\"",
401 g_quark_to_string(event_class
->model_emf_uri
));
402 if (pos
->print_names
)
403 fprintf(pos
->fp
, ", ");
406 if ((opt_callsite_field
|| opt_all_fields
)) {
407 struct ctf_callsite_dups
*cs_dups
;
408 struct ctf_callsite
*callsite
;
410 cs_dups
= ctf_trace_callsite_lookup(stream_class
->trace
,
415 set_field_names_print(pos
, ITEM_HEADER
);
416 if (pos
->print_names
) {
417 fprintf(pos
->fp
, "callsite = ");
418 } else if (dom_print
) {
419 fprintf(pos
->fp
, ":");
421 fprintf(pos
->fp
, "[");
422 bt_list_for_each_entry(callsite
, &cs_dups
->head
, node
) {
424 fprintf(pos
->fp
, ",");
425 if (CTF_CALLSITE_FIELD_IS_SET(callsite
, ip
)) {
426 fprintf(pos
->fp
, "%s@0x%" PRIx64
":%s:%" PRIu64
"",
427 callsite
->func
, callsite
->ip
, callsite
->file
,
430 fprintf(pos
->fp
, "%s:%s:%" PRIu64
"",
431 callsite
->func
, callsite
->file
,
436 fprintf(pos
->fp
, "]");
437 if (pos
->print_names
)
438 fprintf(pos
->fp
, ", ");
442 if (dom_print
&& !pos
->print_names
)
443 fprintf(pos
->fp
, " ");
444 set_field_names_print(pos
, ITEM_HEADER
);
445 if (pos
->print_names
)
446 fprintf(pos
->fp
, "name = ");
447 fprintf(pos
->fp
, "%s", g_quark_to_string(event_class
->name
));
448 if (pos
->print_names
)
451 fprintf(pos
->fp
, ":");
453 /* print cpuid field from packet context */
454 if (stream
->stream_packet_context
) {
455 if (pos
->field_nr
++ != 0)
456 fprintf(pos
->fp
, ",");
457 set_field_names_print(pos
, ITEM_SCOPE
);
458 if (pos
->print_names
)
459 fprintf(pos
->fp
, " stream.packet.context =");
460 field_nr_saved
= pos
->field_nr
;
462 set_field_names_print(pos
, ITEM_CONTEXT
);
463 ret
= generic_rw(ppos
, &stream
->stream_packet_context
->p
);
466 pos
->field_nr
= field_nr_saved
;
469 /* Only show the event header in verbose mode */
470 if (babeltrace_verbose
&& stream
->stream_event_header
) {
471 if (pos
->field_nr
++ != 0)
472 fprintf(pos
->fp
, ",");
473 set_field_names_print(pos
, ITEM_SCOPE
);
474 if (pos
->print_names
)
475 fprintf(pos
->fp
, " stream.event.header =");
476 field_nr_saved
= pos
->field_nr
;
478 set_field_names_print(pos
, ITEM_CONTEXT
);
479 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
482 pos
->field_nr
= field_nr_saved
;
485 /* print stream-declared event context */
486 if (stream
->stream_event_context
) {
487 if (pos
->field_nr
++ != 0)
488 fprintf(pos
->fp
, ",");
489 set_field_names_print(pos
, ITEM_SCOPE
);
490 if (pos
->print_names
)
491 fprintf(pos
->fp
, " stream.event.context =");
492 field_nr_saved
= pos
->field_nr
;
494 set_field_names_print(pos
, ITEM_CONTEXT
);
495 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
498 pos
->field_nr
= field_nr_saved
;
501 /* print event-declared event context */
502 if (event
->event_context
) {
503 if (pos
->field_nr
++ != 0)
504 fprintf(pos
->fp
, ",");
505 set_field_names_print(pos
, ITEM_SCOPE
);
506 if (pos
->print_names
)
507 fprintf(pos
->fp
, " event.context =");
508 field_nr_saved
= pos
->field_nr
;
510 set_field_names_print(pos
, ITEM_CONTEXT
);
511 ret
= generic_rw(ppos
, &event
->event_context
->p
);
514 pos
->field_nr
= field_nr_saved
;
517 /* Read and print event payload */
518 if (event
->event_fields
) {
519 if (pos
->field_nr
++ != 0)
520 fprintf(pos
->fp
, ",");
521 set_field_names_print(pos
, ITEM_SCOPE
);
522 if (pos
->print_names
)
523 fprintf(pos
->fp
, " event.fields =");
524 field_nr_saved
= pos
->field_nr
;
526 set_field_names_print(pos
, ITEM_PAYLOAD
);
527 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
530 pos
->field_nr
= field_nr_saved
;
533 fprintf(pos
->fp
, "\n");
539 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
544 struct bt_trace_descriptor
*ctf_text_open_trace(const char *path
, int flags
,
545 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
546 int whence
), FILE *metadata_fp
)
548 struct ctf_text_stream_pos
*pos
;
551 pos
= g_new0(struct ctf_text_stream_pos
, 1);
555 init_trace_descriptor(&pos
->trace_descriptor
);
557 pos
->last_real_timestamp
= -1ULL;
558 pos
->last_cycles_timestamp
= -1ULL;
559 switch (flags
& O_ACCMODE
) {
564 fp
= fopen(path
, "w");
568 pos
->parent
.rw_table
= write_dispatch_table
;
569 pos
->parent
.event_cb
= ctf_text_write_event
;
570 pos
->parent
.trace
= &pos
->trace_descriptor
;
571 pos
->print_names
= 0;
572 babeltrace_ctf_console_output
++;
576 fprintf(stderr
, "[error] Incorrect open flags.\n");
580 return &pos
->trace_descriptor
;
587 int ctf_text_close_trace(struct bt_trace_descriptor
*td
)
590 struct ctf_text_stream_pos
*pos
=
591 container_of(td
, struct ctf_text_stream_pos
, trace_descriptor
);
593 babeltrace_ctf_console_output
--;
594 if (pos
->fp
!= stdout
) {
595 ret
= fclose(pos
->fp
);
597 perror("Error on fclose");
606 void __attribute__((constructor
)) ctf_text_init(void)
610 ctf_text_format
.name
= g_quark_from_static_string("text");
611 ret
= bt_register_format(&ctf_text_format
);
616 void __attribute__((destructor
)) ctf_text_exit(void)
618 bt_unregister_format(&ctf_text_format
);