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 PP |
28 | #include <glib.h> |
29 | #include <babeltrace/babeltrace-internal.h> | |
9d408fca | 30 | #include <babeltrace/babeltrace.h> |
e98a2d6e | 31 | |
413bc2c4 | 32 | #include "../common/notif-iter/notif-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 JG |
40 | struct ctf_fs_ds_index_entry { |
41 | /* Position, in bytes, of the packet from the beginning of the file. */ | |
42 | uint64_t offset; | |
43 | ||
44 | /* Size of the packet, in bytes. */ | |
45 | uint64_t packet_size; | |
46 | ||
47 | /* | |
48 | * Extracted from the packet context, relative to the respective fields' | |
49 | * mapped clock classes (in cycles). | |
50 | */ | |
b6c3dcb2 | 51 | uint64_t timestamp_begin, timestamp_end; |
97ade20b JG |
52 | |
53 | /* | |
54 | * Converted from the packet context, relative to the trace's EPOCH | |
55 | * (in ns since EPOCH). | |
56 | */ | |
57 | int64_t timestamp_begin_ns, timestamp_end_ns; | |
b6c3dcb2 JG |
58 | }; |
59 | ||
97ade20b JG |
60 | struct ctf_fs_ds_index { |
61 | /* Array of struct ctf_fs_fd_index_entry. */ | |
62 | GArray *entries; | |
63 | }; | |
64 | ||
65 | struct ctf_fs_ds_file_info { | |
66 | /* | |
67 | * Owned by this. May be NULL. | |
68 | * | |
69 | * A stream cannot be assumed to be indexed as the indexing might have | |
70 | * been skipped. Moreover, the index's fields may not all be available | |
71 | * depending on the producer (e.g. timestamp_begin/end are not | |
72 | * mandatory). | |
73 | * | |
74 | * FIXME In such cases (missing fields), the indexing is aborted as | |
75 | * no the index entries don't have a concept of fields being present | |
76 | * or not. | |
77 | */ | |
78 | struct ctf_fs_ds_index *index; | |
79 | ||
80 | /* Owned by this. */ | |
81 | GString *path; | |
82 | ||
83 | /* Guaranteed to be set, as opposed to the index. */ | |
44c440bc | 84 | int64_t begin_ns; |
97ade20b JG |
85 | }; |
86 | ||
44c440bc PP |
87 | struct ctf_fs_metadata; |
88 | ||
97ade20b | 89 | struct ctf_fs_ds_file { |
44c440bc PP |
90 | /* Weak */ |
91 | struct ctf_fs_metadata *metadata; | |
92 | ||
5c563278 | 93 | /* Weak */ |
f0010051 | 94 | struct bt_private_connection_private_notification_iterator *pc_notif_iter; |
5c563278 | 95 | |
97ade20b JG |
96 | /* Owned by this */ |
97 | struct ctf_fs_file *file; | |
98 | ||
99 | /* Owned by this */ | |
50842bdc | 100 | struct bt_stream *stream; |
97ade20b JG |
101 | |
102 | /* Owned by this */ | |
103 | struct bt_clock_class_priority_map *cc_prio_map; | |
104 | ||
6de92955 | 105 | /* Weak */ |
50842bdc | 106 | struct bt_notif_iter *notif_iter; |
97ade20b JG |
107 | |
108 | void *mmap_addr; | |
109 | ||
2f5a009b JG |
110 | /* |
111 | * Max length of chunk to mmap() when updating the current mapping. | |
112 | * This value must be page-aligned. | |
113 | */ | |
97ade20b JG |
114 | size_t mmap_max_len; |
115 | ||
2c701ca6 | 116 | /* Length of the current mapping. Never exceeds the file's length. */ |
97ade20b JG |
117 | size_t mmap_len; |
118 | ||
97ade20b JG |
119 | /* Offset in the file where the current mapping starts. */ |
120 | off_t mmap_offset; | |
121 | ||
122 | /* | |
123 | * Offset, in the current mapping, of the address to return on the next | |
124 | * request. | |
125 | */ | |
126 | off_t request_offset; | |
127 | ||
128 | bool end_reached; | |
b6c3dcb2 | 129 | }; |
e98a2d6e PP |
130 | |
131 | BT_HIDDEN | |
94cf822e PP |
132 | struct ctf_fs_ds_file *ctf_fs_ds_file_create( |
133 | struct ctf_fs_trace *ctf_fs_trace, | |
f0010051 | 134 | struct bt_private_connection_private_notification_iterator *pc_notif_iter, |
50842bdc PP |
135 | struct bt_notif_iter *notif_iter, |
136 | struct bt_stream *stream, const char *path); | |
e98a2d6e PP |
137 | |
138 | BT_HIDDEN | |
312c056a | 139 | int ctf_fs_ds_file_borrow_packet_header_context_fields( |
97ade20b | 140 | struct ctf_fs_ds_file *ds_file, |
50842bdc PP |
141 | struct bt_field **packet_header_field, |
142 | struct bt_field **packet_context_field); | |
e98a2d6e PP |
143 | |
144 | BT_HIDDEN | |
94cf822e | 145 | void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream); |
e98a2d6e | 146 | |
4f1f88a6 | 147 | BT_HIDDEN |
d4393e08 PP |
148 | enum bt_notification_iterator_status ctf_fs_ds_file_next( |
149 | struct ctf_fs_ds_file *ds_file, | |
150 | struct bt_notification **notif); | |
4f1f88a6 | 151 | |
97ade20b JG |
152 | BT_HIDDEN |
153 | struct ctf_fs_ds_index *ctf_fs_ds_file_build_index( | |
154 | struct ctf_fs_ds_file *ds_file); | |
155 | ||
156 | BT_HIDDEN | |
157 | void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index); | |
158 | ||
50842bdc | 159 | extern struct bt_notif_iter_medium_ops ctf_fs_ds_file_medops; |
6de92955 | 160 | |
94cf822e | 161 | #endif /* CTF_FS_DS_FILE_H */ |