Commit | Line | Data |
---|---|---|
fc93b2bd MD |
1 | #ifndef _BABELTRACE_FORMAT_H |
2 | #define _BABELTRACE_FORMAT_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
7 | * Trace Format Header | |
8 | * | |
64fa3fec MD |
9 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation |
10 | * | |
11 | * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
fc93b2bd | 12 | * |
ccd7e1c8 MD |
13 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
14 | * of this software and associated documentation files (the "Software"), to deal | |
15 | * in the Software without restriction, including without limitation the rights | |
16 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
17 | * copies of the Software, and to permit persons to whom the Software is | |
18 | * furnished to do so, subject to the following conditions: | |
fc93b2bd | 19 | * |
ccd7e1c8 MD |
20 | * The above copyright notice and this permission notice shall be included in |
21 | * all copies or substantial portions of the Software. | |
c462e188 MD |
22 | * |
23 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
24 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
25 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
26 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
27 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
28 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
29 | * SOFTWARE. | |
fc93b2bd MD |
30 | */ |
31 | ||
3122e6f0 | 32 | #include <babeltrace/list.h> |
03798a93 | 33 | #include <babeltrace/clock-types.h> |
fc93b2bd | 34 | #include <stdint.h> |
7fb21036 | 35 | #include <stdio.h> |
34861b9d | 36 | |
6946751f JD |
37 | #ifdef __cplusplus |
38 | extern "C" { | |
39 | #endif | |
40 | ||
34861b9d | 41 | typedef int bt_intern_str; |
fc93b2bd | 42 | |
95d36295 | 43 | /* forward declaration */ |
1cf393f6 | 44 | struct bt_stream_pos; |
98a04903 JD |
45 | struct bt_context; |
46 | struct bt_trace_handle; | |
caf929fa | 47 | struct bt_trace_descriptor; |
bbefb8dd | 48 | |
c150f912 | 49 | struct bt_mmap_stream { |
f571dfb1 | 50 | int fd; |
3122e6f0 | 51 | struct bt_list_head list; |
731087d8 | 52 | void *priv; |
f571dfb1 JD |
53 | }; |
54 | ||
c150f912 | 55 | struct bt_mmap_stream_list { |
3122e6f0 | 56 | struct bt_list_head head; |
f571dfb1 JD |
57 | }; |
58 | ||
37b99bdb | 59 | struct bt_format { |
34861b9d | 60 | bt_intern_str name; |
fc93b2bd | 61 | |
1b8455b7 | 62 | struct bt_trace_descriptor *(*open_trace)(const char *path, int flags, |
1cf393f6 | 63 | void (*packet_seek)(struct bt_stream_pos *pos, |
20d0dcf9 | 64 | size_t index, int whence), |
d6425aaf | 65 | FILE *metadata_fp); |
1b8455b7 | 66 | struct bt_trace_descriptor *(*open_mmap_trace)( |
c150f912 | 67 | struct bt_mmap_stream_list *mmap_list, |
1cf393f6 | 68 | void (*packet_seek)(struct bt_stream_pos *pos, |
20d0dcf9 | 69 | size_t index, int whence), |
d6425aaf | 70 | FILE *metadata_fp); |
1b8455b7 JD |
71 | int (*close_trace)(struct bt_trace_descriptor *descriptor); |
72 | void (*set_context)(struct bt_trace_descriptor *descriptor, | |
98a04903 | 73 | struct bt_context *ctx); |
1b8455b7 | 74 | void (*set_handle)(struct bt_trace_descriptor *descriptor, |
98a04903 | 75 | struct bt_trace_handle *handle); |
1b8455b7 | 76 | uint64_t (*timestamp_begin)(struct bt_trace_descriptor *descriptor, |
03798a93 | 77 | struct bt_trace_handle *handle, enum bt_clock_type type); |
1b8455b7 | 78 | uint64_t (*timestamp_end)(struct bt_trace_descriptor *descriptor, |
03798a93 | 79 | struct bt_trace_handle *handle, enum bt_clock_type type); |
1b8455b7 | 80 | int (*convert_index_timestamp)(struct bt_trace_descriptor *descriptor); |
fc93b2bd MD |
81 | }; |
82 | ||
37b99bdb | 83 | extern struct bt_format *bt_lookup_format(bt_intern_str qname); |
5901aa79 | 84 | extern void bt_fprintf_format_list(FILE *fp); |
37b99bdb JD |
85 | extern int bt_register_format(struct bt_format *format); |
86 | extern void bt_unregister_format(struct bt_format *format); | |
fc93b2bd | 87 | |
6946751f JD |
88 | #ifdef __cplusplus |
89 | } | |
90 | #endif | |
fc93b2bd MD |
91 | |
92 | #endif /* _BABELTRACE_FORMAT_H */ |