X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Fstream-class.h;h=ca0b9ef954581a4b8a53b30b2675f68cae6f23ed;hp=2e2f3fb93f5678427a652d7774b12203dee4b2d0;hb=44c440bc5fe8219cc17d1b786d91fd83c4c9860a;hpb=adc315b840e3970b9f6e255c91e38ec29f05adab diff --git a/include/babeltrace/ctf-ir/stream-class.h b/include/babeltrace/ctf-ir/stream-class.h index 2e2f3fb9..ca0b9ef9 100644 --- a/include/babeltrace/ctf-ir/stream-class.h +++ b/include/babeltrace/ctf-ir/stream-class.h @@ -4,7 +4,7 @@ /* * BabelTrace - CTF IR: Stream Class * - * Copyright 2014 EfficiOS Inc. + * Copyright 2014 Jérémie Galarneau * * Author: Jérémie Galarneau * @@ -30,75 +30,115 @@ * http://www.efficios.com/ctf */ +#include + +/* For bt_bool */ +#include + #ifdef __cplusplus extern "C" { #endif -struct bt_ctf_event_class; -struct bt_ctf_stream_class; -struct bt_ctf_clock; +struct bt_trace; +struct bt_stream_class; +struct bt_event_class; +struct bt_clock_class; +struct bt_event_header_field; +struct bt_packet_context_field; -/* - * 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); +extern struct bt_stream_class *bt_stream_class_create(struct bt_trace *trace); -/* - * 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); +extern struct bt_stream_class *bt_stream_class_create_with_id( + struct bt_trace *trace, uint64_t id); -/* - * 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); +extern struct bt_trace *bt_stream_class_borrow_trace( + struct bt_stream_class *stream_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); +extern const char *bt_stream_class_get_name( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_name(struct bt_stream_class *stream_class, + const char *name); + +extern bt_bool bt_stream_class_assigns_automatic_event_class_id( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_assigns_automatic_event_class_id( + struct bt_stream_class *stream_class, bt_bool value); + +extern bt_bool bt_stream_class_assigns_automatic_stream_id( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_assigns_automatic_stream_id( + struct bt_stream_class *stream_class, bt_bool value); + +extern uint64_t bt_stream_class_get_id(struct bt_stream_class *stream_class); + +extern struct bt_field_type *bt_stream_class_borrow_packet_context_field_type( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_packet_context_field_type( + struct bt_stream_class *stream_class, + struct bt_field_type *field_type); + +extern struct bt_field_type * +bt_stream_class_borrow_event_header_field_type( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_event_header_field_type( + struct bt_stream_class *stream_class, + struct bt_field_type *field_type); + +extern struct bt_field_type * +bt_stream_class_borrow_event_common_context_field_type( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_event_common_context_field_type( + struct bt_stream_class *stream_class, + struct bt_field_type *field_type); + +extern uint64_t bt_stream_class_get_event_class_count( + struct bt_stream_class *stream_class); + +extern struct bt_event_class *bt_stream_class_borrow_event_class_by_index( + struct bt_stream_class *stream_class, uint64_t index); + +extern struct bt_event_class *bt_stream_class_borrow_event_class_by_id( + struct bt_stream_class *stream_class, uint64_t id); + +extern int bt_stream_class_set_default_clock_class( + struct bt_stream_class *stream_class, + struct bt_clock_class *clock_class); + +extern struct bt_clock_class *bt_stream_class_borrow_default_clock_class( + struct bt_stream_class *stream_class); + +extern bt_bool bt_stream_class_default_clock_is_always_known( + struct bt_stream_class *stream_class); + +extern bt_bool bt_stream_class_packets_have_discarded_event_counter_snapshot( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_packets_have_discarded_event_counter_snapshot( + struct bt_stream_class *stream_class, bt_bool value); + +extern bt_bool bt_stream_class_packets_have_packet_counter_snapshot( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_packets_have_packet_counter_snapshot( + struct bt_stream_class *stream_class, bt_bool value); + +extern bt_bool bt_stream_class_packets_have_default_beginning_clock_value( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_packets_have_default_beginning_clock_value( + struct bt_stream_class *stream_class, bt_bool value); + +extern bt_bool bt_stream_class_packets_have_default_end_clock_value( + struct bt_stream_class *stream_class); + +extern int bt_stream_class_set_packets_have_default_end_clock_value( + struct bt_stream_class *stream_class, bt_bool value); #ifdef __cplusplus }