| 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 (pos->print_names) |
| 96 | fprintf(pos->fp, "timestamp = "); |
| 97 | else |
| 98 | fprintf(pos->fp, "["); |
| 99 | fprintf(pos->fp, "%" PRIu64, (uint64_t) 0); /* TODO */ |
| 100 | if (!pos->print_names) |
| 101 | fprintf(pos->fp, "]"); |
| 102 | |
| 103 | if (pos->print_names) |
| 104 | fprintf(pos->fp, ", "); |
| 105 | else |
| 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 | if (pos->print_names) |
| 111 | field_nr++; |
| 112 | else |
| 113 | fprintf(pos->fp, ": "); |
| 114 | |
| 115 | if (stream_class->event_header) { |
| 116 | if (field_nr++ != 0) |
| 117 | fprintf(pos->fp, ", "); |
| 118 | if (pos->print_names) |
| 119 | fprintf(pos->fp, "stream.event.header = "); |
| 120 | ret = generic_rw(ppos, &stream_class->event_header->p); |
| 121 | if (ret) |
| 122 | goto error; |
| 123 | } |
| 124 | |
| 125 | /* print stream-declared event context */ |
| 126 | if (stream_class->event_context) { |
| 127 | if (field_nr++ != 0) |
| 128 | fprintf(pos->fp, ", "); |
| 129 | if (pos->print_names) |
| 130 | fprintf(pos->fp, "stream.event.context = "); |
| 131 | ret = generic_rw(ppos, &stream_class->event_context->p); |
| 132 | if (ret) |
| 133 | goto error; |
| 134 | } |
| 135 | |
| 136 | /* print event-declared event context */ |
| 137 | if (event_class->context) { |
| 138 | if (field_nr++ != 0) |
| 139 | fprintf(pos->fp, ", "); |
| 140 | if (pos->print_names) |
| 141 | fprintf(pos->fp, "event.context = "); |
| 142 | ret = generic_rw(ppos, &event_class->context->p); |
| 143 | if (ret) |
| 144 | goto error; |
| 145 | } |
| 146 | |
| 147 | /* Read and print event payload */ |
| 148 | if (event_class->fields) { |
| 149 | if (field_nr++ != 0) |
| 150 | fprintf(pos->fp, ", "); |
| 151 | if (pos->print_names) |
| 152 | fprintf(pos->fp, "event.fields = "); |
| 153 | ret = generic_rw(ppos, &event_class->fields->p); |
| 154 | if (ret) |
| 155 | goto error; |
| 156 | } |
| 157 | fprintf(pos->fp, "\n"); |
| 158 | |
| 159 | return 0; |
| 160 | |
| 161 | error: |
| 162 | fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n"); |
| 163 | return ret; |
| 164 | } |
| 165 | |
| 166 | |
| 167 | struct trace_descriptor *ctf_text_open_trace(const char *path, int flags) |
| 168 | { |
| 169 | struct ctf_text_stream_pos *pos; |
| 170 | FILE *fp; |
| 171 | |
| 172 | pos = g_new0(struct ctf_text_stream_pos, 1); |
| 173 | |
| 174 | switch (flags & O_ACCMODE) { |
| 175 | case O_RDWR: |
| 176 | if (!path) |
| 177 | fp = stdout; |
| 178 | else |
| 179 | fp = fopen(path, "w"); |
| 180 | if (!fp) |
| 181 | goto error; |
| 182 | pos->fp = fp; |
| 183 | pos->parent.rw_table = write_dispatch_table; |
| 184 | pos->parent.event_cb = ctf_text_write_event; |
| 185 | pos->print_names = opt_field_names; |
| 186 | break; |
| 187 | case O_RDONLY: |
| 188 | default: |
| 189 | fprintf(stdout, "[error] Incorrect open flags.\n"); |
| 190 | goto error; |
| 191 | } |
| 192 | |
| 193 | return &pos->trace_descriptor; |
| 194 | error: |
| 195 | g_free(pos); |
| 196 | return NULL; |
| 197 | } |
| 198 | |
| 199 | void ctf_text_close_trace(struct trace_descriptor *td) |
| 200 | { |
| 201 | struct ctf_text_stream_pos *pos = |
| 202 | container_of(td, struct ctf_text_stream_pos, trace_descriptor); |
| 203 | fclose(pos->fp); |
| 204 | g_free(pos); |
| 205 | } |
| 206 | |
| 207 | void __attribute__((constructor)) ctf_text_init(void) |
| 208 | { |
| 209 | int ret; |
| 210 | |
| 211 | ctf_text_format.name = g_quark_from_static_string("text"); |
| 212 | ret = bt_register_format(&ctf_text_format); |
| 213 | assert(!ret); |
| 214 | } |
| 215 | |
| 216 | /* TODO: finalize */ |