Commit | Line | Data |
---|---|---|
94cf822e PP |
1 | #ifndef CTF_FS_DS_FILE_H |
2 | #define CTF_FS_DS_FILE_H | |
e98a2d6e PP |
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> | |
94cf822e | 27 | #include <stdbool.h> |
e98a2d6e | 28 | #include <glib.h> |
91d81473 | 29 | #include "common/macros.h" |
3fadfbc0 | 30 | #include <babeltrace2/babeltrace.h> |
e98a2d6e | 31 | |
d6e69534 | 32 | #include "../common/msg-iter/msg-iter.h" |
b6c3dcb2 JG |
33 | #include "lttng-index.h" |
34 | ||
35 | struct ctf_fs_component; | |
36 | struct ctf_fs_file; | |
1a9f7075 | 37 | struct ctf_fs_trace; |
94cf822e | 38 | struct ctf_fs_ds_file; |
f6e68e70 SM |
39 | struct ctf_fs_ds_file_group; |
40 | struct ctf_fs_ds_group_medops_data; | |
b6c3dcb2 | 41 | |
97ade20b | 42 | struct ctf_fs_ds_file_info { |
97ade20b JG |
43 | /* Owned by this. */ |
44 | GString *path; | |
45 | ||
46 | /* Guaranteed to be set, as opposed to the index. */ | |
44c440bc | 47 | int64_t begin_ns; |
97ade20b JG |
48 | }; |
49 | ||
44c440bc PP |
50 | struct ctf_fs_metadata; |
51 | ||
97ade20b | 52 | struct ctf_fs_ds_file { |
98903a3e PP |
53 | bt_logging_level log_level; |
54 | ||
4c65a157 PP |
55 | /* Weak */ |
56 | bt_self_component *self_comp; | |
57 | ||
44c440bc | 58 | /* Weak */ |
f30762e5 | 59 | bt_self_message_iterator *self_msg_iter; |
44c440bc | 60 | |
5c563278 | 61 | /* Weak */ |
f30762e5 | 62 | struct ctf_fs_metadata *metadata; |
5c563278 | 63 | |
97ade20b JG |
64 | /* Owned by this */ |
65 | struct ctf_fs_file *file; | |
66 | ||
67 | /* Owned by this */ | |
b19ff26f | 68 | bt_stream *stream; |
97ade20b | 69 | |
97ade20b JG |
70 | void *mmap_addr; |
71 | ||
2f5a009b JG |
72 | /* |
73 | * Max length of chunk to mmap() when updating the current mapping. | |
74 | * This value must be page-aligned. | |
75 | */ | |
97ade20b JG |
76 | size_t mmap_max_len; |
77 | ||
2c701ca6 | 78 | /* Length of the current mapping. Never exceeds the file's length. */ |
97ade20b JG |
79 | size_t mmap_len; |
80 | ||
97ade20b | 81 | /* Offset in the file where the current mapping starts. */ |
e9bfbfe0 | 82 | off_t mmap_offset_in_file; |
97ade20b JG |
83 | |
84 | /* | |
85 | * Offset, in the current mapping, of the address to return on the next | |
86 | * request. | |
87 | */ | |
e9bfbfe0 | 88 | off_t request_offset_in_mapping; |
b6c3dcb2 | 89 | }; |
e98a2d6e PP |
90 | |
91 | BT_HIDDEN | |
94cf822e PP |
92 | struct ctf_fs_ds_file *ctf_fs_ds_file_create( |
93 | struct ctf_fs_trace *ctf_fs_trace, | |
f5f7e8df | 94 | bt_self_message_iterator *self_msg_iter, |
98903a3e PP |
95 | bt_stream *stream, const char *path, |
96 | bt_logging_level log_level); | |
e98a2d6e | 97 | |
e98a2d6e | 98 | BT_HIDDEN |
94cf822e | 99 | void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream); |
e98a2d6e | 100 | |
97ade20b JG |
101 | BT_HIDDEN |
102 | struct ctf_fs_ds_index *ctf_fs_ds_file_build_index( | |
bf012bde | 103 | struct ctf_fs_ds_file *ds_file, |
6d54260a SM |
104 | struct ctf_fs_ds_file_info *ds_file_info, |
105 | struct ctf_msg_iter *msg_iter); | |
97ade20b | 106 | |
7ed5243a | 107 | BT_HIDDEN |
4c65a157 PP |
108 | struct ctf_fs_ds_index *ctf_fs_ds_index_create(bt_logging_level log_level, |
109 | bt_self_component *self_comp); | |
7ed5243a | 110 | |
97ade20b JG |
111 | BT_HIDDEN |
112 | void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index); | |
113 | ||
f6e68e70 SM |
114 | /* |
115 | * Medium operations to iterate on a single ctf_fs_ds_file. | |
116 | * | |
117 | * The data pointer when using this must be a pointer to the ctf_fs_ds_file. | |
118 | */ | |
18a1979b | 119 | extern struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops; |
6de92955 | 120 | |
f6e68e70 SM |
121 | /* |
122 | * Medium operations to iterate on the packet of a ctf_fs_ds_group. | |
123 | * | |
124 | * The iteration is done based on the index of the group. | |
125 | * | |
126 | * The data pointer when using these medops must be a pointer to a ctf_fs_ds | |
127 | * group_medops_data structure. | |
128 | */ | |
129 | extern struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops; | |
130 | ||
131 | BT_HIDDEN | |
132 | enum ctf_msg_iter_medium_status ctf_fs_ds_group_medops_data_create( | |
133 | struct ctf_fs_ds_file_group *ds_file_group, | |
134 | bt_self_message_iterator *self_msg_iter, | |
135 | bt_logging_level log_level, | |
136 | struct ctf_fs_ds_group_medops_data **out); | |
137 | ||
138 | BT_HIDDEN | |
139 | void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data); | |
140 | ||
141 | BT_HIDDEN | |
142 | void ctf_fs_ds_group_medops_data_destroy( | |
143 | struct ctf_fs_ds_group_medops_data *data); | |
144 | ||
94cf822e | 145 | #endif /* CTF_FS_DS_FILE_H */ |