lib: make trace IR API const-correct
[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/babeltrace.h>
33
34 struct writer_component {
35 GString *base_path;
36 GString *trace_name_base;
37 /* For the directory name suffix. */
38 int trace_id;
39 /* Map between struct bt_trace and struct fs_writer. */
40 GHashTable *trace_map;
41 FILE *err;
42 struct bt_notification_iterator *input_iterator;
43 bool error;
44 bool single_trace;
45 unsigned int nr_traces;
46 };
47
48 enum fs_writer_stream_state {
49 /*
50 * We know the stream exists but we have never received a
51 * stream_begin notification for it.
52 */
53 FS_WRITER_UNKNOWN_STREAM,
54 /* We know this stream is active (between stream_begin and _end). */
55 FS_WRITER_ACTIVE_STREAM,
56 /* We have received a stream_end for this stream. */
57 FS_WRITER_COMPLETED_STREAM,
58 };
59
60 struct fs_writer {
61 struct bt_ctf_writer *writer;
62 const struct bt_trace *trace;
63 const struct bt_trace *writer_trace;
64 struct writer_component *writer_component;
65 int static_listener_id;
66 int trace_static;
67 /* Map between reader and writer stream. */
68 GHashTable *stream_map;
69 /* Map between reader and writer stream class. */
70 GHashTable *stream_class_map;
71 GHashTable *stream_states;
72 };
73
74 BT_HIDDEN
75 void writer_close(struct writer_component *writer_component,
76 struct fs_writer *fs_writer);
77 BT_HIDDEN
78 enum bt_component_status writer_output_event(struct writer_component *writer,
79 const struct bt_event *event);
80 BT_HIDDEN
81 enum bt_component_status writer_new_packet(struct writer_component *writer,
82 const struct bt_packet *packet);
83 BT_HIDDEN
84 enum bt_component_status writer_close_packet(struct writer_component *writer,
85 const struct bt_packet *packet);
86 BT_HIDDEN
87 enum bt_component_status writer_stream_begin(struct writer_component *writer,
88 const struct bt_stream *stream);
89 BT_HIDDEN
90 enum bt_component_status writer_stream_end(struct writer_component *writer,
91 const struct bt_stream *stream);
92
93 BT_HIDDEN
94 enum bt_component_status writer_component_init(
95 struct bt_self_component *component, struct bt_value *params,
96 void *init_method_data);
97
98 BT_HIDDEN
99 enum bt_component_status writer_run(struct bt_self_component *component);
100
101 BT_HIDDEN
102 void writer_component_port_connected(
103 struct bt_self_component *component,
104 struct bt_private_port *self_port,
105 struct bt_port *other_port);
106
107 BT_HIDDEN
108 void writer_component_finalize(struct bt_self_component *component);
109
110 #endif /* BABELTRACE_PLUGIN_WRITER_H */
This page took 0.036147 seconds and 5 git commands to generate.