include/babeltrace/ctf-ir/stream-class-internal.h

   1 #ifndef BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Stream class internal
   6  *
   7  * Copyright 2013, 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
  30 #include <babeltrace/ctf-writer/clock.h>
  31 #include <babeltrace/ctf-writer/event-fields.h>
  32 #include <babeltrace/ctf-writer/event-types.h>
  33 #include <babeltrace/ctf-ir/trace.h>
  34 #include <babeltrace/object-internal.h>
  35 #include <babeltrace/babeltrace-internal.h>
  36 #include <babeltrace/ctf/types.h>
  37 #include <babeltrace/ctf-ir/trace-internal.h>
  38 #include <glib.h>
  39
  40 struct bt_ctf_stream_class {
  41         struct bt_object base;
  42         GString *name;
  43         struct bt_ctf_clock *clock;
  44         GPtrArray *event_classes; /* Array of pointers to bt_ctf_event_class */
  45         int id_set;
  46         uint32_t id;
  47         uint32_t next_event_id;
  48         uint32_t next_stream_id;
  49         struct bt_ctf_field_type *packet_context_type;
  50         struct bt_ctf_field_type *event_header_type;
  51         struct bt_ctf_field_type *event_context_type;
  52         int frozen;
  53         int byte_order;
  54
  55         /*
  56          * This flag indicates if the stream class is valid. A valid
  57          * stream class is _always_ frozen.
  58          */
  59         int valid;
  60 };
  61
  62 BT_HIDDEN
  63 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class *stream_class);
  64
  65 BT_HIDDEN
  66 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class *stream_class,
  67                 struct metadata_context *context);
  68
  69 BT_HIDDEN
  70 void bt_ctf_stream_class_set_byte_order(
  71                 struct bt_ctf_stream_class *stream_class, int byte_order);
  72
  73 /* Set stream_class id without checking if the stream class is frozen */
  74 BT_HIDDEN
  75 int _bt_ctf_stream_class_set_id(struct bt_ctf_stream_class *stream_class,
  76                 uint32_t id);
  77
  78 BT_HIDDEN
  79 int bt_ctf_stream_class_set_id_no_check(
  80                 struct bt_ctf_stream_class *stream_class, uint32_t id);
  81
  82 /*
  83  * bt_ctf_stream_class_get_trace: Get a stream class' associated trace.
  84  *
  85  * @param stream_class Stream class.
  86  *
  87  * Returns the stream class' associated trace, NULL on error.
  88  */
  89 BT_HIDDEN
  90 struct bt_ctf_trace *bt_ctf_stream_class_get_trace(
  91                 struct bt_ctf_stream_class *stream_class);
  92
  93 /*
  94  * bt_ctf_stream_class_get_name: Get a stream class' name.
  95  *
  96  * @param stream_class Stream class.
  97  *
  98  * Returns the stream class' name, NULL on error.
  99  */
 100 BT_HIDDEN
 101 const char *bt_ctf_stream_class_get_name(
 102                 struct bt_ctf_stream_class *stream_class);
 103
 104 /*
 105  * bt_ctf_stream_class_set_name: Set a stream class' name.
 106  *
 107  * @param stream_class Stream class.
 108  *
 109  * Returns 0 on success, a negative value on error.
 110  */
 111 BT_HIDDEN
 112 int bt_ctf_stream_class_set_name(struct bt_ctf_stream_class *stream_class,
 113                 const char *name);
 114
 115 /*
 116  * bt_ctf_stream_class_get_clock: get the clock associated with a stream class.
 117  *
 118  * @param stream_class Stream class.
 119  *
 120  * Returns a clock instance, NULL on error.
 121  */
 122 BT_HIDDEN
 123 struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
 124                 struct bt_ctf_stream_class *stream_class);
 125
 126 /*
 127  * bt_ctf_stream_class_get_id: Get a stream class' id.
 128  *
 129  * @param stream_class Stream class.
 130  *
 131  * Returns the stream class' id, a negative value on error.
 132  */
 133 BT_HIDDEN
 134 int64_t bt_ctf_stream_class_get_id(
 135                 struct bt_ctf_stream_class *stream_class);
 136
 137 /*
 138  * bt_ctf_stream_class_set_id: Set a stream class' id.
 139  *
 140  * Set a stream class' id. Must be unique trace-wise.
 141  * Note that stream classes are assigned a unique id when a stream instance
 142  * is created for the first time from a trace or writer.
 143  *
 144  * @param stream_class Stream class.
 145  * @param id Stream class id.
 146  *
 147  * Returns 0 on success, a negative value on error.
 148  */
 149 BT_HIDDEN
 150 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class *stream_class,
 151                 uint32_t id);
 152
 153 /*
 154  * bt_ctf_stream_class_get_event_class_count: Get a stream class' event class
 155  * count.
 156  *
 157  * @param stream_class Stream class.
 158  *
 159  * Returns the stream class' event count, a negative value on error.
 160  */
 161 BT_HIDDEN
 162 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 BT_HIDDEN
 174 struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class(
 175                 struct bt_ctf_stream_class *stream_class, int index);
 176
 177 /*
 178  * bt_ctf_stream_class_get_event_class_by_name: Get stream class event class by
 179  * name.
 180  *
 181  * @param stream_class Stream class.
 182  * @param name Event name.
 183  *
 184  * Returns event class, NULL on error.
 185  */
 186 BT_HIDDEN
 187 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_event_class_by_name: Get stream class event class by
 192  * ID.
 193  *
 194  * @param stream_class Stream class.
 195  * @param id Event class ID.
 196  *
 197  * Returns event class, NULL on error.
 198  */
 199 BT_HIDDEN
 200 struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_id(
 201                 struct bt_ctf_stream_class *stream_class, uint32_t id);
 202
 203 /*
 204  * bt_ctf_stream_class_set_packet_context_type: set the stream class' packet
 205  * context type.
 206  *
 207  * @param stream_class Stream class.
 208  * @param packet_context_type Packet context type (must be a structure).
 209  *
 210  * Returns 0 on success, a negative value on error.
 211  */
 212 BT_HIDDEN
 213 int bt_ctf_stream_class_set_packet_context_type(
 214                 struct bt_ctf_stream_class *stream_class,
 215                 struct bt_ctf_field_type *packet_context_type);
 216
 217 /*
 218  * bt_ctf_stream_class_get_event_header_type: get the stream class'
 219  * event header type.
 220  *
 221  * @param stream_class Stream class.
 222  *
 223  * Returns the stream event header's type (a structure), NULL on error.
 224  */
 225 BT_HIDDEN
 226 struct bt_ctf_field_type *bt_ctf_stream_class_get_event_header_type(
 227                 struct bt_ctf_stream_class *stream_class);
 228
 229 /*
 230  * bt_ctf_stream_class_set_event_header_type: set the stream class'
 231  * event header type.
 232  *
 233  * @param stream_class Stream class.
 234  * @param event_header_type Event header type (must be a structure).
 235  *
 236  * Returns 0 on success, a negative value on error.
 237  */
 238 BT_HIDDEN
 239 int bt_ctf_stream_class_set_event_header_type(
 240                 struct bt_ctf_stream_class *stream_class,
 241                 struct bt_ctf_field_type *event_header_type);
 242
 243 /*
 244  * bt_ctf_stream_class_get_event_context_type: get the stream class'
 245  * event context type.
 246  *
 247  * @param stream_class Stream class.
 248  *
 249  * Returns the stream event context's type (a structure), NULL on error.
 250  */
 251 BT_HIDDEN
 252 struct bt_ctf_field_type *bt_ctf_stream_class_get_event_context_type(
 253                 struct bt_ctf_stream_class *stream_class);
 254
 255 /*
 256  * bt_ctf_stream_class_set_event_context_type: set the stream class'
 257  * event context type.
 258  *
 259  * @param stream_class Stream class.
 260  * @param event_context_type Event context type (must be a structure).
 261  *
 262  * Returns 0 on success, a negative value on error.
 263  */
 264 BT_HIDDEN
 265 int bt_ctf_stream_class_set_event_context_type(
 266                 struct bt_ctf_stream_class *stream_class,
 267                 struct bt_ctf_field_type *event_context_type);
 268
 269 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H */