| 1 | #ifndef BABELTRACE_PLUGIN_CTF_FS_H |
| 2 | #define BABELTRACE_PLUGIN_CTF_FS_H |
| 3 | |
| 4 | /* |
| 5 | * BabelTrace - CTF on File System Component |
| 6 | * |
| 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 8 | * Copyright 2016 Philippe Proulx <pproulx@efficios.com> |
| 9 | * |
| 10 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 11 | * |
| 12 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 13 | * of this software and associated documentation files (the "Software"), to deal |
| 14 | * in the Software without restriction, including without limitation the rights |
| 15 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 16 | * copies of the Software, and to permit persons to whom the Software is |
| 17 | * furnished to do so, subject to the following conditions: |
| 18 | * |
| 19 | * The above copyright notice and this permission notice shall be included in |
| 20 | * all copies or substantial portions of the Software. |
| 21 | * |
| 22 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 23 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 24 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 25 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 26 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 27 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 28 | * SOFTWARE. |
| 29 | */ |
| 30 | |
| 31 | #include <babeltrace/babeltrace-internal.h> |
| 32 | #include <babeltrace/component/component.h> |
| 33 | #include "data-stream.h" |
| 34 | |
| 35 | #define CTF_FS_COMPONENT_DESCRIPTION \ |
| 36 | "Component used to read a CTF trace located on a file system." |
| 37 | |
| 38 | BT_HIDDEN |
| 39 | extern bool ctf_fs_debug; |
| 40 | |
| 41 | struct bt_notification_heap; |
| 42 | |
| 43 | struct ctf_fs_file { |
| 44 | struct ctf_fs_component *ctf_fs; |
| 45 | GString *path; |
| 46 | FILE *fp; |
| 47 | off_t size; |
| 48 | }; |
| 49 | |
| 50 | struct ctf_fs_metadata { |
| 51 | struct bt_ctf_trace *trace; |
| 52 | uint8_t uuid[16]; |
| 53 | bool is_uuid_set; |
| 54 | int bo; |
| 55 | char *text; |
| 56 | }; |
| 57 | |
| 58 | struct ctf_fs_stream { |
| 59 | struct ctf_fs_file *file; |
| 60 | struct bt_ctf_stream *stream; |
| 61 | /* FIXME There should be many and ctf_fs_stream should not own them. */ |
| 62 | struct bt_ctf_notif_iter *notif_iter; |
| 63 | /* A stream is assumed to be indexed. */ |
| 64 | struct index index; |
| 65 | void *mmap_addr; |
| 66 | /* Max length of chunk to mmap() when updating the current mapping. */ |
| 67 | size_t mmap_max_len; |
| 68 | /* Length of the current mapping. */ |
| 69 | size_t mmap_len; |
| 70 | /* Length of the current mapping which *exists* in the backing file. */ |
| 71 | size_t mmap_valid_len; |
| 72 | /* Offset in the file where the current mapping starts. */ |
| 73 | off_t mmap_offset; |
| 74 | /* |
| 75 | * Offset, in the current mapping, of the address to return on the next |
| 76 | * request. |
| 77 | */ |
| 78 | off_t request_offset; |
| 79 | bool end_reached; |
| 80 | }; |
| 81 | |
| 82 | struct ctf_fs_iterator { |
| 83 | struct bt_notification_heap *pending_notifications; |
| 84 | /* |
| 85 | * struct ctf_fs_data_stream* which have not yet been associated to a |
| 86 | * bt_ctf_stream. The association is performed on the first packet |
| 87 | * read by the stream (since, at that point, we have read a packet |
| 88 | * header). |
| 89 | */ |
| 90 | GPtrArray *pending_streams; |
| 91 | /* bt_ctf_stream -> ctf_fs_stream */ |
| 92 | GHashTable *stream_ht; |
| 93 | }; |
| 94 | |
| 95 | struct ctf_fs_component_options { |
| 96 | bool opt_dummy : 1; |
| 97 | }; |
| 98 | |
| 99 | struct ctf_fs_component { |
| 100 | GString *trace_path; |
| 101 | FILE *error_fp; |
| 102 | size_t page_size; |
| 103 | struct ctf_fs_component_options options; |
| 104 | struct ctf_fs_metadata *metadata; |
| 105 | }; |
| 106 | |
| 107 | BT_HIDDEN |
| 108 | enum bt_component_status ctf_fs_init(struct bt_private_component *source, |
| 109 | struct bt_value *params, void *init_method_data); |
| 110 | |
| 111 | BT_HIDDEN |
| 112 | void ctf_fs_finalize(struct bt_private_component *component); |
| 113 | |
| 114 | BT_HIDDEN |
| 115 | enum bt_notification_iterator_status ctf_fs_iterator_init( |
| 116 | struct bt_private_notification_iterator *it, |
| 117 | struct bt_private_port *port); |
| 118 | |
| 119 | void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it); |
| 120 | |
| 121 | struct bt_notification_iterator_next_return ctf_fs_iterator_next( |
| 122 | struct bt_private_notification_iterator *iterator); |
| 123 | |
| 124 | BT_HIDDEN |
| 125 | struct bt_value *ctf_fs_query(struct bt_component_class *comp_class, |
| 126 | const char *object, struct bt_value *params); |
| 127 | |
| 128 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |