ctf: add weak ref to stream file in index entry
[babeltrace.git] / src / plugins / ctf / fs-src / data-stream-file.h
1 #ifndef CTF_FS_DS_FILE_H
2 #define CTF_FS_DS_FILE_H
3
4 /*
5 * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26 #include <stdio.h>
27 #include <stdbool.h>
28 #include <glib.h>
29 #include "common/macros.h"
30 #include <babeltrace2/babeltrace.h>
31
32 #include "../common/msg-iter/msg-iter.h"
33 #include "lttng-index.h"
34
35 struct ctf_fs_component;
36 struct ctf_fs_file;
37 struct ctf_fs_trace;
38 struct ctf_fs_ds_file;
39
40 struct ctf_fs_ds_file_info {
41 /* Owned by this. */
42 GString *path;
43
44 /* Guaranteed to be set, as opposed to the index. */
45 int64_t begin_ns;
46 };
47
48 struct ctf_fs_metadata;
49
50 struct ctf_fs_ds_file {
51 bt_logging_level log_level;
52
53 /* Weak */
54 bt_self_component *self_comp;
55
56 /* Weak */
57 struct ctf_fs_metadata *metadata;
58
59 /* Weak */
60 bt_self_message_iterator *pc_msg_iter;
61
62 /* Owned by this */
63 struct ctf_fs_file *file;
64
65 /* Owned by this */
66 bt_stream *stream;
67
68 /* Weak */
69 struct bt_msg_iter *msg_iter;
70
71 void *mmap_addr;
72
73 /*
74 * Max length of chunk to mmap() when updating the current mapping.
75 * This value must be page-aligned.
76 */
77 size_t mmap_max_len;
78
79 /* Length of the current mapping. Never exceeds the file's length. */
80 size_t mmap_len;
81
82 /* Offset in the file where the current mapping starts. */
83 off_t mmap_offset;
84
85 /*
86 * Offset, in the current mapping, of the address to return on the next
87 * request.
88 */
89 off_t request_offset;
90
91 bool end_reached;
92 };
93
94 BT_HIDDEN
95 struct ctf_fs_ds_file *ctf_fs_ds_file_create(
96 struct ctf_fs_trace *ctf_fs_trace,
97 bt_self_message_iterator *pc_msg_iter,
98 struct bt_msg_iter *msg_iter,
99 bt_stream *stream, const char *path,
100 bt_logging_level log_level);
101
102 BT_HIDDEN
103 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);
104
105 BT_HIDDEN
106 bt_component_class_message_iterator_next_method_status ctf_fs_ds_file_next(
107 struct ctf_fs_ds_file *ds_file,
108 bt_message **msg);
109
110 BT_HIDDEN
111 struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
112 struct ctf_fs_ds_file *ds_file,
113 struct ctf_fs_ds_file_info *ds_file_info);
114
115 BT_HIDDEN
116 struct ctf_fs_ds_index *ctf_fs_ds_index_create(bt_logging_level log_level,
117 bt_self_component *self_comp);
118
119 BT_HIDDEN
120 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);
121
122 extern struct bt_msg_iter_medium_ops ctf_fs_ds_file_medops;
123
124 #endif /* CTF_FS_DS_FILE_H */
This page took 0.032867 seconds and 5 git commands to generate.