2 * SPDX-License-Identifier: MIT
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 #ifndef BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H
9 #define BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H
11 /* Protection: this file uses BT_LIB_LOG*() macros directly */
12 #ifndef BT_LIB_LOG_SUPPORTED
13 # error Please include "lib/logging.h" before including this file.
16 #include "common/macros.h"
17 #include "lib/object.h"
18 #include "common/assert.h"
19 #include <babeltrace2/graph/graph.h>
20 #include <babeltrace2/graph/message.h>
21 #include <babeltrace2/trace-ir/stream.h>
22 #include "lib/object-pool.h"
23 #include <babeltrace2/types.h>
25 /* Protection: this file uses BT_LIB_LOG*() macros directly */
26 #ifndef BT_LIB_LOG_SUPPORTED
27 # error Please include "lib/logging.h" before including this file.
30 typedef struct bt_stream
*(*get_stream_func
)(
31 struct bt_message
*message
);
34 struct bt_object base
;
35 enum bt_message_type type
;
38 /* Owned by this; keeps the graph alive while the msg. is alive */
39 struct bt_graph
*graph
;
42 #define _BT_ASSERT_PRE_MSG_IS_TYPE_COND(_msg, _type) \
43 (((struct bt_message *) (_msg))->type == (_type))
45 #define _BT_ASSERT_PRE_MSG_IS_TYPE_FMT \
46 "Message has the wrong type: expected-type=%s, %![msg-]+n"
48 #define BT_ASSERT_PRE_MSG_IS_TYPE(_msg, _type) \
50 _BT_ASSERT_PRE_MSG_IS_TYPE_COND((_msg), (_type)), \
51 _BT_ASSERT_PRE_MSG_IS_TYPE_FMT, \
52 bt_message_type_string(_type), (_msg))
54 #define BT_ASSERT_PRE_DEV_MSG_IS_TYPE(_msg, _type) \
56 _BT_ASSERT_PRE_MSG_IS_TYPE_COND((_msg), (_type)), \
57 _BT_ASSERT_PRE_MSG_IS_TYPE_FMT, \
58 bt_message_type_string(_type), (_msg))
60 #define BT_ASSERT_PRE_BEGIN_LE_END(_msg_iter, _begin, _end) \
63 "Beginning default clock snapshot value is greater " \
64 "than end default clock snapshot value: " \
65 "cs-begin-val=%" PRIu64 ", cs-end-val=%" PRIu64 ", " \
67 _begin, _end, _msg_iter);
70 void bt_message_init(struct bt_message
*message
,
71 enum bt_message_type type
,
72 bt_object_release_func release
,
73 struct bt_graph
*graph
);
76 void bt_message_reset(struct bt_message
*message
)
78 BT_ASSERT_DBG(message
);
81 message
->frozen
= BT_FALSE
;
86 struct bt_message
*bt_message_create_from_pool(
87 struct bt_object_pool
*pool
, struct bt_graph
*graph
)
89 struct bt_message
*msg
= bt_object_pool_create_object(pool
);
91 if (G_UNLIKELY(!msg
)) {
92 BT_LIB_LOGE_APPEND_CAUSE(
93 "Cannot allocate one message from message pool: "
94 "%![pool-]+o, %![graph-]+g", pool
, graph
);
98 if (G_LIKELY(!msg
->graph
)) {
111 static inline void _bt_message_freeze(struct bt_message
*message
)
113 message
->frozen
= BT_TRUE
;
117 void bt_message_unlink_graph(struct bt_message
*msg
);
120 # define bt_message_freeze _bt_message_freeze
122 # define bt_message_freeze(_x)
123 #endif /* BT_DEV_MODE */
126 const char *bt_message_type_string(enum bt_message_type type
)
129 case BT_MESSAGE_TYPE_EVENT
:
131 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
132 return "MESSAGE_ITERATOR_INACTIVITY";
133 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
134 return "STREAM_BEGINNING";
135 case BT_MESSAGE_TYPE_STREAM_END
:
137 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
138 return "PACKET_BEGINNING";
139 case BT_MESSAGE_TYPE_PACKET_END
:
141 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
142 return "DISCARDED_EVENTS";
148 #endif /* BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H */