Commit | Line | Data |
---|---|---|
8deee039 PP |
1 | /* |
2 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
3 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> | |
4 | * | |
5 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
6 | * of this software and associated documentation files (the "Software"), to deal | |
7 | * in the Software without restriction, including without limitation the rights | |
8 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
9 | * copies of the Software, and to permit persons to whom the Software is | |
10 | * furnished to do so, subject to the following conditions: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
18 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
b03487ab | 24 | #define BT_LOG_TAG "CTF-WRITER/STREAM" |
bf436657 | 25 | #include "logging.h" |
8deee039 | 26 | |
57952005 MJ |
27 | #include <inttypes.h> |
28 | #include <stdint.h> | |
29 | #include <unistd.h> | |
30 | ||
3996bc53 PP |
31 | #include <babeltrace2-ctf-writer/field-types.h> |
32 | #include <babeltrace2-ctf-writer/object.h> | |
33 | #include <babeltrace2-ctf-writer/stream-class.h> | |
34 | #include <babeltrace2-ctf-writer/stream.h> | |
35 | #include <babeltrace2-ctf-writer/trace.h> | |
57952005 MJ |
36 | |
37 | #include "common/align.h" | |
38 | #include "common/assert.h" | |
39 | #include "compat/compiler.h" | |
40 | #include "ctfser/ctfser.h" | |
41 | ||
42 | #include "assert-pre.h" | |
43 | #include "event-class.h" | |
44 | #include "event.h" | |
45 | #include "fields.h" | |
46 | #include "stream-class.h" | |
47 | #include "stream.h" | |
48 | #include "trace.h" | |
49 | #include "writer.h" | |
086dc475 PP |
50 | |
51 | BT_HIDDEN | |
52 | void bt_ctf_stream_common_finalize(struct bt_ctf_stream_common *stream) | |
53 | { | |
54 | BT_LOGD("Finalizing common stream object: addr=%p, name=\"%s\"", | |
55 | stream, bt_ctf_stream_common_get_name(stream)); | |
56 | ||
57 | if (stream->name) { | |
58 | g_string_free(stream->name, TRUE); | |
59 | } | |
60 | } | |
61 | ||
62 | BT_HIDDEN | |
63 | int bt_ctf_stream_common_initialize( | |
64 | struct bt_ctf_stream_common *stream, | |
65 | struct bt_ctf_stream_class_common *stream_class, const char *name, | |
c2606e2f | 66 | uint64_t id, bt_ctf_object_release_func release_func) |
086dc475 PP |
67 | { |
68 | int ret = 0; | |
69 | struct bt_ctf_trace_common *trace = NULL; | |
70 | ||
c2606e2f | 71 | bt_ctf_object_init_shared_with_parent(&stream->base, release_func); |
086dc475 PP |
72 | |
73 | if (!stream_class) { | |
74 | BT_LOGW_STR("Invalid parameter: stream class is NULL."); | |
75 | goto error; | |
76 | } | |
77 | ||
78 | BT_LOGD("Initializing common stream object: stream-class-addr=%p, " | |
79 | "stream-class-name=\"%s\", stream-name=\"%s\", " | |
80 | "stream-id=%" PRIu64, | |
81 | stream_class, bt_ctf_stream_class_common_get_name(stream_class), | |
82 | name, id); | |
83 | trace = bt_ctf_stream_class_common_borrow_trace(stream_class); | |
84 | if (!trace) { | |
85 | BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: " | |
86 | "stream-class-addr=%p, stream-class-name=\"%s\", " | |
87 | "stream-name=\"%s\"", | |
88 | stream_class, | |
89 | bt_ctf_stream_class_common_get_name(stream_class), name); | |
90 | goto error; | |
91 | } | |
92 | ||
93 | if (id != -1ULL) { | |
94 | /* | |
95 | * Validate that the given ID is unique amongst all the | |
96 | * existing trace's streams created from the same stream | |
97 | * class. | |
98 | */ | |
99 | size_t i; | |
100 | ||
101 | for (i = 0; i < trace->streams->len; i++) { | |
102 | struct bt_ctf_stream_common *trace_stream = | |
103 | g_ptr_array_index(trace->streams, i); | |
104 | ||
105 | if (trace_stream->stream_class != (void *) stream_class) { | |
106 | continue; | |
107 | } | |
108 | ||
109 | if (trace_stream->id == id) { | |
110 | BT_LOGW_STR("Invalid parameter: another stream in the same trace already has this ID."); | |
111 | goto error; | |
112 | } | |
113 | } | |
114 | } | |
115 | ||
116 | /* | |
117 | * Acquire reference to parent since stream will become publicly | |
118 | * reachable; it needs its parent to remain valid. | |
119 | */ | |
c2606e2f | 120 | bt_ctf_object_set_parent(&stream->base, &trace->base); |
086dc475 PP |
121 | stream->stream_class = stream_class; |
122 | stream->id = (int64_t) id; | |
123 | ||
124 | if (name) { | |
125 | stream->name = g_string_new(name); | |
126 | if (!stream->name) { | |
127 | BT_LOGE_STR("Failed to allocate a GString."); | |
128 | goto error; | |
129 | } | |
130 | } | |
131 | ||
132 | BT_LOGD("Set common stream's trace parent: trace-addr=%p", trace); | |
133 | ||
134 | /* Add this stream to the trace's streams */ | |
135 | BT_LOGD("Created common stream object: addr=%p", stream); | |
136 | goto end; | |
137 | ||
138 | error: | |
139 | ret = -1; | |
140 | ||
141 | end: | |
142 | return ret; | |
143 | } | |
8deee039 PP |
144 | |
145 | static | |
c2606e2f | 146 | void bt_ctf_stream_destroy(struct bt_ctf_object *obj); |
8deee039 PP |
147 | |
148 | static | |
149 | int try_set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t); | |
150 | ||
151 | static | |
152 | int set_integer_field_value(struct bt_ctf_field* field, uint64_t value) | |
153 | { | |
154 | int ret = 0; | |
155 | struct bt_ctf_field_type *field_type = NULL; | |
156 | ||
157 | if (!field) { | |
158 | BT_LOGW_STR("Invalid parameter: field is NULL."); | |
159 | ret = -1; | |
160 | goto end; | |
161 | } | |
162 | ||
163 | field_type = bt_ctf_field_get_type(field); | |
164 | BT_ASSERT(field_type); | |
165 | ||
166 | if (bt_ctf_field_type_get_type_id(field_type) != | |
167 | BT_CTF_FIELD_TYPE_ID_INTEGER) { | |
168 | /* Not an integer and the value is unset, error. */ | |
169 | BT_LOGW("Invalid parameter: field's type is not an integer field type: " | |
170 | "field-addr=%p, ft-addr=%p, ft-id=%s", | |
171 | field, field_type, | |
086dc475 | 172 | bt_ctf_field_type_id_string((int) |
8deee039 PP |
173 | bt_ctf_field_type_get_type_id(field_type))); |
174 | ret = -1; | |
175 | goto end; | |
176 | } | |
177 | ||
178 | if (bt_ctf_field_type_integer_is_signed(field_type)) { | |
179 | ret = bt_ctf_field_integer_signed_set_value(field, (int64_t) value); | |
180 | if (ret) { | |
181 | /* Value is out of range, error. */ | |
182 | BT_LOGW("Cannot set signed integer field's value: " | |
183 | "addr=%p, value=%" PRId64, | |
184 | field, (int64_t) value); | |
185 | goto end; | |
186 | } | |
187 | } else { | |
188 | ret = bt_ctf_field_integer_unsigned_set_value(field, value); | |
189 | if (ret) { | |
190 | /* Value is out of range, error. */ | |
191 | BT_LOGW("Cannot set unsigned integer field's value: " | |
192 | "addr=%p, value=%" PRIu64, | |
193 | field, value); | |
194 | goto end; | |
195 | } | |
196 | } | |
197 | end: | |
c2606e2f | 198 | bt_ctf_object_put_ref(field_type); |
8deee039 PP |
199 | return ret; |
200 | } | |
201 | ||
202 | static | |
203 | int set_packet_header_magic(struct bt_ctf_stream *stream) | |
204 | { | |
205 | int ret = 0; | |
206 | struct bt_ctf_field *magic_field = bt_ctf_field_structure_get_field_by_name( | |
207 | stream->packet_header, "magic"); | |
208 | const uint32_t magic_value = 0xc1fc1fc1; | |
209 | ||
210 | BT_ASSERT(stream); | |
211 | ||
212 | if (!magic_field) { | |
213 | /* No magic field found. Not an error, skip. */ | |
c9ecaa78 | 214 | BT_LOGT("No field named `magic` in packet header: skipping: " |
8deee039 PP |
215 | "stream-addr=%p, stream-name=\"%s\"", |
216 | stream, bt_ctf_stream_get_name(stream)); | |
217 | goto end; | |
218 | } | |
219 | ||
220 | ret = bt_ctf_field_integer_unsigned_set_value(magic_field, | |
221 | (uint64_t) magic_value); | |
222 | ||
223 | if (ret) { | |
224 | BT_LOGW("Cannot set packet header field's `magic` integer field's value: " | |
225 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
226 | stream, bt_ctf_stream_get_name(stream), | |
227 | magic_field, (uint64_t) magic_value); | |
228 | } else { | |
c9ecaa78 | 229 | BT_LOGT("Set packet header field's `magic` field's value: " |
8deee039 PP |
230 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, |
231 | stream, bt_ctf_stream_get_name(stream), | |
232 | magic_field, (uint64_t) magic_value); | |
233 | } | |
234 | end: | |
c2606e2f | 235 | bt_ctf_object_put_ref(magic_field); |
8deee039 PP |
236 | return ret; |
237 | } | |
238 | ||
239 | static | |
240 | int set_packet_header_uuid(struct bt_ctf_stream *stream) | |
241 | { | |
242 | int ret = 0; | |
243 | int64_t i; | |
244 | struct bt_ctf_trace *trace = NULL; | |
245 | struct bt_ctf_field *uuid_field = bt_ctf_field_structure_get_field_by_name( | |
246 | stream->packet_header, "uuid"); | |
247 | ||
248 | BT_ASSERT(stream); | |
249 | ||
250 | if (!uuid_field) { | |
251 | /* No uuid field found. Not an error, skip. */ | |
c9ecaa78 | 252 | BT_LOGT("No field named `uuid` in packet header: skipping: " |
8deee039 PP |
253 | "stream-addr=%p, stream-name=\"%s\"", |
254 | stream, bt_ctf_stream_get_name(stream)); | |
255 | goto end; | |
256 | } | |
257 | ||
1d7bf349 | 258 | trace = (struct bt_ctf_trace *) |
c2606e2f | 259 | bt_ctf_object_get_parent(&stream->common.base); |
1d7bf349 | 260 | |
8deee039 PP |
261 | for (i = 0; i < 16; i++) { |
262 | struct bt_ctf_field *uuid_element = | |
263 | bt_ctf_field_array_get_field(uuid_field, i); | |
264 | ||
265 | ret = bt_ctf_field_integer_unsigned_set_value( | |
266 | uuid_element, (uint64_t) trace->common.uuid[i]); | |
c2606e2f | 267 | bt_ctf_object_put_ref(uuid_element); |
8deee039 PP |
268 | if (ret) { |
269 | BT_LOGW("Cannot set integer field's value (for `uuid` packet header field): " | |
270 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, " | |
271 | "value=%" PRIu64 ", index=%" PRId64, | |
272 | stream, bt_ctf_stream_get_name(stream), | |
273 | uuid_element, (uint64_t) trace->common.uuid[i], i); | |
274 | goto end; | |
275 | } | |
276 | } | |
277 | ||
c9ecaa78 | 278 | BT_LOGT("Set packet header field's `uuid` field's value: " |
8deee039 PP |
279 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p", |
280 | stream, bt_ctf_stream_get_name(stream), uuid_field); | |
281 | ||
282 | end: | |
c2606e2f PP |
283 | bt_ctf_object_put_ref(uuid_field); |
284 | BT_CTF_OBJECT_PUT_REF_AND_RESET(trace); | |
8deee039 PP |
285 | return ret; |
286 | } | |
287 | static | |
288 | int set_packet_header_stream_id(struct bt_ctf_stream *stream) | |
289 | { | |
290 | int ret = 0; | |
291 | uint32_t stream_id; | |
292 | struct bt_ctf_field *stream_id_field = | |
293 | bt_ctf_field_structure_get_field_by_name( | |
294 | stream->packet_header, "stream_id"); | |
295 | ||
296 | if (!stream_id_field) { | |
297 | /* No stream_id field found. Not an error, skip. */ | |
c9ecaa78 | 298 | BT_LOGT("No field named `stream_id` in packet header: skipping: " |
8deee039 PP |
299 | "stream-addr=%p, stream-name=\"%s\"", |
300 | stream, bt_ctf_stream_get_name(stream)); | |
301 | goto end; | |
302 | } | |
303 | ||
304 | stream_id = stream->common.stream_class->id; | |
305 | ret = bt_ctf_field_integer_unsigned_set_value(stream_id_field, | |
306 | (uint64_t) stream_id); | |
307 | if (ret) { | |
308 | BT_LOGW("Cannot set packet header field's `stream_id` integer field's value: " | |
309 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
310 | stream, bt_ctf_stream_get_name(stream), | |
311 | stream_id_field, (uint64_t) stream_id); | |
312 | } else { | |
c9ecaa78 | 313 | BT_LOGT("Set packet header field's `stream_id` field's value: " |
8deee039 PP |
314 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, |
315 | stream, bt_ctf_stream_get_name(stream), | |
316 | stream_id_field, (uint64_t) stream_id); | |
317 | } | |
318 | ||
319 | end: | |
c2606e2f | 320 | bt_ctf_object_put_ref(stream_id_field); |
8deee039 PP |
321 | return ret; |
322 | } | |
323 | ||
324 | static | |
325 | int auto_populate_packet_header(struct bt_ctf_stream *stream) | |
326 | { | |
327 | int ret = 0; | |
328 | ||
329 | if (!stream->packet_header) { | |
330 | goto end; | |
331 | } | |
332 | ||
333 | ret = set_packet_header_magic(stream); | |
334 | if (ret) { | |
335 | BT_LOGW("Cannot set packet header's magic number field: " | |
336 | "stream-addr=%p, stream-name=\"%s\"", | |
337 | stream, bt_ctf_stream_get_name(stream)); | |
338 | goto end; | |
339 | } | |
340 | ||
341 | ret = set_packet_header_uuid(stream); | |
342 | if (ret) { | |
343 | BT_LOGW("Cannot set packet header's UUID field: " | |
344 | "stream-addr=%p, stream-name=\"%s\"", | |
345 | stream, bt_ctf_stream_get_name(stream)); | |
346 | goto end; | |
347 | } | |
348 | ||
349 | ret = set_packet_header_stream_id(stream); | |
350 | if (ret) { | |
351 | BT_LOGW("Cannot set packet header's stream class ID field: " | |
352 | "stream-addr=%p, stream-name=\"%s\"", | |
353 | stream, bt_ctf_stream_get_name(stream)); | |
354 | goto end; | |
355 | } | |
356 | ||
c9ecaa78 | 357 | BT_LOGT("Automatically populated stream's packet header's known fields: " |
8deee039 PP |
358 | "stream-addr=%p, stream-name=\"%s\"", |
359 | stream, bt_ctf_stream_get_name(stream)); | |
360 | ||
361 | end: | |
362 | return ret; | |
363 | } | |
364 | ||
365 | static | |
6f4eefbe PP |
366 | int set_packet_context_packet_size(struct bt_ctf_stream *stream, |
367 | uint64_t packet_size_bits) | |
8deee039 PP |
368 | { |
369 | int ret = 0; | |
370 | struct bt_ctf_field *field = bt_ctf_field_structure_get_field_by_name( | |
371 | stream->packet_context, "packet_size"); | |
372 | ||
6f4eefbe | 373 | ret = bt_ctf_field_integer_unsigned_set_value(field, packet_size_bits); |
8deee039 PP |
374 | if (ret) { |
375 | BT_LOGW("Cannot set packet context field's `packet_size` integer field's value: " | |
376 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
377 | stream, bt_ctf_stream_get_name(stream), | |
6f4eefbe | 378 | field, packet_size_bits); |
8deee039 | 379 | } else { |
c9ecaa78 | 380 | BT_LOGT("Set packet context field's `packet_size` field's value: " |
8deee039 PP |
381 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, |
382 | stream, bt_ctf_stream_get_name(stream), | |
6f4eefbe | 383 | field, packet_size_bits); |
8deee039 PP |
384 | } |
385 | ||
c2606e2f | 386 | bt_ctf_object_put_ref(field); |
8deee039 PP |
387 | return ret; |
388 | } | |
389 | ||
390 | static | |
6f4eefbe PP |
391 | int set_packet_context_content_size(struct bt_ctf_stream *stream, |
392 | uint64_t content_size_bits) | |
8deee039 PP |
393 | { |
394 | int ret = 0; | |
395 | struct bt_ctf_field *field = bt_ctf_field_structure_get_field_by_name( | |
396 | stream->packet_context, "content_size"); | |
397 | ||
398 | BT_ASSERT(stream); | |
399 | ||
400 | if (!field) { | |
401 | /* No content size field found. Not an error, skip. */ | |
c9ecaa78 | 402 | BT_LOGT("No field named `content_size` in packet context: skipping: " |
8deee039 PP |
403 | "stream-addr=%p, stream-name=\"%s\"", |
404 | stream, bt_ctf_stream_get_name(stream)); | |
405 | goto end; | |
406 | } | |
407 | ||
6f4eefbe | 408 | ret = bt_ctf_field_integer_unsigned_set_value(field, content_size_bits); |
8deee039 PP |
409 | if (ret) { |
410 | BT_LOGW("Cannot set packet context field's `content_size` integer field's value: " | |
6f4eefbe | 411 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, |
8deee039 | 412 | stream, bt_ctf_stream_get_name(stream), |
6f4eefbe | 413 | field, content_size_bits); |
8deee039 | 414 | } else { |
c9ecaa78 | 415 | BT_LOGT("Set packet context field's `content_size` field's value: " |
6f4eefbe | 416 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, |
8deee039 | 417 | stream, bt_ctf_stream_get_name(stream), |
6f4eefbe | 418 | field, content_size_bits); |
8deee039 PP |
419 | } |
420 | ||
421 | end: | |
c2606e2f | 422 | bt_ctf_object_put_ref(field); |
8deee039 PP |
423 | return ret; |
424 | } | |
425 | ||
426 | static | |
427 | int set_packet_context_events_discarded(struct bt_ctf_stream *stream) | |
428 | { | |
429 | int ret = 0; | |
430 | struct bt_ctf_field *field = bt_ctf_field_structure_get_field_by_name( | |
431 | stream->packet_context, "events_discarded"); | |
432 | ||
433 | BT_ASSERT(stream); | |
434 | ||
435 | if (!field) { | |
436 | /* No discarded events count field found. Not an error, skip. */ | |
c9ecaa78 | 437 | BT_LOGT("No field named `events_discarded` in packet context: skipping: " |
8deee039 PP |
438 | "stream-addr=%p, stream-name=\"%s\"", |
439 | stream, bt_ctf_stream_get_name(stream)); | |
440 | goto end; | |
441 | } | |
442 | ||
443 | /* | |
444 | * If the field is set by the user, make sure that the value is | |
445 | * greater than or equal to the stream's current count of | |
446 | * discarded events. We do not allow wrapping here. If it's | |
447 | * valid, update the stream's current count. | |
448 | */ | |
449 | if (bt_ctf_field_is_set_recursive(field)) { | |
450 | uint64_t user_val; | |
451 | ||
452 | ret = bt_ctf_field_integer_unsigned_get_value(field, | |
453 | &user_val); | |
454 | if (ret) { | |
455 | BT_LOGW("Cannot get packet context `events_discarded` field's unsigned value: " | |
456 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p", | |
457 | stream, bt_ctf_stream_get_name(stream), field); | |
458 | goto end; | |
459 | } | |
460 | ||
461 | if (user_val < stream->discarded_events) { | |
462 | BT_LOGW("Invalid packet context `events_discarded` field's unsigned value: " | |
463 | "value is lesser than the stream's current discarded events count: " | |
464 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, " | |
465 | "value=%" PRIu64 ", " | |
466 | "stream-discarded-events-count=%" PRIu64, | |
467 | stream, bt_ctf_stream_get_name(stream), field, | |
468 | user_val, stream->discarded_events); | |
469 | goto end; | |
470 | } | |
471 | ||
472 | stream->discarded_events = user_val; | |
473 | } else { | |
474 | ret = bt_ctf_field_integer_unsigned_set_value(field, | |
475 | stream->discarded_events); | |
476 | if (ret) { | |
477 | BT_LOGW("Cannot set packet context field's `events_discarded` integer field's value: " | |
478 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, | |
479 | stream, bt_ctf_stream_get_name(stream), | |
480 | field, stream->discarded_events); | |
481 | } else { | |
c9ecaa78 | 482 | BT_LOGT("Set packet context field's `events_discarded` field's value: " |
8deee039 PP |
483 | "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64, |
484 | stream, bt_ctf_stream_get_name(stream), | |
485 | field, stream->discarded_events); | |
486 | } | |
487 | } | |
488 | ||
489 | end: | |
c2606e2f | 490 | bt_ctf_object_put_ref(field); |
8deee039 PP |
491 | return ret; |
492 | } | |
493 | ||
494 | static | |
495 | void update_clock_value(uint64_t *val, uint64_t new_val, | |
496 | unsigned int new_val_size) | |
497 | { | |
498 | const uint64_t pow2 = 1ULL << new_val_size; | |
499 | const uint64_t mask = pow2 - 1; | |
500 | uint64_t val_masked; | |
501 | ||
c9ecaa78 | 502 | #ifdef BT_LOG_ENABLED_TRACE |
8deee039 PP |
503 | uint64_t old_val = *val; |
504 | #endif | |
505 | ||
506 | if (new_val_size == 64) { | |
507 | *val = new_val; | |
508 | goto end; | |
509 | } | |
510 | ||
511 | val_masked = *val & mask; | |
512 | ||
513 | if (new_val < val_masked) { | |
514 | /* Wrapped once */ | |
515 | new_val |= pow2; | |
516 | } | |
517 | ||
518 | *val &= ~mask; | |
519 | *val |= new_val; | |
520 | ||
521 | end: | |
c9ecaa78 | 522 | BT_LOGT("Updated clock value: old-val=%" PRIu64 ", new-val=%" PRIu64, |
8deee039 PP |
523 | old_val, *val); |
524 | return; | |
525 | } | |
526 | ||
527 | static | |
528 | int visit_field_update_clock_value(struct bt_ctf_field *field, uint64_t *val) | |
529 | { | |
530 | int ret = 0; | |
086dc475 | 531 | struct bt_ctf_field_common *field_common = (void *) field; |
8deee039 PP |
532 | |
533 | if (!field) { | |
534 | goto end; | |
535 | } | |
536 | ||
537 | switch (bt_ctf_field_get_type_id(field)) { | |
538 | case BT_CTF_FIELD_TYPE_ID_INTEGER: | |
539 | { | |
540 | struct bt_ctf_clock_class *cc = | |
541 | bt_ctf_field_type_integer_get_mapped_clock_class( | |
542 | (void *) field_common->type); | |
543 | int val_size; | |
544 | uint64_t uval; | |
545 | ||
546 | if (!cc) { | |
547 | goto end; | |
548 | } | |
549 | ||
c2606e2f | 550 | bt_ctf_object_put_ref(cc); |
8deee039 PP |
551 | val_size = bt_ctf_field_type_integer_get_size( |
552 | (void *) field_common->type); | |
553 | BT_ASSERT(val_size >= 1); | |
554 | ||
555 | if (bt_ctf_field_type_integer_is_signed( | |
556 | (void *) field_common->type)) { | |
557 | int64_t ival; | |
558 | ||
559 | ret = bt_ctf_field_integer_signed_get_value(field, &ival); | |
560 | uval = (uint64_t) ival; | |
561 | } else { | |
562 | ret = bt_ctf_field_integer_unsigned_get_value(field, &uval); | |
563 | } | |
564 | ||
565 | if (ret) { | |
566 | /* Not set */ | |
567 | goto end; | |
568 | } | |
569 | ||
570 | update_clock_value(val, uval, val_size); | |
571 | break; | |
572 | } | |
573 | case BT_CTF_FIELD_TYPE_ID_ENUM: | |
574 | { | |
575 | struct bt_ctf_field *int_field = | |
576 | bt_ctf_field_enumeration_get_container(field); | |
577 | ||
578 | BT_ASSERT(int_field); | |
579 | ret = visit_field_update_clock_value(int_field, val); | |
c2606e2f | 580 | bt_ctf_object_put_ref(int_field); |
8deee039 PP |
581 | break; |
582 | } | |
583 | case BT_CTF_FIELD_TYPE_ID_ARRAY: | |
584 | { | |
585 | uint64_t i; | |
586 | int64_t len = bt_ctf_field_type_array_get_length( | |
587 | (void *) field_common->type); | |
588 | ||
589 | BT_ASSERT(len >= 0); | |
590 | ||
591 | for (i = 0; i < len; i++) { | |
592 | struct bt_ctf_field *elem_field = | |
593 | bt_ctf_field_array_get_field(field, i); | |
594 | ||
595 | BT_ASSERT(elem_field); | |
596 | ret = visit_field_update_clock_value(elem_field, val); | |
c2606e2f | 597 | bt_ctf_object_put_ref(elem_field); |
8deee039 PP |
598 | if (ret) { |
599 | goto end; | |
600 | } | |
601 | } | |
602 | break; | |
603 | } | |
604 | case BT_CTF_FIELD_TYPE_ID_SEQUENCE: | |
605 | { | |
606 | uint64_t i; | |
086dc475 | 607 | int64_t len = bt_ctf_field_common_sequence_get_length( |
8deee039 PP |
608 | (void *) field); |
609 | ||
610 | if (len < 0) { | |
611 | ret = -1; | |
612 | goto end; | |
613 | } | |
614 | ||
615 | for (i = 0; i < len; i++) { | |
616 | struct bt_ctf_field *elem_field = | |
617 | bt_ctf_field_sequence_get_field(field, i); | |
618 | ||
619 | BT_ASSERT(elem_field); | |
620 | ret = visit_field_update_clock_value(elem_field, val); | |
c2606e2f | 621 | bt_ctf_object_put_ref(elem_field); |
8deee039 PP |
622 | if (ret) { |
623 | goto end; | |
624 | } | |
625 | } | |
626 | break; | |
627 | } | |
628 | case BT_CTF_FIELD_TYPE_ID_STRUCT: | |
629 | { | |
630 | uint64_t i; | |
631 | int64_t len = bt_ctf_field_type_structure_get_field_count( | |
632 | (void *) field_common->type); | |
633 | ||
634 | BT_ASSERT(len >= 0); | |
635 | ||
636 | for (i = 0; i < len; i++) { | |
637 | struct bt_ctf_field *member_field = | |
638 | bt_ctf_field_structure_get_field_by_index(field, i); | |
639 | ||
640 | BT_ASSERT(member_field); | |
641 | ret = visit_field_update_clock_value(member_field, val); | |
c2606e2f | 642 | bt_ctf_object_put_ref(member_field); |
8deee039 PP |
643 | if (ret) { |
644 | goto end; | |
645 | } | |
646 | } | |
647 | break; | |
648 | } | |
649 | case BT_CTF_FIELD_TYPE_ID_VARIANT: | |
650 | { | |
651 | struct bt_ctf_field *cur_field = | |
652 | bt_ctf_field_variant_get_current_field(field); | |
653 | ||
654 | if (!cur_field) { | |
655 | ret = -1; | |
656 | goto end; | |
657 | } | |
658 | ||
659 | ret = visit_field_update_clock_value(cur_field, val); | |
c2606e2f | 660 | bt_ctf_object_put_ref(cur_field); |
8deee039 PP |
661 | break; |
662 | } | |
663 | default: | |
664 | break; | |
665 | } | |
666 | ||
667 | end: | |
668 | return ret; | |
669 | } | |
670 | ||
671 | int visit_event_update_clock_value(struct bt_ctf_event *event, uint64_t *val) | |
672 | { | |
673 | int ret = 0; | |
674 | struct bt_ctf_field *field; | |
675 | ||
676 | field = bt_ctf_event_get_header(event); | |
677 | ret = visit_field_update_clock_value(field, val); | |
c2606e2f | 678 | bt_ctf_object_put_ref(field); |
8deee039 PP |
679 | if (ret) { |
680 | BT_LOGW_STR("Cannot automatically update clock value in " | |
681 | "event's header."); | |
682 | goto end; | |
683 | } | |
684 | ||
685 | field = bt_ctf_event_get_stream_event_context(event); | |
686 | ret = visit_field_update_clock_value(field, val); | |
c2606e2f | 687 | bt_ctf_object_put_ref(field); |
8deee039 PP |
688 | if (ret) { |
689 | BT_LOGW_STR("Cannot automatically update clock value in " | |
690 | "event's stream event context."); | |
691 | goto end; | |
692 | } | |
693 | ||
694 | field = bt_ctf_event_get_context(event); | |
695 | ret = visit_field_update_clock_value(field, val); | |
c2606e2f | 696 | bt_ctf_object_put_ref(field); |
8deee039 PP |
697 | if (ret) { |
698 | BT_LOGW_STR("Cannot automatically update clock value in " | |
699 | "event's context."); | |
700 | goto end; | |
701 | } | |
702 | ||
703 | field = bt_ctf_event_get_payload_field(event); | |
704 | ret = visit_field_update_clock_value(field, val); | |
c2606e2f | 705 | bt_ctf_object_put_ref(field); |
8deee039 PP |
706 | if (ret) { |
707 | BT_LOGW_STR("Cannot automatically update clock value in " | |
708 | "event's payload."); | |
709 | goto end; | |
710 | } | |
711 | ||
712 | end: | |
713 | return ret; | |
714 | } | |
715 | ||
716 | static | |
717 | int set_packet_context_timestamps(struct bt_ctf_stream *stream) | |
718 | { | |
719 | int ret = 0; | |
720 | uint64_t val; | |
721 | uint64_t cur_clock_value; | |
722 | uint64_t init_clock_value = 0; | |
723 | struct bt_ctf_field *ts_begin_field = bt_ctf_field_structure_get_field_by_name( | |
724 | stream->packet_context, "timestamp_begin"); | |
725 | struct bt_ctf_field *ts_end_field = bt_ctf_field_structure_get_field_by_name( | |
726 | stream->packet_context, "timestamp_end"); | |
086dc475 | 727 | struct bt_ctf_field_common *packet_context = |
8deee039 PP |
728 | (void *) stream->packet_context; |
729 | uint64_t i; | |
730 | int64_t len; | |
731 | ||
732 | if (ts_begin_field && bt_ctf_field_is_set_recursive(ts_begin_field)) { | |
733 | /* Use provided `timestamp_begin` value as starting value */ | |
734 | ret = bt_ctf_field_integer_unsigned_get_value(ts_begin_field, &val); | |
735 | BT_ASSERT(ret == 0); | |
736 | init_clock_value = val; | |
737 | } else if (stream->last_ts_end != -1ULL) { | |
738 | /* Use last packet's ending timestamp as starting value */ | |
739 | init_clock_value = stream->last_ts_end; | |
740 | } | |
741 | ||
742 | cur_clock_value = init_clock_value; | |
743 | ||
744 | if (stream->last_ts_end != -1ULL && | |
745 | cur_clock_value < stream->last_ts_end) { | |
746 | BT_LOGW("Packet's initial timestamp is less than previous " | |
747 | "packet's final timestamp: " | |
748 | "stream-addr=%p, stream-name=\"%s\", " | |
749 | "cur-packet-ts-begin=%" PRIu64 ", " | |
750 | "prev-packet-ts-end=%" PRIu64, | |
751 | stream, bt_ctf_stream_get_name(stream), | |
752 | cur_clock_value, stream->last_ts_end); | |
753 | ret = -1; | |
754 | goto end; | |
755 | } | |
756 | ||
757 | /* | |
758 | * Visit all the packet context fields, followed by all the | |
759 | * fields of all the events, in order, updating our current | |
760 | * clock value as we visit. | |
761 | * | |
762 | * While visiting the packet context fields, do not consider | |
763 | * `timestamp_begin` and `timestamp_end` because this function's | |
764 | * purpose is to set them anyway. Also do not consider | |
765 | * `packet_size`, `content_size`, `events_discarded`, and | |
766 | * `packet_seq_num` if they are not set because those are | |
767 | * autopopulating fields. | |
768 | */ | |
769 | len = bt_ctf_field_type_structure_get_field_count( | |
770 | (void *) packet_context->type); | |
771 | BT_ASSERT(len >= 0); | |
772 | ||
773 | for (i = 0; i < len; i++) { | |
774 | const char *member_name; | |
775 | struct bt_ctf_field *member_field; | |
776 | ||
777 | ret = bt_ctf_field_type_structure_get_field_by_index( | |
778 | (void *) packet_context->type, &member_name, NULL, i); | |
779 | BT_ASSERT(ret == 0); | |
780 | ||
781 | if (strcmp(member_name, "timestamp_begin") == 0 || | |
782 | strcmp(member_name, "timestamp_end") == 0) { | |
783 | continue; | |
784 | } | |
785 | ||
786 | member_field = bt_ctf_field_structure_get_field_by_index( | |
787 | stream->packet_context, i); | |
788 | BT_ASSERT(member_field); | |
789 | ||
790 | if (strcmp(member_name, "packet_size") == 0 && | |
791 | !bt_ctf_field_is_set_recursive(member_field)) { | |
c2606e2f | 792 | bt_ctf_object_put_ref(member_field); |
8deee039 PP |
793 | continue; |
794 | } | |
795 | ||
796 | if (strcmp(member_name, "content_size") == 0 && | |
797 | !bt_ctf_field_is_set_recursive(member_field)) { | |
c2606e2f | 798 | bt_ctf_object_put_ref(member_field); |
8deee039 PP |
799 | continue; |
800 | } | |
801 | ||
802 | if (strcmp(member_name, "events_discarded") == 0 && | |
803 | !bt_ctf_field_is_set_recursive(member_field)) { | |
c2606e2f | 804 | bt_ctf_object_put_ref(member_field); |
8deee039 PP |
805 | continue; |
806 | } | |
807 | ||
808 | if (strcmp(member_name, "packet_seq_num") == 0 && | |
809 | !bt_ctf_field_is_set_recursive(member_field)) { | |
c2606e2f | 810 | bt_ctf_object_put_ref(member_field); |
8deee039 PP |
811 | continue; |
812 | } | |
813 | ||
814 | ret = visit_field_update_clock_value(member_field, | |
815 | &cur_clock_value); | |
c2606e2f | 816 | bt_ctf_object_put_ref(member_field); |
8deee039 PP |
817 | if (ret) { |
818 | BT_LOGW("Cannot automatically update clock value " | |
819 | "in stream's packet context: " | |
820 | "stream-addr=%p, stream-name=\"%s\", " | |
821 | "field-name=\"%s\"", | |
822 | stream, bt_ctf_stream_get_name(stream), | |
823 | member_name); | |
824 | goto end; | |
825 | } | |
826 | } | |
827 | ||
828 | for (i = 0; i < stream->events->len; i++) { | |
829 | struct bt_ctf_event *event = g_ptr_array_index(stream->events, i); | |
830 | ||
831 | BT_ASSERT(event); | |
832 | ret = visit_event_update_clock_value(event, &cur_clock_value); | |
833 | if (ret) { | |
834 | BT_LOGW("Cannot automatically update clock value " | |
835 | "in stream's packet context: " | |
836 | "stream-addr=%p, stream-name=\"%s\", " | |
837 | "index=%" PRIu64 ", event-addr=%p, " | |
838 | "event-class-id=%" PRId64 ", " | |
839 | "event-class-name=\"%s\"", | |
840 | stream, bt_ctf_stream_get_name(stream), | |
841 | i, event, | |
086dc475 PP |
842 | bt_ctf_event_class_common_get_id(event->common.class), |
843 | bt_ctf_event_class_common_get_name(event->common.class)); | |
8deee039 PP |
844 | goto end; |
845 | } | |
846 | } | |
847 | ||
848 | /* | |
849 | * Everything is visited, thus the current clock value | |
850 | * corresponds to the ending timestamp. Validate this value | |
851 | * against the provided value of `timestamp_end`, if any, | |
852 | * otherwise set it. | |
853 | */ | |
854 | if (ts_end_field && bt_ctf_field_is_set_recursive(ts_end_field)) { | |
855 | ret = bt_ctf_field_integer_unsigned_get_value(ts_end_field, &val); | |
856 | BT_ASSERT(ret == 0); | |
857 | ||
858 | if (val < cur_clock_value) { | |
859 | BT_LOGW("Packet's final timestamp is less than " | |
860 | "computed packet's final timestamp: " | |
861 | "stream-addr=%p, stream-name=\"%s\", " | |
862 | "cur-packet-ts-end=%" PRIu64 ", " | |
863 | "computed-packet-ts-end=%" PRIu64, | |
864 | stream, bt_ctf_stream_get_name(stream), | |
865 | val, cur_clock_value); | |
866 | ret = -1; | |
867 | goto end; | |
868 | } | |
869 | ||
870 | stream->last_ts_end = val; | |
871 | } | |
872 | ||
873 | if (ts_end_field && !bt_ctf_field_is_set_recursive(ts_end_field)) { | |
874 | ret = set_integer_field_value(ts_end_field, cur_clock_value); | |
875 | BT_ASSERT(ret == 0); | |
876 | stream->last_ts_end = cur_clock_value; | |
877 | } | |
878 | ||
879 | if (!ts_end_field) { | |
880 | stream->last_ts_end = cur_clock_value; | |
881 | } | |
882 | ||
883 | /* Set `timestamp_begin` field to initial clock value */ | |
884 | if (ts_begin_field && !bt_ctf_field_is_set_recursive(ts_begin_field)) { | |
885 | ret = set_integer_field_value(ts_begin_field, init_clock_value); | |
886 | BT_ASSERT(ret == 0); | |
887 | } | |
888 | ||
889 | end: | |
c2606e2f PP |
890 | bt_ctf_object_put_ref(ts_begin_field); |
891 | bt_ctf_object_put_ref(ts_end_field); | |
8deee039 PP |
892 | return ret; |
893 | } | |
894 | ||
895 | static | |
6f4eefbe PP |
896 | int auto_populate_packet_context(struct bt_ctf_stream *stream, bool set_ts, |
897 | uint64_t packet_size_bits, uint64_t content_size_bits) | |
8deee039 PP |
898 | { |
899 | int ret = 0; | |
900 | ||
901 | if (!stream->packet_context) { | |
902 | goto end; | |
903 | } | |
904 | ||
6f4eefbe | 905 | ret = set_packet_context_packet_size(stream, packet_size_bits); |
8deee039 PP |
906 | if (ret) { |
907 | BT_LOGW("Cannot set packet context's packet size field: " | |
908 | "stream-addr=%p, stream-name=\"%s\"", | |
909 | stream, bt_ctf_stream_get_name(stream)); | |
910 | goto end; | |
911 | } | |
912 | ||
6f4eefbe | 913 | ret = set_packet_context_content_size(stream, content_size_bits); |
8deee039 PP |
914 | if (ret) { |
915 | BT_LOGW("Cannot set packet context's content size field: " | |
916 | "stream-addr=%p, stream-name=\"%s\"", | |
917 | stream, bt_ctf_stream_get_name(stream)); | |
918 | goto end; | |
919 | } | |
920 | ||
921 | if (set_ts) { | |
922 | ret = set_packet_context_timestamps(stream); | |
923 | if (ret) { | |
924 | BT_LOGW("Cannot set packet context's timestamp fields: " | |
925 | "stream-addr=%p, stream-name=\"%s\"", | |
926 | stream, bt_ctf_stream_get_name(stream)); | |
927 | goto end; | |
928 | } | |
929 | } | |
930 | ||
931 | ret = set_packet_context_events_discarded(stream); | |
932 | if (ret) { | |
933 | BT_LOGW("Cannot set packet context's discarded events count field: " | |
934 | "stream-addr=%p, stream-name=\"%s\"", | |
935 | stream, bt_ctf_stream_get_name(stream)); | |
936 | goto end; | |
937 | } | |
938 | ||
c9ecaa78 | 939 | BT_LOGT("Automatically populated stream's packet context's known fields: " |
8deee039 PP |
940 | "stream-addr=%p, stream-name=\"%s\"", |
941 | stream, bt_ctf_stream_get_name(stream)); | |
942 | ||
943 | end: | |
944 | return ret; | |
945 | } | |
946 | ||
947 | static | |
948 | void release_event(struct bt_ctf_event *event) | |
949 | { | |
c2606e2f | 950 | if (bt_ctf_object_get_ref_count(&event->common.base)) { |
8deee039 PP |
951 | /* |
952 | * The event is being orphaned, but it must guarantee the | |
953 | * existence of its event class for the duration of its | |
954 | * lifetime. | |
955 | */ | |
c2606e2f PP |
956 | bt_ctf_object_get_ref(event->common.class); |
957 | BT_CTF_OBJECT_PUT_REF_AND_RESET(event->common.base.parent); | |
8deee039 | 958 | } else { |
c2606e2f | 959 | bt_ctf_object_try_spec_release(&event->common.base); |
8deee039 PP |
960 | } |
961 | } | |
962 | ||
963 | static | |
964 | int create_stream_file(struct bt_ctf_writer *writer, | |
965 | struct bt_ctf_stream *stream) | |
966 | { | |
6f4eefbe | 967 | int ret = 0; |
8deee039 PP |
968 | GString *filename = g_string_new(NULL); |
969 | int64_t stream_class_id; | |
970 | char *file_path = NULL; | |
971 | ||
972 | BT_LOGD("Creating stream file: writer-addr=%p, stream-addr=%p, " | |
973 | "stream-name=\"%s\", stream-class-addr=%p, stream-class-name=\"%s\"", | |
974 | writer, stream, bt_ctf_stream_get_name(stream), | |
975 | stream->common.stream_class, | |
976 | stream->common.stream_class->name->str); | |
977 | ||
978 | if (stream->common.name && stream->common.name->len > 0) { | |
979 | /* Use stream name's base name as prefix */ | |
980 | gchar *basename = g_path_get_basename(stream->common.name->str); | |
981 | ||
982 | BT_ASSERT(basename); | |
983 | ||
984 | if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) { | |
985 | g_string_assign(filename, "stream"); | |
986 | } else { | |
987 | g_string_assign(filename, basename); | |
988 | } | |
989 | ||
990 | g_free(basename); | |
991 | goto append_ids; | |
992 | } | |
993 | ||
994 | if (stream->common.stream_class->name && | |
995 | stream->common.stream_class->name->len > 0) { | |
996 | /* Use stream class name's base name as prefix */ | |
997 | gchar *basename = | |
998 | g_path_get_basename( | |
999 | stream->common.stream_class->name->str); | |
1000 | ||
1001 | BT_ASSERT(basename); | |
1002 | ||
1003 | if (strcmp(basename, G_DIR_SEPARATOR_S) == 0) { | |
1004 | g_string_assign(filename, "stream"); | |
1005 | } else { | |
1006 | g_string_assign(filename, basename); | |
1007 | } | |
1008 | ||
1009 | g_free(basename); | |
1010 | goto append_ids; | |
1011 | } | |
1012 | ||
1013 | /* Default to using `stream-` as prefix */ | |
1014 | g_string_assign(filename, "stream"); | |
1015 | ||
1016 | append_ids: | |
086dc475 | 1017 | stream_class_id = bt_ctf_stream_class_common_get_id(stream->common.stream_class); |
8deee039 PP |
1018 | BT_ASSERT(stream_class_id >= 0); |
1019 | BT_ASSERT(stream->common.id >= 0); | |
1020 | g_string_append_printf(filename, "-%" PRId64 "-%" PRId64, | |
1021 | stream_class_id, stream->common.id); | |
1022 | ||
1023 | file_path = g_build_filename(writer->path->str, filename->str, NULL); | |
8e01f2d9 | 1024 | if (!file_path) { |
6f4eefbe | 1025 | ret = -1; |
8deee039 PP |
1026 | goto end; |
1027 | } | |
1028 | ||
c864e29a PP |
1029 | ret = bt_ctfser_init(&stream->ctfser, file_path, |
1030 | BT_LOG_OUTPUT_LEVEL); | |
8deee039 | 1031 | g_free(file_path); |
6f4eefbe PP |
1032 | if (ret) { |
1033 | /* bt_ctfser_init() logs errors */ | |
8deee039 PP |
1034 | goto end; |
1035 | } | |
1036 | ||
1037 | BT_LOGD("Created stream file for writing: " | |
1038 | "stream-addr=%p, stream-name=\"%s\", " | |
6f4eefbe PP |
1039 | "filename=\"%s\"", stream, bt_ctf_stream_get_name(stream), |
1040 | filename->str); | |
8deee039 PP |
1041 | |
1042 | end: | |
1043 | g_string_free(filename, TRUE); | |
6f4eefbe | 1044 | return ret; |
8deee039 PP |
1045 | } |
1046 | ||
1047 | BT_HIDDEN | |
1048 | struct bt_ctf_stream *bt_ctf_stream_create_with_id( | |
1049 | struct bt_ctf_stream_class *stream_class, | |
1050 | const char *name, uint64_t id) | |
1051 | { | |
1052 | int ret; | |
1053 | int fd; | |
1054 | struct bt_ctf_stream *stream = NULL; | |
1055 | struct bt_ctf_trace *trace = NULL; | |
1056 | struct bt_ctf_writer *writer = NULL; | |
1057 | ||
1058 | BT_LOGD("Creating CTF writer stream object: stream-class-addr=%p, " | |
1059 | "stream-class-name=\"%s\", stream-name=\"%s\", " | |
1060 | "stream-id=%" PRIu64, | |
1061 | stream_class, bt_ctf_stream_class_get_name(stream_class), | |
1062 | name, id); | |
1063 | stream = g_new0(struct bt_ctf_stream, 1); | |
1064 | if (!stream) { | |
1065 | BT_LOGE_STR("Failed to allocate one stream."); | |
1066 | goto error; | |
1067 | } | |
1068 | ||
1069 | if (id == -1ULL) { | |
1070 | id = stream_class->next_stream_id; | |
1071 | } | |
1072 | ||
086dc475 PP |
1073 | ret = bt_ctf_stream_common_initialize(BT_CTF_TO_COMMON(stream), |
1074 | BT_CTF_TO_COMMON(stream_class), name, id, bt_ctf_stream_destroy); | |
8deee039 | 1075 | if (ret) { |
086dc475 | 1076 | /* bt_ctf_stream_common_initialize() logs errors */ |
8deee039 PP |
1077 | goto error; |
1078 | } | |
1079 | ||
086dc475 PP |
1080 | trace = BT_CTF_FROM_COMMON(bt_ctf_stream_class_common_borrow_trace( |
1081 | BT_CTF_TO_COMMON(stream_class))); | |
8deee039 PP |
1082 | if (!trace) { |
1083 | BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: " | |
1084 | "stream-class-addr=%p, stream-class-name=\"%s\", " | |
1085 | "stream-name=\"%s\"", | |
1086 | stream_class, bt_ctf_stream_class_get_name(stream_class), | |
1087 | name); | |
1088 | goto error; | |
1089 | } | |
1090 | ||
1d7bf349 | 1091 | writer = (struct bt_ctf_writer *) |
c2606e2f | 1092 | bt_ctf_object_get_parent(&trace->common.base); |
8deee039 PP |
1093 | stream->last_ts_end = -1ULL; |
1094 | BT_LOGD("CTF writer stream object belongs writer's trace: " | |
1095 | "writer-addr=%p", writer); | |
1096 | BT_ASSERT(writer); | |
1097 | ||
1098 | if (stream_class->common.packet_context_field_type) { | |
1099 | BT_LOGD("Creating stream's packet context field: " | |
1100 | "ft-addr=%p", | |
1101 | stream_class->common.packet_context_field_type); | |
1102 | stream->packet_context = bt_ctf_field_create( | |
1103 | (void *) stream_class->common.packet_context_field_type); | |
1104 | if (!stream->packet_context) { | |
1105 | BT_LOGW_STR("Cannot create stream's packet context field."); | |
1106 | goto error; | |
1107 | } | |
1108 | ||
1109 | /* Initialize events_discarded */ | |
1110 | ret = try_set_structure_field_integer( | |
1111 | stream->packet_context, "events_discarded", 0); | |
1112 | if (ret < 0) { | |
1113 | BT_LOGW("Cannot set `events_discarded` field in packet context: " | |
1114 | "ret=%d, packet-context-field-addr=%p", | |
1115 | ret, stream->packet_context); | |
1116 | goto error; | |
1117 | } | |
1118 | } | |
1119 | ||
1120 | stream->events = g_ptr_array_new_with_free_func( | |
1121 | (GDestroyNotify) release_event); | |
1122 | if (!stream->events) { | |
1123 | BT_LOGE_STR("Failed to allocate a GPtrArray."); | |
1124 | goto error; | |
1125 | } | |
1126 | ||
1127 | if (trace->common.packet_header_field_type) { | |
1128 | BT_LOGD("Creating stream's packet header field: " | |
1129 | "ft-addr=%p", trace->common.packet_header_field_type); | |
1130 | stream->packet_header = | |
1131 | bt_ctf_field_create( | |
1132 | (void *) trace->common.packet_header_field_type); | |
1133 | if (!stream->packet_header) { | |
1134 | BT_LOGW_STR("Cannot create stream's packet header field."); | |
1135 | goto error; | |
1136 | } | |
1137 | } | |
1138 | ||
1139 | /* | |
1140 | * Attempt to populate the default trace packet header fields | |
1141 | * (magic, uuid and stream_id). This will _not_ fail shall the | |
1142 | * fields not be found or be of an incompatible type; they will | |
1143 | * simply not be populated automatically. The user will have to | |
1144 | * make sure to set the trace packet header fields himself | |
1145 | * before flushing. | |
1146 | */ | |
1147 | ret = auto_populate_packet_header(stream); | |
1148 | if (ret) { | |
1149 | BT_LOGW_STR("Cannot automatically populate the stream's packet header."); | |
1150 | goto error; | |
1151 | } | |
1152 | ||
1153 | /* Create file associated with this stream */ | |
1154 | fd = create_stream_file(writer, stream); | |
1155 | if (fd < 0) { | |
1156 | BT_LOGW_STR("Cannot create stream file."); | |
1157 | goto error; | |
1158 | } | |
1159 | ||
8deee039 PP |
1160 | /* Freeze the writer */ |
1161 | BT_LOGD_STR("Freezing stream's CTF writer."); | |
1162 | bt_ctf_writer_freeze(writer); | |
1163 | ||
1164 | /* Add this stream to the trace's streams */ | |
1165 | g_ptr_array_add(trace->common.streams, stream); | |
1166 | stream_class->next_stream_id++; | |
1167 | BT_LOGD("Created stream object: addr=%p", stream); | |
1168 | goto end; | |
1169 | ||
1170 | error: | |
c2606e2f | 1171 | BT_CTF_OBJECT_PUT_REF_AND_RESET(stream); |
8deee039 PP |
1172 | |
1173 | end: | |
c2606e2f | 1174 | bt_ctf_object_put_ref(writer); |
8deee039 PP |
1175 | return stream; |
1176 | } | |
1177 | ||
1178 | struct bt_ctf_stream *bt_ctf_stream_create( | |
1179 | struct bt_ctf_stream_class *stream_class, | |
1180 | const char *name, uint64_t id_param) | |
1181 | { | |
1182 | return bt_ctf_stream_create_with_id(stream_class, | |
1183 | name, id_param); | |
1184 | } | |
1185 | ||
1186 | int bt_ctf_stream_get_discarded_events_count( | |
1187 | struct bt_ctf_stream *stream, uint64_t *count) | |
1188 | { | |
1189 | int ret = 0; | |
1190 | ||
1191 | if (!stream) { | |
1192 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1193 | ret = -1; | |
1194 | goto end; | |
1195 | } | |
1196 | ||
1197 | if (!count) { | |
1198 | BT_LOGW_STR("Invalid parameter: count is NULL."); | |
1199 | ret = -1; | |
1200 | goto end; | |
1201 | } | |
1202 | ||
8deee039 PP |
1203 | *count = (uint64_t) stream->discarded_events; |
1204 | ||
1205 | end: | |
1206 | return ret; | |
1207 | } | |
1208 | ||
1209 | static | |
1210 | int set_packet_context_events_discarded_field(struct bt_ctf_stream *stream, | |
1211 | uint64_t count) | |
1212 | { | |
1213 | int ret = 0; | |
1214 | struct bt_ctf_field *events_discarded_field = NULL; | |
1215 | ||
1216 | if (!stream->packet_context) { | |
1217 | goto end; | |
1218 | } | |
1219 | ||
1220 | events_discarded_field = bt_ctf_field_structure_get_field_by_name( | |
1221 | stream->packet_context, "events_discarded"); | |
1222 | if (!events_discarded_field) { | |
1223 | goto end; | |
1224 | } | |
1225 | ||
1226 | ret = bt_ctf_field_integer_unsigned_set_value( | |
1227 | events_discarded_field, count); | |
1228 | if (ret) { | |
1229 | BT_LOGW("Cannot set packet context's `events_discarded` field: " | |
1230 | "field-addr=%p, value=%" PRIu64, | |
1231 | events_discarded_field, count); | |
1232 | goto end; | |
1233 | } | |
1234 | ||
1235 | end: | |
c2606e2f | 1236 | bt_ctf_object_put_ref(events_discarded_field); |
8deee039 PP |
1237 | return ret; |
1238 | } | |
1239 | ||
1240 | void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, | |
1241 | uint64_t event_count) | |
1242 | { | |
1243 | int ret; | |
1244 | uint64_t new_count; | |
1245 | struct bt_ctf_field *events_discarded_field = NULL; | |
1246 | ||
1247 | if (!stream) { | |
1248 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1249 | goto end; | |
1250 | } | |
1251 | ||
c9ecaa78 | 1252 | BT_LOGT("Appending discarded events to stream: " |
8deee039 PP |
1253 | "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64, |
1254 | stream, bt_ctf_stream_get_name(stream), event_count); | |
1255 | ||
1256 | if (!stream->packet_context) { | |
1257 | BT_LOGW_STR("Invalid parameter: stream has no packet context field."); | |
1258 | goto end; | |
1259 | } | |
1260 | ||
8deee039 PP |
1261 | events_discarded_field = bt_ctf_field_structure_get_field_by_name( |
1262 | stream->packet_context, "events_discarded"); | |
1263 | if (!events_discarded_field) { | |
1264 | BT_LOGW_STR("No field named `events_discarded` in stream's packet context."); | |
1265 | goto end; | |
1266 | } | |
1267 | ||
1268 | new_count = stream->discarded_events + event_count; | |
1269 | if (new_count < stream->discarded_events) { | |
1270 | BT_LOGW("New discarded events count is less than the stream's current discarded events count: " | |
1271 | "cur-count=%" PRIu64 ", new-count=%" PRIu64, | |
1272 | stream->discarded_events, new_count); | |
1273 | goto end; | |
1274 | } | |
1275 | ||
1276 | ret = set_packet_context_events_discarded_field(stream, new_count); | |
1277 | if (ret) { | |
1278 | /* set_packet_context_events_discarded_field() logs errors */ | |
1279 | goto end; | |
1280 | } | |
1281 | ||
1282 | stream->discarded_events = new_count; | |
c9ecaa78 | 1283 | BT_LOGT("Appended discarded events to stream: " |
8deee039 PP |
1284 | "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64, |
1285 | stream, bt_ctf_stream_get_name(stream), event_count); | |
1286 | ||
1287 | end: | |
c2606e2f | 1288 | bt_ctf_object_put_ref(events_discarded_field); |
8deee039 PP |
1289 | } |
1290 | ||
1291 | static int auto_populate_event_header(struct bt_ctf_stream *stream, | |
1292 | struct bt_ctf_event *event) | |
1293 | { | |
1294 | int ret = 0; | |
1295 | struct bt_ctf_field *id_field = NULL, *timestamp_field = NULL; | |
1296 | struct bt_ctf_clock_class *mapped_clock_class = NULL; | |
1297 | struct bt_ctf_stream_class *stream_class = | |
086dc475 PP |
1298 | BT_CTF_FROM_COMMON(bt_ctf_stream_common_borrow_class( |
1299 | BT_CTF_TO_COMMON(stream))); | |
8deee039 PP |
1300 | int64_t event_class_id; |
1301 | ||
1302 | BT_ASSERT(event); | |
1303 | ||
1304 | if (!event->common.header_field) { | |
1305 | goto end; | |
1306 | } | |
1307 | ||
1308 | if (event->common.frozen) { | |
1309 | BT_LOGW_STR("Cannot populate event header field: event is frozen."); | |
1310 | ret = -1; | |
1311 | goto end; | |
1312 | } | |
1313 | ||
c9ecaa78 | 1314 | BT_LOGT("Automatically populating event's header field: " |
8deee039 PP |
1315 | "stream-addr=%p, stream-name=\"%s\", event-addr=%p", |
1316 | stream, bt_ctf_stream_get_name(stream), event); | |
1317 | ||
1318 | id_field = bt_ctf_field_structure_get_field_by_name( | |
a6918753 | 1319 | (void *) event->common.header_field->field, "id"); |
086dc475 | 1320 | event_class_id = bt_ctf_event_class_common_get_id(event->common.class); |
8deee039 PP |
1321 | BT_ASSERT(event_class_id >= 0); |
1322 | ||
1323 | if (id_field && bt_ctf_field_get_type_id(id_field) == BT_CTF_FIELD_TYPE_ID_INTEGER) { | |
1324 | ret = set_integer_field_value(id_field, event_class_id); | |
1325 | if (ret) { | |
1326 | BT_LOGW("Cannot set event header's `id` field's value: " | |
1327 | "addr=%p, value=%" PRIu64, id_field, | |
1328 | event_class_id); | |
1329 | goto end; | |
1330 | } | |
1331 | } | |
1332 | ||
1333 | /* | |
1334 | * The conditions to automatically set the timestamp are: | |
1335 | * | |
1336 | * 1. The event header field "timestamp" exists and is an | |
1337 | * integer field. | |
1338 | * 2. This stream's class has a registered clock (set with | |
1339 | * bt_ctf_stream_class_set_clock()). | |
1340 | * 3. The "timestamp" field is not set. | |
1341 | */ | |
1342 | timestamp_field = bt_ctf_field_structure_get_field_by_name( | |
a6918753 | 1343 | (void *) event->common.header_field->field, "timestamp"); |
8deee039 PP |
1344 | if (timestamp_field && stream_class->clock && |
1345 | bt_ctf_field_get_type_id(id_field) == BT_CTF_FIELD_TYPE_ID_INTEGER && | |
1346 | !bt_ctf_field_is_set_recursive(timestamp_field)) { | |
1347 | mapped_clock_class = | |
1348 | bt_ctf_field_type_integer_get_mapped_clock_class( | |
086dc475 | 1349 | (void *) ((struct bt_ctf_field_common *) timestamp_field)->type); |
8deee039 PP |
1350 | if (mapped_clock_class) { |
1351 | uint64_t timestamp; | |
1352 | ||
1353 | BT_ASSERT(mapped_clock_class == | |
1354 | stream_class->clock->clock_class); | |
1355 | ret = bt_ctf_clock_get_value( | |
1356 | stream_class->clock, | |
1357 | ×tamp); | |
1358 | BT_ASSERT(ret == 0); | |
1359 | ret = set_integer_field_value(timestamp_field, | |
1360 | timestamp); | |
1361 | if (ret) { | |
1362 | BT_LOGW("Cannot set event header's `timestamp` field's value: " | |
1363 | "addr=%p, value=%" PRIu64, | |
1364 | timestamp_field, timestamp); | |
1365 | goto end; | |
1366 | } | |
1367 | } | |
1368 | } | |
1369 | ||
c9ecaa78 | 1370 | BT_LOGT("Automatically populated event's header field: " |
8deee039 PP |
1371 | "stream-addr=%p, stream-name=\"%s\", event-addr=%p", |
1372 | stream, bt_ctf_stream_get_name(stream), event); | |
1373 | ||
1374 | end: | |
c2606e2f PP |
1375 | bt_ctf_object_put_ref(id_field); |
1376 | bt_ctf_object_put_ref(timestamp_field); | |
1377 | bt_ctf_object_put_ref(mapped_clock_class); | |
8deee039 PP |
1378 | return ret; |
1379 | } | |
1380 | ||
1381 | int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, | |
1382 | struct bt_ctf_event *event) | |
1383 | { | |
1384 | int ret = 0; | |
1385 | ||
1386 | if (!stream) { | |
1387 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1388 | ret = -1; | |
1389 | goto end; | |
1390 | } | |
1391 | ||
1392 | if (!event) { | |
1393 | BT_LOGW_STR("Invalid parameter: event is NULL."); | |
1394 | ret = -1; | |
1395 | goto end; | |
1396 | } | |
1397 | ||
c9ecaa78 | 1398 | BT_LOGT("Appending event to stream: " |
8deee039 PP |
1399 | "stream-addr=%p, stream-name=\"%s\", event-addr=%p, " |
1400 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
1401 | stream, bt_ctf_stream_get_name(stream), event, | |
086dc475 PP |
1402 | bt_ctf_event_class_common_get_name( |
1403 | bt_ctf_event_common_borrow_class(BT_CTF_TO_COMMON(event))), | |
1404 | bt_ctf_event_class_common_get_id( | |
1405 | bt_ctf_event_common_borrow_class(BT_CTF_TO_COMMON(event)))); | |
8deee039 PP |
1406 | |
1407 | /* | |
1408 | * The event is not supposed to have a parent stream at this | |
1409 | * point. The only other way an event can have a parent stream | |
1410 | * is if it was assigned when setting a packet to the event, | |
1411 | * in which case the packet's stream is not a writer stream, | |
1412 | * and thus the user is trying to append an event which belongs | |
1413 | * to another stream. | |
1414 | */ | |
1415 | if (event->common.base.parent) { | |
1416 | ret = -1; | |
1417 | goto end; | |
1418 | } | |
1419 | ||
c2606e2f | 1420 | bt_ctf_object_set_parent(&event->common.base, &stream->common.base); |
c9ecaa78 | 1421 | BT_LOGT_STR("Automatically populating the header of the event to append."); |
8deee039 PP |
1422 | ret = auto_populate_event_header(stream, event); |
1423 | if (ret) { | |
1424 | /* auto_populate_event_header() reports errors */ | |
1425 | goto error; | |
1426 | } | |
1427 | ||
1428 | /* Make sure the various scopes of the event are set */ | |
c9ecaa78 | 1429 | BT_LOGT_STR("Validating event to append."); |
bf436657 | 1430 | BT_CTF_ASSERT_PRE(bt_ctf_event_common_validate(BT_CTF_TO_COMMON(event)) == 0, |
086dc475 | 1431 | "Invalid event: event-addr=%p", event); |
8deee039 PP |
1432 | |
1433 | /* Save the new event and freeze it */ | |
c9ecaa78 | 1434 | BT_LOGT_STR("Freezing the event to append."); |
086dc475 | 1435 | bt_ctf_event_common_set_is_frozen(BT_CTF_TO_COMMON(event), true); |
8deee039 PP |
1436 | g_ptr_array_add(stream->events, event); |
1437 | ||
1438 | /* | |
1439 | * Event had to hold a reference to its event class as long as it wasn't | |
1440 | * part of the same trace hierarchy. From now on, the event and its | |
1441 | * class share the same lifetime guarantees and the reference is no | |
1442 | * longer needed. | |
1443 | */ | |
c9ecaa78 | 1444 | BT_LOGT_STR("Putting the event's class."); |
c2606e2f | 1445 | bt_ctf_object_put_ref(event->common.class); |
c9ecaa78 | 1446 | BT_LOGT("Appended event to stream: " |
8deee039 PP |
1447 | "stream-addr=%p, stream-name=\"%s\", event-addr=%p, " |
1448 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
1449 | stream, bt_ctf_stream_get_name(stream), event, | |
086dc475 PP |
1450 | bt_ctf_event_class_common_get_name( |
1451 | bt_ctf_event_common_borrow_class(BT_CTF_TO_COMMON(event))), | |
1452 | bt_ctf_event_class_common_get_id( | |
1453 | bt_ctf_event_common_borrow_class(BT_CTF_TO_COMMON(event)))); | |
8deee039 PP |
1454 | |
1455 | end: | |
1456 | return ret; | |
1457 | ||
1458 | error: | |
1459 | /* | |
1460 | * Orphan the event; we were not successful in associating it to | |
1461 | * a stream. | |
1462 | */ | |
c2606e2f | 1463 | bt_ctf_object_set_parent(&event->common.base, NULL); |
8deee039 PP |
1464 | return ret; |
1465 | } | |
1466 | ||
1467 | struct bt_ctf_field *bt_ctf_stream_get_packet_context(struct bt_ctf_stream *stream) | |
1468 | { | |
1469 | struct bt_ctf_field *packet_context = NULL; | |
1470 | ||
1471 | if (!stream) { | |
1472 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1473 | goto end; | |
1474 | } | |
1475 | ||
8deee039 PP |
1476 | packet_context = stream->packet_context; |
1477 | if (packet_context) { | |
c2606e2f | 1478 | bt_ctf_object_get_ref(packet_context); |
8deee039 PP |
1479 | } |
1480 | end: | |
1481 | return packet_context; | |
1482 | } | |
1483 | ||
1484 | int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream, | |
1485 | struct bt_ctf_field *field) | |
1486 | { | |
1487 | int ret = 0; | |
1488 | struct bt_ctf_field_type *field_type; | |
1489 | ||
1490 | if (!stream) { | |
1491 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1492 | ret = -1; | |
1493 | goto end; | |
1494 | } | |
1495 | ||
8deee039 | 1496 | field_type = bt_ctf_field_get_type(field); |
086dc475 | 1497 | if (bt_ctf_field_type_common_compare((void *) field_type, |
8deee039 PP |
1498 | stream->common.stream_class->packet_context_field_type)) { |
1499 | BT_LOGW("Invalid parameter: packet context's field type is different from the stream's packet context field type: " | |
1500 | "stream-addr=%p, stream-name=\"%s\", " | |
1501 | "packet-context-field-addr=%p, " | |
1502 | "packet-context-ft-addr=%p", | |
1503 | stream, bt_ctf_stream_get_name(stream), | |
1504 | field, field_type); | |
1505 | ret = -1; | |
1506 | goto end; | |
1507 | } | |
1508 | ||
c2606e2f PP |
1509 | bt_ctf_object_put_ref(field_type); |
1510 | bt_ctf_object_put_ref(stream->packet_context); | |
1511 | stream->packet_context = bt_ctf_object_get_ref(field); | |
c9ecaa78 | 1512 | BT_LOGT("Set stream's packet context field: " |
8deee039 PP |
1513 | "stream-addr=%p, stream-name=\"%s\", " |
1514 | "packet-context-field-addr=%p", | |
1515 | stream, bt_ctf_stream_get_name(stream), field); | |
1516 | end: | |
1517 | return ret; | |
1518 | } | |
1519 | ||
1520 | struct bt_ctf_field *bt_ctf_stream_get_packet_header(struct bt_ctf_stream *stream) | |
1521 | { | |
1522 | struct bt_ctf_field *packet_header = NULL; | |
1523 | ||
1524 | if (!stream) { | |
1525 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1526 | goto end; | |
1527 | } | |
1528 | ||
8deee039 PP |
1529 | packet_header = stream->packet_header; |
1530 | if (packet_header) { | |
c2606e2f | 1531 | bt_ctf_object_get_ref(packet_header); |
8deee039 PP |
1532 | } |
1533 | end: | |
1534 | return packet_header; | |
1535 | } | |
1536 | ||
1537 | int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream, | |
1538 | struct bt_ctf_field *field) | |
1539 | { | |
1540 | int ret = 0; | |
1541 | struct bt_ctf_trace *trace = NULL; | |
1542 | struct bt_ctf_field_type *field_type = NULL; | |
1543 | ||
1544 | if (!stream) { | |
1545 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1546 | ret = -1; | |
1547 | goto end; | |
1548 | } | |
1549 | ||
1d7bf349 | 1550 | trace = (struct bt_ctf_trace *) |
c2606e2f | 1551 | bt_ctf_object_get_parent(&stream->common.base); |
8deee039 PP |
1552 | |
1553 | if (!field) { | |
1554 | if (trace->common.packet_header_field_type) { | |
1555 | BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: " | |
1556 | "stream-addr=%p, stream-name=\"%s\", " | |
1557 | "packet-header-field-addr=%p, " | |
1558 | "expected-ft-addr=%p", | |
1559 | stream, bt_ctf_stream_get_name(stream), | |
1560 | field, trace->common.packet_header_field_type); | |
1561 | ret = -1; | |
1562 | goto end; | |
1563 | } | |
1564 | ||
1565 | goto skip_validation; | |
1566 | } | |
1567 | ||
1568 | field_type = bt_ctf_field_get_type(field); | |
1569 | BT_ASSERT(field_type); | |
1570 | ||
086dc475 | 1571 | if (bt_ctf_field_type_common_compare((void *) field_type, |
8deee039 PP |
1572 | trace->common.packet_header_field_type)) { |
1573 | BT_LOGW("Invalid parameter: packet header's field type is different from the stream's packet header field type: " | |
1574 | "stream-addr=%p, stream-name=\"%s\", " | |
1575 | "packet-header-field-addr=%p, " | |
1576 | "packet-header-ft-addr=%p", | |
1577 | stream, bt_ctf_stream_get_name(stream), | |
1578 | field, field_type); | |
1579 | ret = -1; | |
1580 | goto end; | |
1581 | } | |
1582 | ||
1583 | skip_validation: | |
c2606e2f PP |
1584 | bt_ctf_object_put_ref(stream->packet_header); |
1585 | stream->packet_header = bt_ctf_object_get_ref(field); | |
c9ecaa78 | 1586 | BT_LOGT("Set stream's packet header field: " |
8deee039 PP |
1587 | "stream-addr=%p, stream-name=\"%s\", " |
1588 | "packet-header-field-addr=%p", | |
1589 | stream, bt_ctf_stream_get_name(stream), field); | |
1590 | end: | |
c2606e2f PP |
1591 | BT_CTF_OBJECT_PUT_REF_AND_RESET(trace); |
1592 | bt_ctf_object_put_ref(field_type); | |
8deee039 PP |
1593 | return ret; |
1594 | } | |
1595 | ||
1596 | static | |
1597 | void reset_structure_field(struct bt_ctf_field *structure, const char *name) | |
1598 | { | |
1599 | struct bt_ctf_field *member; | |
1600 | ||
1601 | member = bt_ctf_field_structure_get_field_by_name(structure, name); | |
1602 | if (member) { | |
086dc475 | 1603 | bt_ctf_field_common_reset_recursive((void *) member); |
c2606e2f | 1604 | bt_ctf_object_put_ref(member); |
8deee039 PP |
1605 | } |
1606 | } | |
1607 | ||
1608 | int bt_ctf_stream_flush(struct bt_ctf_stream *stream) | |
1609 | { | |
1610 | int ret = 0; | |
1611 | size_t i; | |
63512641 | 1612 | uint64_t packet_context_offset_bits = 0; |
8deee039 PP |
1613 | struct bt_ctf_trace *trace; |
1614 | enum bt_ctf_byte_order native_byte_order; | |
1615 | bool has_packet_size = false; | |
6f4eefbe PP |
1616 | uint64_t packet_size_bits = 0; |
1617 | uint64_t content_size_bits = 0; | |
8deee039 PP |
1618 | |
1619 | if (!stream) { | |
1620 | BT_LOGW_STR("Invalid parameter: stream is NULL."); | |
1621 | ret = -1; | |
1622 | goto end_no_stream; | |
1623 | } | |
1624 | ||
8deee039 PP |
1625 | if (stream->packet_context) { |
1626 | struct bt_ctf_field *packet_size_field; | |
1627 | ||
1628 | packet_size_field = bt_ctf_field_structure_get_field_by_name( | |
1629 | stream->packet_context, "packet_size"); | |
8e01f2d9 | 1630 | has_packet_size = packet_size_field; |
c2606e2f | 1631 | bt_ctf_object_put_ref(packet_size_field); |
8deee039 PP |
1632 | } |
1633 | ||
1634 | if (stream->flushed_packet_count == 1) { | |
1635 | if (!stream->packet_context) { | |
1636 | BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once."); | |
1637 | ret = -1; | |
1638 | goto end; | |
1639 | } | |
1640 | ||
1641 | if (!has_packet_size) { | |
1642 | BT_LOGW_STR("Cannot flush a stream which has no packet context's `packet_size` field more than once."); | |
1643 | ret = -1; | |
1644 | goto end; | |
1645 | } | |
1646 | } | |
1647 | ||
c9ecaa78 | 1648 | BT_LOGT("Flushing stream's current packet: stream-addr=%p, " |
8deee039 PP |
1649 | "stream-name=\"%s\", packet-index=%u", stream, |
1650 | bt_ctf_stream_get_name(stream), stream->flushed_packet_count); | |
086dc475 | 1651 | trace = BT_CTF_FROM_COMMON(bt_ctf_stream_class_common_borrow_trace( |
8deee039 PP |
1652 | stream->common.stream_class)); |
1653 | BT_ASSERT(trace); | |
1654 | native_byte_order = bt_ctf_trace_get_native_byte_order(trace); | |
1655 | ||
1656 | ret = auto_populate_packet_header(stream); | |
1657 | if (ret) { | |
1658 | BT_LOGW_STR("Cannot automatically populate the stream's packet header field."); | |
1659 | ret = -1; | |
1660 | goto end; | |
1661 | } | |
1662 | ||
6f4eefbe PP |
1663 | /* Initialize packet/content sizes to `0`; we will overwrite later */ |
1664 | ret = auto_populate_packet_context(stream, true, 0, 0); | |
8deee039 PP |
1665 | if (ret) { |
1666 | BT_LOGW_STR("Cannot automatically populate the stream's packet context field."); | |
1667 | ret = -1; | |
1668 | goto end; | |
1669 | } | |
1670 | ||
6f4eefbe PP |
1671 | ret = bt_ctfser_open_packet(&stream->ctfser); |
1672 | if (ret) { | |
1673 | /* bt_ctfser_open_packet() logs errors */ | |
1674 | ret = -1; | |
1675 | goto end; | |
1676 | } | |
8deee039 PP |
1677 | |
1678 | if (stream->packet_header) { | |
c9ecaa78 | 1679 | BT_LOGT_STR("Serializing packet header field (initial)."); |
8deee039 | 1680 | ret = bt_ctf_field_serialize_recursive(stream->packet_header, |
6f4eefbe | 1681 | &stream->ctfser, native_byte_order); |
8deee039 PP |
1682 | if (ret) { |
1683 | BT_LOGW("Cannot serialize stream's packet header field: " | |
1684 | "field-addr=%p", stream->packet_header); | |
1685 | goto end; | |
1686 | } | |
1687 | } | |
1688 | ||
1689 | if (stream->packet_context) { | |
6f4eefbe PP |
1690 | /* Save packet context's position to overwrite it later */ |
1691 | packet_context_offset_bits = | |
1692 | bt_ctfser_get_offset_in_current_packet_bits( | |
1693 | &stream->ctfser); | |
1694 | ||
8deee039 | 1695 | /* Write packet context */ |
c9ecaa78 | 1696 | BT_LOGT_STR("Serializing packet context field (initial)."); |
8deee039 | 1697 | ret = bt_ctf_field_serialize_recursive(stream->packet_context, |
6f4eefbe | 1698 | &stream->ctfser, native_byte_order); |
8deee039 PP |
1699 | if (ret) { |
1700 | BT_LOGW("Cannot serialize stream's packet context field: " | |
1701 | "field-addr=%p", stream->packet_context); | |
1702 | goto end; | |
1703 | } | |
1704 | } | |
1705 | ||
c9ecaa78 | 1706 | BT_LOGT("Serializing events: count=%u", stream->events->len); |
8deee039 PP |
1707 | |
1708 | for (i = 0; i < stream->events->len; i++) { | |
1709 | struct bt_ctf_event *event = g_ptr_array_index( | |
1710 | stream->events, i); | |
1711 | struct bt_ctf_event_class *event_class = | |
086dc475 PP |
1712 | BT_CTF_FROM_COMMON(bt_ctf_event_common_borrow_class( |
1713 | BT_CTF_TO_COMMON(event))); | |
8deee039 | 1714 | |
c9ecaa78 | 1715 | BT_LOGT("Serializing event: index=%zu, event-addr=%p, " |
8deee039 | 1716 | "event-class-name=\"%s\", event-class-id=%" PRId64 ", " |
6f4eefbe | 1717 | "ser-offset=%" PRIu64, |
8deee039 PP |
1718 | i, event, bt_ctf_event_class_get_name(event_class), |
1719 | bt_ctf_event_class_get_id(event_class), | |
6f4eefbe PP |
1720 | bt_ctfser_get_offset_in_current_packet_bits( |
1721 | &stream->ctfser)); | |
8deee039 PP |
1722 | |
1723 | /* Write event header */ | |
1724 | if (event->common.header_field) { | |
c9ecaa78 | 1725 | BT_LOGT_STR("Serializing event's header field."); |
8deee039 | 1726 | ret = bt_ctf_field_serialize_recursive( |
a6918753 | 1727 | (void *) event->common.header_field->field, |
6f4eefbe | 1728 | &stream->ctfser, native_byte_order); |
8deee039 PP |
1729 | if (ret) { |
1730 | BT_LOGW("Cannot serialize event's header field: " | |
1731 | "field-addr=%p", | |
a6918753 | 1732 | event->common.header_field->field); |
8deee039 PP |
1733 | goto end; |
1734 | } | |
1735 | } | |
1736 | ||
1737 | /* Write stream event context */ | |
1738 | if (event->common.stream_event_context_field) { | |
c9ecaa78 | 1739 | BT_LOGT_STR("Serializing event's stream event context field."); |
8deee039 PP |
1740 | ret = bt_ctf_field_serialize_recursive( |
1741 | (void *) event->common.stream_event_context_field, | |
6f4eefbe | 1742 | &stream->ctfser, native_byte_order); |
8deee039 PP |
1743 | if (ret) { |
1744 | BT_LOGW("Cannot serialize event's stream event context field: " | |
1745 | "field-addr=%p", | |
1746 | event->common.stream_event_context_field); | |
1747 | goto end; | |
1748 | } | |
1749 | } | |
1750 | ||
1751 | /* Write event content */ | |
6f4eefbe PP |
1752 | ret = bt_ctf_event_serialize(event, &stream->ctfser, |
1753 | native_byte_order); | |
8deee039 PP |
1754 | if (ret) { |
1755 | /* bt_ctf_event_serialize() logs errors */ | |
1756 | goto end; | |
1757 | } | |
1758 | } | |
1759 | ||
6f4eefbe PP |
1760 | content_size_bits = bt_ctfser_get_offset_in_current_packet_bits( |
1761 | &stream->ctfser); | |
1762 | ||
1763 | if (!has_packet_size && content_size_bits % 8 != 0) { | |
8deee039 PP |
1764 | BT_LOGW("Stream's packet context field type has no `packet_size` field, " |
1765 | "but current content size is not a multiple of 8 bits: " | |
6f4eefbe | 1766 | "content-size=%" PRIu64 ", " |
8deee039 | 1767 | "packet-size=%" PRIu64, |
6f4eefbe PP |
1768 | content_size_bits, |
1769 | packet_size_bits); | |
8deee039 PP |
1770 | ret = -1; |
1771 | goto end; | |
1772 | } | |
1773 | ||
6f4eefbe PP |
1774 | /* Set packet size; make it a multiple of 8 */ |
1775 | packet_size_bits = (content_size_bits + 7) & ~UINT64_C(7); | |
8deee039 PP |
1776 | |
1777 | if (stream->packet_context) { | |
1778 | /* | |
6f4eefbe PP |
1779 | * The whole packet is serialized at this point. Make |
1780 | * sure that, if `packet_size` is missing, the current | |
1781 | * content size is equal to the current packet size. | |
8deee039 | 1782 | */ |
6f4eefbe PP |
1783 | struct bt_ctf_field *field = |
1784 | bt_ctf_field_structure_get_field_by_name( | |
1785 | stream->packet_context, "content_size"); | |
8deee039 | 1786 | |
c2606e2f | 1787 | bt_ctf_object_put_ref(field); |
8deee039 | 1788 | if (!field) { |
6f4eefbe | 1789 | if (content_size_bits != packet_size_bits) { |
8deee039 PP |
1790 | BT_LOGW("Stream's packet context's `content_size` field is missing, " |
1791 | "but current packet's content size is not equal to its packet size: " | |
6f4eefbe | 1792 | "content-size=%" PRIu64 ", " |
8deee039 | 1793 | "packet-size=%" PRIu64, |
6f4eefbe PP |
1794 | bt_ctfser_get_offset_in_current_packet_bits(&stream->ctfser), |
1795 | packet_size_bits); | |
8deee039 PP |
1796 | ret = -1; |
1797 | goto end; | |
1798 | } | |
1799 | } | |
1800 | ||
1801 | /* | |
1802 | * Overwrite the packet context now that the stream | |
1803 | * position's packet and content sizes have the correct | |
1804 | * values. | |
8deee039 | 1805 | */ |
6f4eefbe PP |
1806 | bt_ctfser_set_offset_in_current_packet_bits(&stream->ctfser, |
1807 | packet_context_offset_bits); | |
1808 | ret = auto_populate_packet_context(stream, false, | |
1809 | packet_size_bits, content_size_bits); | |
8deee039 PP |
1810 | if (ret) { |
1811 | BT_LOGW_STR("Cannot automatically populate the stream's packet context field."); | |
1812 | ret = -1; | |
1813 | goto end; | |
1814 | } | |
1815 | ||
c9ecaa78 | 1816 | BT_LOGT("Rewriting (serializing) packet context field."); |
8deee039 | 1817 | ret = bt_ctf_field_serialize_recursive(stream->packet_context, |
6f4eefbe | 1818 | &stream->ctfser, native_byte_order); |
8deee039 PP |
1819 | if (ret) { |
1820 | BT_LOGW("Cannot serialize stream's packet context field: " | |
1821 | "field-addr=%p", stream->packet_context); | |
1822 | goto end; | |
1823 | } | |
1824 | } | |
1825 | ||
1826 | g_ptr_array_set_size(stream->events, 0); | |
1827 | stream->flushed_packet_count++; | |
6f4eefbe | 1828 | bt_ctfser_close_current_packet(&stream->ctfser, packet_size_bits / 8); |
8deee039 PP |
1829 | |
1830 | end: | |
1831 | /* Reset automatically-set fields. */ | |
1832 | if (stream->packet_context) { | |
1833 | reset_structure_field(stream->packet_context, "timestamp_begin"); | |
1834 | reset_structure_field(stream->packet_context, "timestamp_end"); | |
1835 | reset_structure_field(stream->packet_context, "packet_size"); | |
1836 | reset_structure_field(stream->packet_context, "content_size"); | |
1837 | reset_structure_field(stream->packet_context, "events_discarded"); | |
1838 | } | |
1839 | ||
6f4eefbe | 1840 | if (ret == 0) { |
c9ecaa78 | 1841 | BT_LOGT("Flushed stream's current packet: " |
6f4eefbe PP |
1842 | "content-size=%" PRIu64 ", packet-size=%" PRIu64, |
1843 | content_size_bits, packet_size_bits); | |
8deee039 PP |
1844 | } |
1845 | ||
1846 | end_no_stream: | |
1847 | return ret; | |
1848 | } | |
1849 | ||
1850 | static | |
c2606e2f | 1851 | void bt_ctf_stream_destroy(struct bt_ctf_object *obj) |
8deee039 PP |
1852 | { |
1853 | struct bt_ctf_stream *stream = (void *) obj; | |
1854 | ||
1855 | BT_LOGD("Destroying CTF writer stream object: addr=%p, name=\"%s\"", | |
1856 | stream, bt_ctf_stream_get_name(stream)); | |
1857 | ||
086dc475 | 1858 | bt_ctf_stream_common_finalize(BT_CTF_TO_COMMON(stream)); |
6f4eefbe | 1859 | bt_ctfser_fini(&stream->ctfser); |
8deee039 PP |
1860 | |
1861 | if (stream->events) { | |
1862 | BT_LOGD_STR("Putting events."); | |
1863 | g_ptr_array_free(stream->events, TRUE); | |
1864 | } | |
1865 | ||
1866 | BT_LOGD_STR("Putting packet header field."); | |
c2606e2f | 1867 | bt_ctf_object_put_ref(stream->packet_header); |
8deee039 | 1868 | BT_LOGD_STR("Putting packet context field."); |
c2606e2f | 1869 | bt_ctf_object_put_ref(stream->packet_context); |
8deee039 PP |
1870 | g_free(stream); |
1871 | } | |
1872 | ||
1873 | static | |
1874 | int _set_structure_field_integer(struct bt_ctf_field *structure, char *name, | |
d7279670 | 1875 | uint64_t value, bt_ctf_bool force) |
8deee039 PP |
1876 | { |
1877 | int ret = 0; | |
1878 | struct bt_ctf_field_type *field_type = NULL; | |
1879 | struct bt_ctf_field *integer; | |
1880 | ||
1881 | BT_ASSERT(structure); | |
1882 | BT_ASSERT(name); | |
1883 | ||
1884 | integer = bt_ctf_field_structure_get_field_by_name(structure, name); | |
1885 | if (!integer) { | |
1886 | /* Field not found, not an error. */ | |
c9ecaa78 | 1887 | BT_LOGT("Field not found: struct-field-addr=%p, " |
8deee039 PP |
1888 | "name=\"%s\", force=%d", structure, name, force); |
1889 | goto end; | |
1890 | } | |
1891 | ||
1892 | /* Make sure the payload has not already been set. */ | |
1893 | if (!force && bt_ctf_field_is_set_recursive(integer)) { | |
1894 | /* Payload already set, not an error */ | |
c9ecaa78 | 1895 | BT_LOGT("Field's payload is already set: struct-field-addr=%p, " |
8deee039 PP |
1896 | "name=\"%s\", force=%d", structure, name, force); |
1897 | goto end; | |
1898 | } | |
1899 | ||
1900 | field_type = bt_ctf_field_get_type(integer); | |
1901 | BT_ASSERT(field_type); | |
1902 | if (bt_ctf_field_type_get_type_id(field_type) != BT_CTF_FIELD_TYPE_ID_INTEGER) { | |
1903 | /* | |
1904 | * The user most likely meant for us to populate this field | |
1905 | * automatically. However, we can only do this if the field | |
1906 | * is an integer. Return an error. | |
1907 | */ | |
1908 | BT_LOGW("Invalid parameter: field's type is not an integer field type: " | |
1909 | "field-addr=%p, ft-addr=%p, ft-id=%s", | |
1910 | integer, field_type, | |
086dc475 | 1911 | bt_ctf_field_type_id_string((int) |
8deee039 PP |
1912 | bt_ctf_field_type_get_type_id(field_type))); |
1913 | ret = -1; | |
1914 | goto end; | |
1915 | } | |
1916 | ||
1917 | if (bt_ctf_field_type_integer_is_signed(field_type)) { | |
1918 | ret = bt_ctf_field_integer_signed_set_value(integer, | |
1919 | (int64_t) value); | |
1920 | } else { | |
1921 | ret = bt_ctf_field_integer_unsigned_set_value(integer, value); | |
1922 | } | |
1923 | ret = !ret ? 1 : ret; | |
1924 | end: | |
c2606e2f PP |
1925 | bt_ctf_object_put_ref(integer); |
1926 | bt_ctf_object_put_ref(field_type); | |
8deee039 PP |
1927 | return ret; |
1928 | } | |
1929 | ||
1930 | /* | |
1931 | * Returns the following codes: | |
1932 | * 1 if the field was found and set, | |
1933 | * 0 if nothing was done (field not found, or was already set), | |
1934 | * <0 if an error was encoutered | |
1935 | */ | |
1936 | static | |
1937 | int try_set_structure_field_integer(struct bt_ctf_field *structure, char *name, | |
1938 | uint64_t value) | |
1939 | { | |
d7279670 | 1940 | return _set_structure_field_integer(structure, name, value, BT_CTF_FALSE); |
8deee039 PP |
1941 | } |
1942 | ||
1943 | struct bt_ctf_stream_class *bt_ctf_stream_get_class( | |
1944 | struct bt_ctf_stream *stream) | |
1945 | { | |
c2606e2f | 1946 | return bt_ctf_object_get_ref(bt_ctf_stream_common_borrow_class(BT_CTF_TO_COMMON(stream))); |
8deee039 PP |
1947 | } |
1948 | ||
1949 | const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream) | |
1950 | { | |
086dc475 | 1951 | return bt_ctf_stream_common_get_name(BT_CTF_TO_COMMON(stream)); |
8deee039 PP |
1952 | } |
1953 | ||
1954 | int64_t bt_ctf_stream_get_id(struct bt_ctf_stream *stream) | |
1955 | { | |
086dc475 | 1956 | return bt_ctf_stream_common_get_id(BT_CTF_TO_COMMON(stream)); |
8deee039 | 1957 | } |