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