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 uint64_t packet_size
; /* packet size, in bits */
40 uint64_t content_size
; /* content size, in bits */
41 uint64_t timestamp_begin
;
42 uint64_t timestamp_end
;
43 uint64_t events_discarded
;
44 size_t events_discarded_len
; /* length of the field, in bits */
48 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
50 struct ctf_stream_pos
{
51 struct stream_pos parent
;
52 int fd
; /* backing file fd. -1 if unset. */
53 GArray
*packet_index
; /* contains struct packet_index */
54 int prot
; /* mmap protection */
55 int flags
; /* mmap flags */
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 */
61 uint32_t *content_size_loc
; /* pointer to current content size */
62 char *base
; /* mmap base address */
63 ssize_t offset
; /* offset from base, in bits. EOF for end of file. */
64 ssize_t last_offset
; /* offset before the last read_event */
65 size_t cur_index
; /* current index in packet index */
66 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
67 int whence
); /* function called to switch packet */
69 int dummy
; /* dummy position, for length calculation */
70 struct bt_stream_callbacks
*cb
; /* Callbacks registered for iterator. */
74 struct ctf_stream_pos
*ctf_pos(struct stream_pos
*pos
)
76 return container_of(pos
, struct ctf_stream_pos
, parent
);
79 int ctf_integer_read(struct stream_pos
*pos
, struct definition
*definition
);
80 int ctf_integer_write(struct stream_pos
*pos
, struct definition
*definition
);
81 int ctf_float_read(struct stream_pos
*pos
, struct definition
*definition
);
82 int ctf_float_write(struct stream_pos
*pos
, struct definition
*definition
);
83 int ctf_string_read(struct stream_pos
*pos
, struct definition
*definition
);
84 int ctf_string_write(struct stream_pos
*pos
, struct definition
*definition
);
85 int ctf_enum_read(struct stream_pos
*pos
, struct definition
*definition
);
86 int ctf_enum_write(struct stream_pos
*pos
, struct definition
*definition
);
87 int ctf_struct_rw(struct stream_pos
*pos
, struct definition
*definition
);
88 int ctf_variant_rw(struct stream_pos
*pos
, struct definition
*definition
);
89 int ctf_array_read(struct stream_pos
*pos
, struct definition
*definition
);
90 int ctf_array_write(struct stream_pos
*pos
, struct definition
*definition
);
91 int ctf_sequence_read(struct stream_pos
*pos
, struct definition
*definition
);
92 int ctf_sequence_write(struct stream_pos
*pos
, struct definition
*definition
);
94 void ctf_packet_seek(struct stream_pos
*pos
, size_t index
, int whence
);
96 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
);
97 void ctf_fini_pos(struct ctf_stream_pos
*pos
);
100 * move_pos - move position of a relative bit offset
102 * TODO: allow larger files by updating base too.
105 void ctf_move_pos(struct ctf_stream_pos
*pos
, size_t bit_offset
)
107 printf_debug("ctf_move_pos test EOF: %zd\n", pos
->offset
);
108 if (unlikely(pos
->offset
== EOF
))
113 * PROT_READ ctf_packet_seek is called from within
114 * ctf_pos_get_event so end of packet does not change
115 * the packet context on for the last event of the
118 if ((pos
->prot
== PROT_WRITE
)
119 && (unlikely(pos
->offset
+ bit_offset
>= pos
->packet_size
))) {
120 printf_debug("ctf_packet_seek (before call): %zd\n",
122 ctf_packet_seek(&pos
->parent
, 0, SEEK_CUR
);
123 printf_debug("ctf_packet_seek (after call): %zd\n",
128 pos
->offset
+= bit_offset
;
129 printf_debug("ctf_move_pos after increment: %zd\n", pos
->offset
);
133 * align_pos - align position on a bit offset (> 0)
135 * TODO: allow larger files by updating base too.
138 void ctf_align_pos(struct ctf_stream_pos
*pos
, size_t bit_offset
)
140 ctf_move_pos(pos
, offset_align(pos
->offset
, bit_offset
));
144 char *ctf_get_pos_addr(struct ctf_stream_pos
*pos
)
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
);
152 void ctf_dummy_pos(struct ctf_stream_pos
*pos
, struct ctf_stream_pos
*dummy
)
154 memcpy(dummy
, pos
, sizeof(struct ctf_stream_pos
));
160 * Check if current packet can hold data.
161 * Returns 0 for success, negative error otherwise.
164 int ctf_pos_packet(struct ctf_stream_pos
*dummy
)
166 if (unlikely(dummy
->offset
> dummy
->packet_size
))
172 void ctf_pos_pad_packet(struct ctf_stream_pos
*pos
)
174 ctf_move_pos(pos
, pos
->packet_size
- pos
->offset
);
178 int ctf_pos_access_ok(struct ctf_stream_pos
*pos
, size_t bit_len
)
180 if (unlikely(pos
->offset
== EOF
))
182 if (unlikely(pos
->offset
+ bit_len
> pos
->packet_size
))
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.
192 void ctf_pos_get_event(struct ctf_stream_pos
*pos
)
194 assert(pos
->offset
<= pos
->content_size
);
195 if (pos
->offset
== pos
->content_size
) {
196 printf_debug("ctf_packet_seek (before call): %zd\n",
198 pos
->packet_seek(&pos
->parent
, 0, SEEK_CUR
);
199 printf_debug("ctf_packet_seek (after call): %zd\n",
204 void ctf_print_timestamp(FILE *fp
, struct ctf_stream_definition
*stream
,
207 #endif /* _BABELTRACE_CTF_TYPES_H */
This page took 0.034833 seconds and 5 git commands to generate.