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