2 * BabelTrace - Common Trace Format (CTF)
4 * CTF Text Format registration.
6 * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
19 #include <babeltrace/format.h>
20 #include <babeltrace/ctf-text/types.h>
21 #include <babeltrace/ctf/metadata.h>
22 #include <babeltrace/babeltrace.h>
24 #include <uuid/uuid.h>
27 #include <sys/types.h>
35 struct trace_descriptor
*ctf_text_open_trace(const char *path
, int flags
);
36 void ctf_text_close_trace(struct trace_descriptor
*descriptor
);
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
,
51 struct format ctf_text_format
= {
52 .open_trace
= ctf_text_open_trace
,
53 .close_trace
= ctf_text_close_trace
,
57 int ctf_text_write_event(struct stream_pos
*ppos
,
58 struct ctf_stream
*stream
)
60 struct ctf_text_stream_pos
*pos
=
61 container_of(ppos
, struct ctf_text_stream_pos
, parent
);
62 struct ctf_stream_class
*stream_class
= stream
->stream_class
;
63 struct ctf_event
*event_class
;
69 /* print event header */
70 if (stream_class
->event_header
) {
72 len_index
= struct_declaration_lookup_field_index(stream_class
->event_header_decl
,
73 g_quark_from_static_string("id"));
75 struct definition_integer
*defint
;
76 struct definition
*field
;
78 field
= struct_definition_get_field_from_index(stream_class
->event_header
, len_index
);
79 assert(field
->declaration
->id
== CTF_TYPE_INTEGER
);
80 defint
= container_of(field
, struct definition_integer
, p
);
81 assert(defint
->declaration
->signedness
== FALSE
);
82 id
= defint
->value
._unsigned
; /* set id */
86 if (id
>= stream_class
->events_by_id
->len
) {
87 fprintf(stdout
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
90 event_class
= g_ptr_array_index(stream_class
->events_by_id
, id
);
92 fprintf(stdout
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
97 fprintf(pos
->fp
, "timestamp = ");
99 fprintf(pos
->fp
, "[");
100 fprintf(pos
->fp
, "%12" PRIu64
, stream
->timestamp
);
101 if (!pos
->print_names
)
102 fprintf(pos
->fp
, "]");
104 if (pos
->print_names
)
105 fprintf(pos
->fp
, ", ");
107 fprintf(pos
->fp
, " ");
108 if (pos
->print_names
)
109 fprintf(pos
->fp
, "name = ");
110 fprintf(pos
->fp
, "%s", g_quark_to_string(event_class
->name
));
111 if (pos
->print_names
)
114 fprintf(pos
->fp
, ": ");
116 /* Only show the event header in verbose mode */
117 if (babeltrace_verbose
&& stream_class
->event_header
) {
119 fprintf(pos
->fp
, ", ");
120 if (pos
->print_names
)
121 fprintf(pos
->fp
, "stream.event.header = ");
122 ret
= generic_rw(ppos
, &stream_class
->event_header
->p
);
127 /* print stream-declared event context */
128 if (stream_class
->event_context
) {
130 fprintf(pos
->fp
, ", ");
131 if (pos
->print_names
)
132 fprintf(pos
->fp
, "stream.event.context = ");
133 ret
= generic_rw(ppos
, &stream_class
->event_context
->p
);
138 /* print event-declared event context */
139 if (event_class
->context
) {
141 fprintf(pos
->fp
, ", ");
142 if (pos
->print_names
)
143 fprintf(pos
->fp
, "event.context = ");
144 ret
= generic_rw(ppos
, &event_class
->context
->p
);
149 /* Read and print event payload */
150 if (event_class
->fields
) {
152 fprintf(pos
->fp
, ", ");
153 if (pos
->print_names
)
154 fprintf(pos
->fp
, "event.fields = ");
155 ret
= generic_rw(ppos
, &event_class
->fields
->p
);
159 fprintf(pos
->fp
, "\n");
164 fprintf(stdout
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
169 struct trace_descriptor
*ctf_text_open_trace(const char *path
, int flags
)
171 struct ctf_text_stream_pos
*pos
;
174 pos
= g_new0(struct ctf_text_stream_pos
, 1);
176 switch (flags
& O_ACCMODE
) {
181 fp
= fopen(path
, "w");
185 pos
->parent
.rw_table
= write_dispatch_table
;
186 pos
->parent
.event_cb
= ctf_text_write_event
;
187 pos
->print_names
= opt_field_names
;
191 fprintf(stdout
, "[error] Incorrect open flags.\n");
195 return &pos
->trace_descriptor
;
201 void ctf_text_close_trace(struct trace_descriptor
*td
)
203 struct ctf_text_stream_pos
*pos
=
204 container_of(td
, struct ctf_text_stream_pos
, trace_descriptor
);
209 void __attribute__((constructor
)) ctf_text_init(void)
213 ctf_text_format
.name
= g_quark_from_static_string("text");
214 ret
= bt_register_format(&ctf_text_format
);