Split CTF IR and CTF writer APIs and implementations
[babeltrace.git] / include / babeltrace / ctf-writer / trace.h
CommitLineData
3dca2276
PP
1#ifndef BABELTRACE_CTF_WRITER_TRACE_H
2#define BABELTRACE_CTF_WRITER_TRACE_H
3
4/*
5 * BabelTrace - CTF Writer: Stream Class
6 *
7 * Copyright 2014 EfficiOS Inc.
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
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37struct bt_ctf_trace;
38struct bt_ctf_stream_class;
39struct bt_ctf_stream;
40struct bt_ctf_clock_class;
41
42extern enum bt_ctf_byte_order bt_ctf_trace_get_native_byte_order(
43 struct bt_ctf_trace *trace);
44
45extern int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace,
46 enum bt_ctf_byte_order native_byte_order);
47
48extern const unsigned char *bt_ctf_trace_get_uuid(
49 struct bt_ctf_trace *trace);
50
51extern int bt_ctf_trace_set_uuid(struct bt_ctf_trace *trace,
52 const unsigned char *uuid);
53
54extern int64_t bt_ctf_trace_get_environment_field_count(
55 struct bt_ctf_trace *trace);
56
57extern const char *
58bt_ctf_trace_get_environment_field_name_by_index(
59 struct bt_ctf_trace *trace, uint64_t index);
60
61extern struct bt_value *
62bt_ctf_trace_get_environment_field_value_by_index(struct bt_ctf_trace *trace,
63 uint64_t index);
64
65extern struct bt_value *
66bt_ctf_trace_get_environment_field_value_by_name(
67 struct bt_ctf_trace *trace, const char *name);
68
69extern int bt_ctf_trace_set_environment_field(
70 struct bt_ctf_trace *trace, const char *name,
71 struct bt_value *value);
72
73extern int bt_ctf_trace_set_environment_field_integer(
74 struct bt_ctf_trace *trace, const char *name,
75 int64_t value);
76
77extern int bt_ctf_trace_set_environment_field_string(
78 struct bt_ctf_trace *trace, const char *name,
79 const char *value);
80
81extern struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_field_type(
82 struct bt_ctf_trace *trace);
83
84extern int bt_ctf_trace_set_packet_header_field_type(struct bt_ctf_trace *trace,
85 struct bt_ctf_field_type *packet_header_type);
86
87extern int64_t bt_ctf_trace_get_clock_class_count(
88 struct bt_ctf_trace *trace);
89
90extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_index(
91 struct bt_ctf_trace *trace, uint64_t index);
92
93extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_name(
94 struct bt_ctf_trace *trace, const char *name);
95
96extern int bt_ctf_trace_add_clock_class(struct bt_ctf_trace *trace,
97 struct bt_ctf_clock_class *clock_class);
98
99extern int64_t bt_ctf_trace_get_stream_class_count(
100 struct bt_ctf_trace *trace);
101
102extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_index(
103 struct bt_ctf_trace *trace, uint64_t index);
104
105extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_id(
106 struct bt_ctf_trace *trace, uint64_t id);
107
108extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace,
109 struct bt_ctf_stream_class *stream_class);
110
111extern int64_t bt_ctf_trace_get_stream_count(struct bt_ctf_trace *trace);
112
113extern struct bt_ctf_stream *bt_ctf_trace_get_stream_by_index(
114 struct bt_ctf_trace *trace, uint64_t index);
115
116extern const char *bt_ctf_trace_get_name(struct bt_ctf_trace *trace);
117
118#ifdef __cplusplus
119}
120#endif
121
122#endif /* BABELTRACE_CTF_WRITER_TRACE_H */
This page took 0.026926 seconds and 4 git commands to generate.