| 1 | #ifndef CTF_FS_DS_FILE_H |
| 2 | #define CTF_FS_DS_FILE_H |
| 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> |
| 27 | #include <stdbool.h> |
| 28 | #include <glib.h> |
| 29 | #include <babeltrace/babeltrace-internal.h> |
| 30 | #include <babeltrace/ctf-ir/trace.h> |
| 31 | |
| 32 | #include "../common/notif-iter/notif-iter.h" |
| 33 | #include "lttng-index.h" |
| 34 | |
| 35 | struct ctf_fs_component; |
| 36 | struct ctf_fs_file; |
| 37 | struct ctf_fs_trace; |
| 38 | struct ctf_fs_ds_file; |
| 39 | |
| 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 | */ |
| 51 | uint64_t timestamp_begin, timestamp_end; |
| 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; |
| 58 | }; |
| 59 | |
| 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. */ |
| 84 | uint64_t begin_ns; |
| 85 | }; |
| 86 | |
| 87 | struct ctf_fs_ds_file { |
| 88 | /* Owned by this */ |
| 89 | struct ctf_fs_file *file; |
| 90 | |
| 91 | /* Owned by this */ |
| 92 | struct bt_ctf_stream *stream; |
| 93 | |
| 94 | /* Owned by this */ |
| 95 | struct bt_clock_class_priority_map *cc_prio_map; |
| 96 | |
| 97 | /* Weak */ |
| 98 | struct bt_ctf_notif_iter *notif_iter; |
| 99 | |
| 100 | void *mmap_addr; |
| 101 | |
| 102 | /* |
| 103 | * Max length of chunk to mmap() when updating the current mapping. |
| 104 | * This value must be page-aligned. |
| 105 | */ |
| 106 | size_t mmap_max_len; |
| 107 | |
| 108 | /* Length of the current mapping. Never exceeds the file's length. */ |
| 109 | size_t mmap_len; |
| 110 | |
| 111 | /* Offset in the file where the current mapping starts. */ |
| 112 | off_t mmap_offset; |
| 113 | |
| 114 | /* |
| 115 | * Offset, in the current mapping, of the address to return on the next |
| 116 | * request. |
| 117 | */ |
| 118 | off_t request_offset; |
| 119 | |
| 120 | bool end_reached; |
| 121 | }; |
| 122 | |
| 123 | BT_HIDDEN |
| 124 | struct ctf_fs_ds_file *ctf_fs_ds_file_create( |
| 125 | struct ctf_fs_trace *ctf_fs_trace, |
| 126 | struct bt_ctf_notif_iter *notif_iter, |
| 127 | struct bt_ctf_stream *stream, const char *path); |
| 128 | |
| 129 | BT_HIDDEN |
| 130 | int ctf_fs_ds_file_get_packet_header_context_fields( |
| 131 | struct ctf_fs_ds_file *ds_file, |
| 132 | struct bt_ctf_field **packet_header_field, |
| 133 | struct bt_ctf_field **packet_context_field); |
| 134 | |
| 135 | BT_HIDDEN |
| 136 | void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *stream); |
| 137 | |
| 138 | BT_HIDDEN |
| 139 | struct bt_notification_iterator_next_method_return ctf_fs_ds_file_next( |
| 140 | struct ctf_fs_ds_file *stream); |
| 141 | |
| 142 | BT_HIDDEN |
| 143 | struct ctf_fs_ds_index *ctf_fs_ds_file_build_index( |
| 144 | struct ctf_fs_ds_file *ds_file); |
| 145 | |
| 146 | BT_HIDDEN |
| 147 | void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index); |
| 148 | |
| 149 | extern struct bt_ctf_notif_iter_medium_ops ctf_fs_ds_file_medops; |
| 150 | |
| 151 | #endif /* CTF_FS_DS_FILE_H */ |