Fix: Don't assume that PROT_WRITE grants read permissions
[babeltrace.git] / include / babeltrace / ctf / types.h
CommitLineData
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
45struct bt_stream_callbacks;
46
992e8cc0
MD
47struct packet_index_time {
48 uint64_t timestamp_begin;
49 uint64_t timestamp_end;
50};
51
0f980a35
MD
52struct 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 */
dd2544fd
MD
61};
62
dd2544fd 63/*
46322b33 64 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
dd2544fd 65 */
46322b33 66struct ctf_stream_pos {
1cf393f6 67 struct bt_stream_pos parent;
0f980a35 68 int fd; /* backing file fd. -1 if unset. */
0ace7505 69 FILE *index_fp; /* backing index file fp. NULL if unset. */
992e8cc0 70 GArray *packet_index; /* contains struct packet_index */
8c572eba
MD
71 int prot; /* mmap protection */
72 int flags; /* mmap flags */
dd2544fd 73
0f980a35
MD
74 /* Current position */
75 off_t mmap_offset; /* mmap offset in the file, in bytes */
47415068 76 off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */
fef3bf22
MD
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 */
aee35fcc 80 struct mmap_align *base_mma;/* mmap base address */
fef3bf22
MD
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 */
500634be 83 int64_t data_offset; /* offset of data in current packet */
fef3bf22 84 uint64_t cur_index; /* current index in packet index */
f60efc0e 85 uint64_t last_events_discarded; /* last known amount of event discarded */
1cf393f6 86 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
b086c01a 87 int whence); /* function called to switch packet */
dd2544fd 88
0f980a35 89 int dummy; /* dummy position, for length calculation */
c34ccddd 90 struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */
731087d8 91 void *priv;
0f980a35 92};
dd2544fd 93
46322b33 94static inline
1cf393f6 95struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos)
46322b33
MD
96{
97 return container_of(pos, struct ctf_stream_pos, parent);
98}
99
2e937fb4 100BT_HIDDEN
0d69b916 101int ctf_integer_read(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 102BT_HIDDEN
0d69b916 103int ctf_integer_write(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 104BT_HIDDEN
0d69b916 105int ctf_float_read(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 106BT_HIDDEN
0d69b916 107int ctf_float_write(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 108BT_HIDDEN
0d69b916 109int ctf_string_read(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 110BT_HIDDEN
0d69b916 111int ctf_string_write(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 112BT_HIDDEN
0d69b916 113int ctf_enum_read(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 114BT_HIDDEN
0d69b916 115int ctf_enum_write(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 116BT_HIDDEN
0d69b916 117int ctf_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 118BT_HIDDEN
0d69b916 119int ctf_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 120BT_HIDDEN
0d69b916 121int ctf_array_read(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 122BT_HIDDEN
0d69b916 123int ctf_array_write(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 124BT_HIDDEN
0d69b916 125int ctf_sequence_read(struct bt_stream_pos *pos, struct bt_definition *definition);
2e937fb4 126BT_HIDDEN
0d69b916 127int ctf_sequence_write(struct bt_stream_pos *pos, struct bt_definition *definition);
6dc2ca62 128
1cf393f6 129void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence);
0f980a35 130
ca334c72
MD
131int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
132 int fd, int open_flags);
f824ae04 133int ctf_fini_pos(struct ctf_stream_pos *pos);
0f980a35 134
fcf10417
JG
135static inline
136int 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
0f980a35
MD
157/*
158 * move_pos - move position of a relative bit offset
159 *
70fd5a51
MD
160 * Return 1 if OK, 0 if out-of-bound.
161 *
0f980a35
MD
162 * TODO: allow larger files by updating base too.
163 */
164static inline
70fd5a51 165int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
0f980a35 166{
fcf10417 167 int ret = 0;
70fd5a51 168
fef3bf22 169 printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
fcf10417
JG
170 ret = ctf_pos_access_ok(pos, bit_offset);
171 if (!ret) {
172 goto end;
173 }
8c572eba 174 pos->offset += bit_offset;
fef3bf22 175 printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
fcf10417
JG
176end:
177 return ret;
0f980a35
MD
178}
179
180/*
181 * align_pos - align position on a bit offset (> 0)
182 *
70fd5a51
MD
183 * Return 1 if OK, 0 if out-of-bound.
184 *
0f980a35
MD
185 * TODO: allow larger files by updating base too.
186 */
187static inline
70fd5a51 188int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
0f980a35 189{
70fd5a51 190 return ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
0f980a35
MD
191}
192
193static inline
46322b33 194char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
0f980a35
MD
195{
196 /* Only makes sense to get the address after aligning on CHAR_BIT */
197 assert(!(pos->offset % CHAR_BIT));
47415068
JD
198 return mmap_align_addr(pos->base_mma) +
199 pos->mmap_base_offset + (pos->offset / CHAR_BIT);
0f980a35
MD
200}
201
8c572eba 202static inline
46322b33 203void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
8c572eba 204{
46322b33 205 memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
8c572eba
MD
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 */
214static inline
46322b33 215int ctf_pos_packet(struct ctf_stream_pos *dummy)
8c572eba 216{
90bf3cef 217 if (unlikely(dummy->offset > dummy->packet_size))
8c572eba
MD
218 return -ENOSPC;
219 return 0;
220}
221
222static inline
46322b33 223void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
8c572eba 224{
42d07a0f 225 ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
8c572eba
MD
226}
227
5f643ed7 228/*
fd87c903 229 * Update the stream position to the current event. This moves to
5f643ed7
MD
230 * the next packet if we are located at the end of the current packet.
231 */
232static inline
233void ctf_pos_get_event(struct ctf_stream_pos *pos)
234{
235 assert(pos->offset <= pos->content_size);
236 if (pos->offset == pos->content_size) {
fef3bf22 237 printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
5f643ed7 238 pos->offset);
06789ffd 239 pos->packet_seek(&pos->parent, 0, SEEK_CUR);
fef3bf22 240 printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
5f643ed7
MD
241 pos->offset);
242 }
243}
244
9e88d150 245void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream,
7d97fad9 246 uint64_t timestamp);
0c880b0a
MD
247int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
248 FILE *metadata_fp);
7d97fad9 249
d79865b9 250#endif /* _BABELTRACE_CTF_TYPES_H */
This page took 0.042477 seconds and 4 git commands to generate.