4 * Babeltrace CTF IR - Stream packet
6 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
27 #define BT_LOG_TAG "PACKET"
28 #include <babeltrace/lib-logging-internal.h>
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>
43 struct bt_ctf_stream
*bt_ctf_packet_get_stream(struct bt_ctf_packet
*packet
)
45 return packet
? bt_get(packet
->stream
) : NULL
;
48 struct bt_ctf_field
*bt_ctf_packet_get_header(
49 struct bt_ctf_packet
*packet
)
51 return packet
? bt_get(packet
->header
) : NULL
;
54 int bt_ctf_packet_set_header(struct bt_ctf_packet
*packet
,
55 struct bt_ctf_field
*header
)
58 struct bt_ctf_trace
*trace
= NULL
;
59 struct bt_ctf_stream_class
*stream_class
= NULL
;
60 struct bt_ctf_field_type
*header_field_type
= NULL
;
61 struct bt_ctf_field_type
*expected_header_field_type
= NULL
;
64 BT_LOGW_STR("Invalid parameter: packet is NULL.");
70 BT_LOGW("Invalid parameter: packet is frozen: addr=%p",
76 stream_class
= bt_ctf_stream_get_class(packet
->stream
);
78 trace
= bt_ctf_stream_class_get_trace(stream_class
);
80 expected_header_field_type
= bt_ctf_trace_get_packet_header_type(trace
);
83 if (expected_header_field_type
) {
84 BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: "
85 "packet-addr=%p, packet-header-ft-addr=%p",
86 packet
, expected_header_field_type
);
94 header_field_type
= bt_ctf_field_get_type(header
);
95 assert(header_field_type
);
97 if (bt_ctf_field_type_compare(header_field_type
,
98 expected_header_field_type
)) {
99 BT_LOGW("Invalid parameter: packet header's field type is different from the trace's packet header field type: "
100 "packet-addr=%p, packet-header-addr=%p",
107 bt_put(packet
->header
);
108 packet
->header
= bt_get(header
);
109 BT_LOGV("Set packet's header field: packet-addr=%p, packet-header-addr=%p",
114 BT_PUT(stream_class
);
115 BT_PUT(header_field_type
);
116 BT_PUT(expected_header_field_type
);
121 struct bt_ctf_field
*bt_ctf_packet_get_context(
122 struct bt_ctf_packet
*packet
)
124 return packet
? bt_get(packet
->context
) : NULL
;
127 int bt_ctf_packet_set_context(struct bt_ctf_packet
*packet
,
128 struct bt_ctf_field
*context
)
131 struct bt_ctf_stream_class
*stream_class
= NULL
;
132 struct bt_ctf_field_type
*context_field_type
= NULL
;
133 struct bt_ctf_field_type
*expected_context_field_type
= NULL
;
136 BT_LOGW_STR("Invalid parameter: packet is NULL.");
141 if (packet
->frozen
) {
142 BT_LOGW("Invalid parameter: packet is frozen: addr=%p",
148 stream_class
= bt_ctf_stream_get_class(packet
->stream
);
149 assert(stream_class
);
150 expected_context_field_type
=
151 bt_ctf_stream_class_get_packet_context_type(stream_class
);
154 if (expected_context_field_type
) {
155 BT_LOGW("Invalid parameter: setting no packet context but packet context field type is not NULL: "
156 "packet-addr=%p, packet-context-ft-addr=%p",
157 packet
, expected_context_field_type
);
162 goto skip_validation
;
165 context_field_type
= bt_ctf_field_get_type(context
);
166 assert(context_field_type
);
168 if (bt_ctf_field_type_compare(context_field_type
,
169 expected_context_field_type
)) {
170 BT_LOGW("Invalid parameter: packet context's field type is different from the stream class's packet context field type: "
171 "packet-addr=%p, packet-context-addr=%p",
178 bt_put(packet
->context
);
179 packet
->context
= bt_get(context
);
180 BT_LOGV("Set packet's context field: packet-addr=%p, packet-context-addr=%p",
184 BT_PUT(stream_class
);
185 BT_PUT(context_field_type
);
186 BT_PUT(expected_context_field_type
);
191 void bt_ctf_packet_freeze(struct bt_ctf_packet
*packet
)
193 if (!packet
|| packet
->frozen
) {
197 BT_LOGD("Freezing packet: addr=%p", packet
);
198 BT_LOGD_STR("Freezing packet's header field.");
199 bt_ctf_field_freeze(packet
->header
);
200 BT_LOGD_STR("Freezing packet's context field.");
201 bt_ctf_field_freeze(packet
->context
);
206 void bt_ctf_packet_destroy(struct bt_object
*obj
)
208 struct bt_ctf_packet
*packet
;
210 packet
= container_of(obj
, struct bt_ctf_packet
, base
);
211 BT_LOGD("Destroying packet: addr=%p", packet
);
212 BT_LOGD_STR("Putting packet's header field.");
213 bt_put(packet
->header
);
214 BT_LOGD_STR("Putting packet's context field.");
215 bt_put(packet
->context
);
216 BT_LOGD_STR("Putting packet's stream.");
217 bt_put(packet
->stream
);
221 struct bt_ctf_packet
*bt_ctf_packet_create(
222 struct bt_ctf_stream
*stream
)
224 struct bt_ctf_packet
*packet
= NULL
;
225 struct bt_ctf_stream_class
*stream_class
= NULL
;
226 struct bt_ctf_trace
*trace
= NULL
;
229 BT_LOGW_STR("Invalid parameter: stream is NULL.");
233 BT_LOGD("Creating packet object: stream-addr=%p, "
234 "stream-name=\"%s\", stream-class-addr=%p, "
235 "stream-class-name=\"%s\", stream-class-id=%" PRId64
,
236 stream
, bt_ctf_stream_get_name(stream
),
237 stream
->stream_class
,
238 bt_ctf_stream_class_get_name(stream
->stream_class
),
239 bt_ctf_stream_class_get_id(stream
->stream_class
));
241 if (stream
->pos
.fd
>= 0) {
242 BT_LOGW_STR("Invalid parameter: stream is a CTF writer stream.");
246 stream_class
= bt_ctf_stream_get_class(stream
);
247 assert(stream_class
);
248 trace
= bt_ctf_stream_class_get_trace(stream_class
);
250 packet
= g_new0(struct bt_ctf_packet
, 1);
252 BT_LOGE_STR("Failed to allocate one packet object.");
256 bt_object_init(packet
, bt_ctf_packet_destroy
);
257 packet
->stream
= bt_get(stream
);
259 if (trace
->packet_header_type
) {
260 BT_LOGD("Creating initial packet header field: ft-addr=%p",
261 trace
->packet_header_type
);
262 packet
->header
= bt_ctf_field_create(trace
->packet_header_type
);
263 if (!packet
->header
) {
264 BT_LOGE_STR("Cannot create initial packet header field object.");
270 if (stream
->stream_class
->packet_context_type
) {
271 BT_LOGD("Creating initial packet context field: ft-addr=%p",
272 stream
->stream_class
->packet_context_type
);
273 packet
->context
= bt_ctf_field_create(
274 stream
->stream_class
->packet_context_type
);
275 if (!packet
->context
) {
276 BT_LOGE_STR("Cannot create initial packet header field object.");
282 BT_LOGD("Created packet object: addr=%p", packet
);
286 BT_PUT(stream_class
);