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-ir/trace-internal.h>
  37 #include <assert.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         /* event class id (int64_t) to event class */
  46         GHashTable *event_classes_ht;
  47         int id_set;
  48         uint32_t id;
  49         uint32_t next_event_id;
  50         uint32_t next_stream_id;
  51         struct bt_ctf_field_type *packet_context_type;
  52         struct bt_ctf_field_type *event_header_type;
  53         struct bt_ctf_field_type *event_context_type;
  54         int frozen;
  55         int byte_order;
  56
  57         /*
  58          * This flag indicates if the stream class is valid. A valid
  59          * stream class is _always_ frozen.
  60          */
  61         int valid;
  62 };
  63
  64 BT_HIDDEN
  65 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class *stream_class);
  66
  67 BT_HIDDEN
  68 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class *stream_class,
  69                 struct metadata_context *context);
  70
  71 BT_HIDDEN
  72 void bt_ctf_stream_class_set_byte_order(
  73                 struct bt_ctf_stream_class *stream_class, int byte_order);
  74
  75 /* Set stream_class id without checking if the stream class is frozen */
  76 BT_HIDDEN
  77 int _bt_ctf_stream_class_set_id(struct bt_ctf_stream_class *stream_class,
  78                 uint32_t id);
  79
  80 BT_HIDDEN
  81 int bt_ctf_stream_class_set_id_no_check(
  82                 struct bt_ctf_stream_class *stream_class, uint32_t id);
  83
  84 static inline
  85 struct bt_ctf_trace *bt_ctf_stream_class_borrow_trace(
  86                 struct bt_ctf_stream_class *stream_class)
  87 {
  88         assert(stream_class);
  89         return (void *) bt_object_borrow_parent(stream_class);
  90 }
  91
  92 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H */