4 * Babeltrace CTF Writer Output Plugin Event Handling
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/ctf-ir/event.h>
30 #include <babeltrace/ctf-ir/packet.h>
31 #include <babeltrace/ctf-ir/event-class.h>
32 #include <babeltrace/ctf-ir/stream.h>
33 #include <babeltrace/ctf-ir/stream-class.h>
34 #include <babeltrace/ctf-ir/clock-class.h>
35 #include <babeltrace/ctf-ir/fields.h>
36 #include <babeltrace/ctf-writer/stream-class.h>
37 #include <babeltrace/ctf-writer/stream.h>
40 #include <ctfcopytrace.h>
45 void unref_stream_class(struct bt_ctf_stream_class
*writer_stream_class
)
47 bt_put(writer_stream_class
);
51 void unref_stream(struct bt_ctf_stream_class
*writer_stream
)
53 bt_put(writer_stream
);
56 gboolean
empty_ht(gpointer key
, gpointer value
, gpointer user_data
)
62 void trace_is_static_listener(struct bt_ctf_trace
*trace
, void *data
)
68 struct bt_ctf_stream_class
*insert_new_stream_class(
69 struct writer_component
*writer_component
,
70 struct fs_writer
*fs_writer
,
71 struct bt_ctf_stream_class
*stream_class
)
73 struct bt_ctf_stream_class
*writer_stream_class
= NULL
;
74 struct bt_ctf_trace
*trace
= NULL
, *writer_trace
= NULL
;
75 struct bt_ctf_writer
*ctf_writer
= fs_writer
->writer
;
76 enum bt_component_status ret
;
78 trace
= bt_ctf_stream_class_get_trace(stream_class
);
80 fprintf(writer_component
->err
,
81 "[error] %s in %s:%d\n", __func__
, __FILE__
,
86 writer_trace
= bt_ctf_writer_get_trace(ctf_writer
);
88 fprintf(writer_component
->err
,
89 "[error] %s in %s:%d\n", __func__
, __FILE__
,
94 ret
= ctf_copy_clock_classes(writer_component
->err
, writer_trace
,
95 writer_stream_class
, trace
);
96 if (ret
!= BT_COMPONENT_STATUS_OK
) {
97 fprintf(writer_component
->err
,
98 "[error] %s in %s:%d\n", __func__
, __FILE__
,
103 writer_stream_class
= ctf_copy_stream_class(writer_component
->err
,
104 stream_class
, writer_trace
, true);
105 if (!writer_stream_class
) {
106 fprintf(writer_component
->err
, "[error] Failed to copy stream class\n");
107 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
108 __func__
, __FILE__
, __LINE__
);
112 g_hash_table_insert(fs_writer
->stream_class_map
,
113 (gpointer
) stream_class
, writer_stream_class
);
118 BT_PUT(writer_stream_class
);
120 bt_put(writer_trace
);
122 return writer_stream_class
;
126 struct fs_writer
*insert_new_writer(
127 struct writer_component
*writer_component
,
128 struct bt_ctf_trace
*trace
)
130 struct bt_ctf_writer
*ctf_writer
= NULL
;
131 struct bt_ctf_trace
*writer_trace
= NULL
;
132 char trace_name
[PATH_MAX
];
133 enum bt_component_status ret
;
134 struct fs_writer
*fs_writer
;
136 /* FIXME: replace with trace name when it will work. */
137 snprintf(trace_name
, PATH_MAX
, "%s/%s_%03d",
138 writer_component
->base_path
->str
,
139 writer_component
->trace_name_base
->str
,
140 writer_component
->trace_id
++);
141 printf_verbose("CTF-Writer creating trace in %s\n", trace_name
);
143 ctf_writer
= bt_ctf_writer_create(trace_name
);
145 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
146 __func__
, __FILE__
, __LINE__
);
150 writer_trace
= bt_ctf_writer_get_trace(ctf_writer
);
152 fprintf(writer_component
->err
,
153 "[error] %s in %s:%d\n", __func__
, __FILE__
,
158 ret
= ctf_copy_trace(writer_component
->err
, trace
, writer_trace
);
159 if (ret
!= BT_COMPONENT_STATUS_OK
) {
160 fprintf(writer_component
->err
, "[error] Failed to copy trace\n");
161 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
162 __func__
, __FILE__
, __LINE__
);
167 fs_writer
= g_new0(struct fs_writer
, 1);
169 fprintf(writer_component
->err
,
170 "[error] %s in %s:%d\n", __func__
, __FILE__
,
174 fs_writer
->writer
= ctf_writer
;
175 fs_writer
->stream_class_map
= g_hash_table_new_full(g_direct_hash
,
176 g_direct_equal
, NULL
, (GDestroyNotify
) unref_stream_class
);
177 fs_writer
->stream_map
= g_hash_table_new_full(g_direct_hash
,
178 g_direct_equal
, NULL
, (GDestroyNotify
) unref_stream
);
179 fs_writer
->trace
= trace
;
180 fs_writer
->writer_trace
= writer_trace
;
181 BT_PUT(writer_trace
);
182 if (bt_ctf_trace_is_static(trace
)) {
183 fs_writer
->trace_static
= 1;
184 fs_writer
->static_listener_id
= -1;
186 ret
= bt_ctf_trace_add_is_static_listener(trace
,
187 trace_is_static_listener
, &fs_writer
->trace_static
);
189 fprintf(writer_component
->err
,
190 "[error] %s in %s:%d\n", __func__
, __FILE__
,
196 fs_writer
->static_listener_id
= ret
;
199 g_hash_table_insert(writer_component
->trace_map
, (gpointer
) trace
,
205 bt_put(writer_trace
);
212 struct fs_writer
*get_fs_writer(struct writer_component
*writer_component
,
213 struct bt_ctf_stream_class
*stream_class
)
215 struct bt_ctf_trace
*trace
= NULL
;
216 struct fs_writer
*fs_writer
;
218 trace
= bt_ctf_stream_class_get_trace(stream_class
);
220 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
221 __func__
, __FILE__
, __LINE__
);
225 fs_writer
= g_hash_table_lookup(writer_component
->trace_map
,
228 fs_writer
= insert_new_writer(writer_component
, trace
);
240 struct fs_writer
*get_fs_writer_from_stream(
241 struct writer_component
*writer_component
,
242 struct bt_ctf_stream
*stream
)
244 struct bt_ctf_stream_class
*stream_class
= NULL
;
245 struct fs_writer
*fs_writer
;
247 stream_class
= bt_ctf_stream_get_class(stream
);
249 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
250 __func__
, __FILE__
, __LINE__
);
254 fs_writer
= get_fs_writer(writer_component
, stream_class
);
261 bt_put(stream_class
);
266 struct bt_ctf_stream_class
*lookup_stream_class(
267 struct writer_component
*writer_component
,
268 struct bt_ctf_stream_class
*stream_class
)
270 struct fs_writer
*fs_writer
= get_fs_writer(
271 writer_component
, stream_class
);
273 return (struct bt_ctf_stream_class
*) g_hash_table_lookup(
274 fs_writer
->stream_class_map
, (gpointer
) stream_class
);
278 struct bt_ctf_stream
*lookup_stream(struct writer_component
*writer_component
,
279 struct bt_ctf_stream
*stream
)
281 struct fs_writer
*fs_writer
= get_fs_writer_from_stream(
282 writer_component
, stream
);
284 return (struct bt_ctf_stream
*) g_hash_table_lookup(
285 fs_writer
->stream_map
, (gpointer
) stream
);
289 struct bt_ctf_stream
*insert_new_stream(
290 struct writer_component
*writer_component
,
291 struct fs_writer
*fs_writer
,
292 struct bt_ctf_stream_class
*stream_class
,
293 struct bt_ctf_stream
*stream
)
295 struct bt_ctf_stream
*writer_stream
= NULL
;
296 struct bt_ctf_stream_class
*writer_stream_class
= NULL
;
297 struct bt_ctf_writer
*ctf_writer
= bt_get(fs_writer
->writer
);
299 writer_stream_class
= lookup_stream_class(writer_component
,
301 if (!writer_stream_class
) {
302 writer_stream_class
= insert_new_stream_class(
303 writer_component
, fs_writer
, stream_class
);
304 if (!writer_stream_class
) {
305 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
306 __func__
, __FILE__
, __LINE__
);
310 bt_get(writer_stream_class
);
312 writer_stream
= bt_ctf_writer_create_stream(ctf_writer
,
313 writer_stream_class
);
314 if (!writer_stream
) {
315 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
316 __func__
, __FILE__
, __LINE__
);
320 g_hash_table_insert(fs_writer
->stream_map
, (gpointer
) stream
,
326 BT_PUT(writer_stream
);
329 bt_put(writer_stream_class
);
330 return writer_stream
;
334 struct bt_ctf_event_class
*get_event_class(struct writer_component
*writer_component
,
335 struct bt_ctf_stream_class
*writer_stream_class
,
336 struct bt_ctf_event_class
*event_class
)
338 return bt_ctf_stream_class_get_event_class_by_id(writer_stream_class
,
339 bt_ctf_event_class_get_id(event_class
));
343 struct bt_ctf_stream
*get_writer_stream(
344 struct writer_component
*writer_component
,
345 struct bt_ctf_packet
*packet
, struct bt_ctf_stream
*stream
)
347 struct bt_ctf_stream
*writer_stream
= NULL
;
349 writer_stream
= lookup_stream(writer_component
, stream
);
350 if (!writer_stream
) {
351 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
352 __func__
, __FILE__
, __LINE__
);
355 bt_get(writer_stream
);
360 BT_PUT(writer_stream
);
362 return writer_stream
;
366 void writer_close(struct writer_component
*writer_component
,
367 struct fs_writer
*fs_writer
)
369 if (fs_writer
->static_listener_id
> 0) {
370 bt_ctf_trace_remove_is_static_listener(fs_writer
->trace
,
371 fs_writer
->static_listener_id
);
374 /* Empty the stream class HT. */
375 g_hash_table_foreach_remove(fs_writer
->stream_class_map
,
377 g_hash_table_destroy(fs_writer
->stream_class_map
);
379 /* Empty the stream HT. */
380 g_hash_table_foreach_remove(fs_writer
->stream_map
,
382 g_hash_table_destroy(fs_writer
->stream_map
);
386 enum bt_component_status
writer_stream_begin(
387 struct writer_component
*writer_component
,
388 struct bt_ctf_stream
*stream
)
390 struct bt_ctf_stream_class
*stream_class
= NULL
;
391 struct fs_writer
*fs_writer
;
392 struct bt_ctf_stream
*writer_stream
= NULL
;
393 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
395 stream_class
= bt_ctf_stream_get_class(stream
);
397 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
398 __func__
, __FILE__
, __LINE__
);
402 fs_writer
= get_fs_writer(writer_component
, stream_class
);
404 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
405 __func__
, __FILE__
, __LINE__
);
408 writer_stream
= insert_new_stream(writer_component
, fs_writer
,
409 stream_class
, stream
);
410 if (!writer_stream
) {
411 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
412 __func__
, __FILE__
, __LINE__
);
415 fs_writer
->active_streams
++;
420 ret
= BT_COMPONENT_STATUS_ERROR
;
422 bt_put(stream_class
);
427 enum bt_component_status
writer_stream_end(
428 struct writer_component
*writer_component
,
429 struct bt_ctf_stream
*stream
)
431 struct bt_ctf_stream_class
*stream_class
= NULL
;
432 struct fs_writer
*fs_writer
;
433 struct bt_ctf_trace
*trace
= NULL
;
434 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
436 stream_class
= bt_ctf_stream_get_class(stream
);
438 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
439 __func__
, __FILE__
, __LINE__
);
443 fs_writer
= get_fs_writer(writer_component
, stream_class
);
445 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
446 __func__
, __FILE__
, __LINE__
);
449 g_hash_table_remove(fs_writer
->stream_map
, stream
);
451 assert(fs_writer
->active_streams
> 0);
452 fs_writer
->active_streams
--;
453 if (fs_writer
->active_streams
== 0 && fs_writer
->trace_static
) {
454 writer_close(writer_component
, fs_writer
);
455 g_hash_table_remove(writer_component
->trace_map
,
462 ret
= BT_COMPONENT_STATUS_ERROR
;
465 BT_PUT(stream_class
);
470 enum bt_component_status
writer_new_packet(
471 struct writer_component
*writer_component
,
472 struct bt_ctf_packet
*packet
)
474 struct bt_ctf_stream
*stream
= NULL
, *writer_stream
= NULL
;
475 struct bt_ctf_field
*writer_packet_context
= NULL
;
476 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
479 stream
= bt_ctf_packet_get_stream(packet
);
481 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
482 __func__
, __FILE__
, __LINE__
);
486 writer_stream
= get_writer_stream(writer_component
, packet
, stream
);
487 if (!writer_stream
) {
488 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
489 __func__
, __FILE__
, __LINE__
);
494 writer_packet_context
= ctf_copy_packet_context(writer_component
->err
,
495 packet
, writer_stream
, 1);
496 if (!writer_packet_context
) {
497 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
498 __func__
, __FILE__
, __LINE__
);
502 int_ret
= bt_ctf_stream_set_packet_context(writer_stream
,
503 writer_packet_context
);
505 fprintf(writer_component
->err
, "[error] %s in %s:%d\n", __func__
,
509 BT_PUT(writer_stream
);
510 BT_PUT(writer_packet_context
);
515 ret
= BT_COMPONENT_STATUS_ERROR
;
517 bt_put(writer_stream
);
518 bt_put(writer_packet_context
);
524 enum bt_component_status
writer_close_packet(
525 struct writer_component
*writer_component
,
526 struct bt_ctf_packet
*packet
)
528 struct bt_ctf_stream
*stream
= NULL
, *writer_stream
= NULL
;
529 enum bt_component_status ret
;
531 stream
= bt_ctf_packet_get_stream(packet
);
533 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
534 __func__
, __FILE__
, __LINE__
);
538 writer_stream
= lookup_stream(writer_component
, stream
);
539 if (!writer_stream
) {
540 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
541 __func__
, __FILE__
, __LINE__
);
546 bt_get(writer_stream
);
548 ret
= bt_ctf_stream_flush(writer_stream
);
550 fprintf(writer_component
->err
,
551 "[error] Failed to flush packet\n");
554 BT_PUT(writer_stream
);
556 ret
= BT_COMPONENT_STATUS_OK
;
560 ret
= BT_COMPONENT_STATUS_ERROR
;
562 bt_put(writer_stream
);
568 enum bt_component_status
writer_output_event(
569 struct writer_component
*writer_component
,
570 struct bt_ctf_event
*event
)
572 enum bt_component_status ret
;
573 struct bt_ctf_event_class
*event_class
= NULL
, *writer_event_class
= NULL
;
574 struct bt_ctf_stream
*stream
= NULL
, *writer_stream
= NULL
;
575 struct bt_ctf_stream_class
*stream_class
= NULL
, *writer_stream_class
= NULL
;
576 struct bt_ctf_event
*writer_event
= NULL
;
577 const char *event_name
;
580 event_class
= bt_ctf_event_get_class(event
);
582 fprintf(writer_component
->err
, "[error] %s in %s:%d\n", __func__
,
587 event_name
= bt_ctf_event_class_get_name(event_class
);
589 fprintf(writer_component
->err
, "[error] %s in %s:%d\n", __func__
,
594 stream
= bt_ctf_event_get_stream(event
);
596 fprintf(writer_component
->err
, "[error] %s in %s:%d\n", __func__
,
601 writer_stream
= lookup_stream(writer_component
, stream
);
602 if (!writer_stream
|| !bt_get(writer_stream
)) {
603 fprintf(writer_component
->err
, "[error] %s in %s:%d\n", __func__
,
608 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
610 fprintf(writer_component
->err
, "[error] %s in %s:%d\n", __func__
,
615 writer_stream_class
= lookup_stream_class(writer_component
, stream_class
);
616 if (!writer_stream_class
|| !bt_get(writer_stream_class
)) {
617 fprintf(writer_component
->err
, "[error] %s in %s:%d\n", __func__
,
622 writer_event_class
= get_event_class(writer_component
,
623 writer_stream_class
, event_class
);
624 if (!writer_event_class
) {
625 writer_event_class
= ctf_copy_event_class(writer_component
->err
,
627 if (!writer_event_class
) {
628 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
629 __func__
, __FILE__
, __LINE__
);
632 int_ret
= bt_ctf_stream_class_add_event_class(
633 writer_stream_class
, writer_event_class
);
635 fprintf(writer_component
->err
, "[error] %s in %s:%d\n",
636 __func__
, __FILE__
, __LINE__
);
641 writer_event
= ctf_copy_event(writer_component
->err
, event
,
642 writer_event_class
, true);
644 fprintf(writer_component
->err
, "[error] %s in %s:%d\n", __func__
,
646 fprintf(writer_component
->err
, "[error] Failed to copy event %s\n",
647 bt_ctf_event_class_get_name(writer_event_class
));
651 int_ret
= bt_ctf_stream_append_event(writer_stream
, writer_event
);
653 fprintf(writer_component
->err
, "[error] %s in %s:%d\n", __func__
,
655 fprintf(writer_component
->err
, "[error] Failed to append event %s\n",
656 bt_ctf_event_class_get_name(writer_event_class
));
660 ret
= BT_COMPONENT_STATUS_OK
;
664 ret
= BT_COMPONENT_STATUS_ERROR
;
666 bt_put(writer_event
);
667 bt_put(writer_event_class
);
668 bt_put(writer_stream_class
);
669 bt_put(stream_class
);
670 bt_put(writer_stream
);