Add missing permission notice in each source file
[babeltrace.git] / include / babeltrace / format.h
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 stream_pos;
45 struct bt_context;
46 struct bt_trace_handle;
47
48 /* Parent trace descriptor */
49 struct trace_descriptor {
50 };
51
52 struct mmap_stream {
53 int fd;
54 struct bt_list_head list;
55 };
56
57 struct mmap_stream_list {
58 struct bt_list_head head;
59 };
60
61 struct format {
62 bt_intern_str name;
63
64 struct trace_descriptor *(*open_trace)(const char *path, int flags,
65 void (*packet_seek)(struct stream_pos *pos,
66 size_t index, int whence),
67 FILE *metadata_fp);
68 struct trace_descriptor *(*open_mmap_trace)(
69 struct mmap_stream_list *mmap_list,
70 void (*packet_seek)(struct stream_pos *pos,
71 size_t index, int whence),
72 FILE *metadata_fp);
73 int (*close_trace)(struct trace_descriptor *descriptor);
74 void (*set_context)(struct trace_descriptor *descriptor,
75 struct bt_context *ctx);
76 void (*set_handle)(struct trace_descriptor *descriptor,
77 struct bt_trace_handle *handle);
78 uint64_t (*timestamp_begin)(struct trace_descriptor *descriptor,
79 struct bt_trace_handle *handle, enum bt_clock_type type);
80 uint64_t (*timestamp_end)(struct trace_descriptor *descriptor,
81 struct bt_trace_handle *handle, enum bt_clock_type type);
82 int (*convert_index_timestamp)(struct trace_descriptor *descriptor);
83 };
84
85 extern struct format *bt_lookup_format(bt_intern_str qname);
86 extern void bt_fprintf_format_list(FILE *fp);
87 extern int bt_register_format(struct format *format);
88 extern void bt_unregister_format(struct format *format);
89
90 #ifdef __cplusplus
91 }
92 #endif
93
94 #endif /* _BABELTRACE_FORMAT_H */
This page took 0.046092 seconds and 4 git commands to generate.