| 1 | #ifndef BABELTRACE_CTF_IR_STREAM_H |
| 2 | #define BABELTRACE_CTF_IR_STREAM_H |
| 3 | |
| 4 | /* |
| 5 | * BabelTrace - CTF IR: Stream |
| 6 | * |
| 7 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 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 | * The Common Trace Format (CTF) Specification is available at |
| 30 | * http://www.efficios.com/ctf |
| 31 | */ |
| 32 | |
| 33 | #include <babeltrace/ctf-ir/stream-class.h> |
| 34 | |
| 35 | #ifdef __cplusplus |
| 36 | extern "C" { |
| 37 | #endif |
| 38 | |
| 39 | struct bt_ctf_event; |
| 40 | struct bt_ctf_stream; |
| 41 | |
| 42 | /* |
| 43 | * bt_ctf_stream_get_discarded_events_count: get the number of discarded |
| 44 | * events associated with this stream. |
| 45 | * |
| 46 | * Note that discarded events are not stored if the stream's packet |
| 47 | * context has no "events_discarded" field. An error will be returned |
| 48 | * in that case. |
| 49 | * |
| 50 | * @param stream Stream instance. |
| 51 | * |
| 52 | * Returns the number of discarded events, a negative value on error. |
| 53 | */ |
| 54 | extern int bt_ctf_stream_get_discarded_events_count( |
| 55 | struct bt_ctf_stream *stream, uint64_t *count); |
| 56 | |
| 57 | /* |
| 58 | * bt_ctf_stream_append_discarded_events: increment discarded events count. |
| 59 | * |
| 60 | * Increase the current packet's discarded event count. Has no effect if the |
| 61 | * stream class' packet context has no "events_discarded" field. |
| 62 | * |
| 63 | * @param stream Stream instance. |
| 64 | * @param event_count Number of discarded events to add to the stream's current |
| 65 | * packet. |
| 66 | */ |
| 67 | extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, |
| 68 | uint64_t event_count); |
| 69 | |
| 70 | /* |
| 71 | * bt_ctf_stream_append_event: append an event to the stream. |
| 72 | * |
| 73 | * Append "event" to the stream's current packet. The stream's associated clock |
| 74 | * will be sampled during this call. The event shall not be modified after |
| 75 | * being appended to a stream. The stream will share the event's ownership by |
| 76 | * incrementing its reference count. The current packet is not flushed to disk |
| 77 | * until the next call to bt_ctf_stream_flush. |
| 78 | * |
| 79 | * The stream event context will be sampled for every appended event if |
| 80 | * a stream event context was defined. |
| 81 | * |
| 82 | * @param stream Stream instance. |
| 83 | * @param event Event instance to append to the stream's current packet. |
| 84 | * |
| 85 | * Returns 0 on success, a negative value on error. |
| 86 | */ |
| 87 | extern int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, |
| 88 | struct bt_ctf_event *event); |
| 89 | |
| 90 | /* |
| 91 | * bt_ctf_stream_get_packet_context: get a stream's packet context. |
| 92 | * |
| 93 | * @param stream Stream instance. |
| 94 | * |
| 95 | * Returns a field instance on success, NULL on error. |
| 96 | */ |
| 97 | extern struct bt_ctf_field *bt_ctf_stream_get_packet_context( |
| 98 | struct bt_ctf_stream *stream); |
| 99 | |
| 100 | /* |
| 101 | * bt_ctf_stream_set_packet_context: set a stream's packet context. |
| 102 | * |
| 103 | * The packet context's type must match the stream class' packet |
| 104 | * context type. |
| 105 | * |
| 106 | * @param stream Stream instance. |
| 107 | * @param packet_context Packet context field instance. |
| 108 | * |
| 109 | * Returns a field instance on success, NULL on error. |
| 110 | */ |
| 111 | extern int bt_ctf_stream_set_packet_context( |
| 112 | struct bt_ctf_stream *stream, |
| 113 | struct bt_ctf_field *packet_context); |
| 114 | |
| 115 | /* |
| 116 | * bt_ctf_stream_get_event_context: get a stream's event context. |
| 117 | * |
| 118 | * @param stream Stream instance. |
| 119 | * |
| 120 | * Returns a field instance on success, NULL on error. |
| 121 | */ |
| 122 | extern struct bt_ctf_field *bt_ctf_stream_get_event_context( |
| 123 | struct bt_ctf_stream *stream); |
| 124 | |
| 125 | /* |
| 126 | * bt_ctf_stream_set_event_context: set a stream's event context. |
| 127 | * |
| 128 | * The event context's type must match the stream class' event |
| 129 | * context type. |
| 130 | * |
| 131 | * @param stream Stream instance. |
| 132 | * @param event_context Event context field instance. |
| 133 | * |
| 134 | * Returns a field instance on success, NULL on error. |
| 135 | */ |
| 136 | extern int bt_ctf_stream_set_event_context( |
| 137 | struct bt_ctf_stream *stream, |
| 138 | struct bt_ctf_field *event_context); |
| 139 | |
| 140 | /* |
| 141 | * bt_ctf_stream_get_packet_header: get a stream's packet header. |
| 142 | * |
| 143 | * @param stream Stream instance. |
| 144 | * |
| 145 | * Returns a field instance on success, NULL on error. |
| 146 | */ |
| 147 | extern struct bt_ctf_field *bt_ctf_stream_get_packet_header( |
| 148 | struct bt_ctf_stream *stream); |
| 149 | |
| 150 | /* |
| 151 | * bt_ctf_stream_set_packet_header: set a stream's packet header. |
| 152 | * |
| 153 | * The packet header's type must match the trace's packet header |
| 154 | * type. |
| 155 | * |
| 156 | * @param stream Stream instance. |
| 157 | * @param packet_header Packet header instance. |
| 158 | * |
| 159 | * Returns a field instance on success, NULL on error. |
| 160 | */ |
| 161 | extern int bt_ctf_stream_set_packet_header( |
| 162 | struct bt_ctf_stream *stream, |
| 163 | struct bt_ctf_field *packet_header); |
| 164 | |
| 165 | /* |
| 166 | * bt_ctf_stream_flush: flush a stream. |
| 167 | * |
| 168 | * The stream's current packet's events will be flushed, thus closing the |
| 169 | * current packet. Events subsequently appended to the stream will be |
| 170 | * added to a new packet. |
| 171 | * |
| 172 | * Flushing will also set the packet context's default attributes if |
| 173 | * they remained unset while populating the current packet. These default |
| 174 | * attributes, along with their expected types, are detailed in stream-class.h. |
| 175 | * |
| 176 | * @param stream Stream instance. |
| 177 | * |
| 178 | * Returns 0 on success, a negative value on error. |
| 179 | */ |
| 180 | extern int bt_ctf_stream_flush(struct bt_ctf_stream *stream); |
| 181 | |
| 182 | /* |
| 183 | * bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the |
| 184 | * stream's reference count. |
| 185 | * |
| 186 | * These functions ensure that the stream won't be destroyed while it |
| 187 | * is in use. The same number of get and put (plus one extra put to |
| 188 | * release the initial reference done at creation) have to be done to |
| 189 | * destroy a stream. |
| 190 | * |
| 191 | * When the stream's reference count is decremented to 0 by a |
| 192 | * bt_ctf_stream_put, the stream is freed. |
| 193 | * |
| 194 | * @param stream Stream instance. |
| 195 | */ |
| 196 | extern void bt_ctf_stream_get(struct bt_ctf_stream *stream); |
| 197 | extern void bt_ctf_stream_put(struct bt_ctf_stream *stream); |
| 198 | |
| 199 | #ifdef __cplusplus |
| 200 | } |
| 201 | #endif |
| 202 | |
| 203 | #endif /* BABELTRACE_CTF_IR_STREAM_H */ |