Commit | Line | Data |
---|---|---|
adc315b8 JG |
1 | #ifndef BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H |
2 | #define BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H | |
273b65be JG |
3 | |
4 | /* | |
adc315b8 | 5 | * BabelTrace - CTF IR: Stream class internal |
273b65be | 6 | * |
de9dd397 | 7 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be JG |
8 | * |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
273b65be | 30 | #include <babeltrace/ctf-writer/clock.h> |
adc315b8 JG |
31 | #include <babeltrace/ctf-writer/event-fields.h> |
32 | #include <babeltrace/ctf-writer/event-types.h> | |
d3814b54 | 33 | #include <babeltrace/ctf-ir/trace.h> |
83509119 | 34 | #include <babeltrace/object-internal.h> |
273b65be | 35 | #include <babeltrace/babeltrace-internal.h> |
f79cf0f0 | 36 | #include <babeltrace/ctf-ir/trace-internal.h> |
f6ccaed9 | 37 | #include <babeltrace/assert-internal.h> |
273b65be | 38 | #include <glib.h> |
273b65be | 39 | |
50842bdc | 40 | struct bt_stream_class { |
83509119 | 41 | struct bt_object base; |
273b65be | 42 | GString *name; |
adc315b8 | 43 | struct bt_ctf_clock *clock; |
50842bdc | 44 | GPtrArray *event_classes; /* Array of pointers to bt_event_class */ |
0b9ce69f JG |
45 | /* event class id (int64_t) to event class */ |
46 | GHashTable *event_classes_ht; | |
adc315b8 | 47 | int id_set; |
9ac68eb1 PP |
48 | int64_t id; |
49 | int64_t next_event_id; | |
50 | int64_t next_stream_id; | |
50842bdc PP |
51 | struct bt_field_type *packet_context_type; |
52 | struct bt_field_type *event_header_type; | |
53 | struct bt_field_type *event_context_type; | |
273b65be | 54 | int frozen; |
c35a1669 | 55 | int byte_order; |
09840de5 PP |
56 | |
57 | /* | |
58 | * This flag indicates if the stream class is valid. A valid | |
59 | * stream class is _always_ frozen. | |
60 | */ | |
61 | int valid; | |
2a3ced3c PP |
62 | |
63 | /* | |
64 | * Unique clock class mapped to any field type within this | |
65 | * stream class, including all the stream class's event class | |
66 | * field types. This is only set if the stream class is frozen. | |
67 | * | |
68 | * If the stream class is frozen and this is still NULL, it is | |
69 | * still possible that it becomes non-NULL because | |
70 | * bt_stream_class_add_event_class() can add an event class | |
71 | * containing a field type mapped to some clock class. In this | |
72 | * case, this is the mapped clock class, and at this point, both | |
73 | * the new event class and the stream class are frozen, so the | |
74 | * next added event classes are expected to contain field types | |
75 | * which only map to this specific clock class. | |
76 | * | |
77 | * If this is a CTF writer stream class, then this is the | |
78 | * backing clock class of the `clock` member above. | |
79 | */ | |
80 | struct bt_clock_class *clock_class; | |
273b65be JG |
81 | }; |
82 | ||
83 | BT_HIDDEN | |
50842bdc | 84 | void bt_stream_class_freeze(struct bt_stream_class *stream_class); |
273b65be | 85 | |
adc315b8 | 86 | BT_HIDDEN |
50842bdc | 87 | int bt_stream_class_serialize(struct bt_stream_class *stream_class, |
273b65be JG |
88 | struct metadata_context *context); |
89 | ||
90 | BT_HIDDEN | |
50842bdc PP |
91 | void bt_stream_class_set_byte_order( |
92 | struct bt_stream_class *stream_class, int byte_order); | |
273b65be | 93 | |
5ca83563 JG |
94 | /* Set stream_class id without checking if the stream class is frozen */ |
95 | BT_HIDDEN | |
50842bdc | 96 | void _bt_stream_class_set_id(struct bt_stream_class *stream_class, |
9ac68eb1 | 97 | int64_t id); |
5ca83563 | 98 | |
29664b2a | 99 | BT_HIDDEN |
50842bdc PP |
100 | int bt_stream_class_set_id_no_check( |
101 | struct bt_stream_class *stream_class, int64_t id); | |
29664b2a | 102 | |
e011d2c1 | 103 | BT_HIDDEN |
50842bdc PP |
104 | int bt_stream_class_map_clock_class( |
105 | struct bt_stream_class *stream_class, | |
106 | struct bt_field_type *packet_context_type, | |
107 | struct bt_field_type *event_header_type); | |
e011d2c1 | 108 | |
2a3ced3c PP |
109 | BT_HIDDEN |
110 | int bt_stream_class_validate_single_clock_class( | |
111 | struct bt_stream_class *stream_class, | |
112 | struct bt_clock_class **expected_clock_class); | |
113 | ||
dc3fffef | 114 | static inline |
50842bdc PP |
115 | struct bt_trace *bt_stream_class_borrow_trace( |
116 | struct bt_stream_class *stream_class) | |
dc3fffef | 117 | { |
f6ccaed9 | 118 | BT_ASSERT(stream_class); |
dc3fffef PP |
119 | return (void *) bt_object_borrow_parent(stream_class); |
120 | } | |
121 | ||
adc315b8 | 122 | #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_INTERNAL_H */ |