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. | |
fc93b2bd MD |
22 | */ |
23 | ||
3122e6f0 | 24 | #include <babeltrace/list.h> |
03798a93 | 25 | #include <babeltrace/clock-types.h> |
fc93b2bd | 26 | #include <stdint.h> |
7fb21036 | 27 | #include <stdio.h> |
34861b9d JD |
28 | |
29 | typedef int bt_intern_str; | |
fc93b2bd | 30 | |
95d36295 | 31 | /* forward declaration */ |
d6425aaf | 32 | struct stream_pos; |
98a04903 JD |
33 | struct bt_context; |
34 | struct bt_trace_handle; | |
95d36295 | 35 | |
46322b33 MD |
36 | /* Parent trace descriptor */ |
37 | struct trace_descriptor { | |
38 | }; | |
bbefb8dd | 39 | |
f571dfb1 JD |
40 | struct mmap_stream { |
41 | int fd; | |
3122e6f0 | 42 | struct bt_list_head list; |
f571dfb1 JD |
43 | }; |
44 | ||
45 | struct mmap_stream_list { | |
3122e6f0 | 46 | struct bt_list_head head; |
f571dfb1 JD |
47 | }; |
48 | ||
fc93b2bd | 49 | struct format { |
34861b9d | 50 | bt_intern_str name; |
fc93b2bd | 51 | |
5b80ddfb | 52 | struct trace_descriptor *(*open_trace)(const char *path, int flags, |
06789ffd | 53 | void (*packet_seek)(struct stream_pos *pos, |
20d0dcf9 | 54 | size_t index, int whence), |
d6425aaf | 55 | FILE *metadata_fp); |
f571dfb1 JD |
56 | struct trace_descriptor *(*open_mmap_trace)( |
57 | struct mmap_stream_list *mmap_list, | |
06789ffd | 58 | void (*packet_seek)(struct stream_pos *pos, |
20d0dcf9 | 59 | size_t index, int whence), |
d6425aaf | 60 | FILE *metadata_fp); |
bbefb8dd | 61 | void (*close_trace)(struct trace_descriptor *descriptor); |
98a04903 JD |
62 | void (*set_context)(struct trace_descriptor *descriptor, |
63 | struct bt_context *ctx); | |
64 | void (*set_handle)(struct trace_descriptor *descriptor, | |
65 | struct bt_trace_handle *handle); | |
30c276af | 66 | uint64_t (*timestamp_begin)(struct trace_descriptor *descriptor, |
03798a93 | 67 | struct bt_trace_handle *handle, enum bt_clock_type type); |
30c276af | 68 | uint64_t (*timestamp_end)(struct trace_descriptor *descriptor, |
03798a93 JD |
69 | struct bt_trace_handle *handle, enum bt_clock_type type); |
70 | int (*convert_index_timestamp)(struct trace_descriptor *descriptor); | |
fc93b2bd MD |
71 | }; |
72 | ||
34861b9d | 73 | extern struct format *bt_lookup_format(bt_intern_str qname); |
5901aa79 MD |
74 | extern void bt_fprintf_format_list(FILE *fp); |
75 | extern int bt_register_format(struct format *format); | |
fc93b2bd MD |
76 | |
77 | /* TBD: format unregistration */ | |
78 | ||
79 | #endif /* _BABELTRACE_FORMAT_H */ |