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