[babeltrace.git] / plugins / ctf / fs-sink / writer.h

#ifndef BABELTRACE_PLUGIN_WRITER_H
#define BABELTRACE_PLUGIN_WRITER_H

/*
 * BabelTrace - CTF Writer Output Plug-in
 *
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <stdbool.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/graph/component.h>
#include <babeltrace/ctf-writer/writer.h>

struct writer_component {
	GString *base_path;
	GString *trace_name_base;
	/* For the directory name suffix. */
	int trace_id;
	/* Map between struct bt_ctf_trace and struct fs_writer. */
	GHashTable *trace_map;
	FILE *err;
	struct bt_notification_iterator *input_iterator;
	bool error;
};

enum fs_writer_stream_state {
	/*
	 * We know the stream exists but we have never received a
	 * stream_begin notification for it.
	 */
	FS_WRITER_UNKNOWN_STREAM,
	/* We know this stream is active (between stream_begin and _end). */
	FS_WRITER_ACTIVE_STREAM,
	/* We have received a stream_end for this stream. */
	FS_WRITER_COMPLETED_STREAM,
};

struct fs_writer {
	struct bt_ctf_writer *writer;
	struct bt_ctf_trace *trace;
	struct bt_ctf_trace *writer_trace;
	struct writer_component *writer_component;
	int static_listener_id;
	int trace_static;
	/* Map between reader and writer stream. */
	GHashTable *stream_map;
	/* Map between reader and writer stream class. */
	GHashTable *stream_class_map;
	GHashTable *stream_states;
};

BT_HIDDEN
void writer_close(struct writer_component *writer_component,
		struct fs_writer *fs_writer);
BT_HIDDEN
enum bt_component_status writer_output_event(struct writer_component *writer,
		struct bt_ctf_event *event);
BT_HIDDEN
enum bt_component_status writer_new_packet(struct writer_component *writer,
		struct bt_ctf_packet *packet);
BT_HIDDEN
enum bt_component_status writer_close_packet(struct writer_component *writer,
		struct bt_ctf_packet *packet);
BT_HIDDEN
enum bt_component_status writer_stream_begin(struct writer_component *writer,
		struct bt_ctf_stream *stream);
BT_HIDDEN
enum bt_component_status writer_stream_end(struct writer_component *writer,
		struct bt_ctf_stream *stream);

BT_HIDDEN
enum bt_component_status writer_component_init(
	struct bt_private_component *component, struct bt_value *params,
	void *init_method_data);

BT_HIDDEN
enum bt_component_status writer_run(struct bt_private_component *component);

BT_HIDDEN
void writer_component_port_connected(
		struct bt_private_component *component,
		struct bt_private_port *self_port,
		struct bt_port *other_port);

BT_HIDDEN
void writer_component_finalize(struct bt_private_component *component);

#endif /* BABELTRACE_PLUGIN_WRITER_H */
Commit	Line	Data
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>
b2e0c907	32	#include <babeltrace/graph/component.h>
bc506aa5 JD	33	#include <babeltrace/ctf-writer/writer.h>
	34
	35	struct writer_component {
9057f037 JD	36	GString *base_path;
9057f037 JD	37	GString *trace_name_base;
bc506aa5 JD	38	/* For the directory name suffix. */
bc506aa5 JD	39	int trace_id;
cdcf612f	40	/* Map between struct bt_ctf_trace and struct fs_writer. */
bc506aa5	41	GHashTable *trace_map;
bc506aa5	42	FILE *err;
c70ed359	43	struct bt_notification_iterator *input_iterator;
0d8b4d8e	44	bool error;
bc506aa5 JD	45	};
bc506aa5 JD	46
cdcf612f JD	47	enum fs_writer_stream_state {
	48	/*
	49	* We know the stream exists but we have never received a
	50	* stream_begin notification for it.
	51	*/
	52	FS_WRITER_UNKNOWN_STREAM,
	53	/* We know this stream is active (between stream_begin and _end). */
	54	FS_WRITER_ACTIVE_STREAM,
	55	/* We have received a stream_end for this stream. */
	56	FS_WRITER_COMPLETED_STREAM,
	57	};
	58
f3168545 JD	59	struct fs_writer {
f3168545 JD	60	struct bt_ctf_writer *writer;
a619fcb7	61	struct bt_ctf_trace *trace;
f3168545	62	struct bt_ctf_trace *writer_trace;
6f25f7c4	63	struct writer_component *writer_component;
f3168545	64	int static_listener_id;
f3168545	65	int trace_static;
a619fcb7 JD	66	/* Map between reader and writer stream. */
	67	GHashTable *stream_map;
	68	/* Map between reader and writer stream class. */
	69	GHashTable *stream_class_map;
cdcf612f	70	GHashTable *stream_states;
f3168545 JD	71	};
f3168545 JD	72
a619fcb7 JD	73	BT_HIDDEN
	74	void writer_close(struct writer_component *writer_component,
	75	struct fs_writer *fs_writer);
bc506aa5 JD	76	BT_HIDDEN
	77	enum bt_component_status writer_output_event(struct writer_component *writer,
	78	struct bt_ctf_event *event);
	79	BT_HIDDEN
	80	enum bt_component_status writer_new_packet(struct writer_component *writer,
	81	struct bt_ctf_packet *packet);
	82	BT_HIDDEN
	83	enum bt_component_status writer_close_packet(struct writer_component *writer,
	84	struct bt_ctf_packet *packet);
f3168545	85	BT_HIDDEN
f384901f JD	86	enum bt_component_status writer_stream_begin(struct writer_component *writer,
	87	struct bt_ctf_stream *stream);
	88	BT_HIDDEN
f3168545 JD	89	enum bt_component_status writer_stream_end(struct writer_component *writer,
f3168545 JD	90	struct bt_ctf_stream *stream);
bc506aa5	91
d8866baa PP	92	BT_HIDDEN
	93	enum bt_component_status writer_component_init(
	94	struct bt_private_component component, struct bt_value params,
	95	void *init_method_data);
	96
	97	BT_HIDDEN
	98	enum bt_component_status writer_run(struct bt_private_component *component);
	99
	100	BT_HIDDEN
	101	void writer_component_port_connected(
	102	struct bt_private_component *component,
	103	struct bt_private_port *self_port,
	104	struct bt_port *other_port);
	105
	106	BT_HIDDEN
	107	void writer_component_finalize(struct bt_private_component *component);
	108
bc506aa5	109	#endif /* BABELTRACE_PLUGIN_WRITER_H */