lib: force user to include `<babeltrace2/babeltrace.h>`
[babeltrace.git] / include / babeltrace2 / trace-ir / trace.h
CommitLineData
924dc299
PP
1#ifndef BABELTRACE2_TRACE_IR_TRACE_H
2#define BABELTRACE2_TRACE_IR_TRACE_H
56e18c4c
PP
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
56e18c4c
PP
6 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
56e18c4c
PP
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 *
26 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
28 */
29
4fa90f32
PP
30#ifndef __BT_IN_BABELTRACE_H
31# error "Please include <babeltrace2/babeltrace.h> instead."
32#endif
33
d24d5663
PP
34#include <stdint.h>
35
335a2da5 36/* For bt_bool, bt_uuid, bt_trace, bt_trace_class, bt_stream */
3fadfbc0 37#include <babeltrace2/types.h>
56e18c4c 38
56e18c4c
PP
39#ifdef __cplusplus
40extern "C" {
41#endif
42
b19ff26f 43extern bt_trace_class *bt_trace_borrow_class(bt_trace *trace);
56e18c4c 44
b19ff26f 45extern bt_trace *bt_trace_create(bt_trace_class *trace_class);
56e18c4c 46
d24d5663
PP
47typedef enum bt_trace_set_name_status {
48 BT_TRACE_SET_NAME_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
49 BT_TRACE_SET_NAME_STATUS_OK = __BT_FUNC_STATUS_OK,
50} bt_trace_set_name_status;
51
52extern bt_trace_set_name_status bt_trace_set_name(bt_trace *trace,
23578e82 53 const char *name);
56e18c4c 54
335a2da5
PP
55extern void bt_trace_set_uuid(bt_trace *trace, bt_uuid uuid);
56
57typedef enum bt_trace_set_environment_entry_status {
58 BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
59 BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_OK = __BT_FUNC_STATUS_OK,
60} bt_trace_set_environment_entry_status;
61
62extern bt_trace_set_environment_entry_status
63bt_trace_set_environment_entry_integer(bt_trace *trace, const char *name,
64 int64_t value);
65
66extern bt_trace_set_environment_entry_status
67bt_trace_set_environment_entry_string(bt_trace *trace, const char *name,
68 const char *value);
69
b19ff26f 70extern bt_stream *bt_trace_borrow_stream_by_index(bt_trace *trace,
40f4ba76 71 uint64_t index);
56e18c4c 72
b19ff26f 73extern bt_stream *bt_trace_borrow_stream_by_id(bt_trace *trace,
40f4ba76 74 uint64_t id);
56e18c4c 75
56e18c4c
PP
76#ifdef __cplusplus
77}
78#endif
79
924dc299 80#endif /* BABELTRACE2_TRACE_IR_TRACE_H */
This page took 0.040092 seconds and 4 git commands to generate.