Add missing permission notice in each source file
[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
0f980a35
MD
47struct packet_index {
48 off_t offset; /* offset of the packet in the file, in bytes */
fef3bf22 49 int64_t data_offset; /* offset of data within the packet, in bits */
7e18eedf
JN
50 uint64_t packet_size; /* packet size, in bits */
51 uint64_t content_size; /* content size, in bits */
75cc2c35
MD
52 uint64_t timestamp_begin;
53 uint64_t timestamp_end;
4c4ba021 54 uint64_t events_discarded;
fef3bf22 55 uint64_t events_discarded_len; /* length of the field, in bits */
dd2544fd
MD
56};
57
dd2544fd 58/*
46322b33 59 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
dd2544fd 60 */
46322b33
MD
61struct ctf_stream_pos {
62 struct stream_pos parent;
0f980a35 63 int fd; /* backing file fd. -1 if unset. */
03798a93
JD
64 GArray *packet_cycles_index; /* contains struct packet_index in cycles */
65 GArray *packet_real_index; /* contains struct packet_index in ns */
8c572eba
MD
66 int prot; /* mmap protection */
67 int flags; /* mmap flags */
dd2544fd 68
0f980a35
MD
69 /* Current position */
70 off_t mmap_offset; /* mmap offset in the file, in bytes */
47415068 71 off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */
fef3bf22
MD
72 uint64_t packet_size; /* current packet size, in bits */
73 uint64_t content_size; /* current content size, in bits */
74 uint64_t *content_size_loc; /* pointer to current content size */
aee35fcc 75 struct mmap_align *base_mma;/* mmap base address */
fef3bf22
MD
76 int64_t offset; /* offset from base, in bits. EOF for end of file. */
77 int64_t last_offset; /* offset before the last read_event */
78 uint64_t cur_index; /* current index in packet index */
f60efc0e 79 uint64_t last_events_discarded; /* last known amount of event discarded */
20d0dcf9 80 void (*packet_seek)(struct stream_pos *pos, size_t index,
b086c01a 81 int whence); /* function called to switch packet */
dd2544fd 82
0f980a35 83 int dummy; /* dummy position, for length calculation */
c34ccddd 84 struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */
0f980a35 85};
dd2544fd 86
46322b33
MD
87static inline
88struct ctf_stream_pos *ctf_pos(struct stream_pos *pos)
89{
90 return container_of(pos, struct ctf_stream_pos, parent);
91}
92
c5e74408
MD
93int ctf_integer_read(struct stream_pos *pos, struct definition *definition);
94int ctf_integer_write(struct stream_pos *pos, struct definition *definition);
95int ctf_float_read(struct stream_pos *pos, struct definition *definition);
96int ctf_float_write(struct stream_pos *pos, struct definition *definition);
97int ctf_string_read(struct stream_pos *pos, struct definition *definition);
98int ctf_string_write(struct stream_pos *pos, struct definition *definition);
99int ctf_enum_read(struct stream_pos *pos, struct definition *definition);
100int ctf_enum_write(struct stream_pos *pos, struct definition *definition);
101int ctf_struct_rw(struct stream_pos *pos, struct definition *definition);
102int ctf_variant_rw(struct stream_pos *pos, struct definition *definition);
81dee1bb
MD
103int ctf_array_read(struct stream_pos *pos, struct definition *definition);
104int ctf_array_write(struct stream_pos *pos, struct definition *definition);
105int ctf_sequence_read(struct stream_pos *pos, struct definition *definition);
106int ctf_sequence_write(struct stream_pos *pos, struct definition *definition);
6dc2ca62 107
20d0dcf9 108void ctf_packet_seek(struct stream_pos *pos, size_t index, int whence);
0f980a35 109
f824ae04
MD
110int ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags);
111int ctf_fini_pos(struct ctf_stream_pos *pos);
0f980a35
MD
112
113/*
114 * move_pos - move position of a relative bit offset
115 *
116 * TODO: allow larger files by updating base too.
117 */
118static inline
fef3bf22 119void ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
0f980a35 120{
fef3bf22 121 printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
90bf3cef 122 if (unlikely(pos->offset == EOF))
c5e74408
MD
123 return;
124
8c572eba 125 if (pos->fd >= 0) {
5f643ed7 126 /*
06789ffd 127 * PROT_READ ctf_packet_seek is called from within
5f643ed7
MD
128 * ctf_pos_get_event so end of packet does not change
129 * the packet context on for the last event of the
130 * packet.
131 */
132 if ((pos->prot == PROT_WRITE)
90bf3cef 133 && (unlikely(pos->offset + bit_offset >= pos->packet_size))) {
fef3bf22 134 printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
670977d3 135 pos->offset);
20d0dcf9 136 ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
fef3bf22 137 printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
670977d3 138 pos->offset);
8c572eba
MD
139 return;
140 }
141 }
142 pos->offset += bit_offset;
fef3bf22 143 printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
0f980a35
MD
144}
145
146/*
147 * align_pos - align position on a bit offset (> 0)
148 *
149 * TODO: allow larger files by updating base too.
150 */
151static inline
fef3bf22 152void ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
0f980a35 153{
46322b33 154 ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
0f980a35
MD
155}
156
157static inline
46322b33 158char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
0f980a35
MD
159{
160 /* Only makes sense to get the address after aligning on CHAR_BIT */
161 assert(!(pos->offset % CHAR_BIT));
47415068
JD
162 return mmap_align_addr(pos->base_mma) +
163 pos->mmap_base_offset + (pos->offset / CHAR_BIT);
0f980a35
MD
164}
165
8c572eba 166static inline
46322b33 167void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
8c572eba 168{
46322b33 169 memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
8c572eba
MD
170 dummy->dummy = 1;
171 dummy->fd = -1;
172}
173
174/*
175 * Check if current packet can hold data.
176 * Returns 0 for success, negative error otherwise.
177 */
178static inline
46322b33 179int ctf_pos_packet(struct ctf_stream_pos *dummy)
8c572eba 180{
90bf3cef 181 if (unlikely(dummy->offset > dummy->packet_size))
8c572eba
MD
182 return -ENOSPC;
183 return 0;
184}
185
186static inline
46322b33 187void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
8c572eba 188{
46322b33 189 ctf_move_pos(pos, pos->packet_size - pos->offset);
8c572eba
MD
190}
191
c5e74408 192static inline
fef3bf22 193int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
c5e74408 194{
90bf3cef 195 if (unlikely(pos->offset == EOF))
c5e74408 196 return 0;
90bf3cef 197 if (unlikely(pos->offset + bit_len > pos->packet_size))
c5e74408
MD
198 return 0;
199 return 1;
200}
201
5f643ed7
MD
202/*
203 * Update the stream position for to the current event. This moves to
204 * the next packet if we are located at the end of the current packet.
205 */
206static inline
207void ctf_pos_get_event(struct ctf_stream_pos *pos)
208{
209 assert(pos->offset <= pos->content_size);
210 if (pos->offset == pos->content_size) {
fef3bf22 211 printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
5f643ed7 212 pos->offset);
06789ffd 213 pos->packet_seek(&pos->parent, 0, SEEK_CUR);
fef3bf22 214 printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
5f643ed7
MD
215 pos->offset);
216 }
217}
218
9e88d150 219void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream,
7d97fad9
MD
220 uint64_t timestamp);
221
d79865b9 222#endif /* _BABELTRACE_CTF_TYPES_H */
This page took 0.058152 seconds and 4 git commands to generate.