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  * A stream class' packet context is a structure initialized with the following
  48  * fields:
  49  *      - uint64_t timestamp_begin
  50  *      - uint64_t timestamp_end
  51  *      - uint64_t content_size
  52  *      - uint64_t packet_size
  53  *      - uint64_t events_discarded
  54  *
  55  * A stream class's event header is a structure initialized the following
  56  * fields:
  57  *  - uint32_t id
  58  *  - uint64_t timestamp
  59  *
  60  * @param name Stream name, NULL to create an unnamed stream class.
  61  *
  62  * Returns an allocated stream class on success, NULL on error.
  63  */
  64 extern struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name);
  65
  66 /*
  67  * bt_ctf_stream_class_get_name: Get a stream class' name.
  68  *
  69  * @param stream_class Stream class.
  70  *
  71  * Returns the stream class' name, NULL on error.
  72  */
  73 extern const char *bt_ctf_stream_class_get_name(
  74                 struct bt_ctf_stream_class *stream_class);
  75
  76 /*
  77  * bt_ctf_stream_class_set_name: Set a stream class' name.
  78  *
  79  * @param stream_class Stream class.
  80  *
  81  * Returns 0 on success, a negative value on error.
  82  */
  83 extern int bt_ctf_stream_class_set_name(
  84                 struct bt_ctf_stream_class *stream_class, const char *name);
  85
  86 /*
  87  * bt_ctf_stream_class_get_clock: get the clock associated with a stream class.
  88  *
  89  * @param stream_class Stream class.
  90  *
  91  * Returns a clock instance, NULL on error.
  92  */
  93 extern struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
  94                 struct bt_ctf_stream_class *stream_class);
  95
  96 /*
  97  * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
  98  *
  99  * Assign a clock to a stream class. This clock will be sampled each time an
 100  * event is appended to an instance of this stream class.
 101  *
 102  * @param stream_class Stream class.
 103  * @param clock Clock to assign to the provided stream class.
 104  *
 105  * Returns 0 on success, a negative value on error.
 106  */
 107 extern int bt_ctf_stream_class_set_clock(
 108                 struct bt_ctf_stream_class *stream_class,
 109                 struct bt_ctf_clock *clock);
 110
 111 /*
 112  * bt_ctf_stream_class_get_id: Get a stream class' id.
 113  *
 114  * @param stream_class Stream class.
 115  *
 116  * Returns the stream class' id, a negative value on error.
 117  */
 118 extern int64_t bt_ctf_stream_class_get_id(
 119                 struct bt_ctf_stream_class *stream_class);
 120
 121 /*
 122  * bt_ctf_stream_class_set_id: Set a stream class' id.
 123  *
 124  * Set a stream class' id. Must be unique trace-wise.
 125  * Note that stream classes are assigned a unique id when a stream instance
 126  * is created for the first time from a trace or writer.
 127  *
 128  * @param stream_class Stream class.
 129  * @param id Stream class id.
 130  *
 131  * Returns 0 on success, a negative value on error.
 132  */
 133 extern int bt_ctf_stream_class_set_id(
 134                 struct bt_ctf_stream_class *stream_class, uint32_t id);
 135
 136 /*
 137  * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
 138  *
 139  * Add an event class to a stream class. New events can be added even after a
 140  * stream has beem instanciated and events have been appended. However, a stream
 141  * will not accept events of a class that has not been registered beforehand.
 142  * The stream class will share the ownership of "event_class" by incrementing
 143  * its reference count.
 144  *
 145  * Note that an event class may only be added to one stream class.
 146  *
 147  * @param stream_class Stream class.
 148  * @param event_class Event class to add to the provided stream class.
 149  *
 150  * Returns 0 on success, a negative value on error.
 151  */
 152 extern int bt_ctf_stream_class_add_event_class(
 153                 struct bt_ctf_stream_class *stream_class,
 154                 struct bt_ctf_event_class *event_class);
 155
 156 /*
 157  * bt_ctf_stream_class_get_event_class_count: Get a stream class' event class
 158  * count.
 159  *
 160  * @param stream_class Stream class.
 161  *
 162  * Returns the stream class' event count, a negative value on error.
 163  */
 164 extern int bt_ctf_stream_class_get_event_class_count(
 165                 struct bt_ctf_stream_class *stream_class);
 166
 167 /*
 168  * bt_ctf_stream_class_get_event_class: Get stream class event class by index.
 169  *
 170  * @param stream_class Stream class.
 171  * @param index Index of field.
 172  *
 173  * Returns event class, NULL on error.
 174  */
 175 extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class(
 176                 struct bt_ctf_stream_class *stream_class, int index);
 177
 178 /*
 179  * bt_ctf_stream_class_get_event_class_by_name: Get stream class event class by
 180  * name.
 181  *
 182  * @param stream_class Stream class.
 183  * @param name Event name.
 184  *
 185  * Returns event class, NULL on error.
 186  */
 187 extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_name(
 188                 struct bt_ctf_stream_class *stream_class, const char *name);
 189
 190 /*
 191  * bt_ctf_stream_class_get_packet_context_type: get the stream class' packet
 192  * context type.
 193  *
 194  * @param stream_class Stream class.
 195  *
 196  * Returns the packet context's type (a structure), NULL on error.
 197  */
 198 extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
 199                 struct bt_ctf_stream_class *stream_class);
 200
 201 /*
 202  * bt_ctf_stream_class_set_packet_context_type: set the stream class' packet
 203  * context type.
 204  *
 205  * @param stream_class Stream class.
 206  * @param packet_context_type Packet context type (must be a structure).
 207  *
 208  * Returns 0 on success, a negative value on error.
 209  */
 210 extern int bt_ctf_stream_class_set_packet_context_type(
 211                 struct bt_ctf_stream_class *stream_class,
 212                 struct bt_ctf_field_type *packet_context_type);
 213
 214 /*
 215  * bt_ctf_stream_class_get_event_header_type: get the stream class'
 216  * event header type.
 217  *
 218  * @param stream_class Stream class.
 219  *
 220  * Returns the stream event header's type (a structure), NULL on error.
 221  */
 222 extern struct bt_ctf_field_type *
 223 bt_ctf_stream_class_get_event_header_type(
 224                 struct bt_ctf_stream_class *stream_class);
 225
 226 /*
 227  * bt_ctf_stream_class_set_event_header_type: set the stream class'
 228  * event header type.
 229  *
 230  * @param stream_class Stream class.
 231  * @param event_header_type Event header type (must be a structure).
 232  *
 233  * Returns 0 on success, a negative value on error.
 234  */
 235 extern int bt_ctf_stream_class_set_event_header_type(
 236                 struct bt_ctf_stream_class *stream_class,
 237                 struct bt_ctf_field_type *event_header_type);
 238
 239 /*
 240  * bt_ctf_stream_class_get_event_context_type: get the stream class'
 241  * event context type.
 242  *
 243  * @param stream_class Stream class.
 244  *
 245  * Returns the stream event context's type (a structure), NULL on error.
 246  */
 247 extern struct bt_ctf_field_type *
 248 bt_ctf_stream_class_get_event_context_type(
 249                 struct bt_ctf_stream_class *stream_class);
 250
 251 /*
 252  * bt_ctf_stream_class_set_event_context_type: set the stream class'
 253  * event context type.
 254  *
 255  * @param stream_class Stream class.
 256  * @param event_context_type Event context type (must be a structure).
 257  *
 258  * Returns 0 on success, a negative value on error.
 259  */
 260 extern int bt_ctf_stream_class_set_event_context_type(
 261                 struct bt_ctf_stream_class *stream_class,
 262                 struct bt_ctf_field_type *event_context_type);
 263
 264 /*
 265  * bt_ctf_stream_class_get and bt_ctf_stream_class_put: increment and
 266  * decrement the stream class' reference count.
 267  *
 268  * These functions ensure that the stream class won't be destroyed while it
 269  * is in use. The same number of get and put (plus one extra put to
 270  * release the initial reference done at creation) have to be done to
 271  * destroy a stream class.
 272  *
 273  * When the stream class' reference count is decremented to 0 by a
 274  * bt_ctf_stream_class_put, the stream class is freed.
 275  *
 276  * @param stream_class Stream class.
 277  */
 278 extern void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class);
 279 extern void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class);
 280
 281 #ifdef __cplusplus
 282 }
 283 #endif
 284
 285 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */