Commit | Line | Data |
---|---|---|
d8866baa PP |
1 | /* |
2 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation | |
d94d92ac | 3 | * Copyright 2017 Philippe Proulx <pproulx@efficios.com> |
d8866baa PP |
4 | * |
5 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
6 | * of this software and associated documentation files (the "Software"), to deal | |
7 | * in the Software without restriction, including without limitation the rights | |
8 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
9 | * copies of the Software, and to permit persons to whom the Software is | |
10 | * furnished to do so, subject to the following conditions: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
18 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
33ec5dfa PP |
24 | #define BT_LOG_TAG "PLUGIN-TEXT-DMESG-SRC" |
25 | #include "logging.h" | |
26 | ||
d8866baa | 27 | #include <stdbool.h> |
33ec5dfa PP |
28 | #include <string.h> |
29 | #include <ctype.h> | |
d8866baa | 30 | #include <stdio.h> |
f6ccaed9 | 31 | #include <babeltrace/assert-internal.h> |
da91b29a | 32 | #include <babeltrace/common-internal.h> |
33ec5dfa | 33 | #include <babeltrace/babeltrace.h> |
c6bd8523 | 34 | #include <babeltrace/value-internal.h> |
33ec5dfa PP |
35 | #include <babeltrace/compat/utc-internal.h> |
36 | #include <babeltrace/compat/stdio-internal.h> | |
d8866baa PP |
37 | #include <glib.h> |
38 | ||
33ec5dfa PP |
39 | #define NSEC_PER_USEC 1000UL |
40 | #define NSEC_PER_MSEC 1000000UL | |
41 | #define NSEC_PER_SEC 1000000000ULL | |
42 | #define USEC_PER_SEC 1000000UL | |
43 | ||
d8866baa PP |
44 | struct dmesg_component; |
45 | ||
d6e69534 | 46 | struct dmesg_msg_iter { |
d8866baa | 47 | struct dmesg_component *dmesg_comp; |
d6e69534 | 48 | bt_self_message_iterator *pc_msg_iter; /* Weak */ |
33ec5dfa PP |
49 | char *linebuf; |
50 | size_t linebuf_len; | |
d8866baa | 51 | FILE *fp; |
d6e69534 | 52 | bt_message *tmp_event_msg; |
a6d85d2f | 53 | uint64_t last_clock_value; |
312c056a PP |
54 | |
55 | enum { | |
56 | STATE_EMIT_STREAM_BEGINNING, | |
a59806b7 | 57 | STATE_EMIT_STREAM_ACTIVITY_BEGINNING, |
312c056a PP |
58 | STATE_EMIT_PACKET_BEGINNING, |
59 | STATE_EMIT_EVENT, | |
60 | STATE_EMIT_PACKET_END, | |
a59806b7 | 61 | STATE_EMIT_STREAM_ACTIVITY_END, |
312c056a PP |
62 | STATE_EMIT_STREAM_END, |
63 | STATE_DONE, | |
64 | } state; | |
d8866baa PP |
65 | }; |
66 | ||
67 | struct dmesg_component { | |
68 | struct { | |
69 | GString *path; | |
33ec5dfa | 70 | bt_bool read_from_stdin; |
707b323a | 71 | bt_bool no_timestamp; |
d8866baa PP |
72 | } params; |
73 | ||
41693723 | 74 | bt_self_component_source *self_comp; |
b19ff26f PP |
75 | bt_trace_class *trace_class; |
76 | bt_stream_class *stream_class; | |
77 | bt_event_class *event_class; | |
78 | bt_trace *trace; | |
79 | bt_stream *stream; | |
80 | bt_packet *packet; | |
81 | bt_clock_class *clock_class; | |
d8866baa PP |
82 | }; |
83 | ||
33ec5dfa | 84 | static |
1122a43a | 85 | bt_field_class *create_event_payload_fc(bt_trace_class *trace_class) |
33ec5dfa | 86 | { |
b19ff26f PP |
87 | bt_field_class *root_fc = NULL; |
88 | bt_field_class *fc = NULL; | |
33ec5dfa PP |
89 | int ret; |
90 | ||
1122a43a | 91 | root_fc = bt_field_class_structure_create(trace_class); |
5cd6d0e5 PP |
92 | if (!root_fc) { |
93 | BT_LOGE_STR("Cannot create an empty structure field class object."); | |
33ec5dfa PP |
94 | goto error; |
95 | } | |
96 | ||
1122a43a | 97 | fc = bt_field_class_string_create(trace_class); |
5cd6d0e5 PP |
98 | if (!fc) { |
99 | BT_LOGE_STR("Cannot create a string field class object."); | |
33ec5dfa PP |
100 | goto error; |
101 | } | |
102 | ||
40f4ba76 | 103 | ret = bt_field_class_structure_append_member(root_fc, |
e5be10ef | 104 | "str", fc); |
33ec5dfa | 105 | if (ret) { |
5cd6d0e5 | 106 | BT_LOGE("Cannot add `str` member to structure field class: " |
33ec5dfa PP |
107 | "ret=%d", ret); |
108 | goto error; | |
109 | } | |
110 | ||
111 | goto end; | |
112 | ||
113 | error: | |
c5b9b441 | 114 | BT_FIELD_CLASS_PUT_REF_AND_RESET(root_fc); |
33ec5dfa PP |
115 | |
116 | end: | |
c5b9b441 | 117 | bt_field_class_put_ref(fc); |
5cd6d0e5 | 118 | return root_fc; |
33ec5dfa PP |
119 | } |
120 | ||
33ec5dfa PP |
121 | static |
122 | int create_meta(struct dmesg_component *dmesg_comp, bool has_ts) | |
123 | { | |
b19ff26f | 124 | bt_field_class *fc = NULL; |
d8866baa PP |
125 | int ret = 0; |
126 | ||
41693723 PP |
127 | dmesg_comp->trace_class = bt_trace_class_create( |
128 | bt_self_component_source_as_self_component( | |
129 | dmesg_comp->self_comp)); | |
862ca4ed PP |
130 | if (!dmesg_comp->trace_class) { |
131 | BT_LOGE_STR("Cannot create an empty trace class object."); | |
33ec5dfa PP |
132 | goto error; |
133 | } | |
134 | ||
40f4ba76 | 135 | dmesg_comp->stream_class = bt_stream_class_create( |
862ca4ed | 136 | dmesg_comp->trace_class); |
33ec5dfa | 137 | if (!dmesg_comp->stream_class) { |
44c440bc | 138 | BT_LOGE_STR("Cannot create a stream class object."); |
33ec5dfa PP |
139 | goto error; |
140 | } | |
141 | ||
33ec5dfa | 142 | if (has_ts) { |
0f2d58c9 | 143 | dmesg_comp->clock_class = bt_clock_class_create( |
7fcdb0a9 FD |
144 | bt_self_component_source_as_self_component( |
145 | dmesg_comp->self_comp)); | |
33ec5dfa PP |
146 | if (!dmesg_comp->clock_class) { |
147 | BT_LOGE_STR("Cannot create clock class."); | |
148 | goto error; | |
149 | } | |
150 | ||
21029722 | 151 | /* |
5552377a PP |
152 | * The `dmesg` timestamp's origin is not the Unix epoch, |
153 | * it's the boot time. | |
21029722 | 154 | */ |
5552377a | 155 | bt_clock_class_set_origin_is_unix_epoch(dmesg_comp->clock_class, |
21029722 PP |
156 | BT_FALSE); |
157 | ||
40f4ba76 PP |
158 | ret = bt_stream_class_set_default_clock_class( |
159 | dmesg_comp->stream_class, dmesg_comp->clock_class); | |
33ec5dfa | 160 | if (ret) { |
44c440bc | 161 | BT_LOGE_STR("Cannot set stream class's default clock class."); |
33ec5dfa PP |
162 | goto error; |
163 | } | |
164 | } | |
165 | ||
40f4ba76 | 166 | dmesg_comp->event_class = bt_event_class_create( |
44c440bc | 167 | dmesg_comp->stream_class); |
33ec5dfa | 168 | if (!dmesg_comp->event_class) { |
44c440bc PP |
169 | BT_LOGE_STR("Cannot create an event class object."); |
170 | goto error; | |
171 | } | |
172 | ||
40f4ba76 | 173 | ret = bt_event_class_set_name(dmesg_comp->event_class, "string"); |
44c440bc PP |
174 | if (ret) { |
175 | BT_LOGE_STR("Cannot set event class's name."); | |
33ec5dfa PP |
176 | goto error; |
177 | } | |
178 | ||
1122a43a | 179 | fc = create_event_payload_fc(dmesg_comp->trace_class); |
5cd6d0e5 PP |
180 | if (!fc) { |
181 | BT_LOGE_STR("Cannot create event payload field class."); | |
d8866baa PP |
182 | goto error; |
183 | } | |
184 | ||
40f4ba76 | 185 | ret = bt_event_class_set_payload_field_class(dmesg_comp->event_class, fc); |
33ec5dfa | 186 | if (ret) { |
5cd6d0e5 | 187 | BT_LOGE_STR("Cannot set event class's event payload field class."); |
33ec5dfa PP |
188 | goto error; |
189 | } | |
190 | ||
33ec5dfa PP |
191 | goto end; |
192 | ||
193 | error: | |
194 | ret = -1; | |
195 | ||
196 | end: | |
c5b9b441 | 197 | bt_field_class_put_ref(fc); |
33ec5dfa PP |
198 | return ret; |
199 | } | |
200 | ||
201 | static | |
05e21286 | 202 | int handle_params(struct dmesg_component *dmesg_comp, |
b19ff26f | 203 | const bt_value *params) |
33ec5dfa | 204 | { |
b19ff26f PP |
205 | const bt_value *no_timestamp = NULL; |
206 | const bt_value *path = NULL; | |
33ec5dfa PP |
207 | const char *path_str; |
208 | int ret = 0; | |
209 | ||
05e21286 | 210 | no_timestamp = bt_value_map_borrow_entry_value_const(params, |
07208d85 | 211 | "no-extract-timestamp"); |
707b323a PP |
212 | if (no_timestamp) { |
213 | if (!bt_value_is_bool(no_timestamp)) { | |
214 | BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: " | |
215 | "type=%s", | |
da91b29a | 216 | bt_common_value_type_string( |
707b323a PP |
217 | bt_value_get_type(no_timestamp))); |
218 | goto error; | |
219 | } | |
220 | ||
601b0d3c PP |
221 | dmesg_comp->params.no_timestamp = |
222 | bt_value_bool_get(no_timestamp); | |
707b323a PP |
223 | } |
224 | ||
05e21286 | 225 | path = bt_value_map_borrow_entry_value_const(params, "path"); |
d8866baa PP |
226 | if (path) { |
227 | if (dmesg_comp->params.read_from_stdin) { | |
33ec5dfa | 228 | BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters."); |
d8866baa PP |
229 | goto error; |
230 | } | |
231 | ||
232 | if (!bt_value_is_string(path)) { | |
33ec5dfa PP |
233 | BT_LOGE("Expecting a string value for the `path` parameter: " |
234 | "type=%s", | |
da91b29a | 235 | bt_common_value_type_string( |
33ec5dfa | 236 | bt_value_get_type(path))); |
d8866baa PP |
237 | goto error; |
238 | } | |
239 | ||
601b0d3c | 240 | path_str = bt_value_string_get(path); |
d8866baa PP |
241 | g_string_assign(dmesg_comp->params.path, path_str); |
242 | } else { | |
4da23e31 | 243 | dmesg_comp->params.read_from_stdin = true; |
d8866baa PP |
244 | } |
245 | ||
246 | goto end; | |
247 | ||
248 | error: | |
249 | ret = -1; | |
250 | ||
251 | end: | |
d8866baa PP |
252 | return ret; |
253 | } | |
254 | ||
33ec5dfa | 255 | static |
862ca4ed | 256 | int create_packet_and_stream_and_trace(struct dmesg_component *dmesg_comp) |
33ec5dfa PP |
257 | { |
258 | int ret = 0; | |
e54986cf | 259 | const char *trace_name = NULL; |
862ca4ed PP |
260 | gchar *basename = NULL; |
261 | ||
262 | dmesg_comp->trace = bt_trace_create(dmesg_comp->trace_class); | |
263 | if (!dmesg_comp->trace) { | |
264 | BT_LOGE_STR("Cannot create trace object."); | |
265 | goto error; | |
266 | } | |
33ec5dfa | 267 | |
862ca4ed PP |
268 | if (dmesg_comp->params.read_from_stdin) { |
269 | trace_name = "STDIN"; | |
270 | } else { | |
271 | basename = g_path_get_basename(dmesg_comp->params.path->str); | |
272 | BT_ASSERT(basename); | |
273 | ||
274 | if (strcmp(basename, G_DIR_SEPARATOR_S) != 0 && | |
275 | strcmp(basename, ".") != 0) { | |
276 | trace_name = basename; | |
277 | } | |
278 | } | |
279 | ||
280 | if (trace_name) { | |
281 | ret = bt_trace_set_name(dmesg_comp->trace, trace_name); | |
282 | if (ret) { | |
283 | BT_LOGE("Cannot set trace's name: name=\"%s\"", | |
284 | trace_name); | |
285 | goto error; | |
286 | } | |
287 | } | |
288 | ||
289 | dmesg_comp->stream = bt_stream_create(dmesg_comp->stream_class, | |
290 | dmesg_comp->trace); | |
33ec5dfa PP |
291 | if (!dmesg_comp->stream) { |
292 | BT_LOGE_STR("Cannot create stream object."); | |
293 | goto error; | |
294 | } | |
295 | ||
40f4ba76 | 296 | dmesg_comp->packet = bt_packet_create(dmesg_comp->stream); |
33ec5dfa PP |
297 | if (!dmesg_comp->packet) { |
298 | BT_LOGE_STR("Cannot create packet object."); | |
299 | goto error; | |
300 | } | |
301 | ||
40f4ba76 | 302 | ret = bt_trace_make_static(dmesg_comp->trace); |
33ec5dfa PP |
303 | if (ret) { |
304 | BT_LOGE_STR("Cannot make trace static."); | |
305 | goto error; | |
306 | } | |
307 | ||
308 | goto end; | |
309 | ||
310 | error: | |
311 | ret = -1; | |
312 | ||
313 | end: | |
862ca4ed PP |
314 | if (basename) { |
315 | g_free(basename); | |
316 | } | |
317 | ||
33ec5dfa PP |
318 | return ret; |
319 | } | |
320 | ||
321 | static | |
322 | int try_create_meta_stream_packet(struct dmesg_component *dmesg_comp, | |
323 | bool has_ts) | |
324 | { | |
325 | int ret = 0; | |
326 | ||
327 | if (dmesg_comp->trace) { | |
328 | /* Already created */ | |
329 | goto end; | |
330 | } | |
331 | ||
332 | ret = create_meta(dmesg_comp, has_ts); | |
333 | if (ret) { | |
334 | BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p", | |
335 | dmesg_comp); | |
336 | goto error; | |
337 | } | |
338 | ||
862ca4ed | 339 | ret = create_packet_and_stream_and_trace(dmesg_comp); |
33ec5dfa PP |
340 | if (ret) { |
341 | BT_LOGE("Cannot create packet and stream objects: " | |
342 | "dmesg-comp-addr=%p", dmesg_comp); | |
343 | goto error; | |
344 | } | |
345 | ||
346 | goto end; | |
347 | ||
348 | error: | |
349 | ret = -1; | |
350 | ||
351 | end: | |
352 | return ret; | |
353 | } | |
d8866baa PP |
354 | |
355 | static | |
356 | void destroy_dmesg_component(struct dmesg_component *dmesg_comp) | |
357 | { | |
358 | if (!dmesg_comp) { | |
359 | return; | |
360 | } | |
361 | ||
362 | if (dmesg_comp->params.path) { | |
363 | g_string_free(dmesg_comp->params.path, TRUE); | |
364 | } | |
365 | ||
c5b9b441 PP |
366 | bt_packet_put_ref(dmesg_comp->packet); |
367 | bt_trace_put_ref(dmesg_comp->trace); | |
368 | bt_stream_class_put_ref(dmesg_comp->stream_class); | |
369 | bt_event_class_put_ref(dmesg_comp->event_class); | |
370 | bt_stream_put_ref(dmesg_comp->stream); | |
371 | bt_clock_class_put_ref(dmesg_comp->clock_class); | |
8b5bd70c | 372 | bt_trace_class_put_ref(dmesg_comp->trace_class); |
d8866baa PP |
373 | g_free(dmesg_comp); |
374 | } | |
375 | ||
33ec5dfa | 376 | static |
4cdfc5e8 | 377 | bt_self_component_status create_port( |
b19ff26f | 378 | bt_self_component_source *self_comp) |
33ec5dfa | 379 | { |
d94d92ac | 380 | return bt_self_component_source_add_output_port(self_comp, |
33ec5dfa PP |
381 | "out", NULL, NULL); |
382 | } | |
383 | ||
d8866baa | 384 | BT_HIDDEN |
4cdfc5e8 | 385 | bt_self_component_status dmesg_init( |
b19ff26f PP |
386 | bt_self_component_source *self_comp, |
387 | bt_value *params, void *init_method_data) | |
d8866baa PP |
388 | { |
389 | int ret = 0; | |
390 | struct dmesg_component *dmesg_comp = g_new0(struct dmesg_component, 1); | |
4cdfc5e8 | 391 | bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK; |
d8866baa PP |
392 | |
393 | if (!dmesg_comp) { | |
33ec5dfa | 394 | BT_LOGE_STR("Failed to allocate one dmesg component structure."); |
d8866baa PP |
395 | goto error; |
396 | } | |
397 | ||
41693723 | 398 | dmesg_comp->self_comp = self_comp; |
d8866baa PP |
399 | dmesg_comp->params.path = g_string_new(NULL); |
400 | if (!dmesg_comp->params.path) { | |
33ec5dfa | 401 | BT_LOGE_STR("Failed to allocate a GString."); |
d8866baa PP |
402 | goto error; |
403 | } | |
404 | ||
33ec5dfa | 405 | ret = handle_params(dmesg_comp, params); |
d8866baa | 406 | if (ret) { |
d94d92ac | 407 | BT_LOGE("Invalid parameters: comp-addr=%p", self_comp); |
d8866baa PP |
408 | goto error; |
409 | } | |
410 | ||
33ec5dfa PP |
411 | if (!dmesg_comp->params.read_from_stdin && |
412 | !g_file_test(dmesg_comp->params.path->str, | |
413 | G_FILE_TEST_IS_REGULAR)) { | |
414 | BT_LOGE("Input path is not a regular file: " | |
d94d92ac | 415 | "comp-addr=%p, path=\"%s\"", self_comp, |
33ec5dfa PP |
416 | dmesg_comp->params.path->str); |
417 | goto error; | |
418 | } | |
d8866baa | 419 | |
d94d92ac PP |
420 | status = create_port(self_comp); |
421 | if (status != BT_SELF_COMPONENT_STATUS_OK) { | |
33ec5dfa PP |
422 | goto error; |
423 | } | |
d8866baa | 424 | |
d94d92ac | 425 | bt_self_component_set_data( |
707b7d35 | 426 | bt_self_component_source_as_self_component(self_comp), |
d94d92ac | 427 | dmesg_comp); |
d8866baa PP |
428 | goto end; |
429 | ||
430 | error: | |
431 | destroy_dmesg_component(dmesg_comp); | |
d94d92ac | 432 | bt_self_component_set_data( |
707b7d35 | 433 | bt_self_component_source_as_self_component(self_comp), |
d94d92ac | 434 | NULL); |
33ec5dfa PP |
435 | |
436 | if (status >= 0) { | |
d94d92ac | 437 | status = BT_SELF_COMPONENT_STATUS_ERROR; |
33ec5dfa | 438 | } |
d8866baa PP |
439 | |
440 | end: | |
441 | return status; | |
442 | } | |
443 | ||
444 | BT_HIDDEN | |
b19ff26f | 445 | void dmesg_finalize(bt_self_component_source *self_comp) |
d8866baa | 446 | { |
d94d92ac | 447 | destroy_dmesg_component(bt_self_component_get_data( |
707b7d35 | 448 | bt_self_component_source_as_self_component(self_comp))); |
33ec5dfa PP |
449 | } |
450 | ||
451 | static | |
d6e69534 PP |
452 | bt_message *create_init_event_msg_from_line( |
453 | struct dmesg_msg_iter *msg_iter, | |
312c056a | 454 | const char *line, const char **new_start) |
33ec5dfa | 455 | { |
b19ff26f | 456 | bt_event *event; |
d6e69534 | 457 | bt_message *msg = NULL; |
33ec5dfa PP |
458 | bool has_timestamp = false; |
459 | unsigned long sec, usec, msec; | |
460 | unsigned int year, mon, mday, hour, min; | |
461 | uint64_t ts = 0; | |
33ec5dfa | 462 | int ret = 0; |
d6e69534 | 463 | struct dmesg_component *dmesg_comp = msg_iter->dmesg_comp; |
33ec5dfa | 464 | |
33ec5dfa PP |
465 | *new_start = line; |
466 | ||
707b323a PP |
467 | if (dmesg_comp->params.no_timestamp) { |
468 | goto skip_ts; | |
469 | } | |
470 | ||
33ec5dfa PP |
471 | /* Extract time from input line */ |
472 | if (sscanf(line, "[%lu.%lu] ", &sec, &usec) == 2) { | |
473 | ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec; | |
474 | ||
475 | /* | |
476 | * The clock class we use has a 1 GHz frequency: convert | |
477 | * from µs to ns. | |
478 | */ | |
479 | ts *= NSEC_PER_USEC; | |
480 | has_timestamp = true; | |
481 | } else if (sscanf(line, "[%u-%u-%u %u:%u:%lu.%lu] ", | |
482 | &year, &mon, &mday, &hour, &min, | |
483 | &sec, &msec) == 7) { | |
484 | time_t ep_sec; | |
485 | struct tm ti; | |
486 | ||
487 | memset(&ti, 0, sizeof(ti)); | |
488 | ti.tm_year = year - 1900; /* From 1900 */ | |
489 | ti.tm_mon = mon - 1; /* 0 to 11 */ | |
490 | ti.tm_mday = mday; | |
491 | ti.tm_hour = hour; | |
492 | ti.tm_min = min; | |
493 | ti.tm_sec = sec; | |
494 | ||
495 | ep_sec = bt_timegm(&ti); | |
496 | if (ep_sec != (time_t) -1) { | |
497 | ts = (uint64_t) ep_sec * NSEC_PER_SEC | |
498 | + (uint64_t) msec * NSEC_PER_MSEC; | |
499 | } | |
500 | ||
501 | has_timestamp = true; | |
502 | } | |
503 | ||
504 | if (has_timestamp) { | |
505 | /* Set new start for the message portion of the line */ | |
506 | *new_start = strchr(line, ']'); | |
f6ccaed9 | 507 | BT_ASSERT(*new_start); |
33ec5dfa PP |
508 | (*new_start)++; |
509 | ||
510 | if ((*new_start)[0] == ' ') { | |
511 | (*new_start)++; | |
512 | } | |
513 | } | |
514 | ||
707b323a | 515 | skip_ts: |
33ec5dfa PP |
516 | /* |
517 | * At this point, we know if the stream class's event header | |
5cd6d0e5 | 518 | * field class should have a timestamp or not, so we can lazily |
33ec5dfa PP |
519 | * create the metadata, stream, and packet objects. |
520 | */ | |
521 | ret = try_create_meta_stream_packet(dmesg_comp, has_timestamp); | |
522 | if (ret) { | |
523 | /* try_create_meta_stream_packet() logs errors */ | |
524 | goto error; | |
525 | } | |
526 | ||
2c091c04 PP |
527 | if (dmesg_comp->clock_class) { |
528 | msg = bt_message_event_create_with_default_clock_snapshot( | |
529 | msg_iter->pc_msg_iter, | |
530 | dmesg_comp->event_class, dmesg_comp->packet, ts); | |
531 | msg_iter->last_clock_value = ts; | |
532 | } else { | |
533 | msg = bt_message_event_create(msg_iter->pc_msg_iter, | |
534 | dmesg_comp->event_class, dmesg_comp->packet); | |
535 | } | |
536 | ||
d6e69534 PP |
537 | if (!msg) { |
538 | BT_LOGE_STR("Cannot create event message."); | |
312c056a PP |
539 | goto error; |
540 | } | |
33ec5dfa | 541 | |
d6e69534 | 542 | event = bt_message_event_borrow_event(msg); |
312c056a | 543 | BT_ASSERT(event); |
33ec5dfa PP |
544 | goto end; |
545 | ||
546 | error: | |
d6e69534 | 547 | BT_MESSAGE_PUT_REF_AND_RESET(msg); |
33ec5dfa PP |
548 | |
549 | end: | |
d6e69534 | 550 | return msg; |
33ec5dfa PP |
551 | } |
552 | ||
553 | static | |
e5be10ef | 554 | int fill_event_payload_from_line(const char *line, |
b19ff26f | 555 | bt_event *event) |
33ec5dfa | 556 | { |
b19ff26f PP |
557 | bt_field *ep_field = NULL; |
558 | bt_field *str_field = NULL; | |
33ec5dfa PP |
559 | size_t len; |
560 | int ret; | |
561 | ||
40f4ba76 | 562 | ep_field = bt_event_borrow_payload_field(event); |
312c056a | 563 | BT_ASSERT(ep_field); |
40f4ba76 | 564 | str_field = bt_field_structure_borrow_member_field_by_index( |
e5be10ef | 565 | ep_field, 0); |
33ec5dfa | 566 | if (!str_field) { |
312c056a | 567 | BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field."); |
33ec5dfa PP |
568 | goto error; |
569 | } | |
570 | ||
571 | len = strlen(line); | |
572 | if (line[len - 1] == '\n') { | |
573 | /* Do not include the newline character in the payload */ | |
574 | len--; | |
575 | } | |
576 | ||
40f4ba76 | 577 | ret = bt_field_string_clear(str_field); |
312c056a PP |
578 | if (ret) { |
579 | BT_LOGE_STR("Cannot clear string field object."); | |
580 | goto error; | |
581 | } | |
582 | ||
40f4ba76 | 583 | ret = bt_field_string_append_with_length(str_field, line, len); |
33ec5dfa PP |
584 | if (ret) { |
585 | BT_LOGE("Cannot append value to string field object: " | |
586 | "len=%zu", len); | |
587 | goto error; | |
588 | } | |
589 | ||
33ec5dfa PP |
590 | goto end; |
591 | ||
592 | error: | |
593 | ret = -1; | |
594 | ||
595 | end: | |
33ec5dfa PP |
596 | return ret; |
597 | } | |
598 | ||
599 | static | |
d6e69534 PP |
600 | bt_message *create_msg_from_line( |
601 | struct dmesg_msg_iter *dmesg_msg_iter, const char *line) | |
33ec5dfa | 602 | { |
b19ff26f | 603 | bt_event *event = NULL; |
d6e69534 | 604 | bt_message *msg = NULL; |
33ec5dfa PP |
605 | const char *new_start; |
606 | int ret; | |
607 | ||
d6e69534 | 608 | msg = create_init_event_msg_from_line(dmesg_msg_iter, |
f0010051 | 609 | line, &new_start); |
d6e69534 PP |
610 | if (!msg) { |
611 | BT_LOGE_STR("Cannot create and initialize event message from line."); | |
33ec5dfa PP |
612 | goto error; |
613 | } | |
614 | ||
d6e69534 | 615 | event = bt_message_event_borrow_event(msg); |
312c056a | 616 | BT_ASSERT(event); |
f0010051 | 617 | ret = fill_event_payload_from_line(new_start, event); |
33ec5dfa | 618 | if (ret) { |
312c056a | 619 | BT_LOGE("Cannot fill event payload field from line: " |
33ec5dfa PP |
620 | "ret=%d", ret); |
621 | goto error; | |
622 | } | |
623 | ||
33ec5dfa PP |
624 | goto end; |
625 | ||
626 | error: | |
d6e69534 | 627 | BT_MESSAGE_PUT_REF_AND_RESET(msg); |
33ec5dfa PP |
628 | |
629 | end: | |
d6e69534 | 630 | return msg; |
33ec5dfa PP |
631 | } |
632 | ||
633 | static | |
d6e69534 | 634 | void destroy_dmesg_msg_iter(struct dmesg_msg_iter *dmesg_msg_iter) |
33ec5dfa | 635 | { |
d6e69534 | 636 | if (!dmesg_msg_iter) { |
33ec5dfa PP |
637 | return; |
638 | } | |
639 | ||
d6e69534 PP |
640 | if (dmesg_msg_iter->fp && dmesg_msg_iter->fp != stdin) { |
641 | if (fclose(dmesg_msg_iter->fp)) { | |
33ec5dfa PP |
642 | BT_LOGE_ERRNO("Cannot close input file", "."); |
643 | } | |
644 | } | |
d8866baa | 645 | |
d6e69534 PP |
646 | bt_message_put_ref(dmesg_msg_iter->tmp_event_msg); |
647 | free(dmesg_msg_iter->linebuf); | |
648 | g_free(dmesg_msg_iter); | |
d8866baa PP |
649 | } |
650 | ||
2d6bab5c PP |
651 | |
652 | ||
d8866baa | 653 | BT_HIDDEN |
4cdfc5e8 | 654 | bt_self_message_iterator_status dmesg_msg_iter_init( |
d6e69534 | 655 | bt_self_message_iterator *self_msg_iter, |
b19ff26f PP |
656 | bt_self_component_source *self_comp, |
657 | bt_self_component_port_output *self_port) | |
d8866baa | 658 | { |
33ec5dfa | 659 | struct dmesg_component *dmesg_comp; |
d6e69534 PP |
660 | struct dmesg_msg_iter *dmesg_msg_iter = |
661 | g_new0(struct dmesg_msg_iter, 1); | |
4cdfc5e8 | 662 | bt_self_message_iterator_status status = |
d6e69534 | 663 | BT_SELF_MESSAGE_ITERATOR_STATUS_OK; |
33ec5dfa | 664 | |
d6e69534 PP |
665 | if (!dmesg_msg_iter) { |
666 | BT_LOGE_STR("Failed to allocate on dmesg message iterator structure."); | |
33ec5dfa PP |
667 | goto error; |
668 | } | |
669 | ||
d94d92ac | 670 | dmesg_comp = bt_self_component_get_data( |
707b7d35 | 671 | bt_self_component_source_as_self_component(self_comp)); |
f6ccaed9 | 672 | BT_ASSERT(dmesg_comp); |
d6e69534 PP |
673 | dmesg_msg_iter->dmesg_comp = dmesg_comp; |
674 | dmesg_msg_iter->pc_msg_iter = self_msg_iter; | |
d8866baa | 675 | |
33ec5dfa | 676 | if (dmesg_comp->params.read_from_stdin) { |
d6e69534 | 677 | dmesg_msg_iter->fp = stdin; |
33ec5dfa | 678 | } else { |
d6e69534 PP |
679 | dmesg_msg_iter->fp = fopen(dmesg_comp->params.path->str, "r"); |
680 | if (!dmesg_msg_iter->fp) { | |
33ec5dfa PP |
681 | BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"", |
682 | dmesg_comp->params.path->str); | |
683 | goto error; | |
684 | } | |
685 | } | |
686 | ||
d6e69534 PP |
687 | bt_self_message_iterator_set_data(self_msg_iter, |
688 | dmesg_msg_iter); | |
33ec5dfa PP |
689 | goto end; |
690 | ||
691 | error: | |
d6e69534 PP |
692 | destroy_dmesg_msg_iter(dmesg_msg_iter); |
693 | bt_self_message_iterator_set_data(self_msg_iter, NULL); | |
33ec5dfa | 694 | if (status >= 0) { |
d6e69534 | 695 | status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; |
33ec5dfa PP |
696 | } |
697 | ||
698 | end: | |
33ec5dfa | 699 | return status; |
d8866baa PP |
700 | } |
701 | ||
702 | BT_HIDDEN | |
d6e69534 PP |
703 | void dmesg_msg_iter_finalize( |
704 | bt_self_message_iterator *priv_msg_iter) | |
d8866baa | 705 | { |
d6e69534 PP |
706 | destroy_dmesg_msg_iter(bt_self_message_iterator_get_data( |
707 | priv_msg_iter)); | |
d8866baa PP |
708 | } |
709 | ||
d4393e08 | 710 | static |
4cdfc5e8 | 711 | bt_self_message_iterator_status dmesg_msg_iter_next_one( |
d6e69534 PP |
712 | struct dmesg_msg_iter *dmesg_msg_iter, |
713 | bt_message **msg) | |
d8866baa | 714 | { |
33ec5dfa | 715 | ssize_t len; |
33ec5dfa | 716 | struct dmesg_component *dmesg_comp; |
4cdfc5e8 | 717 | bt_self_message_iterator_status status = |
d6e69534 | 718 | BT_SELF_MESSAGE_ITERATOR_STATUS_OK; |
d8866baa | 719 | |
d6e69534 PP |
720 | BT_ASSERT(dmesg_msg_iter); |
721 | dmesg_comp = dmesg_msg_iter->dmesg_comp; | |
f6ccaed9 | 722 | BT_ASSERT(dmesg_comp); |
33ec5dfa | 723 | |
d6e69534 PP |
724 | if (dmesg_msg_iter->state == STATE_DONE) { |
725 | status = BT_SELF_MESSAGE_ITERATOR_STATUS_END; | |
312c056a PP |
726 | goto end; |
727 | } | |
728 | ||
d6e69534 PP |
729 | if (dmesg_msg_iter->tmp_event_msg || |
730 | dmesg_msg_iter->state == STATE_EMIT_PACKET_END || | |
a59806b7 | 731 | dmesg_msg_iter->state == STATE_EMIT_STREAM_ACTIVITY_END || |
d6e69534 | 732 | dmesg_msg_iter->state == STATE_EMIT_STREAM_END) { |
312c056a PP |
733 | goto handle_state; |
734 | } | |
735 | ||
33ec5dfa PP |
736 | while (true) { |
737 | const char *ch; | |
738 | bool only_spaces = true; | |
739 | ||
d6e69534 PP |
740 | len = bt_getline(&dmesg_msg_iter->linebuf, |
741 | &dmesg_msg_iter->linebuf_len, dmesg_msg_iter->fp); | |
33ec5dfa PP |
742 | if (len < 0) { |
743 | if (errno == EINVAL) { | |
d6e69534 | 744 | status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; |
33ec5dfa | 745 | } else if (errno == ENOMEM) { |
d4393e08 | 746 | status = |
d6e69534 | 747 | BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM; |
33ec5dfa | 748 | } else { |
d6e69534 | 749 | if (dmesg_msg_iter->state == STATE_EMIT_STREAM_BEGINNING) { |
312c056a | 750 | /* Stream did not even begin */ |
d6e69534 | 751 | status = BT_SELF_MESSAGE_ITERATOR_STATUS_END; |
312c056a PP |
752 | goto end; |
753 | } else { | |
754 | /* End current packet now */ | |
d6e69534 | 755 | dmesg_msg_iter->state = |
312c056a PP |
756 | STATE_EMIT_PACKET_END; |
757 | goto handle_state; | |
758 | } | |
33ec5dfa PP |
759 | } |
760 | ||
761 | goto end; | |
762 | } | |
763 | ||
d6e69534 | 764 | BT_ASSERT(dmesg_msg_iter->linebuf); |
33ec5dfa PP |
765 | |
766 | /* Ignore empty lines, once trimmed */ | |
d6e69534 | 767 | for (ch = dmesg_msg_iter->linebuf; *ch != '\0'; ch++) { |
33ec5dfa PP |
768 | if (!isspace(*ch)) { |
769 | only_spaces = false; | |
770 | break; | |
771 | } | |
772 | } | |
773 | ||
774 | if (!only_spaces) { | |
775 | break; | |
776 | } | |
777 | } | |
778 | ||
d6e69534 PP |
779 | dmesg_msg_iter->tmp_event_msg = create_msg_from_line( |
780 | dmesg_msg_iter, dmesg_msg_iter->linebuf); | |
781 | if (!dmesg_msg_iter->tmp_event_msg) { | |
782 | BT_LOGE("Cannot create event message from line: " | |
33ec5dfa | 783 | "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp, |
d6e69534 | 784 | dmesg_msg_iter->linebuf); |
312c056a PP |
785 | goto end; |
786 | } | |
787 | ||
788 | handle_state: | |
789 | BT_ASSERT(dmesg_comp->trace); | |
790 | ||
d6e69534 | 791 | switch (dmesg_msg_iter->state) { |
312c056a | 792 | case STATE_EMIT_STREAM_BEGINNING: |
d6e69534 PP |
793 | BT_ASSERT(dmesg_msg_iter->tmp_event_msg); |
794 | *msg = bt_message_stream_beginning_create( | |
795 | dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream); | |
a59806b7 PP |
796 | dmesg_msg_iter->state = STATE_EMIT_STREAM_ACTIVITY_BEGINNING; |
797 | break; | |
798 | case STATE_EMIT_STREAM_ACTIVITY_BEGINNING: | |
799 | BT_ASSERT(dmesg_msg_iter->tmp_event_msg); | |
800 | *msg = bt_message_stream_activity_beginning_create( | |
801 | dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream); | |
d6e69534 | 802 | dmesg_msg_iter->state = STATE_EMIT_PACKET_BEGINNING; |
312c056a PP |
803 | break; |
804 | case STATE_EMIT_PACKET_BEGINNING: | |
d6e69534 | 805 | BT_ASSERT(dmesg_msg_iter->tmp_event_msg); |
a6d85d2f PP |
806 | |
807 | if (dmesg_comp->clock_class) { | |
808 | *msg = bt_message_packet_beginning_create_with_default_clock_snapshot( | |
809 | dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet, | |
810 | dmesg_msg_iter->last_clock_value); | |
811 | } else { | |
812 | *msg = bt_message_packet_beginning_create( | |
813 | dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet); | |
814 | } | |
815 | ||
d6e69534 | 816 | dmesg_msg_iter->state = STATE_EMIT_EVENT; |
312c056a PP |
817 | break; |
818 | case STATE_EMIT_EVENT: | |
d6e69534 PP |
819 | BT_ASSERT(dmesg_msg_iter->tmp_event_msg); |
820 | *msg = dmesg_msg_iter->tmp_event_msg; | |
821 | dmesg_msg_iter->tmp_event_msg = NULL; | |
312c056a PP |
822 | break; |
823 | case STATE_EMIT_PACKET_END: | |
a6d85d2f PP |
824 | if (dmesg_comp->clock_class) { |
825 | *msg = bt_message_packet_end_create_with_default_clock_snapshot( | |
826 | dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet, | |
827 | dmesg_msg_iter->last_clock_value); | |
828 | } else { | |
829 | *msg = bt_message_packet_end_create( | |
830 | dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet); | |
831 | } | |
832 | ||
a59806b7 PP |
833 | dmesg_msg_iter->state = STATE_EMIT_STREAM_ACTIVITY_END; |
834 | break; | |
835 | case STATE_EMIT_STREAM_ACTIVITY_END: | |
836 | *msg = bt_message_stream_activity_end_create( | |
837 | dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream); | |
d6e69534 | 838 | dmesg_msg_iter->state = STATE_EMIT_STREAM_END; |
312c056a PP |
839 | break; |
840 | case STATE_EMIT_STREAM_END: | |
d6e69534 PP |
841 | *msg = bt_message_stream_end_create( |
842 | dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream); | |
843 | dmesg_msg_iter->state = STATE_DONE; | |
312c056a PP |
844 | break; |
845 | default: | |
846 | break; | |
847 | } | |
848 | ||
d6e69534 PP |
849 | if (!*msg) { |
850 | BT_LOGE("Cannot create message: dmesg-comp-addr=%p", | |
312c056a | 851 | dmesg_comp); |
d6e69534 | 852 | status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR; |
33ec5dfa PP |
853 | } |
854 | ||
855 | end: | |
d4393e08 PP |
856 | return status; |
857 | } | |
858 | ||
859 | BT_HIDDEN | |
4cdfc5e8 | 860 | bt_self_message_iterator_status dmesg_msg_iter_next( |
d6e69534 PP |
861 | bt_self_message_iterator *self_msg_iter, |
862 | bt_message_array_const msgs, uint64_t capacity, | |
d4393e08 PP |
863 | uint64_t *count) |
864 | { | |
d6e69534 PP |
865 | struct dmesg_msg_iter *dmesg_msg_iter = |
866 | bt_self_message_iterator_get_data( | |
867 | self_msg_iter); | |
4cdfc5e8 | 868 | bt_self_message_iterator_status status = |
d6e69534 | 869 | BT_SELF_MESSAGE_ITERATOR_STATUS_OK; |
d4393e08 PP |
870 | uint64_t i = 0; |
871 | ||
d94d92ac | 872 | while (i < capacity && |
d6e69534 PP |
873 | status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { |
874 | bt_message *priv_msg = NULL; | |
e5be10ef | 875 | |
d6e69534 PP |
876 | status = dmesg_msg_iter_next_one(dmesg_msg_iter, |
877 | &priv_msg); | |
878 | msgs[i] = priv_msg; | |
879 | if (status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK) { | |
d4393e08 PP |
880 | i++; |
881 | } | |
882 | } | |
883 | ||
884 | if (i > 0) { | |
885 | /* | |
d6e69534 | 886 | * Even if dmesg_msg_iter_next_one() returned |
d4393e08 | 887 | * something else than |
d6e69534 PP |
888 | * BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we |
889 | * accumulated message objects in the output | |
890 | * message array, so we need to return | |
891 | * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they | |
d94d92ac | 892 | * are transfered to downstream. This other status |
d6e69534 | 893 | * occurs again the next time muxer_msg_iter_do_next() |
d94d92ac | 894 | * is called, possibly without any accumulated |
d6e69534 | 895 | * message, in which case we'll return it. |
d4393e08 PP |
896 | */ |
897 | *count = i; | |
d6e69534 | 898 | status = BT_SELF_MESSAGE_ITERATOR_STATUS_OK; |
d4393e08 PP |
899 | } |
900 | ||
901 | return status; | |
d8866baa | 902 | } |
2d6bab5c PP |
903 | |
904 | BT_HIDDEN | |
905 | bt_bool dmesg_msg_iter_can_seek_beginning( | |
906 | bt_self_message_iterator *self_msg_iter) | |
907 | { | |
908 | struct dmesg_msg_iter *dmesg_msg_iter = | |
909 | bt_self_message_iterator_get_data(self_msg_iter); | |
910 | ||
911 | /* Can't seek the beginning of the standard input stream */ | |
912 | return !dmesg_msg_iter->dmesg_comp->params.read_from_stdin; | |
913 | } | |
914 | ||
915 | BT_HIDDEN | |
916 | bt_self_message_iterator_status dmesg_msg_iter_seek_beginning( | |
917 | bt_self_message_iterator *self_msg_iter) | |
918 | { | |
919 | struct dmesg_msg_iter *dmesg_msg_iter = | |
920 | bt_self_message_iterator_get_data(self_msg_iter); | |
921 | ||
922 | BT_ASSERT(!dmesg_msg_iter->dmesg_comp->params.read_from_stdin); | |
923 | ||
924 | BT_MESSAGE_PUT_REF_AND_RESET(dmesg_msg_iter->tmp_event_msg); | |
925 | dmesg_msg_iter->last_clock_value = 0; | |
926 | dmesg_msg_iter->state = STATE_EMIT_STREAM_BEGINNING; | |
927 | return BT_SELF_MESSAGE_ITERATOR_STATUS_OK; | |
928 | } |