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