Trace IR and notification APIs: split into private and public APIs
[babeltrace.git] / include / babeltrace / trace-ir / trace.h
CommitLineData
56e18c4c
PP
1#ifndef BABELTRACE_TRACE_IR_TRACE_H
2#define BABELTRACE_TRACE_IR_TRACE_H
3
4/*
56e18c4c
PP
5 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 * SOFTWARE.
26 *
27 * The Common Trace Format (CTF) Specification is available at
28 * http://www.efficios.com/ctf
29 */
30
31/* For bt_bool, bt_uuid */
32#include <babeltrace/types.h>
33
34#include <stdint.h>
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40struct bt_trace;
41struct bt_stream;
42struct bt_stream_class;
5cd6d0e5 43struct bt_field_class;
56e18c4c 44struct bt_value;
56e18c4c
PP
45
46extern bt_bool bt_trace_assigns_automatic_stream_class_id(
47 struct bt_trace *trace);
48
56e18c4c
PP
49extern const char *bt_trace_get_name(struct bt_trace *trace);
50
56e18c4c
PP
51extern bt_uuid bt_trace_get_uuid(struct bt_trace *trace);
52
56e18c4c
PP
53extern uint64_t bt_trace_get_environment_entry_count(struct bt_trace *trace);
54
55extern void bt_trace_borrow_environment_entry_by_index(
56 struct bt_trace *trace, uint64_t index,
57 const char **name, struct bt_value **value);
58
59extern struct bt_value *bt_trace_borrow_environment_entry_value_by_name(
60 struct bt_trace *trace, const char *name);
61
5cd6d0e5 62extern struct bt_field_class *bt_trace_borrow_packet_header_field_class(
56e18c4c
PP
63 struct bt_trace *trace);
64
56e18c4c
PP
65extern uint64_t bt_trace_get_stream_class_count(struct bt_trace *trace);
66
67extern struct bt_stream_class *bt_trace_borrow_stream_class_by_index(
68 struct bt_trace *trace, uint64_t index);
69
70extern struct bt_stream_class *bt_trace_borrow_stream_class_by_id(
71 struct bt_trace *trace, uint64_t id);
72
73extern uint64_t bt_trace_get_stream_count(struct bt_trace *trace);
74
75extern struct bt_stream *bt_trace_borrow_stream_by_index(
76 struct bt_trace *trace, uint64_t index);
77
78extern struct bt_stream *bt_trace_borrow_stream_by_id(
79 struct bt_trace *trace, uint64_t id);
80
81extern bt_bool bt_trace_is_static(struct bt_trace *trace);
82
56e18c4c
PP
83#ifdef __cplusplus
84}
85#endif
86
87#endif /* BABELTRACE_TRACE_IR_TRACE_H */
This page took 0.027401 seconds and 4 git commands to generate.