| 1 | #ifndef BABELTRACE_CTF_IR_EVENT_INTERNAL_H |
| 2 | #define BABELTRACE_CTF_IR_EVENT_INTERNAL_H |
| 3 | |
| 4 | /* |
| 5 | * Babeltrace - CTF IR: Event internal |
| 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 | |
| 30 | #include <babeltrace/ctf-writer/event-types.h> |
| 31 | #include <babeltrace/ctf-writer/event-fields.h> |
| 32 | #include <babeltrace/babeltrace-internal.h> |
| 33 | #include <babeltrace/values.h> |
| 34 | #include <babeltrace/ctf/types.h> |
| 35 | #include <babeltrace/ctf-ir/stream-class.h> |
| 36 | #include <babeltrace/ctf-ir/stream.h> |
| 37 | #include <babeltrace/ctf-ir/packet.h> |
| 38 | #include <babeltrace/object-internal.h> |
| 39 | #include <glib.h> |
| 40 | |
| 41 | struct bt_ctf_event { |
| 42 | struct bt_object base; |
| 43 | struct bt_ctf_event_class *event_class; |
| 44 | struct bt_ctf_packet *packet; |
| 45 | struct bt_ctf_field *event_header; |
| 46 | struct bt_ctf_field *stream_event_context; |
| 47 | struct bt_ctf_field *context_payload; |
| 48 | struct bt_ctf_field *fields_payload; |
| 49 | GHashTable *clock_values; /* Maps clock addresses to (uint64_t *) */ |
| 50 | int frozen; |
| 51 | }; |
| 52 | |
| 53 | BT_HIDDEN |
| 54 | int bt_ctf_event_register_stream_clock_values(struct bt_ctf_event *event); |
| 55 | |
| 56 | BT_HIDDEN |
| 57 | int bt_ctf_event_validate(struct bt_ctf_event *event); |
| 58 | |
| 59 | BT_HIDDEN |
| 60 | int bt_ctf_event_serialize(struct bt_ctf_event *event, |
| 61 | struct ctf_stream_pos *pos); |
| 62 | |
| 63 | /* |
| 64 | * Attempt to populate the "id" and "timestamp" fields of the event header if |
| 65 | * they are present, unset and their types are integers. |
| 66 | * |
| 67 | * Not finding these fields or encountering unexpected types is not an error |
| 68 | * since the user may have defined a different event header layout. In this |
| 69 | * case, it is expected that the fields be manually populated before appending |
| 70 | * an event to a stream. |
| 71 | */ |
| 72 | BT_HIDDEN |
| 73 | int bt_ctf_event_populate_event_header(struct bt_ctf_event *event); |
| 74 | |
| 75 | BT_HIDDEN |
| 76 | void bt_ctf_event_freeze(struct bt_ctf_event *event); |
| 77 | |
| 78 | /* |
| 79 | * bt_ctf_event_get_class: get an event's class. |
| 80 | * |
| 81 | * @param event Event. |
| 82 | * |
| 83 | * Returns the event's class, NULL on error. |
| 84 | */ |
| 85 | BT_HIDDEN |
| 86 | struct bt_ctf_event_class *bt_ctf_event_get_class(struct bt_ctf_event *event); |
| 87 | |
| 88 | /* |
| 89 | * bt_ctf_event_get_stream: get an event's associated stream. |
| 90 | * |
| 91 | * @param event Event. |
| 92 | * |
| 93 | * Returns the event's associated stream, NULL on error. |
| 94 | */ |
| 95 | BT_HIDDEN |
| 96 | struct bt_ctf_stream *bt_ctf_event_get_stream(struct bt_ctf_event *event); |
| 97 | |
| 98 | /* |
| 99 | * bt_ctf_event_get_clock: get an event's associated clock. |
| 100 | * |
| 101 | * @param event Event. |
| 102 | * |
| 103 | * Returns the event's clock, NULL on error. |
| 104 | */ |
| 105 | BT_HIDDEN |
| 106 | struct bt_ctf_clock *bt_ctf_event_get_clock(struct bt_ctf_event *event); |
| 107 | |
| 108 | /* |
| 109 | * bt_ctf_event_get_payload_field: get an event's payload. |
| 110 | * |
| 111 | * @param event Event instance. |
| 112 | * |
| 113 | * Returns a field instance on success, NULL on error. |
| 114 | */ |
| 115 | BT_HIDDEN |
| 116 | struct bt_ctf_field *bt_ctf_event_get_payload_field(struct bt_ctf_event *event); |
| 117 | |
| 118 | /* |
| 119 | * bt_ctf_event_set_payload_field: set an event's payload. |
| 120 | * |
| 121 | * @param event Event instance. |
| 122 | * @param payload Field instance (must be a structure). |
| 123 | * |
| 124 | * Returns 0 on success, a negative value on error. |
| 125 | */ |
| 126 | BT_HIDDEN |
| 127 | int bt_ctf_event_set_payload_field(struct bt_ctf_event *event, |
| 128 | struct bt_ctf_field *payload); |
| 129 | |
| 130 | /* |
| 131 | * bt_ctf_event_get_payload_by_index: Get event's field by index. |
| 132 | * |
| 133 | * Returns the field associated with the provided index. bt_ctf_field_put() |
| 134 | * must be called on the returned value. The indexes to be provided are |
| 135 | * the same as can be retrieved from the event class. |
| 136 | * |
| 137 | * @param event Event. |
| 138 | * @param index Index of field. |
| 139 | * |
| 140 | * Returns the event's field, NULL on error. |
| 141 | * |
| 142 | * Note: Will return an error if the payload's type is not a structure. |
| 143 | */ |
| 144 | BT_HIDDEN |
| 145 | struct bt_ctf_field *bt_ctf_event_get_payload_by_index( |
| 146 | struct bt_ctf_event *event, int index); |
| 147 | |
| 148 | /* |
| 149 | * bt_ctf_event_get_header: get an event's header. |
| 150 | * |
| 151 | * @param event Event instance. |
| 152 | * |
| 153 | * Returns a field instance on success, NULL on error. |
| 154 | */ |
| 155 | BT_HIDDEN |
| 156 | struct bt_ctf_field *bt_ctf_event_get_header(struct bt_ctf_event *event); |
| 157 | |
| 158 | /* |
| 159 | * bt_ctf_event_get_event_context: Get an event's context |
| 160 | * |
| 161 | * @param event_class Event class. |
| 162 | * |
| 163 | * Returns a field on success (a structure), NULL on error. |
| 164 | * |
| 165 | * Note: This function is named this way instead of the expected |
| 166 | * "bt_ctf_event_get_context" in order to work around a name clash with |
| 167 | * an unrelated function bearing this name in context.h. |
| 168 | */ |
| 169 | BT_HIDDEN |
| 170 | struct bt_ctf_field *bt_ctf_event_get_event_context(struct bt_ctf_event *event); |
| 171 | |
| 172 | /* |
| 173 | * bt_ctf_event_get_stream_event_context: Get an event's stream event context |
| 174 | * |
| 175 | * @param event_class Event class. |
| 176 | * |
| 177 | * Returns a field on success (a structure), NULL on error. |
| 178 | */ |
| 179 | BT_HIDDEN |
| 180 | struct bt_ctf_field *bt_ctf_event_get_stream_event_context( |
| 181 | struct bt_ctf_event *event); |
| 182 | |
| 183 | BT_HIDDEN |
| 184 | uint64_t bt_ctf_event_get_clock_value(struct bt_ctf_event *event, |
| 185 | struct bt_ctf_clock *clock); |
| 186 | |
| 187 | /* |
| 188 | * bt_ctf_event_set_header: set an event's header. |
| 189 | * |
| 190 | * The event header's type must match the stream class' event |
| 191 | * header type. |
| 192 | * |
| 193 | * @param event Event instance. |
| 194 | * @param header Event header field instance. |
| 195 | * |
| 196 | * Returns a field instance on success, NULL on error. |
| 197 | */ |
| 198 | BT_HIDDEN |
| 199 | int bt_ctf_event_set_header( |
| 200 | struct bt_ctf_event *event, |
| 201 | struct bt_ctf_field *header); |
| 202 | |
| 203 | /* |
| 204 | * bt_ctf_event_set_event_context: Set an event's context |
| 205 | * |
| 206 | * @param event Event. |
| 207 | * @param context Event context field (must match the event class' |
| 208 | * context type). |
| 209 | * |
| 210 | * Returns 0 on success, a negative value on error. |
| 211 | */ |
| 212 | BT_HIDDEN |
| 213 | int bt_ctf_event_set_event_context(struct bt_ctf_event *event, |
| 214 | struct bt_ctf_field *context); |
| 215 | |
| 216 | /* |
| 217 | * bt_ctf_event_set_stream_event_context: Set an event's stream event context |
| 218 | * |
| 219 | * @param event Event. |
| 220 | * @param context Event stream context field (must match the stream class' |
| 221 | * stream event context type). |
| 222 | * |
| 223 | * Returns 0 on success, a negative value on error. |
| 224 | */ |
| 225 | BT_HIDDEN |
| 226 | int bt_ctf_event_set_stream_event_context(struct bt_ctf_event *event, |
| 227 | struct bt_ctf_field *context); |
| 228 | |
| 229 | BT_HIDDEN |
| 230 | int bt_ctf_event_set_packet(struct bt_ctf_event *event, |
| 231 | struct bt_ctf_packet *packet); |
| 232 | |
| 233 | #endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */ |