[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/babeltrace-internal.h>
#include <babeltrace/ctf/types.h>
#include <glib.h>

struct bt_ctf_stream {
	struct bt_object base;
	uint32_t id;
	struct bt_ctf_stream_class *stream_class;
	/* Array of pointers to bt_ctf_event for the current packet */
	GPtrArray *events;
	struct ctf_stream_pos pos;
	unsigned int flushed_packet_count;
	GString *name;
	struct bt_ctf_field *packet_header;
	struct bt_ctf_field *packet_context;
	GHashTable *clock_values; /* Maps clock addresses to (uint64_t *) */
};

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

BT_HIDDEN
void bt_ctf_stream_update_clock_value(struct bt_ctf_stream *stream,
		struct bt_ctf_field *value_field);

BT_HIDDEN
const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream);

BT_HIDDEN
struct bt_ctf_stream *bt_ctf_stream_create(
		struct bt_ctf_stream_class *stream_class,
		const char *name);

/*
 * bt_ctf_stream_get_discarded_events_count: get the number of discarded
 * events associated with this stream.
 *
 * Note that discarded events are not stored if the stream's packet
 * context has no "events_discarded" field. An error will be returned
 * in that case.
 *
 * @param stream Stream instance.
 *
 * Returns the number of discarded events, a negative value on error.
 */
BT_HIDDEN
int bt_ctf_stream_get_discarded_events_count(
		struct bt_ctf_stream *stream, uint64_t *count);

/*
 * bt_ctf_stream_get_stream_class: get a stream's class.
 *
 * @param stream Stream instance.
 *
 * Returns the stream's class, NULL on error.
 */
BT_HIDDEN
struct bt_ctf_stream_class *bt_ctf_stream_get_class(
		struct bt_ctf_stream *stream);

/*
 * bt_ctf_stream_get_packet_header: get a stream's packet header.
 *
 * @param stream Stream instance.
 *
 * Returns a field instance on success, NULL on error.
 */
BT_HIDDEN
struct bt_ctf_field *bt_ctf_stream_get_packet_header(
		struct bt_ctf_stream *stream);

/*
 * bt_ctf_stream_set_packet_header: set a stream's packet header.
 *
 * The packet header's type must match the trace's packet header
 * type.
 *
 * @param stream Stream instance.
 * @param packet_header Packet header instance.
 *
 * Returns a field instance on success, NULL on error.
 */
BT_HIDDEN
int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream,
		struct bt_ctf_field *packet_header);

/*
 * bt_ctf_stream_set_packet_context: set a stream's packet context.
 *
 * The packet context's type must match the stream class' packet
 * context type.
 *
 * @param stream Stream instance.
 * @param packet_context Packet context field instance.
 *
 * Returns a field instance on success, NULL on error.
 */
BT_HIDDEN
int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream,
		struct bt_ctf_field *packet_context);


#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	*
1c822dfb	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
1c822dfb JG	30	#include <babeltrace/ctf-ir/stream.h>
1c822dfb JG	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>
	35	#include <babeltrace/babeltrace-internal.h>
	36	#include <babeltrace/ctf/types.h>
	37	#include <glib.h>
	38
273b65be	39	struct bt_ctf_stream {
1c822dfb	40	struct bt_object base;
273b65be JG	41	uint32_t id;
273b65be JG	42	struct bt_ctf_stream_class *stream_class;
273b65be JG	43	/* Array of pointers to bt_ctf_event for the current packet */
	44	GPtrArray *events;
	45	struct ctf_stream_pos pos;
	46	unsigned int flushed_packet_count;
1c822dfb JG	47	GString *name;
	48	struct bt_ctf_field *packet_header;
	49	struct bt_ctf_field *packet_context;
	50	GHashTable clock_values; / Maps clock addresses to (uint64_t ) /
273b65be JG	51	};
	52
	53	BT_HIDDEN
1c822dfb	54	int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd);
273b65be JG	55
273b65be JG	56	BT_HIDDEN
1c822dfb JG	57	void bt_ctf_stream_update_clock_value(struct bt_ctf_stream *stream,
1c822dfb JG	58	struct bt_ctf_field *value_field);
273b65be	59
eea2626f JG	60	BT_HIDDEN
	61	const char bt_ctf_stream_get_name(struct bt_ctf_stream stream);
	62
	63	BT_HIDDEN
	64	struct bt_ctf_stream *bt_ctf_stream_create(
	65	struct bt_ctf_stream_class *stream_class,
	66	const char *name);
	67
	68	/*
	69	* bt_ctf_stream_get_discarded_events_count: get the number of discarded
	70	* events associated with this stream.
	71	*
	72	* Note that discarded events are not stored if the stream's packet
	73	* context has no "events_discarded" field. An error will be returned
	74	* in that case.
	75	*
	76	* @param stream Stream instance.
	77	*
	78	* Returns the number of discarded events, a negative value on error.
	79	*/
	80	BT_HIDDEN
	81	int bt_ctf_stream_get_discarded_events_count(
	82	struct bt_ctf_stream stream, uint64_t count);
	83
	84	/*
	85	* bt_ctf_stream_get_stream_class: get a stream's class.
	86	*
	87	* @param stream Stream instance.
	88	*
	89	* Returns the stream's class, NULL on error.
	90	*/
	91	BT_HIDDEN
	92	struct bt_ctf_stream_class *bt_ctf_stream_get_class(
	93	struct bt_ctf_stream *stream);
	94
	95	/*
	96	* bt_ctf_stream_get_packet_header: get a stream's packet header.
	97	*
	98	* @param stream Stream instance.
	99	*
	100	* Returns a field instance on success, NULL on error.
	101	*/
	102	BT_HIDDEN
	103	struct bt_ctf_field *bt_ctf_stream_get_packet_header(
	104	struct bt_ctf_stream *stream);
	105
	106	/*
	107	* bt_ctf_stream_set_packet_header: set a stream's packet header.
	108	*
	109	* The packet header's type must match the trace's packet header
	110	* type.
	111	*
	112	* @param stream Stream instance.
	113	* @param packet_header Packet header instance.
	114	*
	115	* Returns a field instance on success, NULL on error.
	116	*/
	117	BT_HIDDEN
	118	int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream,
	119	struct bt_ctf_field *packet_header);
	120
	121	/*
	122	* bt_ctf_stream_set_packet_context: set a stream's packet context.
	123	*
124	* The packet context's type must match the stream class' packet
125	* context type.
126	*
127	* @param stream Stream instance.
128	* @param packet_context Packet context field instance.
129	*
130	* Returns a field instance on success, NULL on error.
131	*/
132	BT_HIDDEN
133	int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream,
134	struct bt_ctf_field *packet_context);
135
136
273b65be	137	#endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */