*
* CTF Text Format registration.
*
- * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
+ *
+ * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
#include <babeltrace/format.h>
#include <babeltrace/ctf-text/types.h>
#include <babeltrace/ctf/metadata.h>
-#include <babeltrace/babeltrace.h>
+#include <babeltrace/babeltrace-internal.h>
+#include <babeltrace/ctf/events-internal.h>
#include <inttypes.h>
-#include <uuid/uuid.h>
#include <sys/mman.h>
#include <errno.h>
#include <sys/types.h>
#include <unistd.h>
#include <stdlib.h>
-struct trace_descriptor *ctf_text_open_trace(const char *path, int flags);
-void ctf_text_close_trace(struct trace_descriptor *descriptor);
+#define NSEC_PER_SEC 1000000000ULL
+
+int opt_all_field_names,
+ opt_scope_field_names,
+ opt_header_field_names,
+ opt_context_field_names,
+ opt_payload_field_names,
+ opt_all_fields,
+ opt_trace_field,
+ opt_trace_domain_field,
+ opt_trace_procname_field,
+ opt_trace_vpid_field,
+ opt_trace_hostname_field,
+ opt_trace_default_fields = 1,
+ opt_loglevel_field,
+ opt_emf_field,
+ opt_callsite_field,
+ opt_delta_field = 1;
+
+enum field_item {
+ ITEM_SCOPE,
+ ITEM_HEADER,
+ ITEM_CONTEXT,
+ ITEM_PAYLOAD,
+};
+
+enum bt_loglevel {
+ BT_LOGLEVEL_EMERG = 0,
+ BT_LOGLEVEL_ALERT = 1,
+ BT_LOGLEVEL_CRIT = 2,
+ BT_LOGLEVEL_ERR = 3,
+ BT_LOGLEVEL_WARNING = 4,
+ BT_LOGLEVEL_NOTICE = 5,
+ BT_LOGLEVEL_INFO = 6,
+ BT_LOGLEVEL_DEBUG_SYSTEM = 7,
+ BT_LOGLEVEL_DEBUG_PROGRAM = 8,
+ BT_LOGLEVEL_DEBUG_PROCESS = 9,
+ BT_LOGLEVEL_DEBUG_MODULE = 10,
+ BT_LOGLEVEL_DEBUG_UNIT = 11,
+ BT_LOGLEVEL_DEBUG_FUNCTION = 12,
+ BT_LOGLEVEL_DEBUG_LINE = 13,
+ BT_LOGLEVEL_DEBUG = 14,
+};
+
+static
+struct bt_trace_descriptor *ctf_text_open_trace(const char *path, int flags,
+ void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
+ int whence), FILE *metadata_fp);
+static
+int ctf_text_close_trace(struct bt_trace_descriptor *descriptor);
static
rw_dispatch write_dispatch_table[] = {
};
static
-struct format ctf_text_format = {
+struct bt_format ctf_text_format = {
.open_trace = ctf_text_open_trace,
.close_trace = ctf_text_close_trace,
};
+static GQuark Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN,
+ Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END,
+ Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED,
+ Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE,
+ Q_STREAM_PACKET_CONTEXT_PACKET_SIZE;
+
static
-int ctf_text_write_event(struct stream_pos *ppos,
- struct ctf_stream *stream)
+void __attribute__((constructor)) init_quarks(void)
{
- struct ctf_text_stream_pos *pos =
- container_of(ppos, struct ctf_text_stream_pos, parent);
- struct ctf_stream_class *stream_class = stream->stream_class;
- int field_nr_saved;
- struct ctf_event *event_class;
- struct ctf_file_event *event;
- uint64_t id = 0;
- int ret;
+ Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN = g_quark_from_static_string("stream.packet.context.timestamp_begin");
+ Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END = g_quark_from_static_string("stream.packet.context.timestamp_end");
+ Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED = g_quark_from_static_string("stream.packet.context.events_discarded");
+ Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE = g_quark_from_static_string("stream.packet.context.content_size");
+ Q_STREAM_PACKET_CONTEXT_PACKET_SIZE = g_quark_from_static_string("stream.packet.context.packet_size");
+}
- /* print event header */
- if (stream->stream_event_header) {
- struct definition_integer *integer_definition;
- struct definition *variant;
+static
+struct ctf_callsite_dups *ctf_trace_callsite_lookup(struct ctf_trace *trace,
+ GQuark callsite_name)
+{
+ return g_hash_table_lookup(trace->callsites,
+ (gpointer) (unsigned long) callsite_name);
+}
- /* lookup event id */
- integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE);
- if (integer_definition) {
- id = integer_definition->value._unsigned;
- } else {
- struct definition_enum *enum_definition;
+int print_field(struct bt_definition *definition)
+{
+ /* Print all fields in verbose mode */
+ if (babeltrace_verbose)
+ return 1;
- enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE);
- if (enum_definition) {
- id = enum_definition->integer->value._unsigned;
- }
- }
+ /* Filter out part of the packet context */
+ if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_BEGIN)
+ return 0;
+ if (definition->path == Q_STREAM_PACKET_CONTEXT_TIMESTAMP_END)
+ return 0;
+ if (definition->path == Q_STREAM_PACKET_CONTEXT_EVENTS_DISCARDED)
+ return 0;
+ if (definition->path == Q_STREAM_PACKET_CONTEXT_CONTENT_SIZE)
+ return 0;
+ if (definition->path == Q_STREAM_PACKET_CONTEXT_PACKET_SIZE)
+ return 0;
- variant = lookup_variant(&stream->stream_event_header->p, "v");
- if (variant) {
- integer_definition = lookup_integer(variant, "id", FALSE);
- if (integer_definition) {
- id = integer_definition->value._unsigned;
- }
- }
+ return 1;
+}
+
+static
+void set_field_names_print(struct ctf_text_stream_pos *pos, enum field_item item)
+{
+ switch (item) {
+ case ITEM_SCOPE:
+ if (opt_all_field_names || opt_scope_field_names)
+ pos->print_names = 1;
+ else
+ pos->print_names = 0;
+ break;
+ case ITEM_HEADER:
+ if (opt_all_field_names || opt_header_field_names)
+ pos->print_names = 1;
+ else
+ pos->print_names = 0;
+ break;
+ case ITEM_CONTEXT:
+ if (opt_all_field_names || opt_context_field_names)
+ pos->print_names = 1;
+ else
+ pos->print_names = 0;
+ break;
+ case ITEM_PAYLOAD:
+ if (opt_all_field_names || opt_payload_field_names)
+ pos->print_names = 1;
+ else
+ pos->print_names = 0;
+
+ break;
+ default:
+ assert(0);
+ }
+}
+
+static
+const char *print_loglevel(int value)
+{
+ switch (value) {
+ case -1:
+ return "";
+ case BT_LOGLEVEL_EMERG:
+ return "TRACE_EMERG";
+ case BT_LOGLEVEL_ALERT:
+ return "TRACE_ALERT";
+ case BT_LOGLEVEL_CRIT:
+ return "TRACE_CRIT";
+ case BT_LOGLEVEL_ERR:
+ return "TRACE_ERR";
+ case BT_LOGLEVEL_WARNING:
+ return "TRACE_WARNING";
+ case BT_LOGLEVEL_NOTICE:
+ return "TRACE_NOTICE";
+ case BT_LOGLEVEL_INFO:
+ return "TRACE_INFO";
+ case BT_LOGLEVEL_DEBUG_SYSTEM:
+ return "TRACE_DEBUG_SYSTEM";
+ case BT_LOGLEVEL_DEBUG_PROGRAM:
+ return "TRACE_DEBUG_PROGRAM";
+ case BT_LOGLEVEL_DEBUG_PROCESS:
+ return "TRACE_DEBUG_PROCESS";
+ case BT_LOGLEVEL_DEBUG_MODULE:
+ return "TRACE_DEBUG_MODULE";
+ case BT_LOGLEVEL_DEBUG_UNIT:
+ return "TRACE_DEBUG_UNIT";
+ case BT_LOGLEVEL_DEBUG_FUNCTION:
+ return "TRACE_DEBUG_FUNCTION";
+ case BT_LOGLEVEL_DEBUG_LINE:
+ return "TRACE_DEBUG_LINE";
+ case BT_LOGLEVEL_DEBUG:
+ return "TRACE_DEBUG";
+ default:
+ return "<<UNKNOWN>>";
}
+}
+
+static
+int ctf_text_write_event(struct bt_stream_pos *ppos, struct ctf_stream_definition *stream)
+
+{
+ struct ctf_text_stream_pos *pos =
+ container_of(ppos, struct ctf_text_stream_pos, parent);
+ struct ctf_stream_declaration *stream_class = stream->stream_class;
+ int field_nr_saved;
+ struct ctf_event_declaration *event_class;
+ struct ctf_event_definition *event;
+ uint64_t id;
+ int ret;
+ int dom_print = 0;
+
+ id = stream->event_id;
if (id >= stream_class->events_by_id->len) {
- fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id);
+ fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
return -EINVAL;
}
event = g_ptr_array_index(stream->events_by_id, id);
if (!event) {
- fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id);
+ fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
return -EINVAL;
}
event_class = g_ptr_array_index(stream_class->events_by_id, id);
- if (!event) {
- fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id);
+ if (!event_class) {
+ fprintf(stderr, "[error] Event class id %" PRIu64 " is unknown.\n", id);
return -EINVAL;
}
- if (stream->timestamp) {
+ if (stream->has_timestamp) {
+ set_field_names_print(pos, ITEM_HEADER);
if (pos->print_names)
fprintf(pos->fp, "timestamp = ");
else
fprintf(pos->fp, "[");
- fprintf(pos->fp, "%12" PRIu64, stream->timestamp);
+ if (opt_clock_cycles) {
+ ctf_print_timestamp(pos->fp, stream, stream->cycles_timestamp);
+ } else {
+ ctf_print_timestamp(pos->fp, stream, stream->real_timestamp);
+ }
if (!pos->print_names)
fprintf(pos->fp, "]");
else
fprintf(pos->fp, " ");
}
+ if (opt_delta_field && stream->has_timestamp) {
+ uint64_t delta, delta_sec, delta_nsec;
+
+ set_field_names_print(pos, ITEM_HEADER);
+ if (pos->print_names)
+ fprintf(pos->fp, "delta = ");
+ else
+ fprintf(pos->fp, "(");
+ if (pos->last_real_timestamp != -1ULL) {
+ delta = stream->real_timestamp - pos->last_real_timestamp;
+ delta_sec = delta / NSEC_PER_SEC;
+ delta_nsec = delta % NSEC_PER_SEC;
+ fprintf(pos->fp, "+%" PRIu64 ".%09" PRIu64,
+ delta_sec, delta_nsec);
+ } else {
+ fprintf(pos->fp, "+?.?????????");
+ }
+ if (!pos->print_names)
+ fprintf(pos->fp, ")");
+
+ if (pos->print_names)
+ fprintf(pos->fp, ", ");
+ else
+ fprintf(pos->fp, " ");
+ pos->last_real_timestamp = stream->real_timestamp;
+ pos->last_cycles_timestamp = stream->cycles_timestamp;
+ }
+
+ if ((opt_trace_field || opt_all_fields) && stream_class->trace->parent.path[0] != '\0') {
+ set_field_names_print(pos, ITEM_HEADER);
+ if (pos->print_names) {
+ fprintf(pos->fp, "trace = ");
+ }
+ fprintf(pos->fp, "%s", stream_class->trace->parent.path);
+ if (pos->print_names)
+ fprintf(pos->fp, ", ");
+ else
+ fprintf(pos->fp, " ");
+ }
+ if ((opt_trace_hostname_field || opt_all_fields || opt_trace_default_fields)
+ && stream_class->trace->env.hostname[0] != '\0') {
+ set_field_names_print(pos, ITEM_HEADER);
+ if (pos->print_names) {
+ fprintf(pos->fp, "trace:hostname = ");
+ }
+ fprintf(pos->fp, "%s", stream_class->trace->env.hostname);
+ if (pos->print_names)
+ fprintf(pos->fp, ", ");
+ dom_print = 1;
+ }
+ if ((opt_trace_domain_field || opt_all_fields) && stream_class->trace->env.domain[0] != '\0') {
+ set_field_names_print(pos, ITEM_HEADER);
+ if (pos->print_names) {
+ fprintf(pos->fp, "trace:domain = ");
+ }
+ fprintf(pos->fp, "%s", stream_class->trace->env.domain);
+ if (pos->print_names)
+ fprintf(pos->fp, ", ");
+ dom_print = 1;
+ }
+ if ((opt_trace_procname_field || opt_all_fields || opt_trace_default_fields)
+ && stream_class->trace->env.procname[0] != '\0') {
+ set_field_names_print(pos, ITEM_HEADER);
+ if (pos->print_names) {
+ fprintf(pos->fp, "trace:procname = ");
+ } else if (dom_print) {
+ fprintf(pos->fp, ":");
+ }
+ fprintf(pos->fp, "%s", stream_class->trace->env.procname);
+ if (pos->print_names)
+ fprintf(pos->fp, ", ");
+ dom_print = 1;
+ }
+ if ((opt_trace_vpid_field || opt_all_fields || opt_trace_default_fields)
+ && stream_class->trace->env.vpid != -1) {
+ set_field_names_print(pos, ITEM_HEADER);
+ if (pos->print_names) {
+ fprintf(pos->fp, "trace:vpid = ");
+ } else if (dom_print) {
+ fprintf(pos->fp, ":");
+ }
+ fprintf(pos->fp, "%d", stream_class->trace->env.vpid);
+ if (pos->print_names)
+ fprintf(pos->fp, ", ");
+ dom_print = 1;
+ }
+ if ((opt_loglevel_field || opt_all_fields) && event_class->loglevel != -1) {
+ set_field_names_print(pos, ITEM_HEADER);
+ if (pos->print_names) {
+ fprintf(pos->fp, "loglevel = ");
+ } else if (dom_print) {
+ fprintf(pos->fp, ":");
+ }
+ fprintf(pos->fp, "%s (%d)",
+ print_loglevel(event_class->loglevel),
+ event_class->loglevel);
+ if (pos->print_names)
+ fprintf(pos->fp, ", ");
+ dom_print = 1;
+ }
+ if ((opt_emf_field || opt_all_fields) && event_class->model_emf_uri) {
+ set_field_names_print(pos, ITEM_HEADER);
+ if (pos->print_names) {
+ fprintf(pos->fp, "model.emf.uri = ");
+ } else if (dom_print) {
+ fprintf(pos->fp, ":");
+ }
+ fprintf(pos->fp, "\"%s\"",
+ g_quark_to_string(event_class->model_emf_uri));
+ if (pos->print_names)
+ fprintf(pos->fp, ", ");
+ dom_print = 1;
+ }
+ if ((opt_callsite_field || opt_all_fields)) {
+ struct ctf_callsite_dups *cs_dups;
+ struct ctf_callsite *callsite;
+
+ cs_dups = ctf_trace_callsite_lookup(stream_class->trace,
+ event_class->name);
+ if (cs_dups) {
+ int i = 0;
+
+ set_field_names_print(pos, ITEM_HEADER);
+ if (pos->print_names) {
+ fprintf(pos->fp, "callsite = ");
+ } else if (dom_print) {
+ fprintf(pos->fp, ":");
+ }
+ fprintf(pos->fp, "[");
+ bt_list_for_each_entry(callsite, &cs_dups->head, node) {
+ if (i != 0)
+ fprintf(pos->fp, ",");
+ if (CTF_CALLSITE_FIELD_IS_SET(callsite, ip)) {
+ fprintf(pos->fp, "%s@0x%" PRIx64 ":%s:%" PRIu64 "",
+ callsite->func, callsite->ip, callsite->file,
+ callsite->line);
+ } else {
+ fprintf(pos->fp, "%s:%s:%" PRIu64 "",
+ callsite->func, callsite->file,
+ callsite->line);
+ }
+ i++;
+ }
+ fprintf(pos->fp, "]");
+ if (pos->print_names)
+ fprintf(pos->fp, ", ");
+ dom_print = 1;
+ }
+ }
+ if (dom_print && !pos->print_names)
+ fprintf(pos->fp, " ");
+ set_field_names_print(pos, ITEM_HEADER);
if (pos->print_names)
fprintf(pos->fp, "name = ");
fprintf(pos->fp, "%s", g_quark_to_string(event_class->name));
if (stream->stream_packet_context) {
if (pos->field_nr++ != 0)
fprintf(pos->fp, ",");
+ set_field_names_print(pos, ITEM_SCOPE);
if (pos->print_names)
fprintf(pos->fp, " stream.packet.context =");
field_nr_saved = pos->field_nr;
pos->field_nr = 0;
+ set_field_names_print(pos, ITEM_CONTEXT);
ret = generic_rw(ppos, &stream->stream_packet_context->p);
if (ret)
goto error;
if (babeltrace_verbose && stream->stream_event_header) {
if (pos->field_nr++ != 0)
fprintf(pos->fp, ",");
+ set_field_names_print(pos, ITEM_SCOPE);
if (pos->print_names)
fprintf(pos->fp, " stream.event.header =");
field_nr_saved = pos->field_nr;
pos->field_nr = 0;
+ set_field_names_print(pos, ITEM_CONTEXT);
ret = generic_rw(ppos, &stream->stream_event_header->p);
if (ret)
goto error;
if (stream->stream_event_context) {
if (pos->field_nr++ != 0)
fprintf(pos->fp, ",");
+ set_field_names_print(pos, ITEM_SCOPE);
if (pos->print_names)
fprintf(pos->fp, " stream.event.context =");
field_nr_saved = pos->field_nr;
pos->field_nr = 0;
+ set_field_names_print(pos, ITEM_CONTEXT);
ret = generic_rw(ppos, &stream->stream_event_context->p);
if (ret)
goto error;
if (event->event_context) {
if (pos->field_nr++ != 0)
fprintf(pos->fp, ",");
+ set_field_names_print(pos, ITEM_SCOPE);
if (pos->print_names)
fprintf(pos->fp, " event.context =");
field_nr_saved = pos->field_nr;
pos->field_nr = 0;
+ set_field_names_print(pos, ITEM_CONTEXT);
ret = generic_rw(ppos, &event->event_context->p);
if (ret)
goto error;
if (event->event_fields) {
if (pos->field_nr++ != 0)
fprintf(pos->fp, ",");
+ set_field_names_print(pos, ITEM_SCOPE);
if (pos->print_names)
fprintf(pos->fp, " event.fields =");
field_nr_saved = pos->field_nr;
pos->field_nr = 0;
+ set_field_names_print(pos, ITEM_PAYLOAD);
ret = generic_rw(ppos, &event->event_fields->p);
if (ret)
goto error;
return 0;
error:
- fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
+ fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
return ret;
}
-
-struct trace_descriptor *ctf_text_open_trace(const char *path, int flags)
+static
+struct bt_trace_descriptor *ctf_text_open_trace(const char *path, int flags,
+ void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
+ int whence), FILE *metadata_fp)
{
struct ctf_text_stream_pos *pos;
FILE *fp;
pos = g_new0(struct ctf_text_stream_pos, 1);
+ pos->last_real_timestamp = -1ULL;
+ pos->last_cycles_timestamp = -1ULL;
switch (flags & O_ACCMODE) {
case O_RDWR:
if (!path)
pos->fp = fp;
pos->parent.rw_table = write_dispatch_table;
pos->parent.event_cb = ctf_text_write_event;
- pos->print_names = opt_field_names;
+ pos->parent.trace = &pos->trace_descriptor;
+ pos->print_names = 0;
+ babeltrace_ctf_console_output++;
break;
case O_RDONLY:
default:
- fprintf(stdout, "[error] Incorrect open flags.\n");
+ fprintf(stderr, "[error] Incorrect open flags.\n");
goto error;
}
return NULL;
}
-void ctf_text_close_trace(struct trace_descriptor *td)
+static
+int ctf_text_close_trace(struct bt_trace_descriptor *td)
{
+ int ret;
struct ctf_text_stream_pos *pos =
container_of(td, struct ctf_text_stream_pos, trace_descriptor);
- fclose(pos->fp);
+
+ babeltrace_ctf_console_output--;
+ if (pos->fp != stdout) {
+ ret = fclose(pos->fp);
+ if (ret) {
+ perror("Error on fclose");
+ return -1;
+ }
+ }
g_free(pos);
+ return 0;
}
+static
void __attribute__((constructor)) ctf_text_init(void)
{
int ret;
assert(!ret);
}
-/* TODO: finalize */
+static
+void __attribute__((destructor)) ctf_text_exit(void)
+{
+ bt_unregister_format(&ctf_text_format);
+}
projects / babeltrace.git / blobdiff