src/lib/graph/message/stream.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "LIB/MSG-STREAM"
  25 #include "lib/logging.h"
  26
  27 #include "lib/assert-pre.h"
  28 #include "compat/compiler.h"
  29 #include <babeltrace2/trace-ir/clock-snapshot-const.h>
  30 #include "lib/trace-ir/stream.h"
  31 #include <babeltrace2/trace-ir/stream-class.h>
  32 #include "lib/trace-ir/stream-class.h"
  33 #include <babeltrace2/graph/message-stream-beginning.h>
  34 #include <babeltrace2/graph/message-stream-end.h>
  35 #include <babeltrace2/graph/message-stream-beginning-const.h>
  36 #include <babeltrace2/graph/message-stream-end-const.h>
  37 #include "common/assert.h"
  38 #include <inttypes.h>
  39
  40 #include "stream.h"
  41
  42 static
  43 void destroy_stream_message(struct bt_object *obj)
  44 {
  45         struct bt_message_stream *message = (void *) obj;
  46
  47         BT_LIB_LOGD("Destroying stream message: %!+n", message);
  48         BT_LIB_LOGD("Putting stream: %!+s", message->stream);
  49         BT_OBJECT_PUT_REF_AND_RESET(message->stream);
  50         g_free(message);
  51 }
  52
  53 static inline
  54 struct bt_message *create_stream_message(
  55                 struct bt_self_message_iterator *self_msg_iter,
  56                 struct bt_stream *stream, enum bt_message_type type)
  57 {
  58         struct bt_message_stream *message;
  59         struct bt_stream_class *stream_class;
  60
  61         BT_ASSERT_PRE_NON_NULL(self_msg_iter, "Message iterator");
  62         BT_ASSERT_PRE_NON_NULL(stream, "Stream");
  63         stream_class = bt_stream_borrow_class(stream);
  64         BT_ASSERT(stream_class);
  65         BT_LIB_LOGD("Creating stream message object: "
  66                 "type=%s, %![stream-]+s, %![sc-]+S",
  67                 bt_message_type_string(type), stream, stream_class);
  68         message = g_new0(struct bt_message_stream, 1);
  69         if (!message) {
  70                 BT_LIB_LOGE_APPEND_CAUSE(
  71                         "Failed to allocate one stream message.");
  72                 goto error;
  73         }
  74
  75         bt_message_init(&message->parent, type,
  76                 destroy_stream_message, NULL);
  77         message->stream = stream;
  78         bt_object_get_no_null_check(message->stream);
  79         BT_LIB_LOGD("Created stream message object: "
  80                 "%![msg-]+n, %![stream-]+s, %![sc-]+S", message,
  81                 stream, stream_class);
  82
  83         return (void *) &message->parent;
  84
  85 error:
  86         return NULL;
  87 }
  88
  89 struct bt_message *bt_message_stream_beginning_create(
  90                 struct bt_self_message_iterator *self_msg_iter,
  91                 const struct bt_stream *stream)
  92 {
  93         return create_stream_message(self_msg_iter, (void *) stream,
  94                 BT_MESSAGE_TYPE_STREAM_BEGINNING);
  95 }
  96
  97 struct bt_message *bt_message_stream_end_create(
  98                 struct bt_self_message_iterator *self_msg_iter,
  99                 const struct bt_stream *stream)
 100 {
 101         return create_stream_message(self_msg_iter, (void *) stream,
 102                 BT_MESSAGE_TYPE_STREAM_END);
 103 }
 104
 105 static inline
 106 struct bt_stream *borrow_stream_message_stream(struct bt_message *message)
 107 {
 108         struct bt_message_stream *stream_msg;
 109
 110         BT_ASSERT(message);
 111         stream_msg = (void *) message;
 112         return stream_msg->stream;
 113 }
 114
 115 struct bt_stream *bt_message_stream_beginning_borrow_stream(
 116                 struct bt_message *message)
 117 {
 118         BT_ASSERT_PRE_NON_NULL(message, "Message");
 119         BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_STREAM_BEGINNING);
 120         return borrow_stream_message_stream(message);
 121 }
 122
 123 struct bt_stream *bt_message_stream_end_borrow_stream(
 124                 struct bt_message *message)
 125 {
 126         BT_ASSERT_PRE_NON_NULL(message, "Message");
 127         BT_ASSERT_PRE_MSG_IS_TYPE(message, BT_MESSAGE_TYPE_STREAM_END);
 128         return borrow_stream_message_stream(message);
 129 }
 130
 131 const struct bt_stream *bt_message_stream_beginning_borrow_stream_const(
 132                 const struct bt_message *message)
 133 {
 134         return bt_message_stream_beginning_borrow_stream(
 135                 (void *) message);
 136 }
 137
 138 const struct bt_stream *bt_message_stream_end_borrow_stream_const(
 139                 const struct bt_message *message)
 140 {
 141         return bt_message_stream_end_borrow_stream(
 142                 (void *) message);
 143 }