*
* Type header
*
- * Copyright (c) 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
+#include <babeltrace/types.h>
+#include <babeltrace/babeltrace-internal.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <errno.h>
#include <stdint.h>
+#include <unistd.h>
#include <glib.h>
+#include <stdio.h>
+#include <inttypes.h>
+#include <babeltrace/mmap-align.h>
+
+#define LAST_OFFSET_POISON ((int64_t) ~0ULL)
+
+struct bt_stream_callbacks;
+
+struct packet_index_time {
+ uint64_t timestamp_begin;
+ uint64_t timestamp_end;
+};
+
+struct packet_index {
+ off_t offset; /* offset of the packet in the file, in bytes */
+ int64_t data_offset; /* offset of data within the packet, in bits */
+ uint64_t packet_size; /* packet size, in bits */
+ uint64_t content_size; /* content size, in bits */
+ uint64_t events_discarded;
+ uint64_t events_discarded_len; /* length of the field, in bits */
+ struct packet_index_time ts_cycles; /* timestamp in cycles */
+ struct packet_index_time ts_real; /* realtime timestamp */
+};
+
+/*
+ * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
+ */
+struct ctf_stream_pos {
+ struct bt_stream_pos parent;
+ int fd; /* backing file fd. -1 if unset. */
+ FILE *index_fp; /* backing index file fp. NULL if unset. */
+ GArray *packet_index; /* contains struct packet_index */
+ int prot; /* mmap protection */
+ int flags; /* mmap flags */
+
+ /* Current position */
+ off_t mmap_offset; /* mmap offset in the file, in bytes */
+ off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */
+ uint64_t packet_size; /* current packet size, in bits */
+ uint64_t content_size; /* current content size, in bits */
+ uint64_t *content_size_loc; /* pointer to current content size */
+ struct mmap_align *base_mma;/* mmap base address */
+ int64_t offset; /* offset from base, in bits. EOF for end of file. */
+ int64_t last_offset; /* offset before the last read_event */
+ int64_t data_offset; /* offset of data in current packet */
+ uint64_t cur_index; /* current index in packet index */
+ uint64_t last_events_discarded; /* last known amount of event discarded */
+ void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
+ int whence); /* function called to switch packet */
+
+ int dummy; /* dummy position, for length calculation */
+ struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */
+ void *priv;
+};
+
+static inline
+struct ctf_stream_pos *ctf_pos(struct bt_stream_pos *pos)
+{
+ return container_of(pos, struct ctf_stream_pos, parent);
+}
+
+BT_HIDDEN
+int ctf_integer_read(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_integer_write(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_float_read(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_float_write(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_string_read(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_string_write(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_enum_read(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_enum_write(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_variant_rw(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_array_read(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_array_write(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_sequence_read(struct bt_stream_pos *pos, struct bt_definition *definition);
+BT_HIDDEN
+int ctf_sequence_write(struct bt_stream_pos *pos, struct bt_definition *definition);
+
+void ctf_packet_seek(struct bt_stream_pos *pos, size_t index, int whence);
+
+int ctf_init_pos(struct ctf_stream_pos *pos, struct bt_trace_descriptor *trace,
+ int fd, int open_flags);
+int ctf_fini_pos(struct ctf_stream_pos *pos);
+
+static inline
+int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len)
+{
+ uint64_t max_len;
+
+ if (unlikely(pos->offset == EOF))
+ return 0;
+ if (pos->prot == PROT_READ) {
+ /*
+ * Reads may only reach up to the "content_size",
+ * regardless of the packet_size.
+ */
+ max_len = pos->content_size;
+ } else {
+ /* Writes may take place up to the end of the packet. */
+ max_len = pos->packet_size;
+ }
+ if (unlikely(pos->offset + bit_len > max_len))
+ return 0;
+ return 1;
+}
+
+/*
+ * move_pos - move position of a relative bit offset
+ *
+ * Return 1 if OK, 0 if out-of-bound.
+ *
+ * TODO: allow larger files by updating base too.
+ */
+static inline
+int ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
+{
+ int ret = 0;
+
+ printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset);
+ ret = ctf_pos_access_ok(pos, bit_offset);
+ if (!ret) {
+ goto end;
+ }
+ pos->offset += bit_offset;
+ printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset);
+end:
+ return ret;
+}
/*
- * IMPORTANT: All lengths (len) and offsets (start, end) are expressed in bits,
- * *not* in bytes.
+ * align_pos - align position on a bit offset (> 0)
*
- * All write primitives, as well as read for dynamically sized entities, can
- * receive a NULL ptr/dest parameter. In this case, no write is performed, but
- * the size is returned.
+ * Return 1 if OK, 0 if out-of-bound.
+ *
+ * TODO: allow larger files by updating base too.
*/
+static inline
+int ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset)
+{
+ return ctf_move_pos(pos, offset_align(pos->offset, bit_offset));
+}
+
+static inline
+char *ctf_get_pos_addr(struct ctf_stream_pos *pos)
+{
+ /* Only makes sense to get the address after aligning on CHAR_BIT */
+ assert(!(pos->offset % CHAR_BIT));
+ return mmap_align_addr(pos->base_mma) +
+ pos->mmap_base_offset + (pos->offset / CHAR_BIT);
+}
-uint64_t ctf_uint_read(const unsigned char *ptr, int byte_order, size_t len);
-int64_t ctf_int_read(const unsigned char *ptr, int byte_order, size_t len);
-size_t ctf_uint_write(unsigned char *ptr, int byte_order, size_t len, uint64_t v);
-size_t ctf_int_write(unsigned char *ptr, int byte_order, size_t len, int64_t v);
-
-uint64_t ctf_bitfield_unsigned_read(const unsigned char *ptr,
- unsigned long start, unsigned long len,
- int byte_order);
-int64_t ctf_bitfield_signed_read(const unsigned char *ptr,
- unsigned long start, unsigned long len,
- int byte_order);
-size_t ctf_bitfield_unsigned_write(unsigned char *ptr,
- unsigned long start, unsigned long len,
- int byte_order, uint64_t v);
-size_t ctf_bitfield_signed_write(unsigned char *ptr,
- unsigned long start, unsigned long len,
- int byte_order, int64_t v);
-
-double ctf_double_read(const unsigned char *ptr, const struct type_class_float *src)
-size_t ctf_double_write(unsigned char *ptr, const struct type_class_float *dest,
- double v);
-long double ctf_ldouble_read(const unsigned char *ptr,
- const struct type_class_float *src)
-size_t ctf_ldouble_write(unsigned char *ptr, const struct type_class_float *dest,
- long double v);
-void ctf_float_copy(unsigned char *destp, const struct type_class_float *dest,
- const unsigned char *srcp, const struct type_class_float *src);
-
-size_t ctf_string_copy(unsigned char *dest, const unsigned char *src);
+static inline
+void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy)
+{
+ memcpy(dummy, pos, sizeof(struct ctf_stream_pos));
+ dummy->dummy = 1;
+ dummy->fd = -1;
+}
/*
- * A GQuark can be translated to/from strings with g_quark_from_string() and
- * g_quark_to_string().
+ * Check if current packet can hold data.
+ * Returns 0 for success, negative error otherwise.
*/
-GQuark ctf_enum_uint_to_quark(const struct enum_table *table, uint64_t v);
-GQuark ctf_enum_int_to_quark(const struct enum_table *table, uint64_t v);
-uint64_t ctf_enum_quark_to_uint(size_t len, int byte_order, GQuark q);
-int64_t ctf_enum_quark_to_int(size_t len, int byte_order, GQuark q);
-void ctf_enum_signed_insert(struct enum_table *table, int64_t v, GQuark q);
-void ctf_enum_unsigned_insert(struct enum_table *table, uint64_t v, GQuark q);
-struct enum_table *ctf_enum_new(void);
-void ctf_enum_destroy(struct enum_table *table);
+static inline
+int ctf_pos_packet(struct ctf_stream_pos *dummy)
+{
+ if (unlikely(dummy->offset > dummy->packet_size))
+ return -ENOSPC;
+ return 0;
+}
+
+static inline
+void ctf_pos_pad_packet(struct ctf_stream_pos *pos)
+{
+ ctf_packet_seek(&pos->parent, 0, SEEK_CUR);
+}
+
+/*
+ * Update the stream position to the current event. This moves to
+ * the next packet if we are located at the end of the current packet.
+ */
+static inline
+void ctf_pos_get_event(struct ctf_stream_pos *pos)
+{
+ assert(pos->offset <= pos->content_size);
+ if (pos->offset == pos->content_size) {
+ printf_debug("ctf_packet_seek (before call): %" PRId64 "\n",
+ pos->offset);
+ pos->packet_seek(&pos->parent, 0, SEEK_CUR);
+ printf_debug("ctf_packet_seek (after call): %" PRId64 "\n",
+ pos->offset);
+ }
+}
+
+void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream,
+ uint64_t timestamp);
+int ctf_append_trace_metadata(struct bt_trace_descriptor *tdp,
+ FILE *metadata_fp);
#endif /* _BABELTRACE_CTF_TYPES_H */
projects / babeltrace.git / blobdiff