Commit | Line | Data |
---|---|---|
273b65be JG |
1 | #ifndef BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H |
2 | #define BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H | |
3 | ||
4 | /* | |
5 | * BabelTrace - CTF Writer: Stream internal | |
6 | * | |
1c822dfb | 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 | ||
1c822dfb | 30 | #include <babeltrace/object-internal.h> |
273b65be JG |
31 | #include <babeltrace/ctf-writer/clock.h> |
32 | #include <babeltrace/ctf-writer/event-fields.h> | |
33 | #include <babeltrace/ctf-writer/event-types.h> | |
34 | #include <babeltrace/babeltrace-internal.h> | |
35 | #include <babeltrace/ctf/types.h> | |
36 | #include <glib.h> | |
37 | ||
273b65be | 38 | struct bt_ctf_stream { |
1c822dfb | 39 | struct bt_object base; |
273b65be JG |
40 | uint32_t id; |
41 | struct bt_ctf_stream_class *stream_class; | |
273b65be JG |
42 | /* Array of pointers to bt_ctf_event for the current packet */ |
43 | GPtrArray *events; | |
44 | struct ctf_stream_pos pos; | |
45 | unsigned int flushed_packet_count; | |
1c822dfb JG |
46 | GString *name; |
47 | struct bt_ctf_field *packet_header; | |
48 | struct bt_ctf_field *packet_context; | |
49 | GHashTable *clock_values; /* Maps clock addresses to (uint64_t *) */ | |
273b65be JG |
50 | }; |
51 | ||
52 | BT_HIDDEN | |
1c822dfb | 53 | int bt_ctf_stream_set_fd(struct bt_ctf_stream *stream, int fd); |
273b65be JG |
54 | |
55 | BT_HIDDEN | |
1c822dfb JG |
56 | void bt_ctf_stream_update_clock_value(struct bt_ctf_stream *stream, |
57 | struct bt_ctf_field *value_field); | |
273b65be | 58 | |
eea2626f JG |
59 | BT_HIDDEN |
60 | const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream); | |
61 | ||
62 | BT_HIDDEN | |
63 | struct bt_ctf_stream *bt_ctf_stream_create( | |
64 | struct bt_ctf_stream_class *stream_class, | |
65 | const char *name); | |
66 | ||
67 | /* | |
68 | * bt_ctf_stream_get_discarded_events_count: get the number of discarded | |
69 | * events associated with this stream. | |
70 | * | |
71 | * Note that discarded events are not stored if the stream's packet | |
72 | * context has no "events_discarded" field. An error will be returned | |
73 | * in that case. | |
74 | * | |
75 | * @param stream Stream instance. | |
76 | * | |
77 | * Returns the number of discarded events, a negative value on error. | |
78 | */ | |
79 | BT_HIDDEN | |
80 | int bt_ctf_stream_get_discarded_events_count( | |
81 | struct bt_ctf_stream *stream, uint64_t *count); | |
82 | ||
83 | /* | |
84 | * bt_ctf_stream_get_stream_class: get a stream's class. | |
85 | * | |
86 | * @param stream Stream instance. | |
87 | * | |
88 | * Returns the stream's class, NULL on error. | |
89 | */ | |
90 | BT_HIDDEN | |
91 | struct bt_ctf_stream_class *bt_ctf_stream_get_class( | |
92 | struct bt_ctf_stream *stream); | |
93 | ||
94 | /* | |
95 | * bt_ctf_stream_get_packet_header: get a stream's packet header. | |
96 | * | |
97 | * @param stream Stream instance. | |
98 | * | |
99 | * Returns a field instance on success, NULL on error. | |
100 | */ | |
101 | BT_HIDDEN | |
102 | struct bt_ctf_field *bt_ctf_stream_get_packet_header( | |
103 | struct bt_ctf_stream *stream); | |
104 | ||
105 | /* | |
106 | * bt_ctf_stream_set_packet_header: set a stream's packet header. | |
107 | * | |
108 | * The packet header's type must match the trace's packet header | |
109 | * type. | |
110 | * | |
111 | * @param stream Stream instance. | |
112 | * @param packet_header Packet header instance. | |
113 | * | |
114 | * Returns a field instance on success, NULL on error. | |
115 | */ | |
116 | BT_HIDDEN | |
117 | int bt_ctf_stream_set_packet_header(struct bt_ctf_stream *stream, | |
118 | struct bt_ctf_field *packet_header); | |
119 | ||
120 | /* | |
121 | * bt_ctf_stream_set_packet_context: set a stream's packet context. | |
122 | * | |
123 | * The packet context's type must match the stream class' packet | |
124 | * context type. | |
125 | * | |
126 | * @param stream Stream instance. | |
127 | * @param packet_context Packet context field instance. | |
128 | * | |
129 | * Returns a field instance on success, NULL on error. | |
130 | */ | |
131 | BT_HIDDEN | |
132 | int bt_ctf_stream_set_packet_context(struct bt_ctf_stream *stream, | |
133 | struct bt_ctf_field *packet_context); | |
134 | ||
135 | ||
273b65be | 136 | #endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */ |