Fix: text output missing separator when printing the domain
[babeltrace.git] / formats / ctf-text / ctf-text.c
1 /*
2 * BabelTrace - Common Trace Format (CTF)
3 *
4 * CTF Text Format registration.
5 *
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
7 *
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 *
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:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
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
26 * SOFTWARE.
27 */
28
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>
35 #include <inttypes.h>
36 #include <sys/mman.h>
37 #include <errno.h>
38 #include <sys/types.h>
39 #include <sys/stat.h>
40 #include <fcntl.h>
41 #include <dirent.h>
42 #include <glib.h>
43 #include <unistd.h>
44 #include <stdlib.h>
45
46 #define NSEC_PER_SEC 1000000000ULL
47
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,
53 opt_all_fields,
54 opt_trace_field,
55 opt_trace_domain_field,
56 opt_trace_procname_field,
57 opt_trace_vpid_field,
58 opt_trace_hostname_field,
59 opt_trace_default_fields = 1,
60 opt_loglevel_field,
61 opt_emf_field,
62 opt_callsite_field,
63 opt_delta_field = 1,
64 opt_debug_info_full_path;
65
66 enum field_item {
67 ITEM_SCOPE,
68 ITEM_HEADER,
69 ITEM_CONTEXT,
70 ITEM_PAYLOAD,
71 };
72
73 enum bt_loglevel {
74 BT_LOGLEVEL_EMERG = 0,
75 BT_LOGLEVEL_ALERT = 1,
76 BT_LOGLEVEL_CRIT = 2,
77 BT_LOGLEVEL_ERR = 3,
78 BT_LOGLEVEL_WARNING = 4,
79 BT_LOGLEVEL_NOTICE = 5,
80 BT_LOGLEVEL_INFO = 6,
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,
89 };
90
91 static
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);
95 static
96 int ctf_text_close_trace(struct bt_trace_descriptor *descriptor);
97
98 static
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,
108 };
109
110 static
111 struct bt_format ctf_text_format = {
112 .open_trace = ctf_text_open_trace,
113 .close_trace = ctf_text_close_trace,
114 };
115
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;
122
123 static
124 void __attribute__((constructor)) init_quarks(void)
125 {
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");
132 }
133
134 static
135 struct ctf_callsite_dups *ctf_trace_callsite_lookup(struct ctf_trace *trace,
136 GQuark callsite_name)
137 {
138 return g_hash_table_lookup(trace->callsites,
139 (gpointer) (unsigned long) callsite_name);
140 }
141
142 int print_field(struct bt_definition *definition)
143 {
144 /* Print all fields in verbose mode */
145 if (babeltrace_verbose)
146 return 1;
147
148 /* Filter out part of the packet context */
149 if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN)
150 return 0;
151 if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END)
152 return 0;
153 if (definition->path == Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED)
154 return 0;
155 if (definition->path == Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE)
156 return 0;
157 if (definition->path == Q_STREAM_PACKET_CONTEXT_PACKET_SIZE)
158 return 0;
159 if (definition->path == Q_STREAM_PACKET_CONTEXT_PACKET_SEQ_NUM)
160 return 0;
161
162 return 1;
163 }
164
165 static
166 void set_field_names_print(struct ctf_text_stream_pos *pos, enum field_item item)
167 {
168 switch (item) {
169 case ITEM_SCOPE:
170 if (opt_all_field_names || opt_scope_field_names)
171 pos->print_names = 1;
172 else
173 pos->print_names = 0;
174 break;
175 case ITEM_HEADER:
176 if (opt_all_field_names || opt_header_field_names)
177 pos->print_names = 1;
178 else
179 pos->print_names = 0;
180 break;
181 case ITEM_CONTEXT:
182 if (opt_all_field_names || opt_context_field_names)
183 pos->print_names = 1;
184 else
185 pos->print_names = 0;
186 break;
187 case ITEM_PAYLOAD:
188 if (opt_all_field_names || opt_payload_field_names)
189 pos->print_names = 1;
190 else
191 pos->print_names = 0;
192
193 break;
194 default:
195 assert(0);
196 }
197 }
198
199 static
200 const char *print_loglevel(int value)
201 {
202 switch (value) {
203 case -1:
204 return "";
205 case BT_LOGLEVEL_EMERG:
206 return "TRACE_EMERG";
207 case BT_LOGLEVEL_ALERT:
208 return "TRACE_ALERT";
209 case BT_LOGLEVEL_CRIT:
210 return "TRACE_CRIT";
211 case BT_LOGLEVEL_ERR:
212 return "TRACE_ERR";
213 case BT_LOGLEVEL_WARNING:
214 return "TRACE_WARNING";
215 case BT_LOGLEVEL_NOTICE:
216 return "TRACE_NOTICE";
217 case BT_LOGLEVEL_INFO:
218 return "TRACE_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";
235 default:
236 return "<<UNKNOWN>>";
237 }
238 }
239
240 static
241 int ctf_text_write_event(struct bt_stream_pos *ppos, struct ctf_stream_definition *stream)
242 {
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;
246 int field_nr_saved;
247 struct ctf_event_declaration *event_class;
248 struct ctf_event_definition *event;
249 uint64_t id;
250 int ret;
251 int dom_print = 0;
252
253 id = stream->event_id;
254
255 if (id >= stream_class->events_by_id->len) {
256 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
257 return -EINVAL;
258 }
259 event = g_ptr_array_index(stream->events_by_id, id);
260 if (!event) {
261 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
262 return -EINVAL;
263 }
264 event_class = g_ptr_array_index(stream_class->events_by_id, id);
265 if (!event_class) {
266 fprintf(stderr, "[error] Event class id %" PRIu64 " is unknown.\n", id);
267 return -EINVAL;
268 }
269
270 handle_debug_info_event(stream_class, event);
271
272 if (stream->has_timestamp) {
273 set_field_names_print(pos, ITEM_HEADER);
274 if (pos->print_names)
275 fprintf(pos->fp, "timestamp = ");
276 else
277 fprintf(pos->fp, "[");
278 if (opt_clock_cycles) {
279 ctf_print_timestamp(pos->fp, stream, stream->cycles_timestamp);
280 } else {
281 ctf_print_timestamp(pos->fp, stream, stream->real_timestamp);
282 }
283 if (!pos->print_names)
284 fprintf(pos->fp, "]");
285
286 if (pos->print_names)
287 fprintf(pos->fp, ", ");
288 else
289 fprintf(pos->fp, " ");
290 }
291 if (opt_delta_field && stream->has_timestamp) {
292 uint64_t delta, delta_sec, delta_nsec;
293
294 set_field_names_print(pos, ITEM_HEADER);
295 if (pos->print_names)
296 fprintf(pos->fp, "delta = ");
297 else
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);
305 } else {
306 fprintf(pos->fp, "+?.?????????");
307 }
308 if (!pos->print_names)
309 fprintf(pos->fp, ")");
310
311 if (pos->print_names)
312 fprintf(pos->fp, ", ");
313 else
314 fprintf(pos->fp, " ");
315 pos->last_real_timestamp = stream->real_timestamp;
316 pos->last_cycles_timestamp = stream->cycles_timestamp;
317 }
318
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 = ");
323 }
324 fprintf(pos->fp, "%s", stream_class->trace->parent.path);
325 if (pos->print_names)
326 fprintf(pos->fp, ", ");
327 else
328 fprintf(pos->fp, " ");
329 }
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 = ");
335 }
336 fprintf(pos->fp, "%s", stream_class->trace->env.hostname);
337 if (pos->print_names)
338 fprintf(pos->fp, ", ");
339 dom_print = 1;
340 }
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, ":");
347 }
348 fprintf(pos->fp, "%s", stream_class->trace->env.domain);
349 if (pos->print_names)
350 fprintf(pos->fp, ", ");
351 dom_print = 1;
352 }
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, ":");
360 }
361 fprintf(pos->fp, "%s", stream_class->trace->env.procname);
362 if (pos->print_names)
363 fprintf(pos->fp, ", ");
364 dom_print = 1;
365 }
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, ":");
373 }
374 fprintf(pos->fp, "%d", stream_class->trace->env.vpid);
375 if (pos->print_names)
376 fprintf(pos->fp, ", ");
377 dom_print = 1;
378 }
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, ":");
385 }
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, ", ");
391 dom_print = 1;
392 }
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, ":");
399 }
400 fprintf(pos->fp, "\"%s\"",
401 g_quark_to_string(event_class->model_emf_uri));
402 if (pos->print_names)
403 fprintf(pos->fp, ", ");
404 dom_print = 1;
405 }
406 if ((opt_callsite_field || opt_all_fields)) {
407 struct ctf_callsite_dups *cs_dups;
408 struct ctf_callsite *callsite;
409
410 cs_dups = ctf_trace_callsite_lookup(stream_class->trace,
411 event_class->name);
412 if (cs_dups) {
413 int i = 0;
414
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, ":");
420 }
421 fprintf(pos->fp, "[");
422 bt_list_for_each_entry(callsite, &cs_dups->head, node) {
423 if (i != 0)
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,
428 callsite->line);
429 } else {
430 fprintf(pos->fp, "%s:%s:%" PRIu64 "",
431 callsite->func, callsite->file,
432 callsite->line);
433 }
434 i++;
435 }
436 fprintf(pos->fp, "]");
437 if (pos->print_names)
438 fprintf(pos->fp, ", ");
439 dom_print = 1;
440 }
441 }
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)
449 pos->field_nr++;
450 else
451 fprintf(pos->fp, ":");
452
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;
461 pos->field_nr = 0;
462 set_field_names_print(pos, ITEM_CONTEXT);
463 ret = generic_rw(ppos, &stream->stream_packet_context->p);
464 if (ret)
465 goto error;
466 pos->field_nr = field_nr_saved;
467 }
468
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;
477 pos->field_nr = 0;
478 set_field_names_print(pos, ITEM_CONTEXT);
479 ret = generic_rw(ppos, &stream->stream_event_header->p);
480 if (ret)
481 goto error;
482 pos->field_nr = field_nr_saved;
483 }
484
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;
493 pos->field_nr = 0;
494 set_field_names_print(pos, ITEM_CONTEXT);
495 ret = generic_rw(ppos, &stream->stream_event_context->p);
496 if (ret)
497 goto error;
498 pos->field_nr = field_nr_saved;
499 }
500
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;
509 pos->field_nr = 0;
510 set_field_names_print(pos, ITEM_CONTEXT);
511 ret = generic_rw(ppos, &event->event_context->p);
512 if (ret)
513 goto error;
514 pos->field_nr = field_nr_saved;
515 }
516
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;
525 pos->field_nr = 0;
526 set_field_names_print(pos, ITEM_PAYLOAD);
527 ret = generic_rw(ppos, &event->event_fields->p);
528 if (ret)
529 goto error;
530 pos->field_nr = field_nr_saved;
531 }
532 /* newline */
533 fprintf(pos->fp, "\n");
534 pos->field_nr = 0;
535
536 return 0;
537
538 error:
539 fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
540 return ret;
541 }
542
543 static
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)
547 {
548 struct ctf_text_stream_pos *pos;
549 FILE *fp;
550
551 pos = g_new0(struct ctf_text_stream_pos, 1);
552 if (!pos) {
553 goto error;
554 }
555 init_trace_descriptor(&pos->trace_descriptor);
556
557 pos->last_real_timestamp = -1ULL;
558 pos->last_cycles_timestamp = -1ULL;
559 switch (flags & O_ACCMODE) {
560 case O_RDWR:
561 if (!path)
562 fp = stdout;
563 else
564 fp = fopen(path, "w");
565 if (!fp)
566 goto error;
567 pos->fp = fp;
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++;
573 break;
574 case O_RDONLY:
575 default:
576 fprintf(stderr, "[error] Incorrect open flags.\n");
577 goto error;
578 }
579
580 return &pos->trace_descriptor;
581 error:
582 g_free(pos);
583 return NULL;
584 }
585
586 static
587 int ctf_text_close_trace(struct bt_trace_descriptor *td)
588 {
589 int ret;
590 struct ctf_text_stream_pos *pos =
591 container_of(td, struct ctf_text_stream_pos, trace_descriptor);
592
593 babeltrace_ctf_console_output--;
594 if (pos->fp != stdout) {
595 ret = fclose(pos->fp);
596 if (ret) {
597 perror("Error on fclose");
598 return -1;
599 }
600 }
601 g_free(pos);
602 return 0;
603 }
604
605 static
606 void __attribute__((constructor)) ctf_text_init(void)
607 {
608 int ret;
609
610 ctf_text_format.name = g_quark_from_static_string("text");
611 ret = bt_register_format(&ctf_text_format);
612 assert(!ret);
613 }
614
615 static
616 void __attribute__((destructor)) ctf_text_exit(void)
617 {
618 bt_unregister_format(&ctf_text_format);
619 }
This page took 0.0415410000000001 seconds and 4 git commands to generate.