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"
29 #include <babeltrace/ctf-ir/fields-internal.h>
30 #include <babeltrace/ctf-ir/packet.h>
31 #include <babeltrace/ctf-ir/packet-internal.h>
32 #include <babeltrace/ctf-ir/trace.h>
33 #include <babeltrace/ctf-ir/stream-class-internal.h>
34 #include <babeltrace/ctf-ir/stream-class.h>
35 #include <babeltrace/ctf-ir/stream.h>
36 #include <babeltrace/ctf-ir/stream-internal.h>
37 #include <babeltrace/ctf-ir/trace-internal.h>
38 #include <babeltrace/lib-logging-internal.h>
39 #include <babeltrace/object-internal.h>
40 #include <babeltrace/ref.h>
42 struct bt_ctf_stream
*bt_ctf_packet_get_stream(struct bt_ctf_packet
*packet
)
44 return packet
? bt_get(packet
->stream
) : NULL
;
47 struct bt_ctf_field
*bt_ctf_packet_get_header(
48 struct bt_ctf_packet
*packet
)
50 return packet
? bt_get(packet
->header
) : NULL
;
53 int bt_ctf_packet_set_header(struct bt_ctf_packet
*packet
,
54 struct bt_ctf_field
*header
)
57 struct bt_ctf_trace
*trace
= NULL
;
58 struct bt_ctf_stream_class
*stream_class
= NULL
;
59 struct bt_ctf_field_type
*header_field_type
= NULL
;
60 struct bt_ctf_field_type
*expected_header_field_type
= NULL
;
63 BT_LOGW_STR("Invalid parameter: packet is NULL.");
69 BT_LOGW("Invalid parameter: packet is frozen: addr=%p",
75 stream_class
= bt_ctf_stream_get_class(packet
->stream
);
77 trace
= bt_ctf_stream_class_get_trace(stream_class
);
79 expected_header_field_type
= bt_ctf_trace_get_packet_header_type(trace
);
82 if (expected_header_field_type
) {
83 BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: "
84 "packet-addr=%p, packet-header-ft-addr=%p",
85 packet
, expected_header_field_type
);
93 header_field_type
= bt_ctf_field_get_type(header
);
94 assert(header_field_type
);
96 if (bt_ctf_field_type_compare(header_field_type
,
97 expected_header_field_type
)) {
98 BT_LOGW("Invalid parameter: packet header's field type is different from the trace's packet header field type: "
99 "packet-addr=%p, packet-header-addr=%p",
106 bt_put(packet
->header
);
107 packet
->header
= bt_get(header
);
108 BT_LOGV("Set packet's header field: packet-addr=%p, packet-header-addr=%p",
113 BT_PUT(stream_class
);
114 BT_PUT(header_field_type
);
115 BT_PUT(expected_header_field_type
);
120 struct bt_ctf_field
*bt_ctf_packet_get_context(
121 struct bt_ctf_packet
*packet
)
123 return packet
? bt_get(packet
->context
) : NULL
;
126 int bt_ctf_packet_set_context(struct bt_ctf_packet
*packet
,
127 struct bt_ctf_field
*context
)
130 struct bt_ctf_stream_class
*stream_class
= NULL
;
131 struct bt_ctf_field_type
*context_field_type
= NULL
;
132 struct bt_ctf_field_type
*expected_context_field_type
= NULL
;
135 BT_LOGW_STR("Invalid parameter: packet is NULL.");
140 if (packet
->frozen
) {
141 BT_LOGW("Invalid parameter: packet is frozen: addr=%p",
147 stream_class
= bt_ctf_stream_get_class(packet
->stream
);
148 assert(stream_class
);
149 expected_context_field_type
=
150 bt_ctf_stream_class_get_packet_context_type(stream_class
);
153 if (expected_context_field_type
) {
154 BT_LOGW("Invalid parameter: setting no packet context but packet context field type is not NULL: "
155 "packet-addr=%p, packet-context-ft-addr=%p",
156 packet
, expected_context_field_type
);
161 goto skip_validation
;
164 context_field_type
= bt_ctf_field_get_type(context
);
165 assert(context_field_type
);
167 if (bt_ctf_field_type_compare(context_field_type
,
168 expected_context_field_type
)) {
169 BT_LOGW("Invalid parameter: packet context's field type is different from the stream class's packet context field type: "
170 "packet-addr=%p, packet-context-addr=%p",
177 bt_put(packet
->context
);
178 packet
->context
= bt_get(context
);
179 BT_LOGV("Set packet's context field: packet-addr=%p, packet-context-addr=%p",
183 BT_PUT(stream_class
);
184 BT_PUT(context_field_type
);
185 BT_PUT(expected_context_field_type
);
190 void bt_ctf_packet_freeze(struct bt_ctf_packet
*packet
)
192 if (!packet
|| packet
->frozen
) {
196 BT_LOGD("Freezing packet: addr=%p", packet
);
197 BT_LOGD_STR("Freezing packet's header field.");
198 bt_ctf_field_freeze(packet
->header
);
199 BT_LOGD_STR("Freezing packet's context field.");
200 bt_ctf_field_freeze(packet
->context
);
205 void bt_ctf_packet_destroy(struct bt_object
*obj
)
207 struct bt_ctf_packet
*packet
;
209 packet
= container_of(obj
, struct bt_ctf_packet
, base
);
210 BT_LOGD("Destroying packet: addr=%p", packet
);
211 BT_LOGD_STR("Putting packet's header field.");
212 bt_put(packet
->header
);
213 BT_LOGD_STR("Putting packet's context field.");
214 bt_put(packet
->context
);
215 BT_LOGD_STR("Putting packet's stream.");
216 bt_put(packet
->stream
);
220 struct bt_ctf_packet
*bt_ctf_packet_create(
221 struct bt_ctf_stream
*stream
)
223 struct bt_ctf_packet
*packet
= NULL
;
224 struct bt_ctf_stream_class
*stream_class
= NULL
;
225 struct bt_ctf_trace
*trace
= NULL
;
227 BT_LOGD("Creating packet object: stream-addr=%p", stream
);
230 BT_LOGW_STR("Invalid parameter: stream is NULL.");
234 if (stream
->pos
.fd
>= 0) {
235 BT_LOGW_STR("Invalid parameter: stream is a CTF writer stream.");
239 stream_class
= bt_ctf_stream_get_class(stream
);
240 assert(stream_class
);
241 trace
= bt_ctf_stream_class_get_trace(stream_class
);
243 packet
= g_new0(struct bt_ctf_packet
, 1);
245 BT_LOGE_STR("Failed to allocate one packet object.");
249 bt_object_init(packet
, bt_ctf_packet_destroy
);
250 packet
->stream
= bt_get(stream
);
251 packet
->header
= bt_ctf_field_create(trace
->packet_header_type
);
252 if (!packet
->header
&& trace
->packet_header_type
) {
253 BT_LOGE_STR("Cannot create initial packet header field object.");
258 packet
->context
= bt_ctf_field_create(
259 stream
->stream_class
->packet_context_type
);
260 if (!packet
->context
&& stream
->stream_class
->packet_context_type
) {
261 BT_LOGE_STR("Cannot create initial packet header field object.");
266 BT_LOGD("Created packet object: addr=%p", packet
);
270 BT_PUT(stream_class
);