include/babeltrace/ctf-writer/stream-internal.h

   1 #ifndef BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
   2 #define BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF Writer: Stream internal
   6  *
   7  * Copyright 2013 EfficiOS Inc.
   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/ref-internal.h>
  31 #include <babeltrace/ctf-writer/clock.h>
  32 #include <babeltrace/ctf-writer/event-fields.h>
  33 #include <babeltrace/ctf-writer/event-types.h>
  34 #include <babeltrace/babeltrace-internal.h>
  35 #include <babeltrace/ctf/types.h>
  36 #include <glib.h>
  37
  38 typedef void(*flush_func)(struct bt_ctf_stream *, void *);
  39
  40 struct bt_ctf_stream_class {
  41         struct bt_ctf_ref ref_count;
  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 *event_header_type;
  50         struct bt_ctf_field *event_header;
  51         struct bt_ctf_field_type *packet_context_type;
  52         struct bt_ctf_field *packet_context;
  53         struct bt_ctf_field_type *event_context_type;
  54         struct bt_ctf_field *event_context;
  55         int frozen;
  56 };
  57
  58 struct flush_callback {
  59         flush_func func;
  60         void *data;
  61 };
  62
  63 struct bt_ctf_stream {
  64         struct bt_ctf_ref ref_count;
  65         uint32_t id;
  66         struct bt_ctf_stream_class *stream_class;
  67         struct flush_callback flush;
  68         /* Array of pointers to bt_ctf_event for the current packet */
  69         GPtrArray *events;
  70         struct ctf_stream_pos pos;
  71         unsigned int flushed_packet_count;
  72         uint64_t events_discarded;
  73 };
  74
  75 BT_HIDDEN
  76 void bt_ctf_stream_class_freeze(struct bt_ctf_stream_class *stream_class);
  77
  78 BT_HIDDEN
  79 int bt_ctf_stream_class_set_id(struct bt_ctf_stream_class *stream_class,
  80                 uint32_t id);
  81
  82 BT_HIDDEN
  83 int bt_ctf_stream_class_serialize(struct bt_ctf_stream_class *stream_class,
  84                 struct metadata_context *context);
  85
  86 BT_HIDDEN
  87 int bt_ctf_stream_class_set_byte_order(struct bt_ctf_stream_class *stream_class,
  88                 enum bt_ctf_byte_order byte_order);
  89
  90 BT_HIDDEN
  91 struct bt_ctf_stream *bt_ctf_stream_create(
  92                 struct bt_ctf_stream_class *stream_class);
  93
  94 BT_HIDDEN
  95 int bt_ctf_stream_set_flush_callback(struct bt_ctf_stream *stream,
  96                 flush_func callback, void *data);
  97
  98 BT_HIDDEN
  99 int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd);
 100
 101 #endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */