[babeltrace.git] / include / babeltrace / ctf-ir / stream-internal.h

#ifndef BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
#define BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H

/*
 * BabelTrace - CTF Writer: Stream internal
 *
 * Copyright 2013, 2014 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 <babeltrace/ctf-ir/stream.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/ctf-writer/clock.h>
#include <babeltrace/ctf-writer/event-fields.h>
#include <babeltrace/ctf-writer/event-types.h>
#include <babeltrace/ctf-writer/serialize-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <glib.h>

struct bt_port;
struct bt_component;

typedef void (*bt_ctf_stream_destroy_listener_func)(
		struct bt_ctf_stream *stream, void *data);

struct bt_ctf_stream_destroy_listener {
	bt_ctf_stream_destroy_listener_func func;
	void *data;
};

struct bt_ctf_stream {
	struct bt_object base;
	uint32_t id;
	struct bt_ctf_stream_class *stream_class;
	GString *name;
	struct bt_ctf_field *packet_header;
	struct bt_ctf_field *packet_context;

	/*
	 * When a notification which contains a reference to a stream
	 * object (event notification, for example) is returned by the
	 * "next" method of a sink or filter component's notification
	 * iterator, it must NOT be returned by the "next" method of a
	 * notification iterator which iterates on the notifications of
	 * another output port of the same component.
	 *
	 * To ensure this, the stream object keeps a hash table which
	 * indicates which port, for a given component, is currently
	 * allowed to emit notifications which contain a reference to
	 * this stream.
	 *
	 * This is a `struct bt_component *` to `struct bt_port *` hash
	 * table. Both pointers are weak references because there's no
	 * need to keep one or the other alive as far as this stream is
	 * concerned.
	 */
	GHashTable *comp_cur_port;

	/* Writer-specific members. */
	/* Array of pointers to bt_ctf_event for the current packet */
	GPtrArray *events;
	struct bt_ctf_stream_pos pos;
	unsigned int flushed_packet_count;
	uint64_t discarded_events;
	uint64_t size;

	/* Array of struct bt_ctf_stream_destroy_listener */
	GArray *destroy_listeners;
};

BT_HIDDEN
int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd);

BT_HIDDEN
void bt_ctf_stream_map_component_to_port(struct bt_ctf_stream *stream,
		struct bt_component *comp,
		struct bt_port *port);

BT_HIDDEN
struct bt_port *bt_ctf_stream_port_for_component(struct bt_ctf_stream *stream,
		struct bt_component *comp);

BT_HIDDEN
void bt_ctf_stream_add_destroy_listener(struct bt_ctf_stream *stream,
		bt_ctf_stream_destroy_listener_func func, void *data);

BT_HIDDEN
void bt_ctf_stream_remove_destroy_listener(struct bt_ctf_stream *stream,
		bt_ctf_stream_destroy_listener_func func, void *data);

#endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */
Commit	Line	Data
273b65be JG	1	#ifndef BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
	2	#define BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
	3
	4	/*
	5	* BabelTrace - CTF Writer: Stream internal
	6	*
de9dd397	7	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be JG	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
bc37ae52	30	#include <babeltrace/ctf-ir/stream.h>
83509119	31	#include <babeltrace/object-internal.h>
273b65be JG	32	#include <babeltrace/ctf-writer/clock.h>
	33	#include <babeltrace/ctf-writer/event-fields.h>
	34	#include <babeltrace/ctf-writer/event-types.h>
dc3fffef	35	#include <babeltrace/ctf-writer/serialize-internal.h>
273b65be	36	#include <babeltrace/babeltrace-internal.h>
273b65be JG	37	#include <glib.h>
273b65be JG	38
3230ee6b PP	39	struct bt_port;
	40	struct bt_component;
	41
	42	typedef void (*bt_ctf_stream_destroy_listener_func)(
	43	struct bt_ctf_stream stream, void data);
	44
	45	struct bt_ctf_stream_destroy_listener {
	46	bt_ctf_stream_destroy_listener_func func;
	47	void *data;
	48	};
	49
273b65be	50	struct bt_ctf_stream {
83509119	51	struct bt_object base;
273b65be JG	52	uint32_t id;
273b65be JG	53	struct bt_ctf_stream_class *stream_class;
0686ef94 JG	54	GString *name;
	55	struct bt_ctf_field *packet_header;
	56	struct bt_ctf_field *packet_context;
	57
3230ee6b PP	58	/*
	59	* When a notification which contains a reference to a stream
	60	* object (event notification, for example) is returned by the
	61	* "next" method of a sink or filter component's notification
	62	* iterator, it must NOT be returned by the "next" method of a
	63	* notification iterator which iterates on the notifications of
	64	* another output port of the same component.
	65	*
	66	* To ensure this, the stream object keeps a hash table which
	67	* indicates which port, for a given component, is currently
	68	* allowed to emit notifications which contain a reference to
	69	* this stream.
	70	*
	71	* This is a `struct bt_component ` to `struct bt_port ` hash
	72	* table. Both pointers are weak references because there's no
	73	* need to keep one or the other alive as far as this stream is
	74	* concerned.
	75	*/
	76	GHashTable *comp_cur_port;
	77
0686ef94	78	/* Writer-specific members. */
273b65be JG	79	/* Array of pointers to bt_ctf_event for the current packet */
273b65be JG	80	GPtrArray *events;
dc3fffef	81	struct bt_ctf_stream_pos pos;
273b65be	82	unsigned int flushed_packet_count;
b3376dd9	83	uint64_t discarded_events;
0686ef94	84	uint64_t size;
3230ee6b PP	85
	86	/* Array of struct bt_ctf_stream_destroy_listener */
	87	GArray *destroy_listeners;
273b65be JG	88	};
273b65be JG	89
273b65be JG	90	BT_HIDDEN
	91	int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd);
	92
3230ee6b PP	93	BT_HIDDEN
	94	void bt_ctf_stream_map_component_to_port(struct bt_ctf_stream *stream,
	95	struct bt_component *comp,
	96	struct bt_port *port);
	97
	98	BT_HIDDEN
	99	struct bt_port bt_ctf_stream_port_for_component(struct bt_ctf_stream stream,
	100	struct bt_component *comp);
	101
	102	BT_HIDDEN
	103	void bt_ctf_stream_add_destroy_listener(struct bt_ctf_stream *stream,
	104	bt_ctf_stream_destroy_listener_func func, void *data);
	105
	106	BT_HIDDEN
	107	void bt_ctf_stream_remove_destroy_listener(struct bt_ctf_stream *stream,
	108	bt_ctf_stream_destroy_listener_func func, void *data);
	109
273b65be	110	#endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */