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

#ifndef BABELTRACE_CTF_WRITER_STREAM_H
#define BABELTRACE_CTF_WRITER_STREAM_H

/*
 * BabelTrace - CTF Writer: Stream
 *
 * Copyright 2013 EfficiOS Inc.
 *
 * 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
 */

#ifdef __cplusplus
extern "C" {
#endif

struct bt_ctf_event;
struct bt_ctf_event_class;
struct bt_ctf_stream_class;
struct bt_ctf_stream;
struct bt_ctf_clock;

/*
 * bt_ctf_stream_class_create: create a stream class.
 *
 * Allocate a new stream class of the given name. The creation of an event class
 * sets its reference count to 1.
 *
 * @param name Stream name.
 *
 * Returns an allocated stream class on success, NULL on error.
 */
extern struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name);

/*
 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
 *
 * Assign a clock to a stream class. This clock will be sampled each time an
 * event is appended to an instance of this stream class.
 *
 * @param stream_class Stream class.
 * @param clock Clock to assign to the provided stream class.
 *
 * Returns 0 on success, a negative value on error.
 */
extern int bt_ctf_stream_class_set_clock(
		struct bt_ctf_stream_class *stream_class,
		struct bt_ctf_clock *clock);

/*
 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
 *
 * Add an event class to a stream class. New events can be added even after a
 * stream has beem instanciated and events have been appended. However, a stream
 * will not accept events of a class that has not been registered beforehand.
 * The stream class will share the ownership of "event_class" by incrementing
 * its reference count.
 *
 * @param stream_class Stream class.
 * @param event_class Event class to add to the provided stream class.
 *
 * Returns 0 on success, a negative value on error.
 */
extern int bt_ctf_stream_class_add_event_class(
		struct bt_ctf_stream_class *stream_class,
		struct bt_ctf_event_class *event_class);

/*
 * bt_ctf_stream_class_get and bt_ctf_stream_class_put: increment and
 * decrement the stream class' reference count.
 *
 * These functions ensure that the stream class won't be destroyed while it
 * is in use. The same number of get and put (plus one extra put to
 * release the initial reference done at creation) have to be done to
 * destroy a stream class.
 *
 * When the stream class' reference count is decremented to 0 by a
 * bt_ctf_stream_class_put, the stream class is freed.
 *
 * @param stream_class Stream class.
 */
extern void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class);
extern void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class);

/*
 * bt_ctf_stream_append_discarded_events: increment discarded events count.
 *
 * Increase the current packet's discarded event count.
 *
 * @param stream Stream instance.
 * @param event_count Number of discarded events to add to the stream's current
 *	packet.
 */
extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
		uint64_t event_count);

/*
 * bt_ctf_stream_append_event: append an event to the stream.
 *
 * Append "event" to the stream's current packet. The stream's associated clock
 * will be sampled during this call. The event shall not be modified after
 * being appended to a stream. The stream will share the event's ownership by
 * incrementing its reference count. The current packet is not flushed to disk
 * until the next call to bt_ctf_stream_flush.
 *
 * @param stream Stream instance.
 * @param event Event instance to append to the stream's current packet.
 *
 * Returns 0 on success, a negative value on error.
 */
extern int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
		struct bt_ctf_event *event);

/*
 * bt_ctf_stream_flush: flush a stream.
 *
 * The stream's current packet's events will be flushed to disk. Events
 * subsequently appended to the stream will be added to a new packet.
 *
 * @param stream Stream instance.
 *
 * Returns 0 on success, a negative value on error.
 */
extern int bt_ctf_stream_flush(struct bt_ctf_stream *stream);

/*
 * bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
 * stream's reference count.
 *
 * These functions ensure that the stream won't be destroyed while it
 * is in use. The same number of get and put (plus one extra put to
 * release the initial reference done at creation) have to be done to
 * destroy a stream.
 *
 * When the stream's reference count is decremented to 0 by a
 * bt_ctf_stream_put, the stream is freed.
 *
 * @param stream Stream instance.
 */
