Commit | Line | Data |
---|---|---|
842c2b97 JD |
1 | #ifndef _BABELTRACE_TRACE_HANDLE_H |
2 | #define _BABELTRACE_TRACE_HANDLE_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
7 | * trace_handle header | |
8 | * | |
9 | * Copyright 2012 EfficiOS Inc. and Linux Foundation | |
10 | * | |
11 | * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
12 | * Julien Desfossez <julien.desfossez@efficios.com> | |
13 | * | |
14 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
15 | * of this software and associated documentation files (the "Software"), to deal | |
16 | * in the Software without restriction, including without limitation the rights | |
17 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
18 | * copies of the Software, and to permit persons to whom the Software is | |
19 | * furnished to do so, subject to the following conditions: | |
20 | * | |
21 | * The above copyright notice and this permission notice shall be included in | |
22 | * all copies or substantial portions of the Software. | |
c462e188 MD |
23 | * |
24 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
25 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
26 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
27 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
28 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
29 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
30 | * SOFTWARE. | |
842c2b97 JD |
31 | */ |
32 | ||
33 | #include <stdint.h> | |
03798a93 | 34 | #include <babeltrace/clock-types.h> |
842c2b97 | 35 | |
6946751f JD |
36 | #ifdef __cplusplus |
37 | extern "C" { | |
38 | #endif | |
39 | ||
842c2b97 JD |
40 | /* |
41 | * trace_handle : unique identifier of a trace | |
42 | * | |
43 | * The trace_handle allows the user to manipulate a trace file directly. | |
44 | * It is a unique identifier representing a trace file. | |
45 | */ | |
46 | struct bt_trace_handle; | |
c50d2a7a | 47 | struct bt_ctf_event; |
842c2b97 | 48 | |
6cba487f | 49 | /* |
5d95b2db JD |
50 | * bt_trace_handle_get_path : returns the path of a trace_handle or NULL |
51 | * on error. | |
6cba487f | 52 | */ |
e3d12cf9 | 53 | const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id); |
842c2b97 JD |
54 | |
55 | /* | |
61cf588b MD |
56 | * bt_trace_handle_get_timestamp_begin : get the creation time (in |
57 | * nanoseconds or cycles depending on type) of the buffers of a trace. | |
58 | * | |
59 | * Returns 0 on success, -1 on error. | |
842c2b97 | 60 | */ |
61cf588b MD |
61 | int bt_trace_handle_get_timestamp_begin(struct bt_context *ctx, |
62 | int handle_id, enum bt_clock_type type, | |
63 | int64_t *timestamp); | |
842c2b97 JD |
64 | |
65 | /* | |
61cf588b MD |
66 | * bt_trace_handle_get_timestamp_end : get the destruction time |
67 | * (in nanoseconds or cycles depending on type) of the buffers of a | |
68 | * trace. | |
69 | * | |
70 | * Returns 0 on success, -1 on error. | |
842c2b97 | 71 | */ |
61cf588b MD |
72 | int bt_trace_handle_get_timestamp_end(struct bt_context *ctx, |
73 | int handle_id, enum bt_clock_type type, | |
74 | int64_t *timestamp); | |
842c2b97 | 75 | |
98a04903 JD |
76 | /* |
77 | * bt_ctf_event_get_handle_id : get the handle id associated with an event | |
78 | * | |
79 | * Returns -1 on error | |
80 | */ | |
c50d2a7a | 81 | int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event); |
98a04903 | 82 | |
6946751f JD |
83 | #ifdef __cplusplus |
84 | } | |
85 | #endif | |
86 | ||
842c2b97 | 87 | #endif /* _BABELTRACE_TRACE_HANDLE_H */ |