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