Commit | Line | Data |
---|---|---|
b1acd2b3 JD |
1 | #ifndef _BABELTRACE_FORMAT_H |
2 | #define _BABELTRACE_FORMAT_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
7 | * Trace Format Header | |
8 | * | |
9 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation | |
10 | * | |
11 | * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
12 | * | |
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: | |
19 | * | |
20 | * The above copyright notice and this permission notice shall be included in | |
21 | * all copies or substantial portions of the Software. | |
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. | |
30 | */ | |
31 | ||
32 | #include <babeltrace/list.h> | |
33 | #include <babeltrace/clock-types.h> | |
34 | #include <stdint.h> | |
35 | #include <stdio.h> | |
36 | ||
37 | #ifdef __cplusplus | |
38 | extern "C" { | |
39 | #endif | |
40 | ||
41 | typedef int bt_intern_str; | |
42 | ||
43 | /* forward declaration */ | |
44 | struct bt_stream_pos; | |
45 | struct bt_context; | |
46 | struct bt_trace_handle; | |
47 | struct bt_trace_descriptor; | |
48 | ||
49 | struct bt_mmap_stream { | |
50 | int fd; | |
51 | struct bt_list_head list; | |
12a91e9d | 52 | void *priv; |
b1acd2b3 JD |
53 | }; |
54 | ||
55 | struct bt_mmap_stream_list { | |
56 | struct bt_list_head head; | |
57 | }; | |
58 | ||
59 | struct bt_format { | |
60 | bt_intern_str name; | |
61 | ||
62 | struct bt_trace_descriptor *(*open_trace)(const char *path, int flags, | |
63 | void (*packet_seek)(struct bt_stream_pos *pos, | |
64 | size_t index, int whence), | |
65 | FILE *metadata_fp); | |
66 | struct bt_trace_descriptor *(*open_mmap_trace)( | |
67 | struct bt_mmap_stream_list *mmap_list, | |
68 | void (*packet_seek)(struct bt_stream_pos *pos, | |
69 | size_t index, int whence), | |
70 | FILE *metadata_fp); | |
71 | int (*close_trace)(struct bt_trace_descriptor *descriptor); | |
72 | void (*set_context)(struct bt_trace_descriptor *descriptor, | |
73 | struct bt_context *ctx); | |
74 | void (*set_handle)(struct bt_trace_descriptor *descriptor, | |
75 | struct bt_trace_handle *handle); | |
76 | uint64_t (*timestamp_begin)(struct bt_trace_descriptor *descriptor, | |
77 | struct bt_trace_handle *handle, enum bt_clock_type type); | |
78 | uint64_t (*timestamp_end)(struct bt_trace_descriptor *descriptor, | |
79 | struct bt_trace_handle *handle, enum bt_clock_type type); | |
80 | int (*convert_index_timestamp)(struct bt_trace_descriptor *descriptor); | |
81 | }; | |
82 | ||
83 | extern struct bt_format *bt_lookup_format(bt_intern_str qname); | |
84 | extern void bt_fprintf_format_list(FILE *fp); | |
85 | extern int bt_register_format(struct bt_format *format); | |
86 | extern void bt_unregister_format(struct bt_format *format); | |
87 | ||
88 | #ifdef __cplusplus | |
89 | } | |
90 | #endif | |
91 | ||
92 | #endif /* _BABELTRACE_FORMAT_H */ |