projects / babeltrace.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
lib: fully detach CTF IR and CTF writer implementations
[babeltrace.git] / include / babeltrace / ctf-writer / event.h
CommitLineData
8c18d80b
PP		 1#ifndef BABELTRACE_CTF_WRITER_EVENT_H
2#define BABELTRACE_CTF_WRITER_EVENT_H
3
46bd0f2b
JG		 4/*
5 * BabelTrace - CTF Writer: Event
6 *
de9dd397 7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
46bd0f2b
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 * The Common Trace Format (CTF) Specification is available at
30 * http://www.efficios.com/ctf
31 */
32
3dca2276 33#include <babeltrace/ref.h>
8c18d80b
PP		 34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
3dca2276
PP		 39struct bt_ctf_event;
40struct bt_ctf_event_class;
41struct bt_ctf_stream;
42struct bt_ctf_field;
43struct bt_ctf_field_type;
8c18d80b 44
3dca2276
PP		 45enum bt_ctf_event_class_log_level {
46 /// Unknown, used for errors.
16ca5ff0 47 BT_CTF_EVENT_CLASS_LOG_LEVEL_UNKNOWN = -1,
3dca2276
PP		 48
49 /// Unspecified log level.
16ca5ff0 50 BT_CTF_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED = 255,
3dca2276
PP		 51
52 /// System is unusable.
16ca5ff0 53 BT_CTF_EVENT_CLASS_LOG_LEVEL_EMERGENCY = 0,
3dca2276
PP		 54
55 /// Action must be taken immediately.
16ca5ff0 56 BT_CTF_EVENT_CLASS_LOG_LEVEL_ALERT = 1,
3dca2276
PP		 57
58 /// Critical conditions.
16ca5ff0 59 BT_CTF_EVENT_CLASS_LOG_LEVEL_CRITICAL = 2,
3dca2276
PP		 60
61 /// Error conditions.
16ca5ff0 62 BT_CTF_EVENT_CLASS_LOG_LEVEL_ERROR = 3,
3dca2276
PP		 63
64 /// Warning conditions.
16ca5ff0 65 BT_CTF_EVENT_CLASS_LOG_LEVEL_WARNING = 4,
3dca2276
PP		 66
67 /// Normal, but significant, condition.
16ca5ff0 68 BT_CTF_EVENT_CLASS_LOG_LEVEL_NOTICE = 5,
3dca2276
PP		 69
70 /// Informational message.
16ca5ff0 71 BT_CTF_EVENT_CLASS_LOG_LEVEL_INFO = 6,
3dca2276
PP		 72
73 /// Debug information with system-level scope (set of programs).
16ca5ff0 74 BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM = 7,
3dca2276
PP		 75
76 /// Debug information with program-level scope (set of processes).
16ca5ff0 77 BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM = 8,
3dca2276
PP		 78
79 /// Debug information with process-level scope (set of modules).
16ca5ff0 80 BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS = 9,
3dca2276
PP		 81
82 /// Debug information with module (executable/library) scope (set of units).
16ca5ff0 83 BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE = 10,
3dca2276
PP		 84
85 /// Debug information with compilation unit scope (set of functions).
16ca5ff0 86 BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT = 11,
3dca2276
PP		 87
88 /// Debug information with function-level scope.
16ca5ff0 89 BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION = 12,
3dca2276
PP		 90
91 /// Debug information with line-level scope (default log level).
16ca5ff0 92 BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE = 13,
3dca2276
PP		 93
94 /// Debug-level message.
16ca5ff0 95 BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG = 14,
3dca2276
PP		 96};
97
98extern struct bt_ctf_event *bt_ctf_event_create(
99 struct bt_ctf_event_class *event_class);
100
101extern struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event,
102 const char *name);
103
104extern int bt_ctf_event_set_payload(struct bt_ctf_event *event,
105 const char *name, struct bt_ctf_field *field);
106
107extern struct bt_ctf_field *bt_ctf_event_get_payload_field(
108 struct bt_ctf_event *event);
109
110extern int bt_ctf_event_set_payload_field(struct bt_ctf_event *event,
111 struct bt_ctf_field *field);
112
113extern int bt_ctf_event_set_context(struct bt_ctf_event *event,
114 struct bt_ctf_field *field);
115
116extern struct bt_ctf_field *bt_ctf_event_get_context(
117 struct bt_ctf_event *event);
118
119extern int bt_ctf_event_set_stream_event_context(struct bt_ctf_event *event,
120 struct bt_ctf_field *field);
121
122extern struct bt_ctf_field *bt_ctf_event_get_stream_event_context(
123 struct bt_ctf_event *event);
124
125extern int bt_ctf_event_set_header(struct bt_ctf_event *event,
126 struct bt_ctf_field *field);
127
128extern struct bt_ctf_field *bt_ctf_event_get_header(
129 struct bt_ctf_event *event);
130
131extern struct bt_ctf_stream *bt_ctf_event_get_stream(
132 struct bt_ctf_event *event);
133
134extern struct bt_ctf_event_class *bt_ctf_event_get_class(
135 struct bt_ctf_event *event);
136
137/* Pre-2.0 CTF writer compatibility */
138static inline
139void bt_ctf_event_get(struct bt_ctf_event *event)
140{
141 bt_get(event);
142}
143
144/* Pre-2.0 CTF writer compatibility */
145static inline
146void bt_ctf_event_put(struct bt_ctf_event *event)
147{
148 bt_put(event);
149}
150
151extern struct bt_ctf_event_class *bt_ctf_event_class_create(const char *name);
152
153extern struct bt_ctf_stream_class *bt_ctf_event_class_get_stream_class(
154 struct bt_ctf_event_class *event_class);
155
156extern const char *bt_ctf_event_class_get_name(
157 struct bt_ctf_event_class *event_class);
158
159extern int64_t bt_ctf_event_class_get_id(
160 struct bt_ctf_event_class *event_class);
161
162extern int bt_ctf_event_class_set_id(
163 struct bt_ctf_event_class *event_class, uint64_t id);
164
165extern enum bt_ctf_event_class_log_level bt_ctf_event_class_get_log_level(
166 struct bt_ctf_event_class *event_class);
167
168extern int bt_ctf_event_class_set_log_level(
169 struct bt_ctf_event_class *event_class,
170 enum bt_ctf_event_class_log_level log_level);
171
172extern const char *bt_ctf_event_class_get_emf_uri(
173 struct bt_ctf_event_class *event_class);
174
175extern int bt_ctf_event_class_set_emf_uri(
176 struct bt_ctf_event_class *event_class,
177 const char *emf_uri);
178
179extern struct bt_ctf_field_type *bt_ctf_event_class_get_context_field_type(
180 struct bt_ctf_event_class *event_class);
181
182extern int bt_ctf_event_class_set_context_field_type(
183 struct bt_ctf_event_class *event_class,
184 struct bt_ctf_field_type *context_type);
185
186extern struct bt_ctf_field_type *bt_ctf_event_class_get_payload_field_type(
187 struct bt_ctf_event_class *event_class);
188
189extern int bt_ctf_event_class_set_payload_field_type(
190 struct bt_ctf_event_class *event_class,
191 struct bt_ctf_field_type *payload_type);
192
193extern int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
194 struct bt_ctf_field_type *field_type,
195 const char *name);
196
197extern struct bt_ctf_field_type *bt_ctf_event_class_get_field_by_name(
198 struct bt_ctf_event_class *event_class, const char *name);
199
200/* Pre-2.0 CTF writer compatibility */
201static inline
202void bt_ctf_event_class_get(struct bt_ctf_event_class *event_class)
203{
204 bt_get(event_class);
205}
206
207/* Pre-2.0 CTF writer compatibility */
208static inline
209void bt_ctf_event_class_put(struct bt_ctf_event_class *event_class)
210{
211 bt_put(event_class);
212}
8c18d80b
PP		 213
214#ifdef __cplusplus
215}
216#endif
217
218#endif /* BABELTRACE_CTF_WRITER_EVENT_H */
BabelTrace - Trace Format Babel Tower
This page took 0.06417 seconds and 4 git commands to generate.