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