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
  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 <inttypes.h>
  26 #include <uuid/uuid.h>
  27 #include <sys/mman.h>
  28 #include <errno.h>
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <fcntl.h>
  32 #include <dirent.h>
  33 #include <glib.h>
  34 #include <unistd.h>
  35 #include <stdlib.h>
  36
  37 #define NSEC_PER_SEC 1000000000ULL
  38
  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,
  44         opt_all_fields,
  45         opt_trace_field,
  46         opt_trace_domain_field,
  47         opt_trace_procname_field,
  48         opt_trace_vpid_field,
  49         opt_loglevel_field,
  50         opt_delta_field = 1;
  51
  52 enum field_item {
  53         ITEM_SCOPE,
  54         ITEM_HEADER,
  55         ITEM_CONTEXT,
  56         ITEM_PAYLOAD,
  57 };
  58
  59 struct trace_descriptor *ctf_text_open_trace(const char *collection_path,
  60                 const char *path, int flags,
  61                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
  62                         int whence), FILE *metadata_fp);
  63 void ctf_text_close_trace(struct trace_descriptor *descriptor);
  64
  65 static
  66 rw_dispatch write_dispatch_table[] = {
  67         [ CTF_TYPE_INTEGER ] = ctf_text_integer_write,
  68         [ CTF_TYPE_FLOAT ] = ctf_text_float_write,
  69         [ CTF_TYPE_ENUM ] = ctf_text_enum_write,
  70         [ CTF_TYPE_STRING ] = ctf_text_string_write,
  71         [ CTF_TYPE_STRUCT ] = ctf_text_struct_write,
  72         [ CTF_TYPE_VARIANT ] = ctf_text_variant_write,
  73         [ CTF_TYPE_ARRAY ] = ctf_text_array_write,
  74         [ CTF_TYPE_SEQUENCE ] = ctf_text_sequence_write,
  75 };
  76
  77 static
  78 struct format ctf_text_format = {
  79         .open_trace = ctf_text_open_trace,
  80         .close_trace = ctf_text_close_trace,
  81 };
  82
  83 static GQuark Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN,
  84         Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END,
  85         Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED,
  86         Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE,
  87         Q_STREAM_PACKET_CONTEXT_PACKET_SIZE;
  88
  89 static
  90 void __attribute__((constructor)) init_quarks(void)
  91 {
  92         Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN = g_quark_from_static_string("stream.packet.context.timestamp_begin");
  93         Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END = g_quark_from_static_string("stream.packet.context.timestamp_end");
  94         Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED = g_quark_from_static_string("stream.packet.context.events_discarded");
  95         Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE = g_quark_from_static_string("stream.packet.context.content_size");
  96         Q_STREAM_PACKET_CONTEXT_PACKET_SIZE = g_quark_from_static_string("stream.packet.context.packet_size");
  97 }
  98
  99 int print_field(struct definition *definition)
 100 {
 101         /* Print all fields in verbose mode */
 102         if (babeltrace_verbose)
 103                 return 1;
 104
 105         /* Filter out part of the packet context */
 106         if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN)
 107                 return 0;
 108         if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END)
 109                 return 0;
 110         if (definition->path == Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED)
 111                 return 0;
 112         if (definition->path == Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE)
 113                 return 0;
 114         if (definition->path == Q_STREAM_PACKET_CONTEXT_PACKET_SIZE)
 115                 return 0;
 116
 117         return 1;
 118 }
 119
 120 static
 121 void set_field_names_print(struct ctf_text_stream_pos *pos, enum field_item item)
 122 {
 123         switch (item) {
 124         case ITEM_SCOPE:
 125                 if (opt_all_field_names || opt_scope_field_names)
 126                         pos->print_names = 1;
 127                 else
 128                         pos->print_names = 0;
 129                 break;
 130         case ITEM_HEADER:
 131                 if (opt_all_field_names || opt_header_field_names)
 132                         pos->print_names = 1;
 133                 else
 134                         pos->print_names = 0;
 135                 break;
 136         case ITEM_CONTEXT:
 137                 if (opt_all_field_names || opt_context_field_names)
 138                         pos->print_names = 1;
 139                 else
 140                         pos->print_names = 0;
 141                 break;
 142         case ITEM_PAYLOAD:
 143                 if (opt_all_field_names || opt_payload_field_names)
 144                         pos->print_names = 1;
 145                 else
 146                         pos->print_names = 0;
 147
 148                 break;
 149         default:
 150                 assert(0);
 151         }
 152 }
 153
 154 static
 155 int ctf_text_write_event(struct stream_pos *ppos,
 156                          struct ctf_stream *stream)
 157 {
 158         struct ctf_text_stream_pos *pos =
 159                 container_of(ppos, struct ctf_text_stream_pos, parent);
 160         struct ctf_stream_class *stream_class = stream->stream_class;
 161         int field_nr_saved;
 162         struct ctf_event *event_class;
 163         struct ctf_stream_event *event;
 164         uint64_t id;
 165         int ret;
 166         int dom_print = 0;
 167
 168         id = stream->event_id;
 169
 170         if (id >= stream_class->events_by_id->len) {
 171                 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
 172                 return -EINVAL;
 173         }
 174         event = g_ptr_array_index(stream->events_by_id, id);
 175         if (!event) {
 176                 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
 177                 return -EINVAL;
 178         }
 179         event_class = g_ptr_array_index(stream_class->events_by_id, id);
 180         if (!event) {
 181                 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
 182                 return -EINVAL;
 183         }
 184
 185         /* Print events discarded */
 186         if (stream->events_discarded) {
 187                 fflush(pos->fp);
 188                 fprintf(stderr, "[warning] Tracer discarded %d events between [",
 189                         stream->events_discarded);
 190                 ctf_print_timestamp(stderr, stream, stream->prev_timestamp);
 191                 fprintf(stderr, "] and [");
 192                 ctf_print_timestamp(stderr, stream, stream->prev_timestamp_end);
 193                 fprintf(stderr, "]. You should consider increasing the buffer size.\n");
 194                 fflush(stderr);
 195                 stream->events_discarded = 0;
 196         }
 197
 198         if (stream->has_timestamp) {
 199                 set_field_names_print(pos, ITEM_HEADER);
 200                 if (pos->print_names)
 201                         fprintf(pos->fp, "timestamp = ");
 202                 else
 203                         fprintf(pos->fp, "[");
 204                 ctf_print_timestamp(pos->fp, stream, stream->timestamp);
 205                 if (!pos->print_names)
 206                         fprintf(pos->fp, "]");
 207
 208                 if (pos->print_names)
 209                         fprintf(pos->fp, ", ");
 210                 else
 211                         fprintf(pos->fp, " ");
 212         }
 213         if ((opt_delta_field || opt_all_fields) && stream->has_timestamp) {
 214                 uint64_t delta, delta_sec, delta_nsec;
 215
 216                 set_field_names_print(pos, ITEM_HEADER);
 217                 if (pos->print_names)
 218                         fprintf(pos->fp, "delta = ");
 219                 else
 220                         fprintf(pos->fp, "(");
 221                 if (pos->last_timestamp != -1ULL) {
 222                         delta = stream->timestamp - pos->last_timestamp;
 223                         delta_sec = delta / NSEC_PER_SEC;
 224                         delta_nsec = delta % NSEC_PER_SEC;
 225                         fprintf(pos->fp, "+%" PRIu64 ".%09" PRIu64,
 226                                 delta_sec, delta_nsec);
 227                 } else {
 228                         fprintf(pos->fp, "+?.?????????");
 229                 }
 230                 if (!pos->print_names)
 231                         fprintf(pos->fp, ")");
 232
 233                 if (pos->print_names)
 234                         fprintf(pos->fp, ", ");
 235                 else
 236                         fprintf(pos->fp, " ");
 237                 pos->last_timestamp = stream->timestamp;
 238         }
 239
 240         if ((opt_trace_field || opt_all_fields) && stream_class->trace->path[0] != '\0') {
 241                 set_field_names_print(pos, ITEM_HEADER);
 242                 if (pos->print_names) {
 243                         fprintf(pos->fp, "trace = ");
 244                 }
 245                 fprintf(pos->fp, "%s", stream_class->trace->path);
 246                 if (pos->print_names)
 247                         fprintf(pos->fp, ", ");
 248                 else
 249                         fprintf(pos->fp, " ");
 250         }
 251         if ((opt_trace_domain_field && !opt_all_fields) && stream_class->trace->domain[0] != '\0') {
 252                 set_field_names_print(pos, ITEM_HEADER);
 253                 if (pos->print_names) {
 254                         fprintf(pos->fp, "trace:domain = ");
 255                 }
 256                 fprintf(pos->fp, "%s", stream_class->trace->domain);
 257                 if (pos->print_names)
 258                         fprintf(pos->fp, ", ");
 259                 dom_print = 1;
 260         }
 261         if ((opt_trace_procname_field && !opt_all_fields) && stream_class->trace->procname[0] != '\0') {
 262                 set_field_names_print(pos, ITEM_HEADER);
 263                 if (pos->print_names) {
 264                         fprintf(pos->fp, "trace:procname = ");
 265                 } else if (dom_print) {
 266                         fprintf(pos->fp, ":");
 267                 }
 268                 fprintf(pos->fp, "%s", stream_class->trace->procname);
 269                 if (pos->print_names)
 270                         fprintf(pos->fp, ", ");
 271                 dom_print = 1;
 272         }
 273         if ((opt_trace_vpid_field && !opt_all_fields) && stream_class->trace->vpid[0] != '\0') {
 274                 set_field_names_print(pos, ITEM_HEADER);
 275                 if (pos->print_names) {
 276                         fprintf(pos->fp, "trace:vpid = ");
 277                 } else if (dom_print) {
 278                         fprintf(pos->fp, ":");
 279                 }
 280                 fprintf(pos->fp, "%s", stream_class->trace->vpid);
 281                 if (pos->print_names)
 282                         fprintf(pos->fp, ", ");
 283                 dom_print = 1;
 284         }
 285         if ((opt_loglevel_field || opt_all_fields) && event_class->loglevel != -1) {
 286                 set_field_names_print(pos, ITEM_HEADER);
 287                 if (pos->print_names) {
 288                         fprintf(pos->fp, "loglevel = ");
 289                 } else if (dom_print) {
 290                         fprintf(pos->fp, ":");
 291                 }
 292                 fprintf(pos->fp, "(%d)",
 293                         event_class->loglevel);
 294                 if (pos->print_names)
 295                         fprintf(pos->fp, ", ");
 296                 dom_print = 1;
 297         }
 298         if (dom_print && !pos->print_names)
 299                 fprintf(pos->fp, " ");
 300         set_field_names_print(pos, ITEM_HEADER);
 301         if (pos->print_names)
 302                 fprintf(pos->fp, "name = ");
 303         fprintf(pos->fp, "%s", g_quark_to_string(event_class->name));
 304         if (pos->print_names)
 305                 pos->field_nr++;
 306         else
 307                 fprintf(pos->fp, ":");
 308
 309         /* print cpuid field from packet context */
 310         if (stream->stream_packet_context) {
 311                 if (pos->field_nr++ != 0)
 312                         fprintf(pos->fp, ",");
 313                 set_field_names_print(pos, ITEM_SCOPE);
 314                 if (pos->print_names)
 315                         fprintf(pos->fp, " stream.packet.context =");
 316                 field_nr_saved = pos->field_nr;
 317                 pos->field_nr = 0;
 318                 set_field_names_print(pos, ITEM_CONTEXT);
 319                 ret = generic_rw(ppos, &stream->stream_packet_context->p);
 320                 if (ret)
 321                         goto error;
 322                 pos->field_nr = field_nr_saved;
 323         }
 324
 325         /* Only show the event header in verbose mode */
 326         if (babeltrace_verbose && stream->stream_event_header) {
 327                 if (pos->field_nr++ != 0)
 328                         fprintf(pos->fp, ",");
 329                 set_field_names_print(pos, ITEM_SCOPE);
 330                 if (pos->print_names)
 331                         fprintf(pos->fp, " stream.event.header =");
 332                 field_nr_saved = pos->field_nr;
 333                 pos->field_nr = 0;
 334                 set_field_names_print(pos, ITEM_CONTEXT);
 335                 ret = generic_rw(ppos, &stream->stream_event_header->p);
 336                 if (ret)
 337                         goto error;
 338                 pos->field_nr = field_nr_saved;
 339         }
 340
 341         /* print stream-declared event context */
 342         if (stream->stream_event_context) {
 343                 if (pos->field_nr++ != 0)
 344                         fprintf(pos->fp, ",");
 345                 set_field_names_print(pos, ITEM_SCOPE);
 346                 if (pos->print_names)
 347                         fprintf(pos->fp, " stream.event.context =");
 348                 field_nr_saved = pos->field_nr;
 349                 pos->field_nr = 0;
 350                 set_field_names_print(pos, ITEM_CONTEXT);
 351                 ret = generic_rw(ppos, &stream->stream_event_context->p);
 352                 if (ret)
 353                         goto error;
 354                 pos->field_nr = field_nr_saved;
 355         }
 356
 357         /* print event-declared event context */
 358         if (event->event_context) {
 359                 if (pos->field_nr++ != 0)
 360                         fprintf(pos->fp, ",");
 361                 set_field_names_print(pos, ITEM_SCOPE);
 362                 if (pos->print_names)
 363                         fprintf(pos->fp, " event.context =");
 364                 field_nr_saved = pos->field_nr;
 365                 pos->field_nr = 0;
 366                 set_field_names_print(pos, ITEM_CONTEXT);
 367                 ret = generic_rw(ppos, &event->event_context->p);
 368                 if (ret)
 369                         goto error;
 370                 pos->field_nr = field_nr_saved;
 371         }
 372
 373         /* Read and print event payload */
 374         if (event->event_fields) {
 375                 if (pos->field_nr++ != 0)
 376                         fprintf(pos->fp, ",");
 377                 set_field_names_print(pos, ITEM_SCOPE);
 378                 if (pos->print_names)
 379                         fprintf(pos->fp, " event.fields =");
 380                 field_nr_saved = pos->field_nr;
 381                 pos->field_nr = 0;
 382                 set_field_names_print(pos, ITEM_PAYLOAD);
 383                 ret = generic_rw(ppos, &event->event_fields->p);
 384                 if (ret)
 385                         goto error;
 386                 pos->field_nr = field_nr_saved;
 387         }
 388         /* newline */
 389         fprintf(pos->fp, "\n");
 390         pos->field_nr = 0;
 391
 392         return 0;
 393
 394 error:
 395         fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
 396         return ret;
 397 }
 398
 399
 400 struct trace_descriptor *ctf_text_open_trace(const char *collection_path,
 401                 const char *path, int flags,
 402                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
 403                         int whence), FILE *metadata_fp)
 404 {
 405         struct ctf_text_stream_pos *pos;
 406         FILE *fp;
 407
 408         pos = g_new0(struct ctf_text_stream_pos, 1);
 409
 410         pos->last_timestamp = -1ULL;
 411         switch (flags & O_ACCMODE) {
 412         case O_RDWR:
 413                 if (!path)
 414                         fp = stdout;
 415                 else
 416                         fp = fopen(path, "w");
 417                 if (!fp)
 418                         goto error;
 419                 pos->fp = fp;
 420                 pos->parent.rw_table = write_dispatch_table;
 421                 pos->parent.event_cb = ctf_text_write_event;
 422                 pos->print_names = 0;
 423                 break;
 424         case O_RDONLY:
 425         default:
 426                 fprintf(stderr, "[error] Incorrect open flags.\n");
 427                 goto error;
 428         }
 429
 430         return &pos->trace_descriptor;
 431 error:
 432         g_free(pos);
 433         return NULL;
 434 }
 435
 436 void ctf_text_close_trace(struct trace_descriptor *td)
 437 {
 438         struct ctf_text_stream_pos *pos =
 439                 container_of(td, struct ctf_text_stream_pos, trace_descriptor);
 440         fclose(pos->fp);
 441         g_free(pos);
 442 }
 443
 444 void __attribute__((constructor)) ctf_text_init(void)
 445 {
 446         int ret;
 447
 448         ctf_text_format.name = g_quark_from_static_string("text");
 449         ret = bt_register_format(&ctf_text_format);
 450         assert(!ret);
 451 }
 452
 453 /* TODO: finalize */