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> |
ccce44e8 | 42 | #include <babeltrace/error.h> |
847bf71a | 43 | |
fef3bf22 | 44 | #define LAST_OFFSET_POISON ((int64_t) ~0ULL) |
3a25e036 | 45 | |
c34ccddd MD |
46 | struct bt_stream_callbacks; |
47 | ||
992e8cc0 MD |
48 | struct packet_index_time { |
49 | uint64_t timestamp_begin; | |
50 | uint64_t timestamp_end; | |
51 | }; | |
52 | ||
0f980a35 MD |
53 | struct packet_index { |
54 | off_t offset; /* offset of the packet in the file, in bytes */ | |
fef3bf22 | 55 | int64_t data_offset; /* offset of data within the packet, in bits */ |
7e18eedf JN |
56 | uint64_t packet_size; /* packet size, in bits */ |
57 | uint64_t content_size; /* content size, in bits */ | |
4c4ba021 | 58 | uint64_t events_discarded; |
fef3bf22 | 59 | uint64_t events_discarded_len; /* length of the field, in bits */ |
992e8cc0 MD |
60 | struct packet_index_time ts_cycles; /* timestamp in cycles */ |
61 | struct packet_index_time ts_real; /* realtime timestamp */ | |
138cb20b JD |
62 | /* CTF_INDEX 1.0 limit */ |
63 | uint64_t stream_instance_id; /* ID of the channel instance */ | |
64 | uint64_t packet_seq_num; /* packet sequence number */ | |
dd2544fd MD |
65 | }; |
66 | ||
dd2544fd | 67 | /* |
46322b33 | 68 | * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos. |
dd2544fd | 69 | */ |
46322b33 | 70 | struct ctf_stream_pos { |
1cf393f6 | 71 | struct bt_stream_pos parent; |
0f980a35 | 72 | int fd; /* backing file fd. -1 if unset. */ |
0ace7505 | 73 | FILE *index_fp; /* backing index file fp. NULL if unset. */ |
992e8cc0 | 74 | GArray *packet_index; /* contains struct packet_index */ |
8c572eba MD |
75 | int prot; /* mmap protection */ |
76 | int flags; /* mmap flags */ | |
dd2544fd | 77 | |
0f980a35 MD |
78 | /* Current position */ |
79 | off_t mmap_offset; /* mmap offset in the file, in bytes */ | |
47415068 | 80 | off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */ |
fef3bf22 MD |
81 | uint64_t packet_size; /* current packet size, in bits */ |
82 | uint64_t content_size; /* current content size, in bits */ | |
83 | uint64_t *content_size_loc; /* pointer to current content size */ | |
aee35fcc | 84 | struct mmap_align *base_mma;/* mmap base address */ |
fef3bf22 MD |
85 | int64_t offset; /* offset from base, in bits. EOF for end of file. */ |
86 | int64_t last_offset; /* offset before the last read_event */ | |
500634be | 87 | int64_t data_offset; /* offset of data in current packet */ |
fef3bf22 | 88 | uint64_t cur_index; /* current index in packet index */ |
f60efc0e | 89 | uint64_t last_events_discarded; /* last known amount of event discarded */ |
1cf393f6 | 90 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, |
b086c01a | 91 | int whence); /* function called to switch packet */ |
dd2544fd | 92 | |
0f980a35 | 93 | int dummy; /* dummy position, for length calculation */ |
c34ccddd | 94 | struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */ |
6730cff6 | 95 | size_t file_length; /* length of backing file, in bytes. */ |
731087d8 | 96 | void *priv; |
0f980a35 | 97 | }; |
dd2544fd | 98 | |
46322b33 | 99 | static inline |
1cf393f6 | 100 | struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos) |
46322b33 MD |
101 | { |
102 | return container_of(pos, struct ctf_stream_pos, parent); | |
103 | } | |
104 | ||
2e937fb4 | 105 | BT_HIDDEN |
0d69b916 | 106 | int ctf_integer_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 107 | BT_HIDDEN |
0d69b916 | 108 | int ctf_integer_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 109 | BT_HIDDEN |
0d69b916 | 110 | int ctf_float_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 111 | BT_HIDDEN |
0d69b916 | 112 | int ctf_float_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 113 | BT_HIDDEN |
0d69b916 | 114 | int ctf_string_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 115 | BT_HIDDEN |
0d69b916 | 116 | int ctf_string_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 117 | BT_HIDDEN |
0d69b916 | 118 | int ctf_enum_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 119 | BT_HIDDEN |
0d69b916 | 120 | int ctf_enum_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 121 | BT_HIDDEN |
0d69b916 | 122 | int ctf_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 123 | BT_HIDDEN |
0d69b916 | 124 | int ctf_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 125 | BT_HIDDEN |
0d69b916 | 126 | int ctf_array_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 127 | BT_HIDDEN |
0d69b916 | 128 | int ctf_array_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 129 | BT_HIDDEN |
0d69b916 | 130 | int ctf_sequence_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 131 | BT_HIDDEN |
0d69b916 | 132 | int ctf_sequence_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
6dc2ca62 | 133 | |
1cf393f6 | 134 | void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence); |
0f980a35 | 135 | |
ca334c72 MD |
136 | int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace, |
137 | int fd, int open_flags); | |
f824ae04 | 138 | int ctf_fini_pos(struct ctf_stream_pos *pos); |
0f980a35 | 139 | |
fcf10417 JG |
140 | static inline |
141 | int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len) | |
142 | { | |
143 | uint64_t max_len; | |
144 | ||
145 | if (unlikely(pos->offset == EOF)) | |
146 | return 0; | |
147 | if (pos->prot == PROT_READ) { | |
148 | /* | |
149 | * Reads may only reach up to the "content_size", | |
150 | * regardless of the packet_size. | |
151 | */ | |
152 | max_len = pos->content_size; | |
153 | } else { | |
154 | /* Writes may take place up to the end of the packet. */ | |
155 | max_len = pos->packet_size; | |
156 | } | |
157 | if (unlikely(pos->offset + bit_len > max_len)) | |
158 | return 0; | |
159 | return 1; | |
160 | } | |
161 | ||
0f980a35 MD |
162 | /* |
163 | * move_pos - move position of a relative bit offset | |
164 | * | |
70fd5a51 MD |
165 | * Return 1 if OK, 0 if out-of-bound. |
166 | * | |
0f980a35 MD |
167 | * TODO: allow larger files by updating base too. |
168 | */ | |
169 | static inline | |
70fd5a51 | 170 | int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset) |
0f980a35 | 171 | { |
fcf10417 | 172 | int ret = 0; |
70fd5a51 | 173 | |
fef3bf22 | 174 | printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset); |
fcf10417 JG |
175 | ret = ctf_pos_access_ok(pos, bit_offset); |
176 | if (!ret) { | |
177 | goto end; | |
178 | } | |
8c572eba | 179 | pos->offset += bit_offset; |
fef3bf22 | 180 | printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset); |
fcf10417 JG |
181 | end: |
182 | return ret; | |
0f980a35 MD |
183 | } |
184 | ||
185 | /* | |
186 | * align_pos - align position on a bit offset (> 0) | |
187 | * | |
70fd5a51 MD |
188 | * Return 1 if OK, 0 if out-of-bound. |
189 | * | |
0f980a35 MD |
190 | * TODO: allow larger files by updating base too. |
191 | */ | |
192 | static inline | |
70fd5a51 | 193 | int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset) |
0f980a35 | 194 | { |
70fd5a51 | 195 | return ctf_move_pos(pos, offset_align(pos->offset, bit_offset)); |
0f980a35 MD |
196 | } |
197 | ||
198 | static inline | |
46322b33 | 199 | char *ctf_get_pos_addr(struct ctf_stream_pos *pos) |
0f980a35 MD |
200 | { |
201 | /* Only makes sense to get the address after aligning on CHAR_BIT */ | |
202 | assert(!(pos->offset % CHAR_BIT)); | |
47415068 JD |
203 | return mmap_align_addr(pos->base_mma) + |
204 | pos->mmap_base_offset + (pos->offset / CHAR_BIT); | |
0f980a35 MD |
205 | } |
206 | ||
8c572eba | 207 | static inline |
46322b33 | 208 | void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy) |
8c572eba | 209 | { |
46322b33 | 210 | memcpy(dummy, pos, sizeof(struct ctf_stream_pos)); |
8c572eba MD |
211 | dummy->dummy = 1; |
212 | dummy->fd = -1; | |
213 | } | |
214 | ||
215 | /* | |
216 | * Check if current packet can hold data. | |
217 | * Returns 0 for success, negative error otherwise. | |
218 | */ | |
219 | static inline | |
46322b33 | 220 | int ctf_pos_packet(struct ctf_stream_pos *dummy) |
8c572eba | 221 | { |
90bf3cef | 222 | if (unlikely(dummy->offset > dummy->packet_size)) |
8c572eba MD |
223 | return -ENOSPC; |
224 | return 0; | |
225 | } | |
226 | ||
227 | static inline | |
ccce44e8 | 228 | int ctf_pos_pad_packet(struct ctf_stream_pos *pos) |
8c572eba | 229 | { |
42d07a0f | 230 | ctf_packet_seek(&pos->parent, 0, SEEK_CUR); |
ccce44e8 | 231 | return bt_packet_seek_get_error(); |
8c572eba MD |
232 | } |
233 | ||
5f643ed7 | 234 | /* |
fd87c903 | 235 | * Update the stream position to the current event. This moves to |
5f643ed7 MD |
236 | * the next packet if we are located at the end of the current packet. |
237 | */ | |
238 | static inline | |
ccce44e8 | 239 | int ctf_pos_get_event(struct ctf_stream_pos *pos) |
5f643ed7 | 240 | { |
ccce44e8 MD |
241 | int ret = 0; |
242 | ||
5f643ed7 MD |
243 | assert(pos->offset <= pos->content_size); |
244 | if (pos->offset == pos->content_size) { | |
fef3bf22 | 245 | printf_debug("ctf_packet_seek (before call): %" PRId64 "\n", |
5f643ed7 | 246 | pos->offset); |
06789ffd | 247 | pos->packet_seek(&pos->parent, 0, SEEK_CUR); |
fef3bf22 | 248 | printf_debug("ctf_packet_seek (after call): %" PRId64 "\n", |
5f643ed7 | 249 | pos->offset); |
ccce44e8 | 250 | ret = bt_packet_seek_get_error(); |
5f643ed7 | 251 | } |
ccce44e8 | 252 | return ret; |
5f643ed7 MD |
253 | } |
254 | ||
9e88d150 | 255 | void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream, |
7d97fad9 | 256 | uint64_t timestamp); |
0c880b0a MD |
257 | int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp, |
258 | FILE *metadata_fp); | |
7371a182 | 259 | void ctf_print_discarded_lost(FILE *fp, struct ctf_stream_definition *stream); |
7d97fad9 | 260 | |
d79865b9 | 261 | #endif /* _BABELTRACE_CTF_TYPES_H */ |