include/babeltrace/ctf-ir/stream-class.h

   1 #ifndef BABELTRACE_CTF_IR_STREAM_CLASS_H
   2 #define BABELTRACE_CTF_IR_STREAM_CLASS_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Stream Class
   6  *
   7  * Copyright 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
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct bt_ctf_event_class;
  38 struct bt_ctf_stream_class;
  39 struct bt_ctf_clock;
  40
  41 /*
  42  * bt_ctf_stream_class_create: create a stream class.
  43  *
  44  * Allocate a new stream class of the given name. The creation of an event class
  45  * sets its reference count to 1.
  46  *
  47  * @param name Stream name.
  48  *
  49  * Returns an allocated stream class on success, NULL on error.
  50  */
  51 extern struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name);
  52
  53 /*
  54  * bt_ctf_stream_class_get_name: Get a stream class' name.
  55  *
  56  * @param stream_class Stream class.
  57  *
  58  * Returns the stream class' name, NULL on error.
  59  */
  60 extern const char *bt_ctf_stream_class_get_name(
  61                 struct bt_ctf_stream_class *stream_class);
  62
  63 /*
  64  * bt_ctf_stream_class_get_clock: get the clock associated with a stream class.
  65  *
  66  * @param stream_class Stream class.
  67  *
  68  * Returns a clock instance, NULL on error.
  69  */
  70 extern struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
  71                 struct bt_ctf_stream_class *stream_class);
  72
  73 /*
  74  * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
  75  *
  76  * Assign a clock to a stream class. This clock will be sampled each time an
  77  * event is appended to an instance of this stream class.
  78  *
  79  * @param stream_class Stream class.
  80  * @param clock Clock to assign to the provided stream class.
  81  *
  82  * Returns 0 on success, a negative value on error.
  83  */
  84 extern int bt_ctf_stream_class_set_clock(
  85                 struct bt_ctf_stream_class *stream_class,
  86                 struct bt_ctf_clock *clock);
  87
  88 /*
  89  * bt_ctf_stream_class_get_id: Get a stream class' id.
  90  *
  91  * @param stream_class Stream class.
  92  *
  93  * Returns the stream class' id, a negative value on error.
  94  */
  95 extern int64_t bt_ctf_stream_class_get_id(
  96                 struct bt_ctf_stream_class *stream_class);
  97
  98 /*
  99  * bt_ctf_stream_class_set_id: Set a stream class' id.
 100  *
 101  * Set a stream class' id. Must be unique trace-wise.
 102  * Note that stream classes are assigned a unique id when a stream instance
 103  * is created for the first time from a trace or writer.
 104  *
 105  * @param stream_class Stream class.
 106  * @param id Stream class id.
 107  *
 108  * Returns 0 on success, a negative value on error.
 109  */
 110 extern int bt_ctf_stream_class_set_id(
 111                 struct bt_ctf_stream_class *stream_class, uint32_t id);
 112
 113 /*
 114  * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
 115  *
 116  * Add an event class to a stream class. New events can be added even after a
 117  * stream has beem instanciated and events have been appended. However, a stream
 118  * will not accept events of a class that has not been registered beforehand.
 119  * The stream class will share the ownership of "event_class" by incrementing
 120  * its reference count.
 121  *
 122  * @param stream_class Stream class.
 123  * @param event_class Event class to add to the provided stream class.
 124  *
 125  * Returns 0 on success, a negative value on error.
 126  */
 127 extern int bt_ctf_stream_class_add_event_class(
 128                 struct bt_ctf_stream_class *stream_class,
 129                 struct bt_ctf_event_class *event_class);
 130
 131 /*
 132  * bt_ctf_stream_class_get_event_class_count: Get a stream class' event class
 133  * count.
 134  *
 135  * @param stream_class Stream class.
 136  *
 137  * Returns the stream class' event count, a negative value on error.
 138  */
 139 extern int64_t bt_ctf_stream_class_get_event_class_count(
 140                 struct bt_ctf_stream_class *stream_class);
 141
 142 /*
 143  * bt_ctf_stream_class_get_event_class: Get stream class event class by index.
 144  *
 145  * @param stream_class Stream class.
 146  * @param index Index of field.
 147  *
 148  * Returns event class, NULL on error.
 149  */
 150 extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class(
 151                 struct bt_ctf_stream_class *stream_class, size_t index);
 152
 153 /*
 154  * bt_ctf_stream_class_get_event_class_by_name: Get stream class event class by
 155  * name.
 156  *
 157  * @param stream_class Stream class.
 158  * @param name Event name.
 159  *
 160  * Returns event class, NULL on error.
 161  */
 162 extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_name(
 163                 struct bt_ctf_stream_class *stream_class, const char *name);
 164
 165 /*
 166  * bt_ctf_stream_class_get and bt_ctf_stream_class_put: increment and
 167  * decrement the stream class' reference count.
 168  *
 169  * These functions ensure that the stream class won't be destroyed while it
 170  * is in use. The same number of get and put (plus one extra put to
 171  * release the initial reference done at creation) have to be done to
 172  * destroy a stream class.
 173  *
 174  * When the stream class' reference count is decremented to 0 by a
 175  * bt_ctf_stream_class_put, the stream class is freed.
 176  *
 177  * @param stream_class Stream class.
 178  */
 179 extern void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class);
 180 extern void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class);
 181
 182 #ifdef __cplusplus
 183 }
 184 #endif
 185
 186 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */