include/babeltrace/ctf-ir/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, 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-ir/stream.h>
  31 #include <babeltrace/object-internal.h>
  32 #include <babeltrace/ctf-writer/clock.h>
  33 #include <babeltrace/ctf-writer/event-fields.h>
  34 #include <babeltrace/ctf-writer/event-types.h>
  35 #include <babeltrace/ctf-writer/serialize-internal.h>
  36 #include <babeltrace/babeltrace-internal.h>
  37 #include <glib.h>
  38
  39 struct bt_port;
  40 struct bt_component;
  41
  42 typedef void (*bt_stream_destroy_listener_func)(
  43                 struct bt_stream *stream, void *data);
  44
  45 struct bt_stream_destroy_listener {
  46         bt_stream_destroy_listener_func func;
  47         void *data;
  48 };
  49
  50 struct bt_stream {
  51         struct bt_object base;
  52         int64_t id;
  53         struct bt_stream_class *stream_class;
  54         GString *name;
  55         struct bt_field *packet_header;
  56         struct bt_field *packet_context;
  57
  58         /*
  59          * When a notification which contains a reference to a stream
  60          * object (event notification, for example) is returned by the
  61          * "next" method of a sink or filter component's notification
  62          * iterator, it must NOT be returned by the "next" method of a
  63          * notification iterator which iterates on the notifications of
  64          * another output port of the same component.
  65          *
  66          * To ensure this, the stream object keeps a hash table which
  67          * indicates which port, for a given component, is currently
  68          * allowed to emit notifications which contain a reference to
  69          * this stream.
  70          *
  71          * This is a `struct bt_component *` to `struct bt_port *` hash
  72          * table. Both pointers are weak references because there's no
  73          * need to keep one or the other alive as far as this stream is
  74          * concerned.
  75          */
  76         GHashTable *comp_cur_port;
  77
  78         /* Writer-specific members. */
  79         /* Array of pointers to bt_event for the current packet */
  80         GPtrArray *events;
  81         struct bt_stream_pos pos;
  82         unsigned int flushed_packet_count;
  83         uint64_t discarded_events;
  84         uint64_t size;
  85
  86         /* Array of struct bt_stream_destroy_listener */
  87         GArray *destroy_listeners;
  88 };
  89
  90 BT_HIDDEN
  91 int bt_stream_set_fd(struct bt_stream *stream, int fd);
  92
  93 BT_HIDDEN
  94 void bt_stream_map_component_to_port(struct bt_stream *stream,
  95                 struct bt_component *comp,
  96                 struct bt_port *port);
  97
  98 BT_HIDDEN
  99 struct bt_port *bt_stream_port_for_component(struct bt_stream *stream,
 100                 struct bt_component *comp);
 101
 102 BT_HIDDEN
 103 void bt_stream_add_destroy_listener(struct bt_stream *stream,
 104                 bt_stream_destroy_listener_func func, void *data);
 105
 106 BT_HIDDEN
 107 void bt_stream_remove_destroy_listener(struct bt_stream *stream,
 108                 bt_stream_destroy_listener_func func, void *data);
 109
 110 static inline
 111 struct bt_stream_class *bt_stream_borrow_stream_class(
 112                 struct bt_stream *stream)
 113 {
 114         assert(stream);
 115         return stream->stream_class;
 116 }
 117
 118 #endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */