2 * SPDX-License-Identifier: MIT
4 * Copyright (C) 2016 Philippe Proulx <pproulx@efficios.com>
7 #ifndef CTF_FS_DS_FILE_H
8 #define CTF_FS_DS_FILE_H
13 #include "common/macros.h"
14 #include <babeltrace2/babeltrace.h>
16 #include "../common/msg-iter/msg-iter.hpp"
17 #include "lttng-index.hpp"
19 struct ctf_fs_component;
22 struct ctf_fs_ds_file;
23 struct ctf_fs_ds_file_group;
24 struct ctf_fs_ds_group_medops_data;
26 struct ctf_fs_ds_file_info
31 /* Guaranteed to be set, as opposed to the index. */
35 struct ctf_fs_metadata;
39 bt_logging_level log_level;
42 bt_self_component *self_comp;
45 struct ctf_fs_metadata *metadata;
48 struct ctf_fs_file *file;
56 * Max length of chunk to mmap() when updating the current mapping.
57 * This value must be page-aligned.
61 /* Length of the current mapping. Never exceeds the file's length. */
64 /* Offset in the file where the current mapping starts. */
65 off_t mmap_offset_in_file;
68 * Offset, in the current mapping, of the address to return on the next
71 off_t request_offset_in_mapping;
74 struct ctf_fs_ds_file *ctf_fs_ds_file_create(struct ctf_fs_trace *ctf_fs_trace, bt_stream *stream,
75 const char *path, bt_logging_level log_level);
77 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream);
79 struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(struct ctf_fs_ds_file *ds_file,
80 struct ctf_fs_ds_file_info *ds_file_info,
81 struct ctf_msg_iter *msg_iter);
83 struct ctf_fs_ds_index *ctf_fs_ds_index_create(bt_logging_level log_level,
84 bt_self_component *self_comp);
86 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index);
89 * Medium operations to iterate on a single ctf_fs_ds_file.
91 * The data pointer when using this must be a pointer to the ctf_fs_ds_file.
93 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops;
96 * Medium operations to iterate on the packet of a ctf_fs_ds_group.
98 * The iteration is done based on the index of the group.
100 * The data pointer when using these medops must be a pointer to a ctf_fs_ds
101 * group_medops_data structure.
103 extern struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops;
105 enum ctf_msg_iter_medium_status ctf_fs_ds_group_medops_data_create(
106 struct ctf_fs_ds_file_group *ds_file_group, bt_self_message_iterator *self_msg_iter,
107 bt_logging_level log_level, struct ctf_fs_ds_group_medops_data **out);
109 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data);
111 void ctf_fs_ds_group_medops_data_destroy(struct ctf_fs_ds_group_medops_data *data);
113 #endif /* CTF_FS_DS_FILE_H */