Commit | Line | Data |
---|---|---|
d79865b9 MD |
1 | #ifndef _BABELTRACE_CTF_TYPES_H |
2 | #define _BABELTRACE_CTF_TYPES_H | |
6dc2ca62 MD |
3 | |
4 | /* | |
5 | * Common Trace Format | |
6 | * | |
7 | * Type header | |
8 | * | |
ccd7e1c8 | 9 | * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
6dc2ca62 | 10 | * |
ccd7e1c8 MD |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
de0ba614 | 17 | * |
ccd7e1c8 MD |
18 | * The above copyright notice and this permission notice shall be included in |
19 | * all copies or substantial portions of the Software. | |
c462e188 MD |
20 | * |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
6dc2ca62 MD |
28 | */ |
29 | ||
4c8bfb7e | 30 | #include <babeltrace/types.h> |
70bd0a12 | 31 | #include <babeltrace/babeltrace-internal.h> |
8563e754 MD |
32 | #include <sys/types.h> |
33 | #include <sys/stat.h> | |
34 | #include <fcntl.h> | |
8c572eba | 35 | #include <errno.h> |
6dc2ca62 | 36 | #include <stdint.h> |
0f980a35 | 37 | #include <unistd.h> |
6dc2ca62 | 38 | #include <glib.h> |
c5e74408 | 39 | #include <stdio.h> |
fef3bf22 | 40 | #include <inttypes.h> |
aee35fcc | 41 | #include <babeltrace/mmap-align.h> |
847bf71a | 42 | |
fef3bf22 | 43 | #define LAST_OFFSET_POISON ((int64_t) ~0ULL) |
3a25e036 | 44 | |
c34ccddd MD |
45 | struct bt_stream_callbacks; |
46 | ||
0f980a35 MD |
47 | struct packet_index { |
48 | off_t offset; /* offset of the packet in the file, in bytes */ | |
fef3bf22 | 49 | int64_t data_offset; /* offset of data within the packet, in bits */ |
7e18eedf JN |
50 | uint64_t packet_size; /* packet size, in bits */ |
51 | uint64_t content_size; /* content size, in bits */ | |
75cc2c35 MD |
52 | uint64_t timestamp_begin; |
53 | uint64_t timestamp_end; | |
4c4ba021 | 54 | uint64_t events_discarded; |
fef3bf22 | 55 | uint64_t events_discarded_len; /* length of the field, in bits */ |
dd2544fd MD |
56 | }; |
57 | ||
dd2544fd | 58 | /* |
46322b33 | 59 | * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos. |
dd2544fd | 60 | */ |
46322b33 | 61 | struct ctf_stream_pos { |
1cf393f6 | 62 | struct bt_stream_pos parent; |
0f980a35 | 63 | int fd; /* backing file fd. -1 if unset. */ |
0ace7505 | 64 | FILE *index_fp; /* backing index file fp. NULL if unset. */ |
03798a93 JD |
65 | GArray *packet_cycles_index; /* contains struct packet_index in cycles */ |
66 | GArray *packet_real_index; /* contains struct packet_index in ns */ | |
8c572eba MD |
67 | int prot; /* mmap protection */ |
68 | int flags; /* mmap flags */ | |
dd2544fd | 69 | |
0f980a35 MD |
70 | /* Current position */ |
71 | off_t mmap_offset; /* mmap offset in the file, in bytes */ | |
47415068 | 72 | off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */ |
fef3bf22 MD |
73 | uint64_t packet_size; /* current packet size, in bits */ |
74 | uint64_t content_size; /* current content size, in bits */ | |
75 | uint64_t *content_size_loc; /* pointer to current content size */ | |
aee35fcc | 76 | struct mmap_align *base_mma;/* mmap base address */ |
fef3bf22 MD |
77 | int64_t offset; /* offset from base, in bits. EOF for end of file. */ |
78 | int64_t last_offset; /* offset before the last read_event */ | |
79 | uint64_t cur_index; /* current index in packet index */ | |
f60efc0e | 80 | uint64_t last_events_discarded; /* last known amount of event discarded */ |
1cf393f6 | 81 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
b086c01a | 82 | int whence); /* function called to switch packet */ |
dd2544fd | 83 | |
0f980a35 | 84 | int dummy; /* dummy position, for length calculation */ |
c34ccddd | 85 | struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */ |
0f980a35 | 86 | }; |
dd2544fd | 87 | |
46322b33 | 88 | static inline |
1cf393f6 | 89 | struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos) |
46322b33 MD |
90 | { |
91 | return container_of(pos, struct ctf_stream_pos, parent); | |
92 | } | |
93 | ||
2e937fb4 | 94 | BT_HIDDEN |
0d69b916 | 95 | int ctf_integer_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 96 | BT_HIDDEN |
0d69b916 | 97 | int ctf_integer_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 98 | BT_HIDDEN |
0d69b916 | 99 | int ctf_float_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 100 | BT_HIDDEN |
0d69b916 | 101 | int ctf_float_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 102 | BT_HIDDEN |
0d69b916 | 103 | int ctf_string_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 104 | BT_HIDDEN |
0d69b916 | 105 | int ctf_string_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 106 | BT_HIDDEN |
0d69b916 | 107 | int ctf_enum_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 108 | BT_HIDDEN |
0d69b916 | 109 | int ctf_enum_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 110 | BT_HIDDEN |
0d69b916 | 111 | int ctf_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 112 | BT_HIDDEN |
0d69b916 | 113 | int ctf_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 114 | BT_HIDDEN |
0d69b916 | 115 | int ctf_array_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 116 | BT_HIDDEN |
0d69b916 | 117 | int ctf_array_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 118 | BT_HIDDEN |
0d69b916 | 119 | int ctf_sequence_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 120 | BT_HIDDEN |
0d69b916 | 121 | int ctf_sequence_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
6dc2ca62 | 122 | |
1cf393f6 | 123 | void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence); |
0f980a35 | 124 | |
ca334c72 MD |
125 | int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace, |
126 | int fd, int open_flags); | |
f824ae04 | 127 | int ctf_fini_pos(struct ctf_stream_pos *pos); |
0f980a35 MD |
128 | |
129 | /* | |
130 | * move_pos - move position of a relative bit offset | |
131 | * | |
70fd5a51 MD |
132 | * Return 1 if OK, 0 if out-of-bound. |
133 | * | |
0f980a35 MD |
134 | * TODO: allow larger files by updating base too. |
135 | */ | |
136 | static inline | |
70fd5a51 | 137 | int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset) |
0f980a35 | 138 | { |
70fd5a51 MD |
139 | uint64_t max_len; |
140 | ||
fef3bf22 | 141 | printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset); |
90bf3cef | 142 | if (unlikely(pos->offset == EOF)) |
70fd5a51 MD |
143 | return 0; |
144 | if (pos->flags & PROT_READ) | |
145 | max_len = pos->content_size; | |
146 | else | |
147 | max_len = pos->packet_size; | |
148 | if (unlikely(pos->offset + bit_offset > max_len)) | |
149 | return 0; | |
c5e74408 | 150 | |
8c572eba | 151 | pos->offset += bit_offset; |
fef3bf22 | 152 | printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset); |
70fd5a51 | 153 | return 1; |
0f980a35 MD |
154 | } |
155 | ||
156 | /* | |
157 | * align_pos - align position on a bit offset (> 0) | |
158 | * | |
70fd5a51 MD |
159 | * Return 1 if OK, 0 if out-of-bound. |
160 | * | |
0f980a35 MD |
161 | * TODO: allow larger files by updating base too. |
162 | */ | |
163 | static inline | |
70fd5a51 | 164 | int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset) |
0f980a35 | 165 | { |
70fd5a51 | 166 | return ctf_move_pos(pos, offset_align(pos->offset, bit_offset)); |
0f980a35 MD |
167 | } |
168 | ||
169 | static inline | |
46322b33 | 170 | char *ctf_get_pos_addr(struct ctf_stream_pos *pos) |
0f980a35 MD |
171 | { |
172 | /* Only makes sense to get the address after aligning on CHAR_BIT */ | |
173 | assert(!(pos->offset % CHAR_BIT)); | |
47415068 JD |
174 | return mmap_align_addr(pos->base_mma) + |
175 | pos->mmap_base_offset + (pos->offset / CHAR_BIT); | |
0f980a35 MD |
176 | } |
177 | ||
8c572eba | 178 | static inline |
46322b33 | 179 | void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy) |
8c572eba | 180 | { |
46322b33 | 181 | memcpy(dummy, pos, sizeof(struct ctf_stream_pos)); |
8c572eba MD |
182 | dummy->dummy = 1; |
183 | dummy->fd = -1; | |
184 | } | |
185 | ||
186 | /* | |
187 | * Check if current packet can hold data. | |
188 | * Returns 0 for success, negative error otherwise. | |
189 | */ | |
190 | static inline | |
46322b33 | 191 | int ctf_pos_packet(struct ctf_stream_pos *dummy) |
8c572eba | 192 | { |
90bf3cef | 193 | if (unlikely(dummy->offset > dummy->packet_size)) |
8c572eba MD |
194 | return -ENOSPC; |
195 | return 0; | |
196 | } | |
197 | ||
198 | static inline | |
46322b33 | 199 | void ctf_pos_pad_packet(struct ctf_stream_pos *pos) |
8c572eba | 200 | { |
42d07a0f | 201 | ctf_packet_seek(&pos->parent, 0, SEEK_CUR); |
8c572eba MD |
202 | } |
203 | ||
c5e74408 | 204 | static inline |
fef3bf22 | 205 | int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len) |
c5e74408 | 206 | { |
70fd5a51 MD |
207 | uint64_t max_len; |
208 | ||
90bf3cef | 209 | if (unlikely(pos->offset == EOF)) |
c5e74408 | 210 | return 0; |
70fd5a51 MD |
211 | if (pos->flags & PROT_READ) |
212 | max_len = pos->content_size; | |
213 | else | |
214 | max_len = pos->packet_size; | |
215 | if (unlikely(pos->offset + bit_len > max_len)) | |
c5e74408 MD |
216 | return 0; |
217 | return 1; | |
218 | } | |
219 | ||
5f643ed7 | 220 | /* |
fd87c903 | 221 | * Update the stream position to the current event. This moves to |
5f643ed7 MD |
222 | * the next packet if we are located at the end of the current packet. |
223 | */ | |
224 | static inline | |
225 | void ctf_pos_get_event(struct ctf_stream_pos *pos) | |
226 | { | |
227 | assert(pos->offset <= pos->content_size); | |
228 | if (pos->offset == pos->content_size) { | |
fef3bf22 | 229 | printf_debug("ctf_packet_seek (before call): %" PRId64 "\n", |
5f643ed7 | 230 | pos->offset); |
06789ffd | 231 | pos->packet_seek(&pos->parent, 0, SEEK_CUR); |
fef3bf22 | 232 | printf_debug("ctf_packet_seek (after call): %" PRId64 "\n", |
5f643ed7 MD |
233 | pos->offset); |
234 | } | |
235 | } | |
236 | ||
9e88d150 | 237 | void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream, |
7d97fad9 MD |
238 | uint64_t timestamp); |
239 | ||
d79865b9 | 240 | #endif /* _BABELTRACE_CTF_TYPES_H */ |