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_get_id: Get a stream class' id.
 110  *
 111  * @param stream_class Stream class.
 112  *
 113  * Returns the stream class' id, a negative value on error.
 114  */
 115 extern int64_t bt_ctf_stream_class_get_id(
 116                 struct bt_ctf_stream_class *stream_class);
 117
 118 /*
 119  * bt_ctf_stream_class_set_id: Set a stream class' id.
 120  *
 121  * Set a stream class' id. Must be unique trace-wise.
 122  * Note that stream classes are assigned a unique id when a stream instance
 123  * is created for the first time from a trace or writer.
 124  *
 125  * @param stream_class Stream class.
 126  * @param id Stream class id.
 127  *
 128  * Returns 0 on success, a negative value on error.
 129  */
 130 extern int bt_ctf_stream_class_set_id(
 131                 struct bt_ctf_stream_class *stream_class, uint32_t id);
 132
 133 /*
 134  * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
 135  *
 136  * Add an event class to a stream class. New events can be added even after a
 137  * stream has beem instanciated and events have been appended. However, a stream
 138  * will not accept events of a class that has not been registered beforehand.
 139  * The stream class will share the ownership of "event_class" by incrementing
 140  * its reference count.
 141  *
 142  * Note that an event class may only be added to one stream class. It
 143  * also becomes immutable.
 144  *
 145  * @param stream_class Stream class.
 146  * @param event_class Event class to add to the provided stream class.
 147  *
 148  * Returns 0 on success, a negative value on error.
 149  */
 150 extern int bt_ctf_stream_class_add_event_class(
 151                 struct bt_ctf_stream_class *stream_class,
 152                 struct bt_ctf_event_class *event_class);
 153
 154 /*
 155  * bt_ctf_stream_class_get_event_class_count: Get a stream class' event class
 156  * count.
 157  *
 158  * @param stream_class Stream class.
 159  *
 160  * Returns the stream class' event count, a negative value on error.
 161  */
 162 extern int bt_ctf_stream_class_get_event_class_count(
 163                 struct bt_ctf_stream_class *stream_class);
 164
 165 /*
 166  * bt_ctf_stream_class_get_event_class: Get stream class event class by index.
 167  *
 168  * @param stream_class Stream class.
 169  * @param index Index of field.
 170  *
 171  * Returns event class, NULL on error.
 172  */
 173 extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class(
 174                 struct bt_ctf_stream_class *stream_class, int index);
 175
 176 /*
 177  * bt_ctf_stream_class_get_event_class_by_name: Get stream class event class by
 178  * name.
 179  *
 180  * @param stream_class Stream class.
 181  * @param name Event name.
 182  *
 183  * Returns event class, NULL on error.
 184  */
 185 extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_name(
 186                 struct bt_ctf_stream_class *stream_class, const char *name);
 187
 188 /*
 189  * bt_ctf_stream_class_get_event_class_by_name: Get stream class event class by
 190  * ID.
 191  *
 192  * @param stream_class Stream class.
 193  * @param id Event class ID.
 194  *
 195  * Returns event class, NULL on error.
 196  */
 197 extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_id(
 198                 struct bt_ctf_stream_class *stream_class, uint32_t id);
 199
 200 /*
 201  * bt_ctf_stream_class_get_packet_context_type: get the stream class' packet
 202  * context type.
 203  *
 204  * @param stream_class Stream class.
 205  *
 206  * Returns the packet context's type (a structure), NULL on error.
 207  */
 208 extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
 209                 struct bt_ctf_stream_class *stream_class);
 210
 211 /*
 212  * bt_ctf_stream_class_set_packet_context_type: set the stream class' packet
 213  * context type.
 214  *
 215  * @param stream_class Stream class.
 216  * @param packet_context_type Packet context type (must be a structure).
 217  *
 218  * Returns 0 on success, a negative value on error.
 219  */
 220 extern int bt_ctf_stream_class_set_packet_context_type(
 221                 struct bt_ctf_stream_class *stream_class,
 222                 struct bt_ctf_field_type *packet_context_type);
 223
 224 /*
 225  * bt_ctf_stream_class_get_event_header_type: get the stream class'
 226  * event header type.
 227  *
 228  * @param stream_class Stream class.
 229  *
 230  * Returns the stream event header's type (a structure), NULL on error.
 231  */
 232 extern struct bt_ctf_field_type *
 233 bt_ctf_stream_class_get_event_header_type(
 234                 struct bt_ctf_stream_class *stream_class);
 235
 236 /*
 237  * bt_ctf_stream_class_set_event_header_type: set the stream class'
 238  * event header type.
 239  *
 240  * @param stream_class Stream class.
 241  * @param event_header_type Event header type (must be a structure).
 242  *
 243  * Returns 0 on success, a negative value on error.
 244  */
 245 extern int bt_ctf_stream_class_set_event_header_type(
 246                 struct bt_ctf_stream_class *stream_class,
 247                 struct bt_ctf_field_type *event_header_type);
 248
 249 /*
 250  * bt_ctf_stream_class_get_event_context_type: get the stream class'
 251  * event context type.
 252  *
 253  * @param stream_class Stream class.
 254  *
 255  * Returns the stream event context's type (a structure), NULL on error.
 256  */
 257 extern struct bt_ctf_field_type *
 258 bt_ctf_stream_class_get_event_context_type(
 259                 struct bt_ctf_stream_class *stream_class);
 260
 261 /*
 262  * bt_ctf_stream_class_set_event_context_type: set the stream class'
 263  * event context type.
 264  *
 265  * @param stream_class Stream class.
 266  * @param event_context_type Event context type (must be a structure).
 267  *
 268  * Returns 0 on success, a negative value on error.
 269  */
 270 extern int bt_ctf_stream_class_set_event_context_type(
 271                 struct bt_ctf_stream_class *stream_class,
 272                 struct bt_ctf_field_type *event_context_type);
 273
 274 #ifdef __cplusplus
 275 }
 276 #endif
 277
 278 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */