1 #ifndef _BABELTRACE_CTF_TYPES_H
2 #define _BABELTRACE_CTF_TYPES_H
9 * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
22 #include <babeltrace/types.h>
23 #include <babeltrace/babeltrace-internal.h>
24 #include <sys/types.h>
34 struct bt_stream_callbacks
;
37 off_t offset
; /* offset of the packet in the file, in bytes */
38 off_t data_offset
; /* offset of data within the packet, in bits */
39 size_t packet_size
; /* packet size, in bits */
40 size_t content_size
; /* content size, in bits */
41 uint64_t timestamp_begin
;
42 uint64_t timestamp_end
;
46 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
48 struct ctf_stream_pos
{
49 struct stream_pos parent
;
50 int fd
; /* backing file fd. -1 if unset. */
51 GArray
*packet_index
; /* contains struct packet_index */
52 int prot
; /* mmap protection */
53 int flags
; /* mmap flags */
55 /* Current position */
56 off_t mmap_offset
; /* mmap offset in the file, in bytes */
57 size_t packet_size
; /* current packet size, in bits */
58 size_t content_size
; /* current content size, in bits */
59 uint32_t *content_size_loc
; /* pointer to current content size */
60 char *base
; /* mmap base address */
61 ssize_t offset
; /* offset from base, in bits. EOF for end of file. */
62 size_t cur_index
; /* current index in packet index */
64 int dummy
; /* dummy position, for length calculation */
65 struct bt_stream_callbacks
*cb
; /* Callbacks registered for iterator. */
69 struct ctf_stream_pos
*ctf_pos(struct stream_pos
*pos
)
71 return container_of(pos
, struct ctf_stream_pos
, parent
);
74 int ctf_integer_read(struct stream_pos
*pos
, struct definition
*definition
);
75 int ctf_integer_write(struct stream_pos
*pos
, struct definition
*definition
);
76 int ctf_float_read(struct stream_pos
*pos
, struct definition
*definition
);
77 int ctf_float_write(struct stream_pos
*pos
, struct definition
*definition
);
78 int ctf_string_read(struct stream_pos
*pos
, struct definition
*definition
);
79 int ctf_string_write(struct stream_pos
*pos
, struct definition
*definition
);
80 int ctf_enum_read(struct stream_pos
*pos
, struct definition
*definition
);
81 int ctf_enum_write(struct stream_pos
*pos
, struct definition
*definition
);
82 int ctf_struct_rw(struct stream_pos
*pos
, struct definition
*definition
);
83 int ctf_variant_rw(struct stream_pos
*pos
, struct definition
*definition
);
84 int ctf_array_read(struct stream_pos
*pos
, struct definition
*definition
);
85 int ctf_array_write(struct stream_pos
*pos
, struct definition
*definition
);
86 int ctf_sequence_read(struct stream_pos
*pos
, struct definition
*definition
);
87 int ctf_sequence_write(struct stream_pos
*pos
, struct definition
*definition
);
89 void ctf_move_pos_slow(struct ctf_stream_pos
*pos
, size_t offset
, int whence
);
91 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
);
92 void ctf_fini_pos(struct ctf_stream_pos
*pos
);
95 * move_pos - move position of a relative bit offset
97 * TODO: allow larger files by updating base too.
100 void ctf_move_pos(struct ctf_stream_pos
*pos
, size_t bit_offset
)
102 printf_debug("ctf_move_pos test EOF: %zd\n", pos
->offset
);
103 if (unlikely(pos
->offset
== EOF
))
108 * PROT_READ ctf_move_pos_slow is called from within
109 * ctf_pos_get_event so end of packet does not change
110 * the packet context on for the last event of the
113 if ((pos
->prot
== PROT_WRITE
)
114 && (unlikely(pos
->offset
+ bit_offset
>= pos
->packet_size
))) {
115 printf_debug("ctf_move_pos_slow (before call): %zd\n",
117 ctf_move_pos_slow(pos
, bit_offset
, SEEK_CUR
);
118 printf_debug("ctf_move_pos_slow (after call): %zd\n",
123 pos
->offset
+= bit_offset
;
124 printf_debug("ctf_move_pos after increment: %zd\n", pos
->offset
);
128 * align_pos - align position on a bit offset (> 0)
130 * TODO: allow larger files by updating base too.
133 void ctf_align_pos(struct ctf_stream_pos
*pos
, size_t bit_offset
)
135 ctf_move_pos(pos
, offset_align(pos
->offset
, bit_offset
));
139 char *ctf_get_pos_addr(struct ctf_stream_pos
*pos
)
141 /* Only makes sense to get the address after aligning on CHAR_BIT */
142 assert(!(pos
->offset
% CHAR_BIT
));
143 return pos
->base
+ (pos
->offset
/ CHAR_BIT
);
147 void ctf_dummy_pos(struct ctf_stream_pos
*pos
, struct ctf_stream_pos
*dummy
)
149 memcpy(dummy
, pos
, sizeof(struct ctf_stream_pos
));
155 * Check if current packet can hold data.
156 * Returns 0 for success, negative error otherwise.
159 int ctf_pos_packet(struct ctf_stream_pos
*dummy
)
161 if (unlikely(dummy
->offset
> dummy
->packet_size
))
167 void ctf_pos_pad_packet(struct ctf_stream_pos
*pos
)
169 ctf_move_pos(pos
, pos
->packet_size
- pos
->offset
);
173 int ctf_pos_access_ok(struct ctf_stream_pos
*pos
, size_t bit_len
)
175 if (unlikely(pos
->offset
== EOF
))
177 if (unlikely(pos
->offset
+ bit_len
> pos
->packet_size
))
183 * Update the stream position for to the current event. This moves to
184 * the next packet if we are located at the end of the current packet.
187 void ctf_pos_get_event(struct ctf_stream_pos
*pos
)
189 assert(pos
->offset
<= pos
->content_size
);
190 if (pos
->offset
== pos
->content_size
) {
191 printf_debug("ctf_move_pos_slow (before call): %zd\n",
193 ctf_move_pos_slow(pos
, 0, SEEK_CUR
);
194 printf_debug("ctf_move_pos_slow (after call): %zd\n",
199 #endif /* _BABELTRACE_CTF_TYPES_H */
This page took 0.033537 seconds and 4 git commands to generate.