formats/ctf-text/ctf-text.c

   1 /*
   2  * BabelTrace - Common Trace Format (CTF)
   3  *
   4  * CTF Text Format registration.
   5  *
   6  * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   7  *
   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:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  */
  18
  19 #include <babeltrace/format.h>
  20 #include <babeltrace/ctf-text/types.h>
  21 #include <babeltrace/ctf/metadata.h>
  22 #include <babeltrace/babeltrace.h>
  23 #include <inttypes.h>
  24 #include <uuid/uuid.h>
  25 #include <sys/mman.h>
  26 #include <errno.h>
  27 #include <sys/types.h>
  28 #include <sys/stat.h>
  29 #include <fcntl.h>
  30 #include <dirent.h>
  31 #include <glib.h>
  32 #include <unistd.h>
  33 #include <stdlib.h>
  34
  35 struct trace_descriptor *ctf_text_open_trace(const char *path, int flags);
  36 void ctf_text_close_trace(struct trace_descriptor *descriptor);
  37
  38 static
  39 rw_dispatch write_dispatch_table[] = {
  40         [ CTF_TYPE_INTEGER ] = ctf_text_integer_write,
  41         [ CTF_TYPE_FLOAT ] = ctf_text_float_write,
  42         [ CTF_TYPE_ENUM ] = ctf_text_enum_write,
  43         [ CTF_TYPE_STRING ] = ctf_text_string_write,
  44         [ CTF_TYPE_STRUCT ] = ctf_text_struct_write,
  45         [ CTF_TYPE_VARIANT ] = ctf_text_variant_write,
  46         [ CTF_TYPE_ARRAY ] = ctf_text_array_write,
  47         [ CTF_TYPE_SEQUENCE ] = ctf_text_sequence_write,
  48 };
  49
  50 static
  51 struct format ctf_text_format = {
  52         .open_trace = ctf_text_open_trace,
  53         .close_trace = ctf_text_close_trace,
  54 };
  55
  56 static
  57 int ctf_text_write_event(struct stream_pos *ppos,
  58                          struct ctf_stream_class *stream_class)
  59 {
  60         struct ctf_text_stream_pos *pos =
  61                 container_of(ppos, struct ctf_text_stream_pos, parent);
  62         struct ctf_event *event_class;
  63         uint64_t id = 0;
  64         int len_index;
  65         int ret;
  66         int field_nr = 0;
  67
  68         /* print event header */
  69         if (stream_class->event_header) {
  70                 /* lookup event id */
  71                 len_index = struct_declaration_lookup_field_index(stream_class->event_header_decl,
  72                                 g_quark_from_static_string("id"));
  73                 if (len_index >= 0) {
  74                         struct definition_integer *defint;
  75                         struct definition *field;
  76
  77                         field = struct_definition_get_field_from_index(stream_class->event_header, len_index);
  78                         assert(field->declaration->id == CTF_TYPE_INTEGER);
  79                         defint = container_of(field, struct definition_integer, p);
  80                         assert(defint->declaration->signedness == FALSE);
  81                         id = defint->value._unsigned;   /* set id */
  82                 }
  83         }
  84
  85         if (id >= stream_class->events_by_id->len) {
  86                 fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id);
  87                 return -EINVAL;
  88         }
  89         event_class = g_ptr_array_index(stream_class->events_by_id, id);
  90         if (!event_class) {
  91                 fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id);
  92                 return -EINVAL;
  93         }
  94
  95         if (field_nr++ != 0)
  96                 fprintf(pos->fp, ", ");
  97         if (pos->print_names)
  98                 fprintf(pos->fp, "timestamp = ");
  99         else
 100                 fprintf(pos->fp, "[");
 101         fprintf(pos->fp, "%" PRIu64, (uint64_t) 0);     /* TODO */
 102         if (!pos->print_names)
 103                 fprintf(pos->fp, "]");
 104
 105         if (field_nr++ != 0)
 106                 fprintf(pos->fp, ", ");
 107         if (pos->print_names)
 108                 fprintf(pos->fp, "name = ");
 109         fprintf(pos->fp, "%s: ", g_quark_to_string(event_class->name));
 110
 111         if (stream_class->event_header) {
 112                 if (field_nr++ != 0)
 113                         fprintf(pos->fp, ", ");
 114                 if (pos->print_names)
 115                         fprintf(pos->fp, "stream.event.header = ");
 116                 ret = generic_rw(ppos, &stream_class->event_header->p);
 117                 if (ret)
 118                         goto error;
 119         }
 120
 121         /* print stream-declared event context */
 122         if (stream_class->event_context) {
 123                 if (field_nr++ != 0)
 124                         fprintf(pos->fp, ", ");
 125                 if (pos->print_names)
 126                         fprintf(pos->fp, "stream.event.context = ");
 127                 fprintf(pos->fp, " ");
 128                 ret = generic_rw(ppos, &stream_class->event_context->p);
 129                 if (ret)
 130                         goto error;
 131         }
 132
 133         /* print event-declared event context */
 134         if (event_class->context) {
 135                 if (field_nr++ != 0)
 136                         fprintf(pos->fp, ", ");
 137                 if (pos->print_names)
 138                         fprintf(pos->fp, "event.context = ");
 139                 fprintf(pos->fp, " ");
 140                 ret = generic_rw(ppos, &event_class->context->p);
 141                 if (ret)
 142                         goto error;
 143         }
 144
 145         /* Read and print event payload */
 146         if (event_class->fields) {
 147                 if (field_nr++ != 0)
 148                         fprintf(pos->fp, ", ");
 149                 if (pos->print_names)
 150                         fprintf(pos->fp, "event.fields = ");
 151                 fprintf(pos->fp, " ");
 152                 ret = generic_rw(ppos, &event_class->fields->p);
 153                 if (ret)
 154                         goto error;
 155         }
 156         fprintf(pos->fp, "\n");
 157
 158         return 0;
 159
 160 error:
 161         fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
 162         return ret;
 163 }
 164
 165
 166 struct trace_descriptor *ctf_text_open_trace(const char *path, int flags)
 167 {
 168         struct ctf_text_stream_pos *pos;
 169         FILE *fp;
 170
 171         pos = g_new0(struct ctf_text_stream_pos, 1);
 172
 173         switch (flags & O_ACCMODE) {
 174         case O_RDWR:
 175                 if (!path)
 176                         fp = stdout;
 177                 else
 178                         fp = fopen(path, "w");
 179                 if (!fp)
 180                         goto error;
 181                 pos->fp = fp;
 182                 pos->parent.rw_table = write_dispatch_table;
 183                 pos->parent.event_cb = ctf_text_write_event;
 184                 pos->print_names = opt_field_names;
 185                 break;
 186         case O_RDONLY:
 187         default:
 188                 fprintf(stdout, "[error] Incorrect open flags.\n");
 189                 goto error;
 190         }
 191
 192         return &pos->trace_descriptor;
 193 error:
 194         g_free(pos);
 195         return NULL;
 196 }
 197
 198 void ctf_text_close_trace(struct trace_descriptor *td)
 199 {
 200         struct ctf_text_stream_pos *pos =
 201                 container_of(td, struct ctf_text_stream_pos, trace_descriptor);
 202         fclose(pos->fp);
 203         g_free(pos);
 204 }
 205
 206 void __attribute__((constructor)) ctf_text_init(void)
 207 {
 208         int ret;
 209
 210         ctf_text_format.name = g_quark_from_static_string("text");
 211         ret = bt_register_format(&ctf_text_format);
 212         assert(!ret);
 213 }
 214
 215 /* TODO: finalize */