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