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> |
7b563a77 | 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. */ |
731087d8 | 95 | void *priv; |
0f980a35 | 96 | }; |
dd2544fd | 97 | |
46322b33 | 98 | static inline |
1cf393f6 | 99 | struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos) |
46322b33 MD |
100 | { |
101 | return container_of(pos, struct ctf_stream_pos, parent); | |
102 | } | |
103 | ||
2e937fb4 | 104 | BT_HIDDEN |
0d69b916 | 105 | int ctf_integer_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 106 | BT_HIDDEN |
0d69b916 | 107 | int ctf_integer_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 108 | BT_HIDDEN |
0d69b916 | 109 | int ctf_float_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 110 | BT_HIDDEN |
0d69b916 | 111 | int ctf_float_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 112 | BT_HIDDEN |
0d69b916 | 113 | int ctf_string_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 114 | BT_HIDDEN |
0d69b916 | 115 | int ctf_string_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 116 | BT_HIDDEN |
0d69b916 | 117 | int ctf_enum_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 118 | BT_HIDDEN |
0d69b916 | 119 | int ctf_enum_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 120 | BT_HIDDEN |
0d69b916 | 121 | int ctf_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 122 | BT_HIDDEN |
0d69b916 | 123 | int ctf_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 124 | BT_HIDDEN |
0d69b916 | 125 | int ctf_array_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 126 | BT_HIDDEN |
0d69b916 | 127 | int ctf_array_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 128 | BT_HIDDEN |
0d69b916 | 129 | int ctf_sequence_read(struct bt_stream_pos *pos, struct bt_definition *definition); |
2e937fb4 | 130 | BT_HIDDEN |
0d69b916 | 131 | int ctf_sequence_write(struct bt_stream_pos *pos, struct bt_definition *definition); |
6dc2ca62 | 132 | |
1cf393f6 | 133 | void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence); |
0f980a35 | 134 | |
ca334c72 MD |
135 | int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace, |
136 | int fd, int open_flags); | |
f824ae04 | 137 | int ctf_fini_pos(struct ctf_stream_pos *pos); |
0f980a35 | 138 | |
fcf10417 JG |
139 | static inline |
140 | int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len) | |
141 | { | |
142 | uint64_t max_len; | |
143 | ||
144 | if (unlikely(pos->offset == EOF)) | |
145 | return 0; | |
146 | if (pos->prot == PROT_READ) { | |
147 | /* | |
148 | * Reads may only reach up to the "content_size", | |
149 | * regardless of the packet_size. | |
150 | */ | |
151 | max_len = pos->content_size; | |
152 | } else { | |
153 | /* Writes may take place up to the end of the packet. */ | |
154 | max_len = pos->packet_size; | |
155 | } | |
156 | if (unlikely(pos->offset + bit_len > max_len)) | |
157 | return 0; | |
158 | return 1; | |
159 | } | |
160 | ||
0f980a35 MD |
161 | /* |
162 | * move_pos - move position of a relative bit offset | |
163 | * | |
70fd5a51 MD |
164 | * Return 1 if OK, 0 if out-of-bound. |
165 | * | |
0f980a35 MD |
166 | * TODO: allow larger files by updating base too. |
167 | */ | |
168 | static inline | |
70fd5a51 | 169 | int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset) |
0f980a35 | 170 | { |
fcf10417 | 171 | int ret = 0; |
70fd5a51 | 172 | |
fef3bf22 | 173 | printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset); |
fcf10417 JG |
174 | ret = ctf_pos_access_ok(pos, bit_offset); |
175 | if (!ret) { | |
176 | goto end; | |
177 | } | |
8c572eba | 178 | pos->offset += bit_offset; |
fef3bf22 | 179 | printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset); |
fcf10417 JG |
180 | end: |
181 | return ret; | |
0f980a35 MD |
182 | } |
183 | ||
184 | /* | |
185 | * align_pos - align position on a bit offset (> 0) | |
186 | * | |
70fd5a51 MD |
187 | * Return 1 if OK, 0 if out-of-bound. |
188 | * | |
0f980a35 MD |
189 | * TODO: allow larger files by updating base too. |
190 | */ | |
191 | static inline | |
70fd5a51 | 192 | int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset) |
0f980a35 | 193 | { |
70fd5a51 | 194 | return ctf_move_pos(pos, offset_align(pos->offset, bit_offset)); |
0f980a35 MD |
195 | } |
196 | ||
197 | static inline | |
46322b33 | 198 | char *ctf_get_pos_addr(struct ctf_stream_pos *pos) |
0f980a35 MD |
199 | { |
200 | /* Only makes sense to get the address after aligning on CHAR_BIT */ | |
201 | assert(!(pos->offset % CHAR_BIT)); | |
47415068 JD |
202 | return mmap_align_addr(pos->base_mma) + |
203 | pos->mmap_base_offset + (pos->offset / CHAR_BIT); | |
0f980a35 MD |
204 | } |
205 | ||
8c572eba | 206 | static inline |
46322b33 | 207 | void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy) |
8c572eba | 208 | { |
46322b33 | 209 | memcpy(dummy, pos, sizeof(struct ctf_stream_pos)); |
8c572eba MD |
210 | dummy->dummy = 1; |
211 | dummy->fd = -1; | |
212 | } | |
213 | ||
214 | /* | |
215 | * Check if current packet can hold data. | |
216 | * Returns 0 for success, negative error otherwise. | |
217 | */ | |
218 | static inline | |
46322b33 | 219 | int ctf_pos_packet(struct ctf_stream_pos *dummy) |
8c572eba | 220 | { |
90bf3cef | 221 | if (unlikely(dummy->offset > dummy->packet_size)) |
8c572eba MD |
222 | return -ENOSPC; |
223 | return 0; | |
224 | } | |
225 | ||
226 | static inline | |
7b563a77 | 227 | int ctf_pos_pad_packet(struct ctf_stream_pos *pos) |
8c572eba | 228 | { |
42d07a0f | 229 | ctf_packet_seek(&pos->parent, 0, SEEK_CUR); |
7b563a77 | 230 | return bt_packet_seek_get_error(); |
8c572eba MD |
231 | } |
232 | ||
5f643ed7 | 233 | /* |
fd87c903 | 234 | * Update the stream position to the current event. This moves to |
5f643ed7 MD |
235 | * the next packet if we are located at the end of the current packet. |
236 | */ | |
237 | static inline | |
7b563a77 | 238 | int ctf_pos_get_event(struct ctf_stream_pos *pos) |
5f643ed7 | 239 | { |
7b563a77 MD |
240 | int ret = 0; |
241 | ||
5f643ed7 MD |
242 | assert(pos->offset <= pos->content_size); |
243 | if (pos->offset == pos->content_size) { | |
fef3bf22 | 244 | printf_debug("ctf_packet_seek (before call): %" PRId64 "\n", |
5f643ed7 | 245 | pos->offset); |
06789ffd | 246 | pos->packet_seek(&pos->parent, 0, SEEK_CUR); |
fef3bf22 | 247 | printf_debug("ctf_packet_seek (after call): %" PRId64 "\n", |
5f643ed7 | 248 | pos->offset); |
7b563a77 | 249 | ret = bt_packet_seek_get_error(); |
5f643ed7 | 250 | } |
7b563a77 | 251 | return ret; |
5f643ed7 MD |
252 | } |
253 | ||
9e88d150 | 254 | void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream, |
7d97fad9 | 255 | uint64_t timestamp); |
0c880b0a MD |
256 | int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp, |
257 | FILE *metadata_fp); | |
ed093d0e | 258 | void ctf_print_discarded_lost(FILE *fp, struct ctf_stream_definition *stream); |
7d97fad9 | 259 | |
d79865b9 | 260 | #endif /* _BABELTRACE_CTF_TYPES_H */ |