Commit | Line | Data |
---|---|---|
1c822dfb JG |
1 | /* |
2 | * stream.c | |
3 | * | |
4 | * Babeltrace CTF IR - Stream | |
5 | * | |
6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * | |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
29 | #include <babeltrace/ctf-ir/clock.h> | |
30 | #include <babeltrace/ctf-ir/clock-internal.h> | |
31 | #include <babeltrace/ctf-writer/event.h> | |
32 | #include <babeltrace/ctf-ir/event-internal.h> | |
33 | #include <babeltrace/ctf-ir/field-types-internal.h> | |
34 | #include <babeltrace/ctf-ir/fields-internal.h> | |
35 | #include <babeltrace/ctf-ir/stream.h> | |
36 | #include <babeltrace/ctf-ir/stream-internal.h> | |
37 | #include <babeltrace/ctf-ir/stream-class-internal.h> | |
38 | #include <babeltrace/ctf-ir/trace-internal.h> | |
39 | #include <babeltrace/ctf-writer/writer-internal.h> | |
40 | #include <babeltrace/ref.h> | |
41 | #include <babeltrace/ctf-writer/functor-internal.h> | |
42 | #include <babeltrace/compiler.h> | |
43 | #include <babeltrace/align.h> | |
44 | #include <babeltrace/ctf/ctf-index.h> | |
45 | ||
46 | static | |
47 | void bt_ctf_stream_destroy(struct bt_object *obj); | |
48 | static | |
49 | int set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t); | |
50 | ||
51 | static | |
52 | int set_packet_header_magic(struct bt_ctf_stream *stream) | |
53 | { | |
54 | int ret = 0; | |
55 | struct bt_ctf_field_type *magic_field_type = NULL; | |
56 | struct bt_ctf_field *magic_field = bt_ctf_field_structure_get_field( | |
57 | stream->packet_header, "magic"); | |
58 | ||
59 | if (!magic_field) { | |
60 | /* No magic field found. Not an error, skip. */ | |
61 | goto end; | |
62 | } | |
63 | ||
64 | if (!bt_ctf_field_validate(magic_field)) { | |
65 | /* Value already set. Not an error, skip. */ | |
66 | goto end; | |
67 | } | |
68 | ||
69 | magic_field_type = bt_ctf_field_get_type(magic_field); | |
70 | assert(magic_field_type); | |
71 | ||
72 | if (bt_ctf_field_type_get_type_id(magic_field_type) != | |
73 | BT_CTF_TYPE_ID_INTEGER) { | |
74 | /* Magic field is not an integer. Not an error, skip. */ | |
75 | goto end; | |
76 | } | |
77 | ||
78 | if (bt_ctf_field_type_integer_get_size(magic_field_type) != 32) { | |
79 | /* | |
80 | * Magic field is not of the expected size. | |
81 | * Not an error, skip. | |
82 | */ | |
83 | goto end; | |
84 | } | |
85 | ||
86 | ret = bt_ctf_field_type_integer_get_signed(magic_field_type); | |
87 | assert(ret >= 0); | |
88 | if (ret) { | |
89 | ret = bt_ctf_field_signed_integer_set_value(magic_field, | |
90 | (int64_t) 0xC1FC1FC1); | |
91 | } else { | |
92 | ret = bt_ctf_field_unsigned_integer_set_value(magic_field, | |
93 | (uint64_t) 0xC1FC1FC1); | |
94 | } | |
95 | end: | |
96 | bt_put(magic_field); | |
97 | bt_put(magic_field_type); | |
98 | return ret; | |
99 | } | |
100 | ||
101 | static | |
102 | int set_packet_header_uuid(struct bt_ctf_stream *stream) | |
103 | { | |
104 | int i, ret = 0; | |
105 | struct bt_ctf_trace *trace = NULL; | |
106 | struct bt_ctf_field_type *uuid_field_type = NULL; | |
107 | struct bt_ctf_field_type *element_field_type = NULL; | |
108 | struct bt_ctf_field *uuid_field = bt_ctf_field_structure_get_field( | |
109 | stream->packet_header, "uuid"); | |
110 | ||
111 | if (!uuid_field) { | |
112 | /* No uuid field found. Not an error, skip. */ | |
113 | goto end; | |
114 | } | |
115 | ||
116 | if (!bt_ctf_field_validate(uuid_field)) { | |
117 | /* Value already set. Not an error, skip. */ | |
118 | goto end; | |
119 | } | |
120 | ||
121 | uuid_field_type = bt_ctf_field_get_type(uuid_field); | |
122 | assert(uuid_field_type); | |
123 | if (bt_ctf_field_type_get_type_id(uuid_field_type) != | |
124 | BT_CTF_TYPE_ID_ARRAY) { | |
125 | /* UUID field is not an array. Not an error, skip. */ | |
126 | goto end; | |
127 | } | |
128 | ||
129 | if (bt_ctf_field_type_array_get_length(uuid_field_type) != 16) { | |
130 | /* | |
131 | * UUID field is not of the expected size. | |
132 | * Not an error, skip. | |
133 | */ | |
134 | goto end; | |
135 | } | |
136 | ||
137 | element_field_type = bt_ctf_field_type_array_get_element_type( | |
138 | uuid_field_type); | |
139 | assert(element_field_type); | |
140 | if (bt_ctf_field_type_get_type_id(element_field_type) != | |
141 | BT_CTF_TYPE_ID_INTEGER) { | |
142 | /* UUID array elements are not integers. Not an error, skip */ | |
143 | goto end; | |
144 | } | |
145 | ||
146 | trace = (struct bt_ctf_trace *) bt_object_get_parent(stream); | |
147 | for (i = 0; i < 16; i++) { | |
148 | struct bt_ctf_field *uuid_element = | |
149 | bt_ctf_field_array_get_field(uuid_field, i); | |
150 | ||
151 | ret = bt_ctf_field_type_integer_get_signed(element_field_type); | |
152 | assert(ret >= 0); | |
153 | ||
154 | if (ret) { | |
155 | ret = bt_ctf_field_signed_integer_set_value( | |
156 | uuid_element, (int64_t) trace->uuid[i]); | |
157 | } else { | |
158 | ret = bt_ctf_field_unsigned_integer_set_value( | |
159 | uuid_element, | |
160 | (uint64_t) trace->uuid[i]); | |
161 | } | |
162 | bt_put(uuid_element); | |
163 | if (ret) { | |
164 | goto end; | |
165 | } | |
166 | } | |
167 | ||
168 | end: | |
169 | bt_put(uuid_field); | |
170 | bt_put(uuid_field_type); | |
171 | bt_put(element_field_type); | |
172 | BT_PUT(trace); | |
173 | return ret; | |
174 | } | |
175 | static | |
176 | int set_packet_header_stream_id(struct bt_ctf_stream *stream) | |
177 | { | |
178 | int ret = 0; | |
179 | uint32_t stream_id; | |
180 | struct bt_ctf_field_type *stream_id_field_type = NULL; | |
181 | struct bt_ctf_field *stream_id_field = bt_ctf_field_structure_get_field( | |
182 | stream->packet_header, "stream_id"); | |
183 | ||
184 | if (!stream_id_field) { | |
185 | /* No stream_id field found. Not an error, skip. */ | |
186 | goto end; | |
187 | } | |
188 | ||
189 | if (!bt_ctf_field_validate(stream_id_field)) { | |
190 | /* Value already set. Not an error, skip. */ | |
191 | goto end; | |
192 | } | |
193 | ||
194 | stream_id_field_type = bt_ctf_field_get_type(stream_id_field); | |
195 | assert(stream_id_field_type); | |
196 | if (bt_ctf_field_type_get_type_id(stream_id_field_type) != | |
197 | BT_CTF_TYPE_ID_INTEGER) { | |
198 | /* stream_id field is not an integer. Not an error, skip. */ | |
199 | goto end; | |
200 | } | |
201 | ||
202 | stream_id = stream->stream_class->id; | |
203 | ret = bt_ctf_field_type_integer_get_signed(stream_id_field_type); | |
204 | assert(ret >= 0); | |
205 | if (ret) { | |
206 | ret = bt_ctf_field_signed_integer_set_value(stream_id_field, | |
207 | (int64_t) stream_id); | |
208 | } else { | |
209 | ret = bt_ctf_field_unsigned_integer_set_value(stream_id_field, | |
210 | (uint64_t) stream_id); | |
211 | } | |
212 | end: | |
213 | bt_put(stream_id_field); | |
214 | bt_put(stream_id_field_type); | |
215 | return ret; | |
216 | } | |
217 | ||
218 | static | |
219 | int set_packet_header(struct bt_ctf_stream *stream) | |
220 | { | |
221 | int ret; | |
222 | ||
223 | ret = set_packet_header_magic(stream); | |
224 | if (ret) { | |
225 | goto end; | |
226 | } | |
227 | ||
228 | ret = set_packet_header_uuid(stream); | |
229 | if (ret) { | |
230 | goto end; | |
231 | } | |
232 | ||
233 | ret = set_packet_header_stream_id(stream); | |
234 | if (ret) { | |
235 | goto end; | |
236 | } | |
237 | end: | |
238 | return ret; | |
239 | } | |
240 | ||
241 | static | |
242 | void release_event(struct bt_ctf_event *event) | |
243 | { | |
244 | if (bt_object_get_ref_count(event)) { | |
245 | /* | |
246 | * The event is being orphaned, but it must guarantee the | |
247 | * existence of its event class for the duration of its | |
248 | * lifetime. | |
249 | */ | |
250 | bt_get(event->event_class); | |
251 | BT_PUT(event->base.parent); | |
252 | } else { | |
253 | bt_object_release(event); | |
254 | } | |
255 | } | |
256 | ||
257 | static | |
258 | int create_stream_file(struct bt_ctf_writer *writer, | |
259 | struct bt_ctf_stream *stream) | |
260 | { | |
261 | int fd; | |
262 | GString *filename = g_string_new(stream->stream_class->name->str); | |
263 | ||
264 | if (stream->stream_class->name->len == 0) { | |
265 | int64_t ret; | |
266 | ||
267 | ret = bt_ctf_stream_class_get_id(stream->stream_class); | |
268 | if (ret < 0) { | |
269 | fd = -1; | |
270 | goto error; | |
271 | } | |
272 | ||
273 | g_string_printf(filename, "stream_%" PRId64, ret); | |
274 | } | |
275 | ||
276 | g_string_append_printf(filename, "_%" PRIu32, stream->id); | |
277 | fd = openat(writer->trace_dir_fd, filename->str, | |
278 | O_RDWR | O_CREAT | O_TRUNC, | |
279 | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP); | |
280 | error: | |
281 | g_string_free(filename, TRUE); | |
282 | return fd; | |
283 | } | |
284 | ||
285 | static | |
286 | int set_stream_fd(struct bt_ctf_stream *stream, int fd) | |
287 | { | |
288 | int ret = 0; | |
289 | ||
290 | if (stream->pos.fd != -1) { | |
291 | ret = -1; | |
292 | goto end; | |
293 | } | |
294 | ||
295 | ctf_init_pos(&stream->pos, NULL, fd, O_RDWR); | |
296 | stream->pos.fd = fd; | |
297 | end: | |
298 | return ret; | |
299 | } | |
300 | ||
301 | struct bt_ctf_stream *bt_ctf_stream_create( | |
302 | struct bt_ctf_stream_class *stream_class, | |
303 | const char *name) | |
304 | { | |
305 | int ret; | |
306 | struct bt_ctf_stream *stream = NULL; | |
307 | struct bt_ctf_trace *trace = NULL; | |
308 | struct bt_ctf_writer *writer = NULL; | |
309 | ||
310 | if (!stream_class) { | |
311 | goto error; | |
312 | } | |
313 | ||
314 | trace = bt_ctf_stream_class_get_trace(stream_class); | |
315 | if (!trace) { | |
316 | goto error; | |
317 | } | |
318 | ||
319 | stream = g_new0(struct bt_ctf_stream, 1); | |
320 | if (!stream) { | |
321 | goto error; | |
322 | } | |
323 | ||
324 | bt_object_init(stream, bt_ctf_stream_destroy); | |
325 | /* | |
326 | * Acquire reference to parent since stream will become publicly | |
327 | * reachable; it needs its parent to remain valid. | |
328 | */ | |
329 | bt_object_set_parent(stream, trace); | |
330 | stream->id = stream_class->next_stream_id++; | |
331 | stream->stream_class = stream_class; | |
332 | stream->pos.fd = -1; | |
333 | ||
334 | if (name) { | |
335 | stream->name = g_string_new(name); | |
336 | if (!stream->name) { | |
337 | goto error; | |
338 | } | |
339 | } | |
340 | ||
341 | if (trace->is_created_by_writer) { | |
342 | int fd; | |
343 | writer = (struct bt_ctf_writer *) | |
344 | bt_object_get_parent(trace); | |
345 | ||
346 | assert(writer); | |
347 | stream->packet_context = bt_ctf_field_create( | |
348 | stream_class->packet_context_type); | |
349 | if (!stream->packet_context) { | |
350 | goto error; | |
351 | } | |
352 | ||
353 | /* Initialize events_discarded */ | |
354 | ret = set_structure_field_integer(stream->packet_context, | |
355 | "events_discarded", 0); | |
356 | if (ret) { | |
357 | goto error; | |
358 | } | |
359 | ||
360 | stream->events = g_ptr_array_new_with_free_func( | |
361 | (GDestroyNotify) release_event); | |
362 | if (!stream->events) { | |
363 | goto error; | |
364 | } | |
365 | ||
366 | /* A trace is not allowed to have a NULL packet header */ | |
367 | assert(trace->packet_header_type); | |
368 | stream->packet_header = | |
369 | bt_ctf_field_create(trace->packet_header_type); | |
370 | if (!stream->packet_header) { | |
371 | goto error; | |
372 | } | |
373 | ||
374 | /* | |
375 | * Attempt to populate the default trace packet header fields | |
376 | * (magic, uuid and stream_id). This will _not_ fail shall the | |
377 | * fields not be found or be of an incompatible type; they will | |
378 | * simply not be populated automatically. The user will have to | |
379 | * make sure to set the trace packet header fields himself | |
380 | * before flushing. | |
381 | */ | |
382 | ret = set_packet_header(stream); | |
383 | if (ret) { | |
384 | goto error; | |
385 | } | |
386 | ||
387 | /* Create file associated with this stream */ | |
388 | fd = create_stream_file(writer, stream); | |
389 | if (fd < 0) { | |
390 | goto error; | |
391 | } | |
392 | ||
393 | ret = set_stream_fd(stream, fd); | |
394 | if (ret) { | |
395 | goto error; | |
396 | } | |
397 | ||
398 | /* Freeze the writer */ | |
399 | bt_ctf_writer_freeze(writer); | |
400 | } else { | |
401 | /* Non-writer stream indicated by a negative FD */ | |
402 | ret = set_stream_fd(stream, -1); | |
403 | if (ret) { | |
404 | goto error; | |
405 | } | |
406 | ||
407 | stream->clock_values = g_hash_table_new_full(g_direct_hash, | |
408 | g_direct_equal, NULL, g_free); | |
409 | } | |
410 | ||
411 | /* Add this stream to the trace's streams */ | |
412 | g_ptr_array_add(trace->streams, stream); | |
413 | ||
414 | BT_PUT(trace); | |
415 | BT_PUT(writer); | |
416 | return stream; | |
417 | error: | |
418 | BT_PUT(stream); | |
419 | BT_PUT(trace); | |
420 | BT_PUT(writer); | |
421 | return stream; | |
422 | } | |
423 | ||
424 | struct bt_ctf_stream_class *bt_ctf_stream_get_class( | |
425 | struct bt_ctf_stream *stream) | |
426 | { | |
427 | struct bt_ctf_stream_class *stream_class = NULL; | |
428 | ||
429 | if (!stream) { | |
430 | goto end; | |
431 | } | |
432 | ||
433 | stream_class = stream->stream_class; | |
434 | bt_get(stream_class); | |
435 | end: | |
436 | return stream_class; | |
437 | } | |
438 | ||
439 | int bt_ctf_stream_get_discarded_events_count( | |
440 | struct bt_ctf_stream *stream, uint64_t *count) | |
441 | { | |
442 | int64_t ret = 0; | |
443 | int field_signed; | |
444 | struct bt_ctf_field *events_discarded_field = NULL; | |
445 | struct bt_ctf_field_type *events_discarded_field_type = NULL; | |
446 | ||
447 | if (!stream || !count || !stream->packet_context || | |
448 | stream->pos.fd < 0) { | |
449 | ret = -1; | |
450 | goto end; | |
451 | } | |
452 | ||
453 | events_discarded_field = bt_ctf_field_structure_get_field( | |
454 | stream->packet_context, "events_discarded"); | |
455 | if (!events_discarded_field) { | |
456 | ret = -1; | |
457 | goto end; | |
458 | } | |
459 | ||
460 | events_discarded_field_type = bt_ctf_field_get_type( | |
461 | events_discarded_field); | |
462 | if (!events_discarded_field_type) { | |
463 | ret = -1; | |
464 | goto end; | |
465 | } | |
466 | ||
467 | field_signed = bt_ctf_field_type_integer_get_signed( | |
468 | events_discarded_field_type); | |
469 | if (field_signed < 0) { | |
470 | ret = field_signed; | |
471 | goto end; | |
472 | } | |
473 | ||
474 | if (field_signed) { | |
475 | int64_t signed_count; | |
476 | ||
477 | ret = bt_ctf_field_signed_integer_get_value( | |
478 | events_discarded_field, &signed_count); | |
479 | if (ret) { | |
480 | goto end; | |
481 | } | |
482 | if (signed_count < 0) { | |
483 | /* Invalid value */ | |
484 | ret = -1; | |
485 | goto end; | |
486 | } | |
487 | *count = (uint64_t) signed_count; | |
488 | } else { | |
489 | ret = bt_ctf_field_unsigned_integer_get_value( | |
490 | events_discarded_field, count); | |
491 | if (ret) { | |
492 | goto end; | |
493 | } | |
494 | } | |
495 | end: | |
496 | bt_put(events_discarded_field); | |
497 | bt_put(events_discarded_field_type); | |
498 | return ret; | |
499 | } | |
500 | ||
501 | void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, | |
502 | uint64_t event_count) | |
503 | { | |
504 | int ret; | |
505 | int field_signed; | |
506 | uint64_t previous_count; | |
507 | uint64_t new_count; | |
508 | struct bt_ctf_field *events_discarded_field = NULL; | |
509 | struct bt_ctf_field_type *events_discarded_field_type = NULL; | |
510 | ||
511 | if (!stream || !stream->packet_context || stream->pos.fd < 0) { | |
512 | goto end; | |
513 | } | |
514 | ||
515 | ret = bt_ctf_stream_get_discarded_events_count(stream, | |
516 | &previous_count); | |
517 | if (ret) { | |
518 | goto end; | |
519 | } | |
520 | ||
521 | events_discarded_field = bt_ctf_field_structure_get_field( | |
522 | stream->packet_context, "events_discarded"); | |
523 | if (!events_discarded_field) { | |
524 | goto end; | |
525 | } | |
526 | ||
527 | events_discarded_field_type = bt_ctf_field_get_type( | |
528 | events_discarded_field); | |
529 | if (!events_discarded_field_type) { | |
530 | goto end; | |
531 | } | |
532 | ||
533 | field_signed = bt_ctf_field_type_integer_get_signed( | |
534 | events_discarded_field_type); | |
535 | if (field_signed < 0) { | |
536 | goto end; | |
537 | } | |
538 | ||
539 | new_count = previous_count + event_count; | |
540 | if (field_signed) { | |
541 | ret = bt_ctf_field_signed_integer_set_value( | |
542 | events_discarded_field, (int64_t) new_count); | |
543 | if (ret) { | |
544 | goto end; | |
545 | } | |
546 | } else { | |
547 | ret = bt_ctf_field_unsigned_integer_set_value( | |
548 | events_discarded_field, new_count); | |
549 | if (ret) { | |
550 | goto end; | |
551 | } | |
552 | } | |
553 | ||
554 | end: | |
555 | bt_put(events_discarded_field); | |
556 | bt_put(events_discarded_field_type); | |
557 | } | |
558 | ||
559 | int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, | |
560 | struct bt_ctf_event *event) | |
561 | { | |
562 | int ret = 0; | |
563 | ||
564 | if (!stream || !event || stream->pos.fd < 0) { | |
565 | ret = -1; | |
566 | goto end; | |
567 | } | |
568 | ||
569 | /* | |
570 | * The event is not supposed to have a parent stream at this | |
571 | * point. The only other way an event can have a parent stream | |
572 | * is if it was assigned when setting a packet to the event, | |
573 | * in which case the packet's stream is not a writer stream, | |
574 | * and thus the user is trying to append an event which belongs | |
575 | * to another stream. | |
576 | */ | |
577 | if (event->base.parent) { | |
578 | ret = -1; | |
579 | goto end; | |
580 | } | |
581 | ||
582 | bt_object_set_parent(event, stream); | |
583 | ret = bt_ctf_event_populate_event_header(event); | |
584 | if (ret) { | |
585 | goto error; | |
586 | } | |
587 | ||
588 | /* Make sure the various scopes of the event are set */ | |
589 | ret = bt_ctf_event_validate(event); | |
590 | if (ret) { | |
591 | goto error; | |
592 | } | |
593 | ||
594 | /* Save the new event and freeze it */ | |
595 | bt_ctf_event_freeze(event); | |
596 | g_ptr_array_add(stream->events, event); | |
597 | ||
598 | /* | |
599 | * Event had to hold a reference to its event class as long as it wasn't | |
600 | * part of the same trace hierarchy. From now on, the event and its | |
601 | * class share the same lifetime guarantees and the reference is no | |
602 | * longer needed. | |
603 | */ | |
604 | bt_put(event->event_class); | |
605 | ||
606 | end: | |
607 | return ret; | |
608 | ||
609 | error: | |
610 | /* | |
611 | * Orphan the event; we were not successful in associating it to | |
612 | * a stream. | |
613 | */ | |
614 | bt_object_set_parent(event, NULL); | |
615 | ||
616 | return ret; | |
617 | } | |
618 | ||
619 | struct bt_ctf_field *bt_ctf_stream_get_packet_context( | |
620 | struct bt_ctf_stream *stream) | |
621 | { | |
622 | struct bt_ctf_field *packet_context = NULL; | |
623 | ||
624 | if (!stream || stream->pos.fd < 0) { | |
625 | goto end; | |
626 | } | |
627 | ||
628 | packet_context = stream->packet_context; | |
629 | if (packet_context) { | |
630 | bt_get(packet_context); | |
631 | } | |
632 | end: | |
633 | return packet_context; | |
634 | } | |
635 | ||
636 | int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream, | |
637 | struct bt_ctf_field *field) | |
638 | { | |
639 | int ret = 0; | |
640 | struct bt_ctf_field_type *field_type; | |
641 | ||
642 | if (!stream || !field || stream->pos.fd < 0) { | |
643 | ret = -1; | |
644 | goto end; | |
645 | } | |
646 | ||
647 | field_type = bt_ctf_field_get_type(field); | |
648 | if (bt_ctf_field_type_compare(field_type, | |
649 | stream->stream_class->packet_context_type)) { | |
650 | ret = -1; | |
651 | goto end; | |
652 | } | |
653 | ||
654 | bt_put(field_type); | |
655 | bt_get(field); | |
656 | bt_put(stream->packet_context); | |
657 | stream->packet_context = field; | |
658 | end: | |
659 | return ret; | |
660 | } | |
661 | ||
662 | struct bt_ctf_field *bt_ctf_stream_get_packet_header( | |
663 | struct bt_ctf_stream *stream) | |
664 | { | |
665 | struct bt_ctf_field *packet_header = NULL; | |
666 | ||
667 | if (!stream || stream->pos.fd < 0) { | |
668 | goto end; | |
669 | } | |
670 | ||
671 | packet_header = stream->packet_header; | |
672 | if (packet_header) { | |
673 | bt_get(packet_header); | |
674 | } | |
675 | end: | |
676 | return packet_header; | |
677 | } | |
678 | ||
679 | int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream, | |
680 | struct bt_ctf_field *field) | |
681 | { | |
682 | int ret = 0; | |
683 | struct bt_ctf_trace *trace = NULL; | |
684 | struct bt_ctf_field_type *field_type = NULL; | |
685 | ||
686 | if (!stream || !field || stream->pos.fd < 0) { | |
687 | ret = -1; | |
688 | goto end; | |
689 | } | |
690 | ||
691 | trace = (struct bt_ctf_trace *) bt_object_get_parent(stream); | |
692 | field_type = bt_ctf_field_get_type(field); | |
693 | if (bt_ctf_field_type_compare(field_type, trace->packet_header_type)) { | |
694 | ret = -1; | |
695 | goto end; | |
696 | } | |
697 | ||
698 | bt_get(field); | |
699 | bt_put(stream->packet_header); | |
700 | stream->packet_header = field; | |
701 | end: | |
702 | BT_PUT(trace); | |
703 | bt_put(field_type); | |
704 | return ret; | |
705 | } | |
706 | ||
707 | static | |
708 | int get_event_header_timestamp(struct bt_ctf_field *event_header, uint64_t *timestamp) | |
709 | { | |
710 | int ret = 0; | |
711 | struct bt_ctf_field *timestamp_field = NULL; | |
712 | struct bt_ctf_field_type *timestamp_field_type = NULL; | |
713 | ||
714 | timestamp_field = bt_ctf_field_structure_get_field(event_header, | |
715 | "timestamp"); | |
716 | if (!timestamp_field) { | |
717 | ret = -1; | |
718 | goto end; | |
719 | } | |
720 | ||
721 | timestamp_field_type = bt_ctf_field_get_type(timestamp_field); | |
722 | assert(timestamp_field_type); | |
723 | if (bt_ctf_field_type_get_type_id(timestamp_field_type) != | |
724 | BT_CTF_TYPE_ID_INTEGER) { | |
725 | ret = -1; | |
726 | goto end; | |
727 | } | |
728 | ||
729 | if (bt_ctf_field_type_integer_get_signed(timestamp_field_type)) { | |
730 | int64_t val; | |
731 | ||
732 | ret = bt_ctf_field_signed_integer_get_value(timestamp_field, | |
733 | &val); | |
734 | if (ret) { | |
735 | goto end; | |
736 | } | |
737 | *timestamp = (uint64_t) val; | |
738 | } else { | |
739 | ret = bt_ctf_field_unsigned_integer_get_value(timestamp_field, | |
740 | timestamp); | |
741 | if (ret) { | |
742 | goto end; | |
743 | } | |
744 | } | |
745 | end: | |
746 | bt_put(timestamp_field); | |
747 | bt_put(timestamp_field_type); | |
748 | return ret; | |
749 | } | |
750 | ||
751 | int bt_ctf_stream_flush(struct bt_ctf_stream *stream) | |
752 | { | |
753 | int ret = 0; | |
754 | size_t i; | |
755 | uint64_t timestamp_begin, timestamp_end, events_discarded; | |
756 | struct bt_ctf_field *integer = NULL; | |
757 | struct ctf_stream_pos packet_context_pos; | |
758 | ||
759 | if (!stream || stream->pos.fd < 0) { | |
760 | /* | |
761 | * Stream does not have an associated fd. It is, | |
762 | * therefore, not a stream being used to write events. | |
763 | */ | |
764 | ret = -1; | |
765 | goto end; | |
766 | } | |
767 | ||
768 | if (!stream->events->len) { | |
769 | goto end; | |
770 | } | |
771 | ||
772 | ret = bt_ctf_field_validate(stream->packet_header); | |
773 | if (ret) { | |
774 | goto end; | |
775 | } | |
776 | ||
777 | /* mmap the next packet */ | |
778 | ctf_packet_seek(&stream->pos.parent, 0, SEEK_CUR); | |
779 | ||
780 | ret = bt_ctf_field_serialize(stream->packet_header, &stream->pos); | |
781 | if (ret) { | |
782 | goto end; | |
783 | } | |
784 | ||
785 | /* Set the default context attributes if present and unset. */ | |
786 | if (!get_event_header_timestamp( | |
787 | ((struct bt_ctf_event *) g_ptr_array_index( | |
788 | stream->events, 0))->event_header, ×tamp_begin)) { | |
789 | ret = set_structure_field_integer(stream->packet_context, | |
790 | "timestamp_begin", timestamp_begin); | |
791 | if (ret) { | |
792 | goto end; | |
793 | } | |
794 | } | |
795 | ||
796 | if (!get_event_header_timestamp( | |
797 | ((struct bt_ctf_event *) g_ptr_array_index( | |
798 | stream->events, stream->events->len - 1))->event_header, | |
799 | ×tamp_end)) { | |
800 | ||
801 | ret = set_structure_field_integer(stream->packet_context, | |
802 | "timestamp_end", timestamp_end); | |
803 | if (ret) { | |
804 | goto end; | |
805 | } | |
806 | } | |
807 | ret = set_structure_field_integer(stream->packet_context, | |
808 | "content_size", UINT64_MAX); | |
809 | if (ret) { | |
810 | goto end; | |
811 | } | |
812 | ||
813 | ret = set_structure_field_integer(stream->packet_context, | |
814 | "packet_size", UINT64_MAX); | |
815 | if (ret) { | |
816 | goto end; | |
817 | } | |
818 | ||
819 | /* Write packet context */ | |
820 | memcpy(&packet_context_pos, &stream->pos, | |
821 | sizeof(struct ctf_stream_pos)); | |
822 | ret = bt_ctf_field_serialize(stream->packet_context, | |
823 | &stream->pos); | |
824 | if (ret) { | |
825 | goto end; | |
826 | } | |
827 | ||
828 | ret = bt_ctf_stream_get_discarded_events_count(stream, | |
829 | &events_discarded); | |
830 | if (ret) { | |
831 | goto end; | |
832 | } | |
833 | ||
834 | /* Unset the packet context's fields. */ | |
835 | ret = bt_ctf_field_reset(stream->packet_context); | |
836 | if (ret) { | |
837 | goto end; | |
838 | } | |
839 | ||
840 | /* Set the previous number of discarded events. */ | |
841 | ret = set_structure_field_integer(stream->packet_context, | |
842 | "events_discarded", events_discarded); | |
843 | if (ret) { | |
844 | goto end; | |
845 | } | |
846 | ||
847 | for (i = 0; i < stream->events->len; i++) { | |
848 | struct bt_ctf_event *event = g_ptr_array_index( | |
849 | stream->events, i); | |
850 | ||
851 | ret = bt_ctf_field_reset(event->event_header); | |
852 | if (ret) { | |
853 | goto end; | |
854 | } | |
855 | ||
856 | /* Write event header */ | |
857 | ret = bt_ctf_field_serialize(event->event_header, | |
858 | &stream->pos); | |
859 | if (ret) { | |
860 | goto end; | |
861 | } | |
862 | ||
863 | /* Write stream event context */ | |
864 | if (event->stream_event_context) { | |
865 | ret = bt_ctf_field_serialize( | |
866 | event->stream_event_context, &stream->pos); | |
867 | if (ret) { | |
868 | goto end; | |
869 | } | |
870 | } | |
871 | ||
872 | /* Write event content */ | |
873 | ret = bt_ctf_event_serialize(event, &stream->pos); | |
874 | if (ret) { | |
875 | goto end; | |
876 | } | |
877 | } | |
878 | ||
879 | /* | |
880 | * Update the packet total size and content size and overwrite the | |
881 | * packet context. | |
882 | * Copy base_mma as the packet may have been remapped (e.g. when a | |
883 | * packet is resized). | |
884 | */ | |
885 | packet_context_pos.base_mma = stream->pos.base_mma; | |
886 | ret = set_structure_field_integer(stream->packet_context, | |
887 | "content_size", stream->pos.offset); | |
888 | if (ret) { | |
889 | goto end; | |
890 | } | |
891 | ||
892 | ret = set_structure_field_integer(stream->packet_context, | |
893 | "packet_size", stream->pos.packet_size); | |
894 | if (ret) { | |
895 | goto end; | |
896 | } | |
897 | ||
898 | ret = bt_ctf_field_serialize(stream->packet_context, | |
899 | &packet_context_pos); | |
900 | if (ret) { | |
901 | goto end; | |
902 | } | |
903 | ||
904 | g_ptr_array_set_size(stream->events, 0); | |
905 | stream->flushed_packet_count++; | |
906 | end: | |
907 | bt_put(integer); | |
908 | return ret; | |
909 | } | |
910 | ||
911 | void bt_ctf_stream_get(struct bt_ctf_stream *stream) | |
912 | { | |
913 | bt_get(stream); | |
914 | } | |
915 | ||
916 | void bt_ctf_stream_put(struct bt_ctf_stream *stream) | |
917 | { | |
918 | bt_put(stream); | |
919 | } | |
920 | ||
921 | static | |
922 | void bt_ctf_stream_destroy(struct bt_object *obj) | |
923 | { | |
924 | struct bt_ctf_stream *stream; | |
925 | ||
926 | stream = container_of(obj, struct bt_ctf_stream, base); | |
927 | ctf_fini_pos(&stream->pos); | |
928 | if (stream->pos.fd >= 0 && close(stream->pos.fd)) { | |
929 | perror("close"); | |
930 | } | |
931 | ||
932 | if (stream->events) { | |
933 | g_ptr_array_free(stream->events, TRUE); | |
934 | } | |
935 | ||
936 | if (stream->name) { | |
937 | g_string_free(stream->name, TRUE); | |
938 | } | |
939 | ||
940 | if (stream->clock_values) { | |
941 | g_hash_table_destroy(stream->clock_values); | |
942 | } | |
943 | ||
944 | bt_put(stream->packet_header); | |
945 | bt_put(stream->packet_context); | |
946 | g_free(stream); | |
947 | } | |
948 | ||
949 | static | |
950 | int set_structure_field_integer(struct bt_ctf_field *structure, char *name, | |
951 | uint64_t value) | |
952 | { | |
953 | int ret = 0; | |
954 | struct bt_ctf_field_type *field_type = NULL; | |
955 | struct bt_ctf_field *integer = | |
956 | bt_ctf_field_structure_get_field(structure, name); | |
957 | ||
958 | if (!structure || !name) { | |
959 | ret = -1; | |
960 | goto end; | |
961 | } | |
962 | ||
963 | if (!integer) { | |
964 | /* Field not found, not an error. */ | |
965 | goto end; | |
966 | } | |
967 | ||
968 | /* Make sure the payload has not already been set. */ | |
969 | if (!bt_ctf_field_validate(integer)) { | |
970 | /* Payload already set, not an error */ | |
971 | goto end; | |
972 | } | |
973 | ||
974 | field_type = bt_ctf_field_get_type(integer); | |
975 | /* Something is serioulsly wrong */ | |
976 | assert(field_type); | |
977 | if (bt_ctf_field_type_get_type_id(field_type) != BT_CTF_TYPE_ID_INTEGER) { | |
978 | /* | |
979 | * The user most likely meant for us to populate this field | |
980 | * automatically. However, we can only do this if the field | |
981 | * is an integer. Return an error. | |
982 | */ | |
983 | ret = -1; | |
984 | goto end; | |
985 | } | |
986 | ||
987 | if (bt_ctf_field_type_integer_get_signed(field_type)) { | |
988 | ret = bt_ctf_field_signed_integer_set_value(integer, | |
989 | (int64_t) value); | |
990 | } else { | |
991 | ret = bt_ctf_field_unsigned_integer_set_value(integer, value); | |
992 | } | |
993 | end: | |
994 | bt_put(integer); | |
995 | bt_put(field_type); | |
996 | return ret; | |
997 | } | |
998 | ||
999 | const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream) | |
1000 | { | |
1001 | const char *name = NULL; | |
1002 | ||
1003 | if (!stream) { | |
1004 | goto end; | |
1005 | } | |
1006 | ||
1007 | name = stream->name ? stream->name->str : NULL; | |
1008 | ||
1009 | end: | |
1010 | return name; | |
1011 | } | |
1012 | ||
1013 | BT_HIDDEN | |
1014 | void bt_ctf_stream_update_clock_value(struct bt_ctf_stream *stream, | |
1015 | struct bt_ctf_field *value_field) | |
1016 | { | |
1017 | struct bt_ctf_field_type *value_type = NULL; | |
1018 | struct bt_ctf_clock *clock = NULL; | |
1019 | uint64_t requested_new_value; | |
1020 | uint64_t requested_new_value_mask; | |
1021 | uint64_t *cur_value; | |
1022 | uint64_t cur_value_masked; | |
1023 | int requested_new_value_size; | |
1024 | int ret; | |
1025 | ||
1026 | assert(stream); | |
1027 | assert(clock); | |
1028 | assert(value_field); | |
1029 | value_type = bt_ctf_field_get_type(value_field); | |
1030 | assert(value_type); | |
1031 | clock = bt_ctf_field_type_integer_get_mapped_clock(value_type); | |
1032 | assert(clock); | |
1033 | requested_new_value_size = | |
1034 | bt_ctf_field_type_integer_get_size(value_type); | |
1035 | assert(requested_new_value_size > 0); | |
1036 | ret = bt_ctf_field_unsigned_integer_get_value(value_field, | |
1037 | &requested_new_value); | |
1038 | assert(!ret); | |
1039 | cur_value = g_hash_table_lookup(stream->clock_values, clock); | |
1040 | ||
1041 | if (!cur_value) { | |
1042 | /* | |
1043 | * Updating the value of a clock which is not registered | |
1044 | * yet, so register it with the new value as its initial | |
1045 | * value. | |
1046 | */ | |
1047 | uint64_t *requested_new_value_ptr = g_new0(uint64_t, 1); | |
1048 | ||
1049 | *requested_new_value_ptr = requested_new_value; | |
1050 | g_hash_table_insert(stream->clock_values, clock, | |
1051 | requested_new_value_ptr); | |
1052 | goto end; | |
1053 | } | |
1054 | ||
1055 | /* | |
1056 | * Special case for a 64-bit new value, which is the limit | |
1057 | * of a clock value as of this version: overwrite the | |
1058 | * current value directly. | |
1059 | */ | |
1060 | if (requested_new_value_size == 64) { | |
1061 | *cur_value = requested_new_value; | |
1062 | goto end; | |
1063 | } | |
1064 | ||
1065 | requested_new_value_mask = (1ULL << requested_new_value_size) - 1; | |
1066 | cur_value_masked = *cur_value & requested_new_value_mask; | |
1067 | ||
1068 | if (requested_new_value < cur_value_masked) { | |
1069 | /* | |
1070 | * It looks like a wrap happened on the number of bits | |
1071 | * of the requested new value. Assume that the clock | |
1072 | * value wrapped only one time. | |
1073 | */ | |
1074 | *cur_value += requested_new_value_mask + 1; | |
1075 | } | |
1076 | ||
1077 | /* Clear the low bits of the current clock value */ | |
1078 | *cur_value &= ~requested_new_value_mask; | |
1079 | ||
1080 | /* Set the low bits of the current clock value */ | |
1081 | *cur_value |= requested_new_value; | |
1082 | ||
1083 | end: | |
1084 | bt_put(clock); | |
1085 | bt_put(value_type); | |
1086 | } |