Move bt_message_type_string to common
[babeltrace.git] / src / lib / graph / message / message.h
CommitLineData
d6e69534 1/*
0235b0db
MJ
2 * SPDX-License-Identifier: MIT
3 *
d6e69534
PP
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
d6e69534
PP
6 */
7
0235b0db
MJ
8#ifndef BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H
9#define BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H
10
870631a2
PP
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.
14#endif
15
91d81473 16#include "common/macros.h"
578e048b
MJ
17#include "lib/object.h"
18#include "common/assert.h"
3fadfbc0 19#include <babeltrace2/graph/graph.h>
43c59509 20#include <babeltrace2/graph/message.h>
3fadfbc0 21#include <babeltrace2/trace-ir/stream.h>
578e048b 22#include "lib/object-pool.h"
3fadfbc0 23#include <babeltrace2/types.h>
d6e69534 24
f137d351
PP
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.
28#endif
29
d6e69534
PP
30typedef struct bt_stream *(*get_stream_func)(
31 struct bt_message *message);
32
33struct bt_message {
34 struct bt_object base;
35 enum bt_message_type type;
d6e69534
PP
36 bt_bool frozen;
37
38 /* Owned by this; keeps the graph alive while the msg. is alive */
39 struct bt_graph *graph;
40};
41
d6e69534
PP
42BT_HIDDEN
43void bt_message_init(struct bt_message *message,
44 enum bt_message_type type,
45 bt_object_release_func release,
46 struct bt_graph *graph);
47
48static inline
49void bt_message_reset(struct bt_message *message)
50{
98b15851 51 BT_ASSERT_DBG(message);
d6e69534
PP
52
53#ifdef BT_DEV_MODE
54 message->frozen = BT_FALSE;
d6e69534
PP
55#endif
56}
57
58static inline
59struct bt_message *bt_message_create_from_pool(
60 struct bt_object_pool *pool, struct bt_graph *graph)
61{
62 struct bt_message *msg = bt_object_pool_create_object(pool);
63
91d81473 64 if (G_UNLIKELY(!msg)) {
870631a2
PP
65 BT_LIB_LOGE_APPEND_CAUSE(
66 "Cannot allocate one message from message pool: "
d6e69534 67 "%![pool-]+o, %![graph-]+g", pool, graph);
d6e69534
PP
68 goto error;
69 }
70
91d81473 71 if (G_LIKELY(!msg->graph)) {
d6e69534
PP
72 msg->graph = graph;
73 }
74
75 goto end;
76
77error:
78 BT_ASSERT(!msg);
79
80end:
81 return msg;
82}
83
84static inline void _bt_message_freeze(struct bt_message *message)
85{
86 message->frozen = BT_TRUE;
87}
88
89BT_HIDDEN
90void bt_message_unlink_graph(struct bt_message *msg);
91
92#ifdef BT_DEV_MODE
93# define bt_message_freeze _bt_message_freeze
94#else
95# define bt_message_freeze(_x)
96#endif /* BT_DEV_MODE */
97
d6e69534 98#endif /* BABELTRACE_GRAPH_MESSAGE_MESSAGE_INTERNAL_H */
This page took 0.071982 seconds and 4 git commands to generate.