projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| adc315b8 JG |
1 | #ifndef BABELTRACE_CTF_IR_EVENT_INTERNAL_H |
| 2 | #define BABELTRACE_CTF_IR_EVENT_INTERNAL_H | |
| 273b65be JG |
3 | |
| 4 | /* | |
| adc315b8 | 5 | * BabelTrace - CTF IR: Event 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 | ||
| 30 | #include <babeltrace/ctf-writer/ref-internal.h> | |
| 31 | #include <babeltrace/ctf-writer/event-types.h> | |
| 32 | #include <babeltrace/ctf-writer/event-fields.h> | |
| 33 | #include <babeltrace/babeltrace-internal.h> | |
| b8248cc0 | 34 | #include <babeltrace/objects.h> |
| 273b65be JG |
35 | #include <babeltrace/ctf/types.h> |
| 36 | #include <glib.h> | |
| 37 | ||
| b8248cc0 PP |
38 | #define BT_CTF_EVENT_CLASS_ATTR_ID_INDEX 0 |
| 39 | #define BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX 1 | |
| 40 | ||
| 273b65be JG |
41 | struct bt_ctf_event_class { |
| 42 | struct bt_ctf_ref ref_count; | |
| b8248cc0 | 43 | struct bt_object *attributes; |
| 662e778c | 44 | /* An event class does not have ownership of a stream class */ |
| 2f100782 | 45 | struct bt_ctf_stream_class *stream_class; |
| 273b65be JG |
46 | /* Structure type containing the event's context */ |
| 47 | struct bt_ctf_field_type *context; | |
| 48 | /* Structure type containing the event's fields */ | |
| 49 | struct bt_ctf_field_type *fields; | |
| 50 | int frozen; | |
| 51 | }; | |
| 52 | ||
| 53 | struct bt_ctf_event { | |
| 54 | struct bt_ctf_ref ref_count; | |
| 273b65be | 55 | struct bt_ctf_event_class *event_class; |
| 662e778c | 56 | struct bt_ctf_field *event_header; |
| 273b65be JG |
57 | struct bt_ctf_field *context_payload; |
| 58 | struct bt_ctf_field *fields_payload; | |
| 59 | }; | |
| 60 | ||
| 61 | BT_HIDDEN | |
| 62 | void bt_ctf_event_class_freeze(struct bt_ctf_event_class *event_class); | |
| 63 | ||
| 64 | BT_HIDDEN | |
| 2f100782 JG |
65 | int bt_ctf_event_class_set_stream_class(struct bt_ctf_event_class *event_class, |
| 66 | struct bt_ctf_stream_class *stream_class); | |
| 273b65be JG |
67 | |
| 68 | BT_HIDDEN | |
| 69 | int bt_ctf_event_class_serialize(struct bt_ctf_event_class *event_class, | |
| 70 | struct metadata_context *context); | |
| 71 | ||
| c35a1669 JG |
72 | BT_HIDDEN |
| 73 | void bt_ctf_event_class_set_native_byte_order( | |
| 74 | struct bt_ctf_event_class *event_class, | |
| 75 | int byte_order); | |
| 76 | ||
| 273b65be JG |
77 | BT_HIDDEN |
| 78 | int bt_ctf_event_validate(struct bt_ctf_event *event); | |
| 79 | ||
| 80 | BT_HIDDEN | |
| 81 | int bt_ctf_event_serialize(struct bt_ctf_event *event, | |
| 82 | struct ctf_stream_pos *pos); | |
| 83 | ||
| 662e778c JG |
84 | /* |
| 85 | * Attempt to populate the "id" and "timestamp" fields of the event header if | |
| 86 | * they are present, unset and their types are integers. | |
| 87 | * | |
| 88 | * Not finding these fields or encountering unexpected types is not an error | |
| 89 | * since the user may have defined a different event header layout. In this | |
| 90 | * case, it is expected that the fields be manually populated before appending | |
| 91 | * an event to a stream. | |
| 92 | */ | |
| 93 | BT_HIDDEN | |
| 94 | int bt_ctf_event_populate_event_header(struct bt_ctf_event *event); | |
| 95 | ||
| adc315b8 | 96 | #endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */ |