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.
21 #include <babeltrace/format.h>
22 #include <babeltrace/ctf-text/types.h>
23 #include <babeltrace/ctf/metadata.h>
24 #include <babeltrace/babeltrace-internal.h>
25 #include <babeltrace/ctf/events-internal.h>
29 #include <sys/types.h>
37 #define NSEC_PER_SEC 1000000000ULL
39 int opt_all_field_names
,
40 opt_scope_field_names
,
41 opt_header_field_names
,
42 opt_context_field_names
,
43 opt_payload_field_names
,
46 opt_trace_domain_field
,
47 opt_trace_procname_field
,
60 BT_LOGLEVEL_EMERG
= 0,
61 BT_LOGLEVEL_ALERT
= 1,
64 BT_LOGLEVEL_WARNING
= 4,
65 BT_LOGLEVEL_NOTICE
= 5,
67 BT_LOGLEVEL_DEBUG_SYSTEM
= 7,
68 BT_LOGLEVEL_DEBUG_PROGRAM
= 8,
69 BT_LOGLEVEL_DEBUG_PROCESS
= 9,
70 BT_LOGLEVEL_DEBUG_MODULE
= 10,
71 BT_LOGLEVEL_DEBUG_UNIT
= 11,
72 BT_LOGLEVEL_DEBUG_FUNCTION
= 12,
73 BT_LOGLEVEL_DEBUG_LINE
= 13,
74 BT_LOGLEVEL_DEBUG
= 14,
78 struct trace_descriptor
*ctf_text_open_trace(const char *path
, int flags
,
79 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
80 int whence
), FILE *metadata_fp
);
81 void ctf_text_close_trace(struct trace_descriptor
*descriptor
);
84 rw_dispatch write_dispatch_table
[] = {
85 [ CTF_TYPE_INTEGER
] = ctf_text_integer_write
,
86 [ CTF_TYPE_FLOAT
] = ctf_text_float_write
,
87 [ CTF_TYPE_ENUM
] = ctf_text_enum_write
,
88 [ CTF_TYPE_STRING
] = ctf_text_string_write
,
89 [ CTF_TYPE_STRUCT
] = ctf_text_struct_write
,
90 [ CTF_TYPE_VARIANT
] = ctf_text_variant_write
,
91 [ CTF_TYPE_ARRAY
] = ctf_text_array_write
,
92 [ CTF_TYPE_SEQUENCE
] = ctf_text_sequence_write
,
96 struct format ctf_text_format
= {
97 .open_trace
= ctf_text_open_trace
,
98 .close_trace
= ctf_text_close_trace
,
101 static GQuark Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN
,
102 Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END
,
103 Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED
,
104 Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE
,
105 Q_STREAM_PACKET_CONTEXT_PACKET_SIZE
;
108 void __attribute__((constructor
)) init_quarks(void)
110 Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN
= g_quark_from_static_string("stream.packet.context.timestamp_begin");
111 Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END
= g_quark_from_static_string("stream.packet.context.timestamp_end");
112 Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED
= g_quark_from_static_string("stream.packet.context.events_discarded");
113 Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE
= g_quark_from_static_string("stream.packet.context.content_size");
114 Q_STREAM_PACKET_CONTEXT_PACKET_SIZE
= g_quark_from_static_string("stream.packet.context.packet_size");
117 int print_field(struct definition
*definition
)
119 /* Print all fields in verbose mode */
120 if (babeltrace_verbose
)
123 /* Filter out part of the packet context */
124 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN
)
126 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END
)
128 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED
)
130 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE
)
132 if (definition
->path
== Q_STREAM_PACKET_CONTEXT_PACKET_SIZE
)
139 void set_field_names_print(struct ctf_text_stream_pos
*pos
, enum field_item item
)
143 if (opt_all_field_names
|| opt_scope_field_names
)
144 pos
->print_names
= 1;
146 pos
->print_names
= 0;
149 if (opt_all_field_names
|| opt_header_field_names
)
150 pos
->print_names
= 1;
152 pos
->print_names
= 0;
155 if (opt_all_field_names
|| opt_context_field_names
)
156 pos
->print_names
= 1;
158 pos
->print_names
= 0;
161 if (opt_all_field_names
|| opt_payload_field_names
)
162 pos
->print_names
= 1;
164 pos
->print_names
= 0;
173 const char *print_loglevel(int value
)
178 case BT_LOGLEVEL_EMERG
:
179 return "TRACE_EMERG";
180 case BT_LOGLEVEL_ALERT
:
181 return "TRACE_ALERT";
182 case BT_LOGLEVEL_CRIT
:
184 case BT_LOGLEVEL_ERR
:
186 case BT_LOGLEVEL_WARNING
:
187 return "TRACE_WARNING";
188 case BT_LOGLEVEL_NOTICE
:
189 return "TRACE_NOTICE";
190 case BT_LOGLEVEL_INFO
:
192 case BT_LOGLEVEL_DEBUG_SYSTEM
:
193 return "TRACE_DEBUG_SYSTEM";
194 case BT_LOGLEVEL_DEBUG_PROGRAM
:
195 return "TRACE_DEBUG_PROGRAM";
196 case BT_LOGLEVEL_DEBUG_PROCESS
:
197 return "TRACE_DEBUG_PROCESS";
198 case BT_LOGLEVEL_DEBUG_MODULE
:
199 return "TRACE_DEBUG_MODULE";
200 case BT_LOGLEVEL_DEBUG_UNIT
:
201 return "TRACE_DEBUG_UNIT";
202 case BT_LOGLEVEL_DEBUG_FUNCTION
:
203 return "TRACE_DEBUG_FUNCTION";
204 case BT_LOGLEVEL_DEBUG_LINE
:
205 return "TRACE_DEBUG_LINE";
206 case BT_LOGLEVEL_DEBUG
:
207 return "TRACE_DEBUG";
209 return "<<UNKNOWN>>";
214 int ctf_text_write_event(struct stream_pos
*ppos
, struct ctf_stream_definition
*stream
)
217 struct ctf_text_stream_pos
*pos
=
218 container_of(ppos
, struct ctf_text_stream_pos
, parent
);
219 struct ctf_stream_declaration
*stream_class
= stream
->stream_class
;
221 struct ctf_event_declaration
*event_class
;
222 struct ctf_event_definition
*event
;
227 id
= stream
->event_id
;
229 if (id
>= stream_class
->events_by_id
->len
) {
230 fprintf(stderr
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
233 event
= g_ptr_array_index(stream
->events_by_id
, id
);
235 fprintf(stderr
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
238 event_class
= g_ptr_array_index(stream_class
->events_by_id
, id
);
240 fprintf(stderr
, "[error] Event class id %" PRIu64
" is unknown.\n", id
);
244 /* Print events discarded */
245 if (stream
->events_discarded
) {
247 fprintf(stderr
, "[warning] Tracer discarded %" PRIu64
" events between [",
248 stream
->events_discarded
);
249 if (opt_clock_cycles
) {
250 ctf_print_timestamp(stderr
, stream
,
251 stream
->prev_cycles_timestamp
);
252 fprintf(stderr
, "] and [");
253 ctf_print_timestamp(stderr
, stream
,
254 stream
->prev_cycles_timestamp_end
);
256 ctf_print_timestamp(stderr
, stream
,
257 stream
->prev_real_timestamp
);
258 fprintf(stderr
, "] and [");
259 ctf_print_timestamp(stderr
, stream
,
260 stream
->prev_real_timestamp_end
);
262 fprintf(stderr
, "]. You should consider recording a new trace with larger buffers or with fewer events enabled.\n");
264 stream
->events_discarded
= 0;
267 if (stream
->has_timestamp
) {
268 set_field_names_print(pos
, ITEM_HEADER
);
269 if (pos
->print_names
)
270 fprintf(pos
->fp
, "timestamp = ");
272 fprintf(pos
->fp
, "[");
273 if (opt_clock_cycles
) {
274 ctf_print_timestamp(pos
->fp
, stream
, stream
->cycles_timestamp
);
276 ctf_print_timestamp(pos
->fp
, stream
, stream
->real_timestamp
);
278 if (!pos
->print_names
)
279 fprintf(pos
->fp
, "]");
281 if (pos
->print_names
)
282 fprintf(pos
->fp
, ", ");
284 fprintf(pos
->fp
, " ");
286 if ((opt_delta_field
|| opt_all_fields
) && stream
->has_timestamp
) {
287 uint64_t delta
, delta_sec
, delta_nsec
;
289 set_field_names_print(pos
, ITEM_HEADER
);
290 if (pos
->print_names
)
291 fprintf(pos
->fp
, "delta = ");
293 fprintf(pos
->fp
, "(");
294 if (pos
->last_real_timestamp
!= -1ULL) {
295 delta
= stream
->real_timestamp
- pos
->last_real_timestamp
;
296 delta_sec
= delta
/ NSEC_PER_SEC
;
297 delta_nsec
= delta
% NSEC_PER_SEC
;
298 fprintf(pos
->fp
, "+%" PRIu64
".%09" PRIu64
,
299 delta_sec
, delta_nsec
);
301 fprintf(pos
->fp
, "+?.?????????");
303 if (!pos
->print_names
)
304 fprintf(pos
->fp
, ")");
306 if (pos
->print_names
)
307 fprintf(pos
->fp
, ", ");
309 fprintf(pos
->fp
, " ");
310 pos
->last_real_timestamp
= stream
->real_timestamp
;
311 pos
->last_cycles_timestamp
= stream
->cycles_timestamp
;
314 if ((opt_trace_field
|| opt_all_fields
) && stream_class
->trace
->path
[0] != '\0') {
315 set_field_names_print(pos
, ITEM_HEADER
);
316 if (pos
->print_names
) {
317 fprintf(pos
->fp
, "trace = ");
319 fprintf(pos
->fp
, "%s", stream_class
->trace
->path
);
320 if (pos
->print_names
)
321 fprintf(pos
->fp
, ", ");
323 fprintf(pos
->fp
, " ");
325 if ((opt_trace_domain_field
&& !opt_all_fields
) && stream_class
->trace
->env
.domain
[0] != '\0') {
326 set_field_names_print(pos
, ITEM_HEADER
);
327 if (pos
->print_names
) {
328 fprintf(pos
->fp
, "trace:domain = ");
330 fprintf(pos
->fp
, "%s", stream_class
->trace
->env
.domain
);
331 if (pos
->print_names
)
332 fprintf(pos
->fp
, ", ");
335 if ((opt_trace_procname_field
&& !opt_all_fields
) && stream_class
->trace
->env
.procname
[0] != '\0') {
336 set_field_names_print(pos
, ITEM_HEADER
);
337 if (pos
->print_names
) {
338 fprintf(pos
->fp
, "trace:procname = ");
339 } else if (dom_print
) {
340 fprintf(pos
->fp
, ":");
342 fprintf(pos
->fp
, "%s", stream_class
->trace
->env
.procname
);
343 if (pos
->print_names
)
344 fprintf(pos
->fp
, ", ");
347 if ((opt_trace_vpid_field
&& !opt_all_fields
) && stream_class
->trace
->env
.vpid
!= -1) {
348 set_field_names_print(pos
, ITEM_HEADER
);
349 if (pos
->print_names
) {
350 fprintf(pos
->fp
, "trace:vpid = ");
351 } else if (dom_print
) {
352 fprintf(pos
->fp
, ":");
354 fprintf(pos
->fp
, "%d", stream_class
->trace
->env
.vpid
);
355 if (pos
->print_names
)
356 fprintf(pos
->fp
, ", ");
359 if ((opt_loglevel_field
|| opt_all_fields
) && event_class
->loglevel
!= -1) {
360 set_field_names_print(pos
, ITEM_HEADER
);
361 if (pos
->print_names
) {
362 fprintf(pos
->fp
, "loglevel = ");
363 } else if (dom_print
) {
364 fprintf(pos
->fp
, ":");
366 fprintf(pos
->fp
, "%s (%d)",
367 print_loglevel(event_class
->loglevel
),
368 event_class
->loglevel
);
369 if (pos
->print_names
)
370 fprintf(pos
->fp
, ", ");
373 if (dom_print
&& !pos
->print_names
)
374 fprintf(pos
->fp
, " ");
375 set_field_names_print(pos
, ITEM_HEADER
);
376 if (pos
->print_names
)
377 fprintf(pos
->fp
, "name = ");
378 fprintf(pos
->fp
, "%s", g_quark_to_string(event_class
->name
));
379 if (pos
->print_names
)
382 fprintf(pos
->fp
, ":");
384 /* print cpuid field from packet context */
385 if (stream
->stream_packet_context
) {
386 if (pos
->field_nr
++ != 0)
387 fprintf(pos
->fp
, ",");
388 set_field_names_print(pos
, ITEM_SCOPE
);
389 if (pos
->print_names
)
390 fprintf(pos
->fp
, " stream.packet.context =");
391 field_nr_saved
= pos
->field_nr
;
393 set_field_names_print(pos
, ITEM_CONTEXT
);
394 ret
= generic_rw(ppos
, &stream
->stream_packet_context
->p
);
397 pos
->field_nr
= field_nr_saved
;
400 /* Only show the event header in verbose mode */
401 if (babeltrace_verbose
&& stream
->stream_event_header
) {
402 if (pos
->field_nr
++ != 0)
403 fprintf(pos
->fp
, ",");
404 set_field_names_print(pos
, ITEM_SCOPE
);
405 if (pos
->print_names
)
406 fprintf(pos
->fp
, " stream.event.header =");
407 field_nr_saved
= pos
->field_nr
;
409 set_field_names_print(pos
, ITEM_CONTEXT
);
410 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
413 pos
->field_nr
= field_nr_saved
;
416 /* print stream-declared event context */
417 if (stream
->stream_event_context
) {
418 if (pos
->field_nr
++ != 0)
419 fprintf(pos
->fp
, ",");
420 set_field_names_print(pos
, ITEM_SCOPE
);
421 if (pos
->print_names
)
422 fprintf(pos
->fp
, " stream.event.context =");
423 field_nr_saved
= pos
->field_nr
;
425 set_field_names_print(pos
, ITEM_CONTEXT
);
426 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
429 pos
->field_nr
= field_nr_saved
;
432 /* print event-declared event context */
433 if (event
->event_context
) {
434 if (pos
->field_nr
++ != 0)
435 fprintf(pos
->fp
, ",");
436 set_field_names_print(pos
, ITEM_SCOPE
);
437 if (pos
->print_names
)
438 fprintf(pos
->fp
, " event.context =");
439 field_nr_saved
= pos
->field_nr
;
441 set_field_names_print(pos
, ITEM_CONTEXT
);
442 ret
= generic_rw(ppos
, &event
->event_context
->p
);
445 pos
->field_nr
= field_nr_saved
;
448 /* Read and print event payload */
449 if (event
->event_fields
) {
450 if (pos
->field_nr
++ != 0)
451 fprintf(pos
->fp
, ",");
452 set_field_names_print(pos
, ITEM_SCOPE
);
453 if (pos
->print_names
)
454 fprintf(pos
->fp
, " event.fields =");
455 field_nr_saved
= pos
->field_nr
;
457 set_field_names_print(pos
, ITEM_PAYLOAD
);
458 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
461 pos
->field_nr
= field_nr_saved
;
464 fprintf(pos
->fp
, "\n");
470 fprintf(stderr
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
475 struct trace_descriptor
*ctf_text_open_trace(const char *path
, int flags
,
476 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
477 int whence
), FILE *metadata_fp
)
479 struct ctf_text_stream_pos
*pos
;
482 pos
= g_new0(struct ctf_text_stream_pos
, 1);
484 pos
->last_real_timestamp
= -1ULL;
485 pos
->last_cycles_timestamp
= -1ULL;
486 switch (flags
& O_ACCMODE
) {
491 fp
= fopen(path
, "w");
495 pos
->parent
.rw_table
= write_dispatch_table
;
496 pos
->parent
.event_cb
= ctf_text_write_event
;
497 pos
->print_names
= 0;
501 fprintf(stderr
, "[error] Incorrect open flags.\n");
505 return &pos
->trace_descriptor
;
511 void ctf_text_close_trace(struct trace_descriptor
*td
)
513 struct ctf_text_stream_pos
*pos
=
514 container_of(td
, struct ctf_text_stream_pos
, trace_descriptor
);
519 void __attribute__((constructor
)) ctf_text_init(void)
523 ctf_text_format
.name
= g_quark_from_static_string("text");
524 ret
= bt_register_format(&ctf_text_format
);