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
;
64 struct ctf_event
*event_class
;
65 struct ctf_file_event
*event
;
69 /* print event header */
70 if (stream
->stream_event_header
) {
71 struct definition_integer
*integer_definition
;
72 struct definition
*variant
;
75 integer_definition
= lookup_integer(&stream
->stream_event_header
->p
, "id", FALSE
);
76 if (integer_definition
) {
77 id
= integer_definition
->value
._unsigned
;
79 struct definition_enum
*enum_definition
;
81 enum_definition
= lookup_enum(&stream
->stream_event_header
->p
, "id", FALSE
);
82 if (enum_definition
) {
83 id
= enum_definition
->integer
->value
._unsigned
;
87 variant
= lookup_variant(&stream
->stream_event_header
->p
, "v");
89 integer_definition
= lookup_integer(variant
, "id", FALSE
);
90 if (integer_definition
) {
91 id
= integer_definition
->value
._unsigned
;
96 if (id
>= stream_class
->events_by_id
->len
) {
97 fprintf(stdout
, "[error] Event id %" PRIu64
" is outside range.\n", id
);
100 event
= g_ptr_array_index(stream
->events_by_id
, id
);
102 fprintf(stdout
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
105 event_class
= g_ptr_array_index(stream_class
->events_by_id
, id
);
107 fprintf(stdout
, "[error] Event id %" PRIu64
" is unknown.\n", id
);
111 if (stream
->timestamp
) {
112 if (pos
->print_names
)
113 fprintf(pos
->fp
, "timestamp = ");
115 fprintf(pos
->fp
, "[");
116 fprintf(pos
->fp
, "%12" PRIu64
, stream
->timestamp
);
117 if (!pos
->print_names
)
118 fprintf(pos
->fp
, "]");
120 if (pos
->print_names
)
121 fprintf(pos
->fp
, ", ");
123 fprintf(pos
->fp
, " ");
125 if (pos
->print_names
)
126 fprintf(pos
->fp
, "name = ");
127 fprintf(pos
->fp
, "%s", g_quark_to_string(event_class
->name
));
128 if (pos
->print_names
)
131 fprintf(pos
->fp
, ":");
133 /* print cpuid field from packet context */
134 if (stream
->stream_packet_context
) {
135 if (pos
->field_nr
++ != 0)
136 fprintf(pos
->fp
, ",");
137 if (pos
->print_names
)
138 fprintf(pos
->fp
, " stream.packet.context =");
139 field_nr_saved
= pos
->field_nr
;
141 ret
= generic_rw(ppos
, &stream
->stream_packet_context
->p
);
144 pos
->field_nr
= field_nr_saved
;
147 /* Only show the event header in verbose mode */
148 if (babeltrace_verbose
&& stream
->stream_event_header
) {
149 if (pos
->field_nr
++ != 0)
150 fprintf(pos
->fp
, ",");
151 if (pos
->print_names
)
152 fprintf(pos
->fp
, " stream.event.header =");
153 field_nr_saved
= pos
->field_nr
;
155 ret
= generic_rw(ppos
, &stream
->stream_event_header
->p
);
158 pos
->field_nr
= field_nr_saved
;
161 /* print stream-declared event context */
162 if (stream
->stream_event_context
) {
163 if (pos
->field_nr
++ != 0)
164 fprintf(pos
->fp
, ",");
165 if (pos
->print_names
)
166 fprintf(pos
->fp
, " stream.event.context =");
167 field_nr_saved
= pos
->field_nr
;
169 ret
= generic_rw(ppos
, &stream
->stream_event_context
->p
);
172 pos
->field_nr
= field_nr_saved
;
175 /* print event-declared event context */
176 if (event
->event_context
) {
177 if (pos
->field_nr
++ != 0)
178 fprintf(pos
->fp
, ",");
179 if (pos
->print_names
)
180 fprintf(pos
->fp
, " event.context =");
181 field_nr_saved
= pos
->field_nr
;
183 ret
= generic_rw(ppos
, &event
->event_context
->p
);
186 pos
->field_nr
= field_nr_saved
;
189 /* Read and print event payload */
190 if (event
->event_fields
) {
191 if (pos
->field_nr
++ != 0)
192 fprintf(pos
->fp
, ",");
193 if (pos
->print_names
)
194 fprintf(pos
->fp
, " event.fields =");
195 field_nr_saved
= pos
->field_nr
;
197 ret
= generic_rw(ppos
, &event
->event_fields
->p
);
200 pos
->field_nr
= field_nr_saved
;
203 fprintf(pos
->fp
, "\n");
209 fprintf(stdout
, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
214 struct trace_descriptor
*ctf_text_open_trace(const char *path
, int flags
)
216 struct ctf_text_stream_pos
*pos
;
219 pos
= g_new0(struct ctf_text_stream_pos
, 1);
221 switch (flags
& O_ACCMODE
) {
226 fp
= fopen(path
, "w");
230 pos
->parent
.rw_table
= write_dispatch_table
;
231 pos
->parent
.event_cb
= ctf_text_write_event
;
232 pos
->print_names
= opt_field_names
;
236 fprintf(stdout
, "[error] Incorrect open flags.\n");
240 return &pos
->trace_descriptor
;
246 void ctf_text_close_trace(struct trace_descriptor
*td
)
248 struct ctf_text_stream_pos
*pos
=
249 container_of(td
, struct ctf_text_stream_pos
, trace_descriptor
);
254 void __attribute__((constructor
)) ctf_text_init(void)
258 ctf_text_format
.name
= g_quark_from_static_string("text");
259 ret
= bt_register_format(&ctf_text_format
);