f4c44065bf6e8ef0654d7992a44081d78674b471
[babeltrace.git] / include / babeltrace / trace-handle.h
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.
23 */
24
25 #include <stdint.h>
26 #include <babeltrace/clock-types.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /*
33 * trace_handle : unique identifier of a trace
34 *
35 * The trace_handle allows the user to manipulate a trace file directly.
36 * It is a unique identifier representing a trace file.
37 */
38 struct bt_trace_handle;
39 struct bt_ctf_event;
40
41 /*
42 * bt_trace_handle_get_path : returns the path of a trace_handle or NULL
43 * on error.
44 */
45 const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id);
46
47 /*
48 * bt_trace_handle_get_timestamp_begin : returns the creation time (in
49 * nanoseconds or cycles depending on type) of the buffers of a trace
50 * or -1ULL on error.
51 */
52 uint64_t bt_trace_handle_get_timestamp_begin(struct bt_context *ctx,
53 int handle_id, enum bt_clock_type type);
54
55 /*
56 * bt_trace_handle_get_timestamp_end : returns the destruction timestamp
57 * (in nanoseconds or cycles depending on type) of the buffers of a trace
58 * or -1ULL on error.
59 */
60 uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx,
61 int handle_id, enum bt_clock_type type);
62
63 /*
64 * bt_ctf_event_get_handle_id : get the handle id associated with an event
65 *
66 * Returns -1 on error
67 */
68 int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event);
69
70 #ifdef __cplusplus
71 }
72 #endif
73
74 #endif /* _BABELTRACE_TRACE_HANDLE_H */
This page took 0.043022 seconds and 3 git commands to generate.