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