Change -EOF for EOF (it is worth -1), fix assertion
[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.h>
24 #include <sys/types.h>
25 #include <sys/stat.h>
26 #include <fcntl.h>
27 #include <sys/mman.h>
28 #include <errno.h>
29 #include <stdint.h>
30 #include <unistd.h>
31 #include <glib.h>
32 #include <stdio.h>
33
34 struct packet_index {
35 off_t offset; /* offset of the packet in the file, in bytes */
36 off_t data_offset; /* offset of data within the packet */
37 size_t packet_size; /* packet size, in bits */
38 size_t content_size; /* content size, in bits */
39 };
40
41 /*
42 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
43 */
44 struct ctf_stream_pos {
45 struct stream_pos parent;
46 int fd; /* backing file fd. -1 if unset. */
47 GArray *packet_index; /* contains struct packet_index */
48 int prot; /* mmap protection */
49 int flags; /* mmap flags */
50
51 /* Current position */
52 off_t mmap_offset; /* mmap offset in the file, in bytes */
53 size_t packet_size; /* current packet size, in bits */
54 size_t content_size; /* current content size, in bits */
55 uint32_t *content_size_loc; /* pointer to current content size */
56 char *base; /* mmap base address */
57 ssize_t offset; /* offset from base, in bits. EOF for end of file. */
58 size_t cur_index; /* current index in packet index */
59
60 int dummy; /* dummy position, for length calculation */
61 };
62
63 static inline
64 struct ctf_stream_pos *ctf_pos(struct stream_pos *pos)
65 {
66 return container_of(pos, struct ctf_stream_pos, parent);
67 }
68
69 int ctf_integer_read(struct stream_pos *pos, struct definition *definition);
70 int ctf_integer_write(struct stream_pos *pos, struct definition *definition);
71 int ctf_float_read(struct stream_pos *pos, struct definition *definition);
72 int ctf_float_write(struct stream_pos *pos, struct definition *definition);
73 int ctf_string_read(struct stream_pos *pos, struct definition *definition);
74 int ctf_string_write(struct stream_pos *pos, struct definition *definition);
75 int ctf_enum_read(struct stream_pos *pos, struct definition *definition);
76 int ctf_enum_write(struct stream_pos *pos, struct definition *definition);
77 int ctf_struct_rw(struct stream_pos *pos, struct definition *definition);
78 int ctf_variant_rw(struct stream_pos *pos, struct definition *definition);
79 int ctf_array_rw(struct stream_pos *pos, struct definition *definition);
80 int ctf_sequence_rw(struct stream_pos *pos, struct definition *definition);
81
82 void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence);
83
84 void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags);
85 void ctf_fini_pos(struct ctf_stream_pos *pos);
86
87 /*
88 * move_pos - move position of a relative bit offset
89 *
90 * TODO: allow larger files by updating base too.
91 */
92 static inline
93 void ctf_move_pos(struct ctf_stream_pos *pos, size_t bit_offset)
94 {
95 printf_debug("ctf_move_pos test EOF: %zd\n", pos->offset);
96 if (pos->offset == EOF)
97 return;
98
99 if (pos->fd >= 0) {
100 if (((pos->prot == PROT_READ)
101 && (pos->offset + bit_offset >= pos->content_size))
102 || ((pos->prot == PROT_WRITE)
103 && (pos->offset + bit_offset >= pos->packet_size))) {
104 printf_debug("ctf_move_pos_slow (before call): %zd\n",
105 pos->offset);
106 ctf_move_pos_slow(pos, bit_offset, SEEK_CUR);
107 printf_debug("ctf_move_pos_slow (after call): %zd\n",
108 pos->offset);
109 return;
110 }
111 }
112 pos->offset += bit_offset;
113 printf_debug("ctf_move_pos after increment: %zd\n", pos->offset);
114 }
115
116 /*
117 * align_pos - align position on a bit offset (> 0)
118 *
119 * TODO: allow larger files by updating base too.
120 */
121 static inline
122 void ctf_align_pos(struct ctf_stream_pos *pos, size_t bit_offset)
123 {
124 ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
125 }
126
127 static inline
128 char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
129 {
130 /* Only makes sense to get the address after aligning on CHAR_BIT */
131 assert(!(pos->offset % CHAR_BIT));
132 return pos->base + (pos->offset / CHAR_BIT);
133 }
134
135 static inline
136 void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
137 {
138 memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
139 dummy->dummy = 1;
140 dummy->fd = -1;
141 }
142
143 /*
144 * Check if current packet can hold data.
145 * Returns 0 for success, negative error otherwise.
146 */
147 static inline
148 int ctf_pos_packet(struct ctf_stream_pos *dummy)
149 {
150 if (dummy->offset > dummy->packet_size)
151 return -ENOSPC;
152 return 0;
153 }
154
155 static inline
156 void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
157 {
158 ctf_move_pos(pos, pos->packet_size - pos->offset);
159 }
160
161 static inline
162 int ctf_pos_access_ok(struct ctf_stream_pos *pos, size_t bit_len)
163 {
164 if (pos->offset == EOF)
165 return 0;
166 if (pos->offset + bit_len > pos->packet_size)
167 return 0;
168 return 1;
169 }
170
171 #endif /* _BABELTRACE_CTF_TYPES_H */
This page took 0.0318 seconds and 4 git commands to generate.