Fix: Don't assume that PROT_WRITE grants read permissions
[babeltrace.git] / include / babeltrace / ctf / types.h
1 #ifndef _BABELTRACE_CTF_TYPES_H
2 #define _BABELTRACE_CTF_TYPES_H
3
4 /*
5 * Common Trace Format
6 *
7 * Type header
8 *
9 * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 *
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:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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.
28 */
29
30 #include <babeltrace/types.h>
31 #include <babeltrace/babeltrace-internal.h>
32 #include <sys/types.h>
33 #include <sys/stat.h>
34 #include <fcntl.h>
35 #include <errno.h>
36 #include <stdint.h>
37 #include <unistd.h>
38 #include <glib.h>
39 #include <stdio.h>
40 #include <inttypes.h>
41 #include <babeltrace/mmap-align.h>
42
43 #define LAST_OFFSET_POISON ((int64_t) ~0ULL)
44
45 struct bt_stream_callbacks;
46
47 struct packet_index_time {
48 uint64_t timestamp_begin;
49 uint64_t timestamp_end;
50 };
51
52 struct packet_index {
53 off_t offset; /* offset of the packet in the file, in bytes */
54 int64_t data_offset; /* offset of data within the packet, in bits */
55 uint64_t packet_size; /* packet size, in bits */
56 uint64_t content_size; /* content size, in bits */
57 uint64_t events_discarded;
58 uint64_t events_discarded_len; /* length of the field, in bits */
59 struct packet_index_time ts_cycles; /* timestamp in cycles */
60 struct packet_index_time ts_real; /* realtime timestamp */
61 };
62
63 /*
64 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
65 */
66 struct ctf_stream_pos {
67 struct bt_stream_pos parent;
68 int fd; /* backing file fd. -1 if unset. */
69 FILE *index_fp; /* backing index file fp. NULL if unset. */
70 GArray *packet_index; /* contains struct packet_index */
71 int prot; /* mmap protection */
72 int flags; /* mmap flags */
73
74 /* Current position */
75 off_t mmap_offset; /* mmap offset in the file, in bytes */
76 off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */
77 uint64_t packet_size; /* current packet size, in bits */
78 uint64_t content_size; /* current content size, in bits */
79 uint64_t *content_size_loc; /* pointer to current content size */
80 struct mmap_align *base_mma;/* mmap base address */
81 int64_t offset; /* offset from base, in bits. EOF for end of file. */
82 int64_t last_offset; /* offset before the last read_event */
83 int64_t data_offset; /* offset of data in current packet */
84 uint64_t cur_index; /* current index in packet index */
85 uint64_t last_events_discarded; /* last known amount of event discarded */
86 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
87 int whence); /* function called to switch packet */
88
89 int dummy; /* dummy position, for length calculation */
90 struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */
91 void *priv;
92 };
93
94 static inline
95 struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos)
96 {
97 return container_of(pos, struct ctf_stream_pos, parent);
98 }
99
100 BT_HIDDEN
101 int ctf_integer_read(struct bt_stream_pos *pos, struct bt_definition *definition);
102 BT_HIDDEN
103 int ctf_integer_write(struct bt_stream_pos *pos, struct bt_definition *definition);
104 BT_HIDDEN
105 int ctf_float_read(struct bt_stream_pos *pos, struct bt_definition *definition);
106 BT_HIDDEN
107 int ctf_float_write(struct bt_stream_pos *pos, struct bt_definition *definition);
108 BT_HIDDEN
109 int ctf_string_read(struct bt_stream_pos *pos, struct bt_definition *definition);
110 BT_HIDDEN
111 int ctf_string_write(struct bt_stream_pos *pos, struct bt_definition *definition);
112 BT_HIDDEN
113 int ctf_enum_read(struct bt_stream_pos *pos, struct bt_definition *definition);
114 BT_HIDDEN
115 int ctf_enum_write(struct bt_stream_pos *pos, struct bt_definition *definition);
116 BT_HIDDEN
117 int ctf_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
118 BT_HIDDEN
119 int ctf_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
120 BT_HIDDEN
121 int ctf_array_read(struct bt_stream_pos *pos, struct bt_definition *definition);
122 BT_HIDDEN
123 int ctf_array_write(struct bt_stream_pos *pos, struct bt_definition *definition);
124 BT_HIDDEN
125 int ctf_sequence_read(struct bt_stream_pos *pos, struct bt_definition *definition);
126 BT_HIDDEN
127 int ctf_sequence_write(struct bt_stream_pos *pos, struct bt_definition *definition);
128
129 void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence);
130
131 int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
132 int fd, int open_flags);
133 int ctf_fini_pos(struct ctf_stream_pos *pos);
134
135 static inline
136 int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
137 {
138 uint64_t max_len;
139
140 if (unlikely(pos->offset == EOF))
141 return 0;
142 if (pos->prot == PROT_READ) {
143 /*
144 * Reads may only reach up to the "content_size",
145 * regardless of the packet_size.
146 */
147 max_len = pos->content_size;
148 } else {
149 /* Writes may take place up to the end of the packet. */
150 max_len = pos->packet_size;
151 }
152 if (unlikely(pos->offset + bit_len > max_len))
153 return 0;
154 return 1;
155 }
156
157 /*
158 * move_pos - move position of a relative bit offset
159 *
160 * Return 1 if OK, 0 if out-of-bound.
161 *
162 * TODO: allow larger files by updating base too.
163 */
164 static inline
165 int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
166 {
167 int ret = 0;
168
169 printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
170 ret = ctf_pos_access_ok(pos, bit_offset);
171 if (!ret) {
172 goto end;
173 }
174 pos->offset += bit_offset;
175 printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
176 end:
177 return ret;
178 }
179
180 /*
181 * align_pos - align position on a bit offset (> 0)
182 *
183 * Return 1 if OK, 0 if out-of-bound.
184 *
185 * TODO: allow larger files by updating base too.
186 */
187 static inline
188 int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
189 {
190 return ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
191 }
192
193 static inline
194 char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
195 {
196 /* Only makes sense to get the address after aligning on CHAR_BIT */
197 assert(!(pos->offset % CHAR_BIT));
198 return mmap_align_addr(pos->base_mma) +
199 pos->mmap_base_offset + (pos->offset / CHAR_BIT);
200 }
201
202 static inline
203 void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
204 {
205 memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
206 dummy->dummy = 1;
207 dummy->fd = -1;
208 }
209
210 /*
211 * Check if current packet can hold data.
212 * Returns 0 for success, negative error otherwise.
213 */
214 static inline
215 int ctf_pos_packet(struct ctf_stream_pos *dummy)
216 {
217 if (unlikely(dummy->offset > dummy->packet_size))
218 return -ENOSPC;
219 return 0;
220 }
221
222 static inline
223 void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
224 {
225 ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
226 }
227
228 /*
229 * Update the stream position to the current event. This moves to
230 * the next packet if we are located at the end of the current packet.
231 */
232 static inline
233 void ctf_pos_get_event(struct ctf_stream_pos *pos)
234 {
235 assert(pos->offset <= pos->content_size);
236 if (pos->offset == pos->content_size) {
237 printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
238 pos->offset);
239 pos->packet_seek(&pos->parent, 0, SEEK_CUR);
240 printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
241 pos->offset);
242 }
243 }
244
245 void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream,
246 uint64_t timestamp);
247 int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
248 FILE *metadata_fp);
249
250 #endif /* _BABELTRACE_CTF_TYPES_H */
This page took 0.033574 seconds and 4 git commands to generate.