Rename ctf_stream to ctf_stream_definition
[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
24 #include <babeltrace/list.h>
25 #include <stdint.h>
26 #include <stdio.h>
27
28 typedef int bt_intern_str;
29
30 /* forward declaration */
31 struct stream_pos;
32 struct bt_context;
33 struct bt_trace_handle;
34
35 /* Parent trace descriptor */
36 struct trace_descriptor {
37 };
38
39 struct mmap_stream {
40 int fd;
41 struct bt_list_head list;
42 };
43
44 struct mmap_stream_list {
45 struct bt_list_head head;
46 };
47
48 struct format {
49 bt_intern_str name;
50
51 struct trace_descriptor *(*open_trace)(const char *path, int flags,
52 void (*packet_seek)(struct stream_pos *pos,
53 size_t index, int whence),
54 FILE *metadata_fp);
55 struct trace_descriptor *(*open_mmap_trace)(
56 struct mmap_stream_list *mmap_list,
57 void (*packet_seek)(struct stream_pos *pos,
58 size_t index, int whence),
59 FILE *metadata_fp);
60 void (*close_trace)(struct trace_descriptor *descriptor);
61 void (*set_context)(struct trace_descriptor *descriptor,
62 struct bt_context *ctx);
63 void (*set_handle)(struct trace_descriptor *descriptor,
64 struct bt_trace_handle *handle);
65 };
66
67 extern struct format *bt_lookup_format(bt_intern_str qname);
68 extern void bt_fprintf_format_list(FILE *fp);
69 extern int bt_register_format(struct format *format);
70
71 /* TBD: format unregistration */
72
73 #endif /* _BABELTRACE_FORMAT_H */
This page took 0.0309739999999999 seconds and 4 git commands to generate.