extern void bt_ctf_stream_get(struct bt_ctf_stream *stream);
extern void bt_ctf_stream_put(struct bt_ctf_stream *stream);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_CTF_WRITER_STREAM_H */
Commit	Line	Data
46bd0f2b JG	1	#ifndef BABELTRACE_CTF_WRITER_STREAM_H
	2	#define BABELTRACE_CTF_WRITER_STREAM_H
	3
	4	/*
	5	* BabelTrace - CTF Writer: Stream
	6	*
	7	* Copyright 2013 EfficiOS Inc.
	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
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
	37	struct bt_ctf_event;
	38	struct bt_ctf_event_class;
	39	struct bt_ctf_stream_class;
	40	struct bt_ctf_stream;
	41	struct bt_ctf_clock;
	42
	43	/*
	44	* bt_ctf_stream_class_create: create a stream class.
	45	*
	46	* Allocate a new stream class of the given name. The creation of an event class
	47	* sets its reference count to 1.
	48	*
	49	* @param name Stream name.
	50	*
	51	* Returns an allocated stream class on success, NULL on error.
	52	*/
	53	extern struct bt_ctf_stream_class bt_ctf_stream_class_create(const char name);
	54
	55	/*
	56	* bt_ctf_stream_class_set_clock: assign a clock to a stream class.
	57	*
	58	* Assign a clock to a stream class. This clock will be sampled each time an
	59	* event is appended to an instance of this stream class.
	60	*
	61	* @param stream_class Stream class.
	62	* @param clock Clock to assign to the provided stream class.
	63	*
	64	* Returns 0 on success, a negative value on error.
65	*/
66	extern int bt_ctf_stream_class_set_clock(
67	struct bt_ctf_stream_class *stream_class,
68	struct bt_ctf_clock *clock);
69
70	/*
71	* bt_ctf_stream_class_set_clock: assign a clock to a stream class.
72	*
73	* Add an event class to a stream class. New events can be added even after a
74	* stream has beem instanciated and events have been appended. However, a stream
75	* will not accept events of a class that has not been registered beforehand.
76	* The stream class will share the ownership of "event_class" by incrementing
77	* its reference count.
78	*
79	* @param stream_class Stream class.
80	* @param event_class Event class to add to the provided stream class.
81	*
82	* Returns 0 on success, a negative value on error.
83	*/
84	extern int bt_ctf_stream_class_add_event_class(
85	struct bt_ctf_stream_class *stream_class,
86	struct bt_ctf_event_class *event_class);
87
88	/*
89	* bt_ctf_stream_class_get and bt_ctf_stream_class_put: increment and
90	* decrement the stream class' reference count.
91	*
92	* These functions ensure that the stream class won't be destroyed while it
93	* is in use. The same number of get and put (plus one extra put to
94	* release the initial reference done at creation) have to be done to
95	* destroy a stream class.
96	*
97	* When the stream class' reference count is decremented to 0 by a
98	* bt_ctf_stream_class_put, the stream class is freed.
99	*
100	* @param stream_class Stream class.
101	*/
102	extern void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class);
103	extern void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class);
104
105	/*
106	* bt_ctf_stream_append_discarded_events: increment discarded events count.
107	*
108	* Increase the current packet's discarded event count.
109	*
110	* @param stream Stream instance.
111	* @param event_count Number of discarded events to add to the stream's current
112	* packet.
46bd0f2b JG	113	*/
	114	extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
	115	uint64_t event_count);
	116
	117	/*
	118	* bt_ctf_stream_append_event: append an event to the stream.
	119	*
	120	* Append "event" to the stream's current packet. The stream's associated clock
	121	* will be sampled during this call. The event shall not be modified after
	122	* being appended to a stream. The stream will share the event's ownership by
	123	* incrementing its reference count. The current packet is not flushed to disk
	124	* until the next call to bt_ctf_stream_flush.
	125	*
	126	* @param stream Stream instance.
	127	* @param event Event instance to append to the stream's current packet.
	128	*
	129	* Returns 0 on success, a negative value on error.
	130	*/
	131	extern int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
	132	struct bt_ctf_event *event);
	133
	134	/*
	135	* bt_ctf_stream_flush: flush a stream.
	136	*
	137	* The stream's current packet's events will be flushed to disk. Events
	138	* subsequently appended to the stream will be added to a new packet.
	139	*
	140	* @param stream Stream instance.
	141	*
	142	* Returns 0 on success, a negative value on error.
	143	*/
	144	extern int bt_ctf_stream_flush(struct bt_ctf_stream *stream);
	145
	146	/*
	147	* bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
	148	* stream's reference count.
	149	*
	150	* These functions ensure that the stream won't be destroyed while it
	151	* is in use. The same number of get and put (plus one extra put to
	152	* release the initial reference done at creation) have to be done to
	153	* destroy a stream.
	154	*
	155	* When the stream's reference count is decremented to 0 by a
	156	* bt_ctf_stream_put, the stream is freed.
	157	*
	158	* @param stream Stream instance.
	159	*/
	160	extern void bt_ctf_stream_get(struct bt_ctf_stream *stream);
	161	extern void bt_ctf_stream_put(struct bt_ctf_stream *stream);
	162
	163	#ifdef __cplusplus
	164	}
	165	#endif
	166
	167	#endif /* BABELTRACE_CTF_WRITER_STREAM_H */