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

#ifndef BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
#define BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H

/*
 * BabelTrace - CTF Writer: Stream
 *
 * 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.
 *
 * The Common Trace Format (CTF) Specification is available at
 * http://www.efficios.com/ctf
 */

#include <babeltrace/assert-internal.h>
#include <babeltrace/assert-pre-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/babeltrace.h>
#include <babeltrace/ctf-writer/serialize-internal.h>
#include <babeltrace/ctf-writer/stream-internal.h>
#include <babeltrace/ctf-writer/stream.h>
#include <babeltrace/ctf-writer/utils-internal.h>
#include <babeltrace/object-internal.h>
#include <stdint.h>

struct bt_ctf_stream_common;

struct bt_ctf_stream_common {
	struct bt_object base;
	int64_t id;
	struct bt_ctf_stream_class_common *stream_class;
	GString *name;
};

BT_HIDDEN
int bt_ctf_stream_common_initialize(
		struct bt_ctf_stream_common *stream,
		struct bt_ctf_stream_class_common *stream_class, const char *name,
		uint64_t id, bt_object_release_func release_func);

BT_HIDDEN
void bt_ctf_stream_common_finalize(struct bt_ctf_stream_common *stream);

static inline
struct bt_ctf_stream_class_common *bt_ctf_stream_common_borrow_class(
		struct bt_ctf_stream_common *stream)
{
	BT_ASSERT(stream);
	return stream->stream_class;
}

static inline
const char *bt_ctf_stream_common_get_name(struct bt_ctf_stream_common *stream)
{
	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	return stream->name ? stream->name->str : NULL;
}

static inline
int64_t bt_ctf_stream_common_get_id(struct bt_ctf_stream_common *stream)
{
	int64_t ret;

	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	ret = stream->id;
	if (ret < 0) {
		BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
			stream, bt_ctf_stream_common_get_name(stream));
	}

	return ret;
}

struct bt_ctf_stream {
	struct bt_ctf_stream_common common;
	struct bt_ctf_field *packet_header;
	struct bt_ctf_field *packet_context;

	/* 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;
	uint64_t last_ts_end;
};

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

BT_HIDDEN
struct bt_ctf_stream *bt_ctf_stream_create_with_id(
		struct bt_ctf_stream_class *stream_class,
		const char *name, uint64_t id);

#endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */
Commit	Line	Data
3dca2276 PP	1	#ifndef BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
	2	#define BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
	3
	4	/*
	5	* BabelTrace - CTF Writer: Stream
	6	*
	7	* Copyright 2013, 2014 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	* The Common Trace Format (CTF) Specification is available at
	30	* http://www.efficios.com/ctf
	31	*/
	32
16ca5ff0	33	#include <babeltrace/assert-internal.h>
3dca2276	34	#include <babeltrace/assert-pre-internal.h>
16ca5ff0	35	#include <babeltrace/babeltrace-internal.h>
3dca2276	36	#include <babeltrace/babeltrace.h>
16ca5ff0 PP	37	#include <babeltrace/ctf-writer/serialize-internal.h>
	38	#include <babeltrace/ctf-writer/stream-internal.h>
	39	#include <babeltrace/ctf-writer/stream.h>
	40	#include <babeltrace/ctf-writer/utils-internal.h>
	41	#include <babeltrace/object-internal.h>
3dca2276 PP	42	#include <stdint.h>
3dca2276 PP	43
16ca5ff0 PP	44	struct bt_ctf_stream_common;
	45
	46	struct bt_ctf_stream_common {
	47	struct bt_object base;
	48	int64_t id;
	49	struct bt_ctf_stream_class_common *stream_class;
	50	GString *name;
	51	};
	52
	53	BT_HIDDEN
	54	int bt_ctf_stream_common_initialize(
	55	struct bt_ctf_stream_common *stream,
	56	struct bt_ctf_stream_class_common stream_class, const char name,
	57	uint64_t id, bt_object_release_func release_func);
	58
	59	BT_HIDDEN
	60	void bt_ctf_stream_common_finalize(struct bt_ctf_stream_common *stream);
	61
	62	static inline
	63	struct bt_ctf_stream_class_common *bt_ctf_stream_common_borrow_class(
	64	struct bt_ctf_stream_common *stream)
	65	{
	66	BT_ASSERT(stream);
	67	return stream->stream_class;
	68	}
	69
	70	static inline
	71	const char bt_ctf_stream_common_get_name(struct bt_ctf_stream_common stream)
	72	{
	73	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	74	return stream->name ? stream->name->str : NULL;
	75	}
	76
	77	static inline
	78	int64_t bt_ctf_stream_common_get_id(struct bt_ctf_stream_common *stream)
	79	{
	80	int64_t ret;
	81
	82	BT_ASSERT_PRE_NON_NULL(stream, "Stream");
	83	ret = stream->id;
	84	if (ret < 0) {
	85	BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
	86	stream, bt_ctf_stream_common_get_name(stream));
	87	}
	88
	89	return ret;
	90	}
	91
3dca2276	92	struct bt_ctf_stream {
16ca5ff0	93	struct bt_ctf_stream_common common;
3dca2276 PP	94	struct bt_ctf_field *packet_header;
	95	struct bt_ctf_field *packet_context;
	96
	97	/* Array of pointers to bt_ctf_event for the current packet */
	98	GPtrArray *events;
	99	struct bt_ctf_stream_pos pos;
	100	unsigned int flushed_packet_count;
	101	uint64_t discarded_events;
	102	uint64_t size;
	103	uint64_t last_ts_end;
	104	};
	105
	106	BT_HIDDEN
16ca5ff0	107	int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd);
3dca2276 PP	108
	109	BT_HIDDEN
	110	struct bt_ctf_stream *bt_ctf_stream_create_with_id(
	111	struct bt_ctf_stream_class *stream_class,
	112	const char *name, uint64_t id);
	113
	114	#endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */