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> |
85e7137b | 29 | #include "common/macros.h" |
71c5da58 | 30 | #include <babeltrace2/babeltrace.h> |
e98a2d6e | 31 | |
b09a5592 | 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; |
b6c3dcb2 | 39 | |
97ade20b | 40 | struct ctf_fs_ds_file_info { |
97ade20b JG |
41 | /* Owned by this. */ |
42 | GString *path; | |
43 | ||
44 | /* Guaranteed to be set, as opposed to the index. */ | |
7b33a0e0 | 45 | int64_t begin_ns; |
97ade20b JG |
46 | }; |
47 | ||
7b33a0e0 PP |
48 | struct ctf_fs_metadata; |
49 | ||
97ade20b | 50 | struct ctf_fs_ds_file { |
3d731ea9 PP |
51 | bt_logging_level log_level; |
52 | ||
f67894f9 PP |
53 | /* Weak */ |
54 | bt_self_component *self_comp; | |
55 | ||
7b33a0e0 | 56 | /* Weak */ |
1d744019 | 57 | bt_self_message_iterator *self_msg_iter; |
7b33a0e0 | 58 | |
f7c3ac09 | 59 | /* Weak */ |
1d744019 | 60 | struct ctf_fs_metadata *metadata; |
f7c3ac09 | 61 | |
97ade20b JG |
62 | /* Owned by this */ |
63 | struct ctf_fs_file *file; | |
64 | ||
65 | /* Owned by this */ | |
8eee8ea2 | 66 | bt_stream *stream; |
97ade20b | 67 | |
97ade20b JG |
68 | void *mmap_addr; |
69 | ||
7b7d8091 JG |
70 | /* |
71 | * Max length of chunk to mmap() when updating the current mapping. | |
72 | * This value must be page-aligned. | |
73 | */ | |
97ade20b JG |
74 | size_t mmap_max_len; |
75 | ||
52eb1a72 | 76 | /* Length of the current mapping. Never exceeds the file's length. */ |
97ade20b JG |
77 | size_t mmap_len; |
78 | ||
97ade20b JG |
79 | /* Offset in the file where the current mapping starts. */ |
80 | off_t mmap_offset; | |
81 | ||
82 | /* | |
83 | * Offset, in the current mapping, of the address to return on the next | |
84 | * request. | |
85 | */ | |
86 | off_t request_offset; | |
87 | ||
88 | bool end_reached; | |
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, | |
c7d8bfa1 | 94 | bt_self_message_iterator *self_msg_iter, |
3d731ea9 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 | |
4f1f88a6 | 101 | BT_HIDDEN |
fb25b9e3 | 102 | bt_component_class_message_iterator_next_method_status ctf_fs_ds_file_next( |
3b89958b | 103 | struct ctf_msg_iter *msg_iter, |
55e57fc9 | 104 | const bt_message **msg); |
4f1f88a6 | 105 | |
97ade20b JG |
106 | BT_HIDDEN |
107 | struct ctf_fs_ds_index *ctf_fs_ds_file_build_index( | |
13772304 | 108 | struct ctf_fs_ds_file *ds_file, |
3b89958b SM |
109 | struct ctf_fs_ds_file_info *ds_file_info, |
110 | struct ctf_msg_iter *msg_iter); | |
97ade20b | 111 | |
779f4a23 | 112 | BT_HIDDEN |
f67894f9 PP |
113 | struct ctf_fs_ds_index *ctf_fs_ds_index_create(bt_logging_level log_level, |
114 | bt_self_component *self_comp); | |
779f4a23 | 115 | |
97ade20b JG |
116 | BT_HIDDEN |
117 | void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index); | |
118 | ||
5d452e1f | 119 | extern struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops; |
55fa6491 | 120 | |
94cf822e | 121 | #endif /* CTF_FS_DS_FILE_H */ |