fs-sink: add the single-trace option
[babeltrace.git] / plugins / ctf / fs-sink / writer.h
1 #ifndef BABELTRACE_PLUGIN_WRITER_H
2 #define BABELTRACE_PLUGIN_WRITER_H
3
4 /*
5 * BabelTrace - CTF Writer Output Plug-in
6 *
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * SOFTWARE.
28 */
29
30 #include <stdbool.h>
31 #include <babeltrace/babeltrace-internal.h>
32 #include <babeltrace/graph/component.h>
33 #include <babeltrace/ctf-writer/writer.h>
34
35 struct writer_component {
36 GString *base_path;
37 GString *trace_name_base;
38 /* For the directory name suffix. */
39 int trace_id;
40 /* Map between struct bt_ctf_trace and struct fs_writer. */
41 GHashTable *trace_map;
42 FILE *err;
43 struct bt_notification_iterator *input_iterator;
44 bool error;
45 bool single_trace;
46 unsigned int nr_traces;
47 };
48
49 enum fs_writer_stream_state {
50 /*
51 * We know the stream exists but we have never received a
52 * stream_begin notification for it.
53 */
54 FS_WRITER_UNKNOWN_STREAM,
55 /* We know this stream is active (between stream_begin and _end). */
56 FS_WRITER_ACTIVE_STREAM,
57 /* We have received a stream_end for this stream. */
58 FS_WRITER_COMPLETED_STREAM,
59 };
60
61 struct fs_writer {
62 struct bt_ctf_writer *writer;
63 struct bt_ctf_trace *trace;
64 struct bt_ctf_trace *writer_trace;
65 struct writer_component *writer_component;
66 int static_listener_id;
67 int trace_static;
68 /* Map between reader and writer stream. */
69 GHashTable *stream_map;
70 /* Map between reader and writer stream class. */
71 GHashTable *stream_class_map;
72 GHashTable *stream_states;
73 };
74
75 BT_HIDDEN
76 void writer_close(struct writer_component *writer_component,
77 struct fs_writer *fs_writer);
78 BT_HIDDEN
79 enum bt_component_status writer_output_event(struct writer_component *writer,
80 struct bt_ctf_event *event);
81 BT_HIDDEN
82 enum bt_component_status writer_new_packet(struct writer_component *writer,
83 struct bt_ctf_packet *packet);
84 BT_HIDDEN
85 enum bt_component_status writer_close_packet(struct writer_component *writer,
86 struct bt_ctf_packet *packet);
87 BT_HIDDEN
88 enum bt_component_status writer_stream_begin(struct writer_component *writer,
89 struct bt_ctf_stream *stream);
90 BT_HIDDEN
91 enum bt_component_status writer_stream_end(struct writer_component *writer,
92 struct bt_ctf_stream *stream);
93
94 BT_HIDDEN
95 enum bt_component_status writer_component_init(
96 struct bt_private_component *component, struct bt_value *params,
97 void *init_method_data);
98
99 BT_HIDDEN
100 enum bt_component_status writer_run(struct bt_private_component *component);
101
102 BT_HIDDEN
103 void writer_component_port_connected(
104 struct bt_private_component *component,
105 struct bt_private_port *self_port,
106 struct bt_port *other_port);
107
108 BT_HIDDEN
109 void writer_component_finalize(struct bt_private_component *component);
110
111 #endif /* BABELTRACE_PLUGIN_WRITER_H */
This page took 0.032812 seconds and 5 git commands to generate.