lib: add aliases for Babeltrace structure types
[babeltrace.git] / plugins / ctf / fs-sink / writer.h
CommitLineData
bc506aa5
JD
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>
9d408fca 32#include <babeltrace/babeltrace.h>
bc506aa5
JD
33
34struct writer_component {
9057f037
JD
35 GString *base_path;
36 GString *trace_name_base;
bc506aa5
JD
37 /* For the directory name suffix. */
38 int trace_id;
b19ff26f 39 /* Map between bt_trace and struct fs_writer. */
bc506aa5 40 GHashTable *trace_map;
bc506aa5 41 FILE *err;
b19ff26f 42 bt_notification_iterator *input_iterator;
0d8b4d8e 43 bool error;
6ca0eb99
JD
44 bool single_trace;
45 unsigned int nr_traces;
bc506aa5
JD
46};
47
cdcf612f
JD
48enum 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
f3168545
JD
60struct fs_writer {
61 struct bt_ctf_writer *writer;
b19ff26f
PP
62 const bt_trace *trace;
63 const bt_trace *writer_trace;
6f25f7c4 64 struct writer_component *writer_component;
f3168545 65 int static_listener_id;
f3168545 66 int trace_static;
a619fcb7
JD
67 /* Map between reader and writer stream. */
68 GHashTable *stream_map;
69 /* Map between reader and writer stream class. */
70 GHashTable *stream_class_map;
cdcf612f 71 GHashTable *stream_states;
f3168545
JD
72};
73
a619fcb7
JD
74BT_HIDDEN
75void writer_close(struct writer_component *writer_component,
76 struct fs_writer *fs_writer);
bc506aa5
JD
77BT_HIDDEN
78enum bt_component_status writer_output_event(struct writer_component *writer,
b19ff26f 79 const bt_event *event);
bc506aa5
JD
80BT_HIDDEN
81enum bt_component_status writer_new_packet(struct writer_component *writer,
b19ff26f 82 const bt_packet *packet);
bc506aa5
JD
83BT_HIDDEN
84enum bt_component_status writer_close_packet(struct writer_component *writer,
b19ff26f 85 const bt_packet *packet);
f3168545 86BT_HIDDEN
f384901f 87enum bt_component_status writer_stream_begin(struct writer_component *writer,
b19ff26f 88 const bt_stream *stream);
f384901f 89BT_HIDDEN
f3168545 90enum bt_component_status writer_stream_end(struct writer_component *writer,
b19ff26f 91 const bt_stream *stream);
bc506aa5 92
d8866baa
PP
93BT_HIDDEN
94enum bt_component_status writer_component_init(
b19ff26f 95 bt_self_component *component, bt_value *params,
d8866baa
PP
96 void *init_method_data);
97
98BT_HIDDEN
b19ff26f 99enum bt_component_status writer_run(bt_self_component *component);
d8866baa
PP
100
101BT_HIDDEN
102void writer_component_port_connected(
b19ff26f 103 bt_self_component *component,
d8866baa 104 struct bt_private_port *self_port,
b19ff26f 105 const bt_port *other_port);
d8866baa
PP
106
107BT_HIDDEN
b19ff26f 108void writer_component_finalize(bt_self_component *component);
d8866baa 109
bc506aa5 110#endif /* BABELTRACE_PLUGIN_WRITER_H */
This page took 0.041395 seconds and 4 git commands to generate.