Commit | Line | Data |
---|---|---|
f79cf0f0 PP |
1 | /* |
2 | * packet.c | |
3 | * | |
4 | * Babeltrace CTF IR - Stream packet | |
5 | * | |
6 | * Copyright 2016 Philippe Proulx <pproulx@efficios.com> | |
7 | * | |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
8ea705f0 | 27 | #define BT_LOG_TAG "PACKET" |
be514b0c | 28 | #include <babeltrace/lib-logging-internal.h> |
8ea705f0 | 29 | |
f79cf0f0 PP |
30 | #include <babeltrace/ctf-ir/fields-internal.h> |
31 | #include <babeltrace/ctf-ir/packet.h> | |
32 | #include <babeltrace/ctf-ir/packet-internal.h> | |
33 | #include <babeltrace/ctf-ir/trace.h> | |
34 | #include <babeltrace/ctf-ir/stream-class-internal.h> | |
35 | #include <babeltrace/ctf-ir/stream-class.h> | |
36 | #include <babeltrace/ctf-ir/stream.h> | |
37 | #include <babeltrace/ctf-ir/stream-internal.h> | |
38 | #include <babeltrace/ctf-ir/trace-internal.h> | |
39 | #include <babeltrace/object-internal.h> | |
40 | #include <babeltrace/ref.h> | |
8b45963b PP |
41 | #include <babeltrace/assert-internal.h> |
42 | #include <babeltrace/assert-pre-internal.h> | |
be514b0c | 43 | #include <inttypes.h> |
f79cf0f0 | 44 | |
839d52a5 | 45 | struct bt_stream *bt_packet_get_stream(struct bt_packet *packet) |
f79cf0f0 | 46 | { |
8b45963b PP |
47 | BT_ASSERT_PRE_NON_NULL(packet, "Packet"); |
48 | return bt_get(packet->stream); | |
f79cf0f0 PP |
49 | } |
50 | ||
839d52a5 PP |
51 | struct bt_field *bt_packet_get_header( |
52 | struct bt_packet *packet) | |
f79cf0f0 | 53 | { |
8b45963b PP |
54 | BT_ASSERT_PRE_NON_NULL(packet, "Packet"); |
55 | return bt_get(packet->header); | |
f79cf0f0 PP |
56 | } |
57 | ||
8b45963b PP |
58 | BT_ASSERT_PRE_FUNC |
59 | static inline bool validate_field_to_set(struct bt_field *field, | |
60 | struct bt_field_type *expected_ft) | |
f79cf0f0 | 61 | { |
8b45963b PP |
62 | bool ret = true; |
63 | ||
64 | if (!field) { | |
65 | if (expected_ft) { | |
66 | BT_ASSERT_PRE_MSG("Setting no field, but expected " | |
67 | "field type is not NULL: " | |
68 | "%![field-]+f, %![expected-ft-]+F", | |
69 | field, expected_ft); | |
70 | ret = false; | |
c5c82c6e PP |
71 | goto end; |
72 | } | |
73 | ||
8b45963b | 74 | goto end; |
c5c82c6e PP |
75 | } |
76 | ||
8b45963b PP |
77 | if (bt_field_type_compare(field->type, expected_ft) != 0) { |
78 | BT_ASSERT_PRE_MSG("Field type is different from expected " | |
79 | " field type: %![field-ft-]+F, %![expected-ft-]+F", | |
80 | field->type, expected_ft); | |
81 | ret = false; | |
f79cf0f0 PP |
82 | goto end; |
83 | } | |
84 | ||
8b45963b PP |
85 | end: |
86 | return ret; | |
87 | } | |
88 | ||
89 | int bt_packet_set_header(struct bt_packet *packet, | |
90 | struct bt_field *header) | |
91 | { | |
92 | BT_ASSERT_PRE_NON_NULL(packet, "Packet"); | |
93 | BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet); | |
94 | BT_ASSERT_PRE(validate_field_to_set(header, | |
95 | bt_stream_class_borrow_trace(packet->stream->stream_class)->packet_header_type), | |
96 | "Invalid packet header field: " | |
97 | "%![packet-]+a, %![field-]+f", packet, header); | |
f79cf0f0 PP |
98 | bt_put(packet->header); |
99 | packet->header = bt_get(header); | |
8ea705f0 PP |
100 | BT_LOGV("Set packet's header field: packet-addr=%p, packet-header-addr=%p", |
101 | packet, header); | |
8b45963b | 102 | return 0; |
f79cf0f0 PP |
103 | } |
104 | ||
8b45963b | 105 | struct bt_field *bt_packet_get_context(struct bt_packet *packet) |
f79cf0f0 | 106 | { |
8b45963b PP |
107 | BT_ASSERT_PRE_NON_NULL(packet, "Packet"); |
108 | return bt_get(packet->context); | |
f79cf0f0 PP |
109 | } |
110 | ||
839d52a5 PP |
111 | int bt_packet_set_context(struct bt_packet *packet, |
112 | struct bt_field *context) | |
f79cf0f0 | 113 | { |
8b45963b PP |
114 | BT_ASSERT_PRE_NON_NULL(packet, "Packet"); |
115 | BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet); | |
116 | BT_ASSERT_PRE(validate_field_to_set(context, | |
117 | packet->stream->stream_class->packet_context_type), | |
118 | "Invalid packet context field: " | |
119 | "%![packet-]+a, %![field-]+f", packet, context); | |
f79cf0f0 PP |
120 | bt_put(packet->context); |
121 | packet->context = bt_get(context); | |
8ea705f0 PP |
122 | BT_LOGV("Set packet's context field: packet-addr=%p, packet-context-addr=%p", |
123 | packet, context); | |
8b45963b | 124 | return 0; |
f79cf0f0 PP |
125 | } |
126 | ||
127 | BT_HIDDEN | |
8b45963b | 128 | void _bt_packet_freeze(struct bt_packet *packet) |
f79cf0f0 | 129 | { |
8ea705f0 | 130 | if (!packet || packet->frozen) { |
5c3b707d | 131 | return; |
f79cf0f0 PP |
132 | } |
133 | ||
8ea705f0 | 134 | BT_LOGD("Freezing packet: addr=%p", packet); |
d409daba | 135 | BT_LOGD_STR("Freezing packet's header field."); |
8b45963b | 136 | bt_field_freeze_recursive(packet->header); |
d409daba | 137 | BT_LOGD_STR("Freezing packet's context field."); |
8b45963b | 138 | bt_field_freeze_recursive(packet->context); |
f79cf0f0 | 139 | packet->frozen = 1; |
f79cf0f0 PP |
140 | } |
141 | ||
142 | static | |
839d52a5 | 143 | void bt_packet_destroy(struct bt_object *obj) |
f79cf0f0 | 144 | { |
839d52a5 | 145 | struct bt_packet *packet; |
f79cf0f0 | 146 | |
839d52a5 | 147 | packet = container_of(obj, struct bt_packet, base); |
8ea705f0 | 148 | BT_LOGD("Destroying packet: addr=%p", packet); |
d409daba | 149 | BT_LOGD_STR("Putting packet's header field."); |
f79cf0f0 | 150 | bt_put(packet->header); |
d409daba | 151 | BT_LOGD_STR("Putting packet's context field."); |
f79cf0f0 | 152 | bt_put(packet->context); |
d409daba | 153 | BT_LOGD_STR("Putting packet's stream."); |
f79cf0f0 PP |
154 | bt_put(packet->stream); |
155 | g_free(packet); | |
156 | } | |
157 | ||
839d52a5 PP |
158 | struct bt_packet *bt_packet_create( |
159 | struct bt_stream *stream) | |
f79cf0f0 | 160 | { |
839d52a5 PP |
161 | struct bt_packet *packet = NULL; |
162 | struct bt_stream_class *stream_class = NULL; | |
163 | struct bt_trace *trace = NULL; | |
f79cf0f0 | 164 | |
8b45963b | 165 | BT_ASSERT_PRE_NON_NULL(stream, "Stream"); |
be514b0c PP |
166 | BT_LOGD("Creating packet object: stream-addr=%p, " |
167 | "stream-name=\"%s\", stream-class-addr=%p, " | |
168 | "stream-class-name=\"%s\", stream-class-id=%" PRId64, | |
839d52a5 | 169 | stream, bt_stream_get_name(stream), |
be514b0c | 170 | stream->stream_class, |
839d52a5 PP |
171 | bt_stream_class_get_name(stream->stream_class), |
172 | bt_stream_class_get_id(stream->stream_class)); | |
8b45963b PP |
173 | BT_ASSERT_PRE(stream->pos.fd < 0, |
174 | "Stream is a CTF writer stream: %!+s", stream); | |
839d52a5 | 175 | stream_class = bt_stream_get_class(stream); |
8b45963b | 176 | BT_ASSERT(stream_class); |
839d52a5 | 177 | trace = bt_stream_class_get_trace(stream_class); |
8b45963b | 178 | BT_ASSERT(trace); |
839d52a5 | 179 | packet = g_new0(struct bt_packet, 1); |
f79cf0f0 | 180 | if (!packet) { |
8ea705f0 | 181 | BT_LOGE_STR("Failed to allocate one packet object."); |
f79cf0f0 PP |
182 | goto end; |
183 | } | |
184 | ||
839d52a5 | 185 | bt_object_init(packet, bt_packet_destroy); |
f79cf0f0 | 186 | packet->stream = bt_get(stream); |
be514b0c PP |
187 | |
188 | if (trace->packet_header_type) { | |
189 | BT_LOGD("Creating initial packet header field: ft-addr=%p", | |
190 | trace->packet_header_type); | |
839d52a5 | 191 | packet->header = bt_field_create(trace->packet_header_type); |
be514b0c PP |
192 | if (!packet->header) { |
193 | BT_LOGE_STR("Cannot create initial packet header field object."); | |
194 | BT_PUT(packet); | |
195 | goto end; | |
196 | } | |
f79cf0f0 PP |
197 | } |
198 | ||
be514b0c PP |
199 | if (stream->stream_class->packet_context_type) { |
200 | BT_LOGD("Creating initial packet context field: ft-addr=%p", | |
201 | stream->stream_class->packet_context_type); | |
839d52a5 | 202 | packet->context = bt_field_create( |
be514b0c PP |
203 | stream->stream_class->packet_context_type); |
204 | if (!packet->context) { | |
205 | BT_LOGE_STR("Cannot create initial packet header field object."); | |
206 | BT_PUT(packet); | |
207 | goto end; | |
208 | } | |
f79cf0f0 PP |
209 | } |
210 | ||
8ea705f0 PP |
211 | BT_LOGD("Created packet object: addr=%p", packet); |
212 | ||
f79cf0f0 PP |
213 | end: |
214 | BT_PUT(trace); | |
215 | BT_PUT(stream_class); | |
216 | ||
217 | return packet; | |
218 | } |