Commit | Line | Data |
---|---|---|
273b65be JG |
1 | /* |
2 | * stream.c | |
3 | * | |
d2dc44b6 | 4 | * Babeltrace CTF IR - Stream |
273b65be | 5 | * |
de9dd397 | 6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be JG |
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 | ||
3f043b05 | 29 | #include <babeltrace/ctf-ir/clock.h> |
adc315b8 | 30 | #include <babeltrace/ctf-ir/clock-internal.h> |
273b65be | 31 | #include <babeltrace/ctf-writer/event.h> |
adc315b8 JG |
32 | #include <babeltrace/ctf-ir/event-internal.h> |
33 | #include <babeltrace/ctf-ir/event-types-internal.h> | |
34 | #include <babeltrace/ctf-ir/event-fields-internal.h> | |
3f043b05 JG |
35 | #include <babeltrace/ctf-ir/stream.h> |
36 | #include <babeltrace/ctf-ir/stream-internal.h> | |
adc315b8 | 37 | #include <babeltrace/ctf-ir/stream-class-internal.h> |
273b65be JG |
38 | #include <babeltrace/ctf-writer/functor-internal.h> |
39 | #include <babeltrace/compiler.h> | |
40 | #include <babeltrace/align.h> | |
d246b111 | 41 | #include <babeltrace/ctf/ctf-index.h> |
273b65be JG |
42 | |
43 | static | |
44 | void bt_ctf_stream_destroy(struct bt_ctf_ref *ref); | |
45 | static | |
273b65be JG |
46 | int set_structure_field_integer(struct bt_ctf_field *, char *, uint64_t); |
47 | ||
d246b111 JG |
48 | static |
49 | int set_packet_header_magic(struct bt_ctf_stream *stream) | |
50 | { | |
51 | int ret = 0; | |
52 | struct bt_ctf_field_type *magic_field_type = NULL; | |
53 | struct bt_ctf_field *magic_field = bt_ctf_field_structure_get_field( | |
54 | stream->packet_header, "magic"); | |
55 | ||
56 | if (!magic_field) { | |
57 | /* No magic field found. Not an error, skip. */ | |
58 | goto end; | |
59 | } | |
60 | ||
61 | if (!bt_ctf_field_validate(magic_field)) { | |
62 | /* Value already set. Not an error, skip. */ | |
63 | goto end; | |
64 | } | |
65 | ||
66 | magic_field_type = bt_ctf_field_get_type(magic_field); | |
67 | assert(magic_field_type); | |
68 | ||
69 | if (bt_ctf_field_type_get_type_id(magic_field_type) != | |
70 | CTF_TYPE_INTEGER) { | |
71 | /* Magic field is not an integer. Not an error, skip. */ | |
72 | goto end; | |
73 | } | |
74 | ||
75 | if (bt_ctf_field_type_integer_get_size(magic_field_type) != 32) { | |
76 | /* | |
77 | * Magic field is not of the expected size. | |
78 | * Not an error, skip. | |
79 | */ | |
80 | goto end; | |
81 | } | |
82 | ||
83 | ret = bt_ctf_field_type_integer_get_signed(magic_field_type); | |
84 | assert(ret >= 0); | |
85 | if (ret) { | |
86 | ret = bt_ctf_field_signed_integer_set_value(magic_field, | |
87 | (int64_t) 0xC1FC1FC1); | |
88 | } else { | |
89 | ret = bt_ctf_field_unsigned_integer_set_value(magic_field, | |
90 | (uint64_t) 0xC1FC1FC1); | |
91 | } | |
92 | end: | |
93 | if (magic_field) { | |
94 | bt_ctf_field_put(magic_field); | |
95 | } | |
96 | if (magic_field_type) { | |
97 | bt_ctf_field_type_put(magic_field_type); | |
98 | } | |
99 | return ret; | |
100 | } | |
101 | ||
102 | static | |
103 | int set_packet_header_uuid(struct bt_ctf_stream *stream) | |
104 | { | |
105 | int i, ret = 0; | |
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 | CTF_TYPE_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 | CTF_TYPE_INTEGER) { | |
142 | /* UUID array elements are not integers. Not an error, skip */ | |
143 | goto end; | |
144 | } | |
145 | ||
146 | for (i = 0; i < 16; i++) { | |
147 | struct bt_ctf_field *uuid_element = | |
148 | bt_ctf_field_array_get_field(uuid_field, i); | |
149 | ||
150 | ret = bt_ctf_field_type_integer_get_signed(element_field_type); | |
151 | assert(ret >= 0); | |
152 | ||
153 | if (ret) { | |
154 | ret = bt_ctf_field_signed_integer_set_value( | |
155 | uuid_element, (int64_t) stream->trace->uuid[i]); | |
156 | } else { | |
157 | ret = bt_ctf_field_unsigned_integer_set_value( | |
158 | uuid_element, | |
159 | (uint64_t) stream->trace->uuid[i]); | |
160 | } | |
161 | bt_ctf_field_put(uuid_element); | |
162 | if (ret) { | |
163 | goto end; | |
164 | } | |
165 | } | |
166 | ||
167 | end: | |
168 | if (uuid_field) { | |
169 | bt_ctf_field_put(uuid_field); | |
170 | } | |
171 | if (uuid_field_type) { | |
172 | bt_ctf_field_type_put(uuid_field_type); | |
173 | } | |
174 | if (element_field_type) { | |
175 | bt_ctf_field_type_put(element_field_type); | |
176 | } | |
177 | return ret; | |
178 | } | |
179 | static | |
180 | int set_packet_header_stream_id(struct bt_ctf_stream *stream) | |
181 | { | |
182 | int ret = 0; | |
183 | uint32_t stream_id; | |
184 | struct bt_ctf_field_type *stream_id_field_type = NULL; | |
185 | struct bt_ctf_field *stream_id_field = bt_ctf_field_structure_get_field( | |
186 | stream->packet_header, "stream_id"); | |
187 | ||
188 | if (!stream_id_field) { | |
189 | /* No stream_id field found. Not an error, skip. */ | |
190 | goto end; | |
191 | } | |
192 | ||
193 | if (!bt_ctf_field_validate(stream_id_field)) { | |
194 | /* Value already set. Not an error, skip. */ | |
195 | goto end; | |
196 | } | |
197 | ||
198 | stream_id_field_type = bt_ctf_field_get_type(stream_id_field); | |
199 | assert(stream_id_field_type); | |
200 | if (bt_ctf_field_type_get_type_id(stream_id_field_type) != | |
201 | CTF_TYPE_INTEGER) { | |
202 | /* stream_id field is not an integer. Not an error, skip. */ | |
203 | goto end; | |
204 | } | |
205 | ||
206 | stream_id = stream->stream_class->id; | |
207 | ret = bt_ctf_field_type_integer_get_signed(stream_id_field_type); | |
208 | assert(ret >= 0); | |
209 | if (ret) { | |
210 | ret = bt_ctf_field_signed_integer_set_value(stream_id_field, | |
211 | (int64_t) stream_id); | |
212 | } else { | |
213 | ret = bt_ctf_field_unsigned_integer_set_value(stream_id_field, | |
214 | (uint64_t) stream_id); | |
215 | } | |
216 | end: | |
217 | if (stream_id_field) { | |
218 | bt_ctf_field_put(stream_id_field); | |
219 | } | |
220 | if (stream_id_field_type) { | |
221 | bt_ctf_field_type_put(stream_id_field_type); | |
222 | } | |
223 | return ret; | |
224 | } | |
225 | ||
226 | static | |
227 | int set_packet_header(struct bt_ctf_stream *stream) | |
228 | { | |
229 | int ret; | |
230 | ||
231 | ret = set_packet_header_magic(stream); | |
232 | if (ret) { | |
233 | goto end; | |
234 | } | |
235 | ||
236 | ret = set_packet_header_uuid(stream); | |
237 | if (ret) { | |
238 | goto end; | |
239 | } | |
240 | ||
241 | ret = set_packet_header_stream_id(stream); | |
242 | if (ret) { | |
243 | goto end; | |
244 | } | |
245 | end: | |
246 | return ret; | |
247 | } | |
248 | ||
273b65be JG |
249 | BT_HIDDEN |
250 | struct bt_ctf_stream *bt_ctf_stream_create( | |
d246b111 JG |
251 | struct bt_ctf_stream_class *stream_class, |
252 | struct bt_ctf_trace *trace) | |
273b65be | 253 | { |
12c8a1a3 | 254 | int ret; |
273b65be JG |
255 | struct bt_ctf_stream *stream = NULL; |
256 | ||
d246b111 | 257 | if (!stream_class || !trace) { |
273b65be JG |
258 | goto end; |
259 | } | |
260 | ||
261 | stream = g_new0(struct bt_ctf_stream, 1); | |
262 | if (!stream) { | |
263 | goto end; | |
264 | } | |
265 | ||
d246b111 | 266 | stream->trace = trace; |
273b65be | 267 | bt_ctf_ref_init(&stream->ref_count); |
12c8a1a3 JG |
268 | stream->packet_context = bt_ctf_field_create( |
269 | stream_class->packet_context_type); | |
270 | if (!stream->packet_context) { | |
271 | goto error_destroy; | |
272 | } | |
273 | ||
af181248 JG |
274 | /* |
275 | * A stream class may not have a stream event context defined | |
276 | * in which case this stream will never have a stream_event_context | |
277 | * member since, after a stream's creation, the parent stream class | |
278 | * is "frozen" (immutable). | |
279 | */ | |
280 | if (stream_class->event_context_type) { | |
281 | stream->event_context = bt_ctf_field_create( | |
282 | stream_class->event_context_type); | |
283 | if (!stream->packet_context) { | |
284 | goto error_destroy; | |
285 | } | |
286 | } | |
287 | ||
e19cc57d | 288 | /* Initialize events_discarded */ |
12c8a1a3 JG |
289 | ret = set_structure_field_integer(stream->packet_context, |
290 | "events_discarded", 0); | |
291 | if (ret) { | |
292 | goto error_destroy; | |
293 | } | |
294 | ||
273b65be JG |
295 | stream->pos.fd = -1; |
296 | stream->id = stream_class->next_stream_id++; | |
297 | stream->stream_class = stream_class; | |
298 | bt_ctf_stream_class_get(stream_class); | |
273b65be | 299 | stream->events = g_ptr_array_new_with_free_func( |
8bfa3f9c JG |
300 | (GDestroyNotify) bt_ctf_event_put); |
301 | if (!stream->events) { | |
302 | goto error_destroy; | |
303 | } | |
304 | if (stream_class->event_context_type) { | |
305 | stream->event_contexts = g_ptr_array_new_with_free_func( | |
306 | (GDestroyNotify) bt_ctf_field_put); | |
307 | if (!stream->event_contexts) { | |
308 | goto error_destroy; | |
309 | } | |
310 | } | |
d246b111 JG |
311 | |
312 | /* A trace is not allowed to have a NULL packet header */ | |
313 | assert(trace->packet_header_type); | |
314 | stream->packet_header = bt_ctf_field_create(trace->packet_header_type); | |
92351460 JG |
315 | if (!stream->packet_header) { |
316 | goto error_destroy; | |
317 | } | |
d246b111 JG |
318 | /* |
319 | * Attempt to populate the default trace packet header fields | |
320 | * (magic, uuid and stream_id). This will _not_ fail shall the | |
321 | * fields not be found or be of an incompatible type; they will | |
322 | * simply not be populated automatically. The user will have to | |
323 | * make sure to set the trace packet header fields himself before | |
324 | * flushing. | |
325 | */ | |
326 | ret = set_packet_header(stream); | |
327 | if (ret) { | |
328 | goto error_destroy; | |
329 | } | |
273b65be JG |
330 | end: |
331 | return stream; | |
12c8a1a3 JG |
332 | error_destroy: |
333 | bt_ctf_stream_destroy(&stream->ref_count); | |
334 | return NULL; | |
273b65be JG |
335 | } |
336 | ||
273b65be JG |
337 | BT_HIDDEN |
338 | int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd) | |
339 | { | |
340 | int ret = 0; | |
341 | ||
342 | if (stream->pos.fd != -1) { | |
343 | ret = -1; | |
344 | goto end; | |
345 | } | |
346 | ||
347 | ctf_init_pos(&stream->pos, NULL, fd, O_RDWR); | |
348 | stream->pos.fd = fd; | |
349 | end: | |
350 | return ret; | |
351 | } | |
352 | ||
d246b111 JG |
353 | BT_HIDDEN |
354 | void bt_ctf_stream_set_trace(struct bt_ctf_stream *stream, | |
355 | struct bt_ctf_trace *trace) | |
356 | { | |
357 | stream->trace = trace; | |
358 | } | |
359 | ||
3baf0856 JG |
360 | struct bt_ctf_stream_class *bt_ctf_stream_get_class( |
361 | struct bt_ctf_stream *stream) | |
362 | { | |
363 | struct bt_ctf_stream_class *stream_class = NULL; | |
364 | ||
365 | if (!stream) { | |
366 | goto end; | |
367 | } | |
368 | ||
369 | stream_class = stream->stream_class; | |
370 | bt_ctf_stream_class_get(stream_class); | |
371 | end: | |
372 | return stream_class; | |
373 | } | |
374 | ||
a78a2e25 JG |
375 | int bt_ctf_stream_get_discarded_events_count( |
376 | struct bt_ctf_stream *stream, uint64_t *count) | |
377 | { | |
378 | int64_t ret = 0; | |
12c8a1a3 JG |
379 | int field_signed; |
380 | struct bt_ctf_field *events_discarded_field = NULL; | |
381 | struct bt_ctf_field_type *events_discarded_field_type = NULL; | |
a78a2e25 | 382 | |
12c8a1a3 | 383 | if (!stream || !count || !stream->packet_context) { |
a78a2e25 JG |
384 | ret = -1; |
385 | goto end; | |
386 | } | |
387 | ||
12c8a1a3 JG |
388 | events_discarded_field = bt_ctf_field_structure_get_field( |
389 | stream->packet_context, "events_discarded"); | |
390 | if (!events_discarded_field) { | |
391 | ret = -1; | |
392 | goto end; | |
393 | } | |
394 | ||
395 | events_discarded_field_type = bt_ctf_field_get_type( | |
396 | events_discarded_field); | |
397 | if (!events_discarded_field_type) { | |
398 | ret = -1; | |
399 | goto end; | |
400 | } | |
401 | ||
402 | field_signed = bt_ctf_field_type_integer_get_signed( | |
403 | events_discarded_field_type); | |
404 | if (field_signed < 0) { | |
405 | ret = field_signed; | |
406 | goto end; | |
407 | } | |
408 | ||
409 | if (field_signed) { | |
410 | int64_t signed_count; | |
411 | ||
412 | ret = bt_ctf_field_signed_integer_get_value( | |
413 | events_discarded_field, &signed_count); | |
414 | if (ret) { | |
415 | goto end; | |
416 | } | |
417 | if (signed_count < 0) { | |
418 | /* Invalid value */ | |
419 | ret = -1; | |
420 | goto end; | |
421 | } | |
422 | *count = (uint64_t) signed_count; | |
423 | } else { | |
424 | ret = bt_ctf_field_unsigned_integer_get_value( | |
425 | events_discarded_field, count); | |
426 | if (ret) { | |
427 | goto end; | |
428 | } | |
429 | } | |
a78a2e25 | 430 | end: |
12c8a1a3 JG |
431 | if (events_discarded_field) { |
432 | bt_ctf_field_put(events_discarded_field); | |
433 | } | |
434 | if (events_discarded_field_type) { | |
435 | bt_ctf_field_type_put(events_discarded_field_type); | |
436 | } | |
a78a2e25 JG |
437 | return ret; |
438 | } | |
439 | ||
273b65be JG |
440 | void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, |
441 | uint64_t event_count) | |
442 | { | |
12c8a1a3 JG |
443 | int ret; |
444 | int field_signed; | |
445 | uint64_t previous_count; | |
446 | uint64_t new_count; | |
447 | struct bt_ctf_field *events_discarded_field = NULL; | |
448 | struct bt_ctf_field_type *events_discarded_field_type = NULL; | |
449 | ||
450 | if (!stream || !stream->packet_context) { | |
451 | goto end; | |
452 | } | |
453 | ||
454 | ret = bt_ctf_stream_get_discarded_events_count(stream, | |
455 | &previous_count); | |
456 | if (ret) { | |
457 | goto end; | |
458 | } | |
459 | ||
460 | events_discarded_field = bt_ctf_field_structure_get_field( | |
461 | stream->packet_context, "events_discarded"); | |
462 | if (!events_discarded_field) { | |
463 | goto end; | |
464 | } | |
465 | ||
466 | events_discarded_field_type = bt_ctf_field_get_type( | |
467 | events_discarded_field); | |
468 | if (!events_discarded_field_type) { | |
469 | goto end; | |
470 | } | |
471 | ||
472 | field_signed = bt_ctf_field_type_integer_get_signed( | |
473 | events_discarded_field_type); | |
474 | if (field_signed < 0) { | |
475 | goto end; | |
273b65be JG |
476 | } |
477 | ||
12c8a1a3 JG |
478 | new_count = previous_count + event_count; |
479 | if (field_signed) { | |
480 | ret = bt_ctf_field_signed_integer_set_value( | |
481 | events_discarded_field, (int64_t) new_count); | |
482 | if (ret) { | |
483 | goto end; | |
484 | } | |
485 | } else { | |
486 | ret = bt_ctf_field_unsigned_integer_set_value( | |
487 | events_discarded_field, new_count); | |
488 | if (ret) { | |
489 | goto end; | |
490 | } | |
491 | } | |
492 | ||
493 | end: | |
494 | if (events_discarded_field) { | |
495 | bt_ctf_field_put(events_discarded_field); | |
496 | } | |
497 | if (events_discarded_field_type) { | |
498 | bt_ctf_field_type_put(events_discarded_field_type); | |
499 | } | |
273b65be JG |
500 | } |
501 | ||
502 | int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, | |
503 | struct bt_ctf_event *event) | |
504 | { | |
505 | int ret = 0; | |
af181248 | 506 | struct bt_ctf_field *event_context_copy = NULL; |
273b65be JG |
507 | |
508 | if (!stream || !event) { | |
509 | ret = -1; | |
510 | goto end; | |
511 | } | |
512 | ||
662e778c JG |
513 | ret = bt_ctf_event_populate_event_header(event); |
514 | if (ret) { | |
515 | goto end; | |
516 | } | |
517 | ||
785b5390 | 518 | /* Make sure the event's payload is set */ |
273b65be JG |
519 | ret = bt_ctf_event_validate(event); |
520 | if (ret) { | |
521 | goto end; | |
522 | } | |
523 | ||
8bfa3f9c JG |
524 | /* Sample the current stream event context by copying it */ |
525 | if (stream->event_context) { | |
526 | /* Make sure the event context's payload is set */ | |
527 | ret = bt_ctf_field_validate(stream->event_context); | |
528 | if (ret) { | |
529 | goto end; | |
530 | } | |
531 | ||
532 | event_context_copy = bt_ctf_field_copy(stream->event_context); | |
533 | if (!event_context_copy) { | |
534 | ret = -1; | |
535 | goto end; | |
536 | } | |
537 | } | |
538 | ||
273b65be | 539 | bt_ctf_event_get(event); |
8bfa3f9c | 540 | /* Save the new event along with its associated stream event context */ |
273b65be | 541 | g_ptr_array_add(stream->events, event); |
8bfa3f9c JG |
542 | if (event_context_copy) { |
543 | g_ptr_array_add(stream->event_contexts, event_context_copy); | |
544 | } | |
273b65be JG |
545 | end: |
546 | return ret; | |
547 | } | |
548 | ||
12c8a1a3 JG |
549 | struct bt_ctf_field *bt_ctf_stream_get_packet_context( |
550 | struct bt_ctf_stream *stream) | |
551 | { | |
552 | struct bt_ctf_field *packet_context = NULL; | |
553 | ||
554 | if (!stream) { | |
555 | goto end; | |
556 | } | |
557 | ||
558 | packet_context = stream->packet_context; | |
12c8a1a3 JG |
559 | if (packet_context) { |
560 | bt_ctf_field_get(packet_context); | |
561 | } | |
34629a55 | 562 | end: |
12c8a1a3 JG |
563 | return packet_context; |
564 | } | |
565 | ||
566 | int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream, | |
567 | struct bt_ctf_field *field) | |
568 | { | |
569 | int ret = 0; | |
570 | struct bt_ctf_field_type *field_type; | |
571 | ||
572 | if (!stream || !field) { | |
573 | ret = -1; | |
574 | goto end; | |
575 | } | |
576 | ||
577 | field_type = bt_ctf_field_get_type(field); | |
578 | if (field_type != stream->stream_class->packet_context_type) { | |
579 | ret = -1; | |
580 | goto end; | |
581 | } | |
582 | ||
583 | bt_ctf_field_type_put(field_type); | |
584 | bt_ctf_field_get(field); | |
585 | bt_ctf_field_put(stream->packet_context); | |
586 | stream->packet_context = field; | |
587 | end: | |
588 | return ret; | |
589 | } | |
590 | ||
8bfa3f9c JG |
591 | struct bt_ctf_field *bt_ctf_stream_get_event_context( |
592 | struct bt_ctf_stream *stream) | |
593 | { | |
594 | struct bt_ctf_field *event_context = NULL; | |
595 | ||
596 | if (!stream) { | |
597 | goto end; | |
598 | } | |
599 | ||
600 | event_context = stream->event_context; | |
601 | if (event_context) { | |
602 | bt_ctf_field_get(event_context); | |
603 | } | |
604 | end: | |
605 | return event_context; | |
606 | } | |
607 | ||
608 | int bt_ctf_stream_set_event_context(struct bt_ctf_stream *stream, | |
609 | struct bt_ctf_field *field) | |
610 | { | |
611 | int ret = 0; | |
612 | struct bt_ctf_field_type *field_type = NULL; | |
613 | ||
614 | if (!stream || !field) { | |
615 | ret = -1; | |
616 | goto end; | |
617 | } | |
618 | ||
619 | field_type = bt_ctf_field_get_type(field); | |
620 | if (field_type != stream->stream_class->event_context_type) { | |
621 | ret = -1; | |
622 | goto end; | |
623 | } | |
624 | ||
625 | bt_ctf_field_get(field); | |
626 | bt_ctf_field_put(stream->event_context); | |
627 | stream->event_context = field; | |
628 | end: | |
629 | if (field_type) { | |
630 | bt_ctf_field_type_put(field_type); | |
631 | } | |
632 | return ret; | |
633 | } | |
634 | ||
263a7df5 JG |
635 | struct bt_ctf_field *bt_ctf_stream_get_packet_header( |
636 | struct bt_ctf_stream *stream) | |
637 | { | |
638 | struct bt_ctf_field *packet_header = NULL; | |
639 | ||
640 | if (!stream) { | |
641 | goto end; | |
642 | } | |
643 | ||
644 | packet_header = stream->packet_header; | |
645 | if (packet_header) { | |
646 | bt_ctf_field_get(packet_header); | |
647 | } | |
648 | end: | |
649 | return packet_header; | |
650 | } | |
651 | ||
652 | int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream, | |
653 | struct bt_ctf_field *field) | |
654 | { | |
655 | int ret = 0; | |
656 | struct bt_ctf_field_type *field_type = NULL; | |
657 | ||
658 | if (!stream || !field) { | |
659 | ret = -1; | |
660 | goto end; | |
661 | } | |
662 | ||
663 | field_type = bt_ctf_field_get_type(field); | |
664 | if (field_type != stream->trace->packet_header_type) { | |
665 | ret = -1; | |
666 | goto end; | |
667 | } | |
668 | ||
669 | bt_ctf_field_get(field); | |
670 | bt_ctf_field_put(stream->packet_header); | |
671 | stream->packet_header = field; | |
672 | end: | |
673 | if (field_type) { | |
674 | bt_ctf_field_type_put(field_type); | |
675 | } | |
676 | return ret; | |
677 | } | |
678 | ||
9a220c32 JG |
679 | static |
680 | int get_event_header_timestamp(struct bt_ctf_field *event_header, uint64_t *timestamp) | |
681 | { | |
682 | int ret = 0; | |
683 | struct bt_ctf_field *timestamp_field = NULL; | |
684 | struct bt_ctf_field_type *timestamp_field_type = NULL; | |
685 | ||
686 | timestamp_field = bt_ctf_field_structure_get_field(event_header, | |
687 | "timestamp"); | |
688 | if (!timestamp_field) { | |
689 | ret = -1; | |
690 | goto end; | |
691 | } | |
692 | ||
693 | timestamp_field_type = bt_ctf_field_get_type(timestamp_field); | |
694 | assert(timestamp_field_type); | |
695 | if (bt_ctf_field_type_get_type_id(timestamp_field_type) != | |
696 | CTF_TYPE_INTEGER) { | |
697 | ret = -1; | |
698 | goto end; | |
699 | } | |
700 | ||
701 | if (bt_ctf_field_type_integer_get_signed(timestamp_field_type)) { | |
702 | int64_t val; | |
703 | ||
704 | ret = bt_ctf_field_signed_integer_get_value(timestamp_field, | |
705 | &val); | |
706 | if (ret) { | |
707 | goto end; | |
708 | } | |
709 | *timestamp = (uint64_t) val; | |
710 | } else { | |
711 | ret = bt_ctf_field_unsigned_integer_get_value(timestamp_field, | |
712 | timestamp); | |
713 | if (ret) { | |
714 | goto end; | |
715 | } | |
716 | } | |
717 | end: | |
718 | bt_ctf_field_put(timestamp_field); | |
719 | bt_ctf_field_type_put(timestamp_field_type); | |
720 | return ret; | |
721 | } | |
722 | ||
273b65be JG |
723 | int bt_ctf_stream_flush(struct bt_ctf_stream *stream) |
724 | { | |
725 | int ret = 0; | |
726 | size_t i; | |
12c8a1a3 | 727 | uint64_t timestamp_begin, timestamp_end, events_discarded; |
273b65be JG |
728 | struct bt_ctf_field *integer = NULL; |
729 | struct ctf_stream_pos packet_context_pos; | |
730 | ||
bc37ae52 JG |
731 | if (!stream || stream->pos.fd < 0) { |
732 | /* | |
733 | * Stream does not have an associated fd. It is, | |
734 | * therefore, not a stream being used to write events. | |
735 | */ | |
273b65be JG |
736 | ret = -1; |
737 | goto end; | |
738 | } | |
739 | ||
740 | if (!stream->events->len) { | |
741 | goto end; | |
742 | } | |
743 | ||
d246b111 JG |
744 | ret = bt_ctf_field_validate(stream->packet_header); |
745 | if (ret) { | |
746 | goto end; | |
747 | } | |
748 | ||
28362f2b JG |
749 | /* mmap the next packet */ |
750 | ctf_packet_seek(&stream->pos.parent, 0, SEEK_CUR); | |
d246b111 JG |
751 | |
752 | ret = bt_ctf_field_serialize(stream->packet_header, &stream->pos); | |
753 | if (ret) { | |
754 | goto end; | |
273b65be JG |
755 | } |
756 | ||
12c8a1a3 | 757 | /* Set the default context attributes if present and unset. */ |
9a220c32 JG |
758 | if (!get_event_header_timestamp( |
759 | ((struct bt_ctf_event *) g_ptr_array_index( | |
760 | stream->events, 0))->event_header, ×tamp_begin)) { | |
761 | ret = set_structure_field_integer(stream->packet_context, | |
762 | "timestamp_begin", timestamp_begin); | |
763 | if (ret) { | |
764 | goto end; | |
765 | } | |
273b65be JG |
766 | } |
767 | ||
9a220c32 JG |
768 | if (!get_event_header_timestamp( |
769 | ((struct bt_ctf_event *) g_ptr_array_index( | |
770 | stream->events, stream->events->len - 1))->event_header, | |
771 | ×tamp_end)) { | |
273b65be | 772 | |
9a220c32 JG |
773 | ret = set_structure_field_integer(stream->packet_context, |
774 | "timestamp_end", timestamp_end); | |
775 | if (ret) { | |
776 | goto end; | |
777 | } | |
778 | } | |
12c8a1a3 | 779 | ret = set_structure_field_integer(stream->packet_context, |
273b65be JG |
780 | "content_size", UINT64_MAX); |
781 | if (ret) { | |
782 | goto end; | |
783 | } | |
784 | ||
12c8a1a3 | 785 | ret = set_structure_field_integer(stream->packet_context, |
273b65be JG |
786 | "packet_size", UINT64_MAX); |
787 | if (ret) { | |
788 | goto end; | |
789 | } | |
790 | ||
791 | /* Write packet context */ | |
792 | memcpy(&packet_context_pos, &stream->pos, | |
793 | sizeof(struct ctf_stream_pos)); | |
12c8a1a3 | 794 | ret = bt_ctf_field_serialize(stream->packet_context, |
273b65be JG |
795 | &stream->pos); |
796 | if (ret) { | |
797 | goto end; | |
798 | } | |
799 | ||
12c8a1a3 JG |
800 | ret = bt_ctf_stream_get_discarded_events_count(stream, |
801 | &events_discarded); | |
802 | if (ret) { | |
803 | goto end; | |
804 | } | |
805 | ||
806 | /* Unset the packet context's fields. */ | |
807 | ret = bt_ctf_field_reset(stream->packet_context); | |
808 | if (ret) { | |
809 | goto end; | |
810 | } | |
811 | ||
812 | /* Set the previous number of discarded events. */ | |
813 | ret = set_structure_field_integer(stream->packet_context, | |
814 | "events_discarded", events_discarded); | |
815 | if (ret) { | |
816 | goto end; | |
817 | } | |
818 | ||
273b65be JG |
819 | for (i = 0; i < stream->events->len; i++) { |
820 | struct bt_ctf_event *event = g_ptr_array_index( | |
821 | stream->events, i); | |
273b65be | 822 | |
662e778c | 823 | ret = bt_ctf_field_reset(event->event_header); |
12c8a1a3 JG |
824 | if (ret) { |
825 | goto end; | |
826 | } | |
827 | ||
273b65be | 828 | /* Write event header */ |
662e778c | 829 | ret = bt_ctf_field_serialize(event->event_header, |
273b65be JG |
830 | &stream->pos); |
831 | if (ret) { | |
832 | goto end; | |
833 | } | |
834 | ||
8bfa3f9c JG |
835 | /* Write stream event context */ |
836 | if (stream->event_contexts) { | |
837 | ret = bt_ctf_field_serialize( | |
838 | g_ptr_array_index(stream->event_contexts, i), | |
839 | &stream->pos); | |
840 | if (ret) { | |
841 | goto end; | |
842 | } | |
843 | } | |
844 | ||
273b65be JG |
845 | /* Write event content */ |
846 | ret = bt_ctf_event_serialize(event, &stream->pos); | |
847 | if (ret) { | |
848 | goto end; | |
849 | } | |
850 | } | |
851 | ||
852 | /* | |
853 | * Update the packet total size and content size and overwrite the | |
854 | * packet context. | |
3a092c05 JG |
855 | * Copy base_mma as the packet may have been remapped (e.g. when a |
856 | * packet is resized). | |
273b65be | 857 | */ |
3a092c05 | 858 | packet_context_pos.base_mma = stream->pos.base_mma; |
12c8a1a3 | 859 | ret = set_structure_field_integer(stream->packet_context, |
273b65be JG |
860 | "content_size", stream->pos.offset); |
861 | if (ret) { | |
862 | goto end; | |
863 | } | |
864 | ||
12c8a1a3 | 865 | ret = set_structure_field_integer(stream->packet_context, |
273b65be JG |
866 | "packet_size", stream->pos.packet_size); |
867 | if (ret) { | |
868 | goto end; | |
869 | } | |
870 | ||
12c8a1a3 | 871 | ret = bt_ctf_field_serialize(stream->packet_context, |
273b65be JG |
872 | &packet_context_pos); |
873 | if (ret) { | |
874 | goto end; | |
875 | } | |
876 | ||
877 | g_ptr_array_set_size(stream->events, 0); | |
8bfa3f9c JG |
878 | if (stream->event_contexts) { |
879 | g_ptr_array_set_size(stream->event_contexts, 0); | |
880 | } | |
273b65be JG |
881 | stream->flushed_packet_count++; |
882 | end: | |
883 | bt_ctf_field_put(integer); | |
884 | return ret; | |
885 | } | |
886 | ||
887 | void bt_ctf_stream_get(struct bt_ctf_stream *stream) | |
888 | { | |
889 | if (!stream) { | |
890 | return; | |
891 | } | |
892 | ||
893 | bt_ctf_ref_get(&stream->ref_count); | |
894 | } | |
895 | ||
896 | void bt_ctf_stream_put(struct bt_ctf_stream *stream) | |
897 | { | |
898 | if (!stream) { | |
899 | return; | |
900 | } | |
901 | ||
902 | bt_ctf_ref_put(&stream->ref_count, bt_ctf_stream_destroy); | |
903 | } | |
904 | ||
905 | static | |
906 | void bt_ctf_stream_destroy(struct bt_ctf_ref *ref) | |
907 | { | |
908 | struct bt_ctf_stream *stream; | |
909 | ||
910 | if (!ref) { | |
911 | return; | |
912 | } | |
913 | ||
914 | stream = container_of(ref, struct bt_ctf_stream, ref_count); | |
915 | ctf_fini_pos(&stream->pos); | |
0e45d308 | 916 | if (stream->pos.fd >= 0 && close(stream->pos.fd)) { |
9f56e450 JG |
917 | perror("close"); |
918 | } | |
12c8a1a3 JG |
919 | |
920 | if (stream->stream_class) { | |
921 | bt_ctf_stream_class_put(stream->stream_class); | |
922 | } | |
923 | if (stream->events) { | |
924 | g_ptr_array_free(stream->events, TRUE); | |
925 | } | |
8bfa3f9c JG |
926 | if (stream->event_contexts) { |
927 | g_ptr_array_free(stream->event_contexts, TRUE); | |
928 | } | |
d246b111 JG |
929 | if (stream->packet_header) { |
930 | bt_ctf_field_put(stream->packet_header); | |
931 | } | |
12c8a1a3 JG |
932 | if (stream->packet_context) { |
933 | bt_ctf_field_put(stream->packet_context); | |
934 | } | |
8bfa3f9c JG |
935 | if (stream->event_context) { |
936 | bt_ctf_field_put(stream->event_context); | |
937 | } | |
273b65be JG |
938 | g_free(stream); |
939 | } | |
940 | ||
273b65be JG |
941 | static |
942 | int set_structure_field_integer(struct bt_ctf_field *structure, char *name, | |
943 | uint64_t value) | |
944 | { | |
945 | int ret = 0; | |
d7b1ea66 | 946 | struct bt_ctf_field_type *field_type = NULL; |
273b65be JG |
947 | struct bt_ctf_field *integer = |
948 | bt_ctf_field_structure_get_field(structure, name); | |
12c8a1a3 JG |
949 | |
950 | if (!structure || !name) { | |
273b65be JG |
951 | ret = -1; |
952 | goto end; | |
953 | } | |
954 | ||
12c8a1a3 JG |
955 | if (!integer) { |
956 | /* Field not found, not an error. */ | |
957 | goto end; | |
958 | } | |
959 | ||
960 | /* Make sure the payload has not already been set. */ | |
961 | if (!bt_ctf_field_validate(integer)) { | |
962 | /* Payload already set, not an error */ | |
963 | goto end; | |
964 | } | |
965 | ||
d7b1ea66 JG |
966 | field_type = bt_ctf_field_get_type(integer); |
967 | /* Something is serioulsly wrong */ | |
968 | assert(field_type); | |
969 | if (bt_ctf_field_type_get_type_id(field_type) != CTF_TYPE_INTEGER) { | |
970 | /* | |
971 | * The user most likely meant for us to populate this field | |
972 | * automatically. However, we can only do this if the field | |
973 | * is an integer. Return an error. | |
974 | */ | |
975 | ret = -1; | |
976 | goto end; | |
977 | } | |
978 | ||
979 | if (bt_ctf_field_type_integer_get_signed(field_type)) { | |
980 | ret = bt_ctf_field_signed_integer_set_value(integer, | |
981 | (int64_t) value); | |
982 | } else { | |
983 | ret = bt_ctf_field_unsigned_integer_set_value(integer, value); | |
984 | } | |
273b65be | 985 | end: |
d7b1ea66 JG |
986 | if (integer) { |
987 | bt_ctf_field_put(integer); | |
988 | } | |
989 | if (field_type) { | |
990 | bt_ctf_field_type_put(field_type); | |
991 | } | |
273b65be JG |
992 | return ret; |
993 | } |