1 #ifndef CTF_FS_DS_FILE_H
2 #define CTF_FS_DS_FILE_H
5 * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
29 #include "common/macros.h"
30 #include <babeltrace2/babeltrace.h>
32 #include "../common/msg-iter/msg-iter.h"
33 #include "lttng-index.h"
35 struct ctf_fs_component
;
38 struct ctf_fs_ds_file
;
39 struct ctf_fs_ds_file_group
;
40 struct ctf_fs_ds_group_medops_data
;
42 struct ctf_fs_ds_file_info
{
46 /* Guaranteed to be set, as opposed to the index. */
50 struct ctf_fs_metadata
;
52 struct ctf_fs_ds_file
{
53 bt_logging_level log_level
;
56 bt_self_component
*self_comp
;
59 bt_self_message_iterator
*self_msg_iter
;
62 struct ctf_fs_metadata
*metadata
;
65 struct ctf_fs_file
*file
;
73 * Max length of chunk to mmap() when updating the current mapping.
74 * This value must be page-aligned.
78 /* Length of the current mapping. Never exceeds the file's length. */
81 /* Offset in the file where the current mapping starts. */
82 off_t mmap_offset_in_file
;
85 * Offset, in the current mapping, of the address to return on the next
88 off_t request_offset_in_mapping
;
92 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
93 struct ctf_fs_trace
*ctf_fs_trace
,
94 bt_self_message_iterator
*self_msg_iter
,
95 bt_stream
*stream
, const char *path
,
96 bt_logging_level log_level
);
99 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*stream
);
102 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(
103 struct ctf_fs_ds_file
*ds_file
,
104 struct ctf_fs_ds_file_info
*ds_file_info
,
105 struct ctf_msg_iter
*msg_iter
);
108 struct ctf_fs_ds_index
*ctf_fs_ds_index_create(bt_logging_level log_level
,
109 bt_self_component
*self_comp
);
112 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
);
115 * Medium operations to iterate on a single ctf_fs_ds_file.
117 * The data pointer when using this must be a pointer to the ctf_fs_ds_file.
119 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops
;
122 * Medium operations to iterate on the packet of a ctf_fs_ds_group.
124 * The iteration is done based on the index of the group.
126 * The data pointer when using these medops must be a pointer to a ctf_fs_ds
127 * group_medops_data structure.
129 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops
;
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
);
139 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data
*data
);
142 void ctf_fs_ds_group_medops_data_destroy(
143 struct ctf_fs_ds_group_medops_data
*data
);
145 #endif /* CTF_FS_DS_FILE_H */