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 <babeltrace/babeltrace-internal.h>
30 #include <babeltrace/babeltrace.h>
32 #include "../common/notif-iter/notif-iter.h"
33 #include "lttng-index.h"
35 struct ctf_fs_component
;
38 struct ctf_fs_ds_file
;
40 struct ctf_fs_ds_index_entry
{
41 /* Position, in bytes, of the packet from the beginning of the file. */
44 /* Size of the packet, in bytes. */
48 * Extracted from the packet context, relative to the respective fields'
49 * mapped clock classes (in cycles).
51 uint64_t timestamp_begin
, timestamp_end
;
54 * Converted from the packet context, relative to the trace's EPOCH
55 * (in ns since EPOCH).
57 int64_t timestamp_begin_ns
, timestamp_end_ns
;
60 struct ctf_fs_ds_index
{
61 /* Array of struct ctf_fs_fd_index_entry. */
65 struct ctf_fs_ds_file_info
{
67 * Owned by this. May be NULL.
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
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
78 struct ctf_fs_ds_index
*index
;
83 /* Guaranteed to be set, as opposed to the index. */
87 struct ctf_fs_metadata
;
89 struct ctf_fs_ds_file
{
91 struct ctf_fs_metadata
*metadata
;
94 struct bt_self_notification_iterator
*pc_notif_iter
;
97 struct ctf_fs_file
*file
;
100 struct bt_private_stream
*stream
;
103 struct bt_notif_iter
*notif_iter
;
108 * Max length of chunk to mmap() when updating the current mapping.
109 * This value must be page-aligned.
113 /* Length of the current mapping. Never exceeds the file's length. */
116 /* Offset in the file where the current mapping starts. */
120 * Offset, in the current mapping, of the address to return on the next
123 off_t request_offset
;
129 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
130 struct ctf_fs_trace
*ctf_fs_trace
,
131 struct bt_self_notification_iterator
*pc_notif_iter
,
132 struct bt_notif_iter
*notif_iter
,
133 struct bt_private_stream
*stream
, const char *path
);
136 int ctf_fs_ds_file_borrow_packet_header_context_fields(
137 struct ctf_fs_ds_file
*ds_file
,
138 struct bt_private_field
**packet_header_field
,
139 struct bt_private_field
**packet_context_field
);
142 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*stream
);
145 enum bt_notification_iterator_status
ctf_fs_ds_file_next(
146 struct ctf_fs_ds_file
*ds_file
,
147 struct bt_private_notification
**notif
);
150 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(
151 struct ctf_fs_ds_file
*ds_file
);
154 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
);
156 extern struct bt_notif_iter_medium_ops ctf_fs_ds_file_medops
;
158 #endif /* CTF_FS_DS_FILE_H */