/*
* Babeltrace - CTF notification iterator
*
- * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
- * Copyright (c) 2015-2016 Philippe Proulx <pproulx@efficios.com>
+ * Copyright (c) 2015-2018 EfficiOS Inc. and Linux Foundation
+ * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* SOFTWARE.
*/
+#define BT_LOG_TAG "PLUGIN-CTF-NOTIF-ITER"
+#include "logging.h"
+
#include <stdint.h>
#include <inttypes.h>
#include <stdio.h>
#include <stddef.h>
#include <stdbool.h>
-#include <assert.h>
+#include <babeltrace/assert-internal.h>
#include <string.h>
-#include <babeltrace/ctf-ir/field-types.h>
-#include <babeltrace/ctf-ir/field-path.h>
-#include <babeltrace/ctf-ir/fields.h>
-#include <babeltrace/ctf-ir/stream-class.h>
-#include <babeltrace/ctf-ir/packet.h>
-#include <babeltrace/ctf-ir/stream.h>
-#include <babeltrace/ctf-ir/clock.h>
-#include <babeltrace/ctf-ir/event-class.h>
-#include <babeltrace/plugin/notification/packet.h>
-#include <babeltrace/plugin/notification/event.h>
-#include <babeltrace/ref.h>
+#include <babeltrace/babeltrace.h>
+#include <babeltrace/common-internal.h>
#include <glib.h>
-
-#define PRINT_ERR_STREAM notit->err_stream
-#define PRINT_PREFIX "ctf-notif-iter"
-#include "print.h"
+#include <stdlib.h>
#include "notif-iter.h"
-#include "../btr/btr.h"
+#include "../bfcr/bfcr.h"
-#define BYTES_TO_BITS(x) ((x) * 8)
-
-struct bt_ctf_notif_iter;
+struct bt_notif_iter;
/* A visit stack entry */
struct stack_entry {
* * sequence
* * variant
*
- * Field is owned by this.
+ * Field is borrowed.
*/
- struct bt_ctf_field *base;
+ struct bt_private_field *base;
- /* index of next field to set */
+ /* Index of next field to set */
size_t index;
};
/* Visit stack */
struct stack {
- /* Entries (struct stack_entry *) (top is last element) */
- GPtrArray *entries;
+ /* Entries (struct stack_entry) */
+ GArray *entries;
+
+ /* Number of active entries */
+ size_t size;
};
/* State */
STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN,
STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE,
STATE_AFTER_STREAM_PACKET_CONTEXT,
+ STATE_EMIT_NOTIF_NEW_STREAM,
STATE_EMIT_NOTIF_NEW_PACKET,
- STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN,
- STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE,
- STATE_AFTER_STREAM_EVENT_HEADER,
- STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN,
- STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE,
- STATE_DSCOPE_EVENT_CONTEXT_BEGIN,
- STATE_DSCOPE_EVENT_CONTEXT_CONTINUE,
+ STATE_DSCOPE_EVENT_HEADER_BEGIN,
+ STATE_DSCOPE_EVENT_HEADER_CONTINUE,
+ STATE_AFTER_EVENT_HEADER,
+ STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN,
+ STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE,
+ STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN,
+ STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE,
STATE_DSCOPE_EVENT_PAYLOAD_BEGIN,
STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE,
STATE_EMIT_NOTIF_EVENT,
STATE_EMIT_NOTIF_END_OF_PACKET,
+ STATE_DONE,
STATE_SKIP_PACKET_PADDING,
};
/* CTF notification iterator */
-struct bt_ctf_notif_iter {
+struct bt_notif_iter {
/* Visit stack */
struct stack *stack;
- /* Error stream (may be NULL) */
- FILE *err_stream;
+ /* Current notification iterator to create notifications (weak) */
+ struct bt_self_notification_iterator *notif_iter;
/*
* Current dynamic scope field pointer.
*
- * This is set when a dynamic scope field is first created by
- * btr_compound_begin_cb(). It points to one of the fields in
- * dscopes below.
+ * This is set by read_dscope_begin_state() and contains the
+ * value of one of the pointers in `dscopes` below.
*/
- struct bt_ctf_field **cur_dscope_field;
+ struct bt_private_field *cur_dscope_field;
- /* Trace and classes (owned by this) */
+ /*
+ * True if we're done filling a string field from a text
+ * array/sequence payload.
+ */
+ bool done_filling_string;
+
+ /* Trace and classes */
struct {
- struct bt_ctf_trace *trace;
- struct bt_ctf_stream_class *stream_class;
- struct bt_ctf_event_class *event_class;
+ struct ctf_trace_class *tc;
+ struct ctf_stream_class *sc;
+ struct ctf_event_class *ec;
} meta;
+ /* Current packet header field wrapper (NULL if not created yet) */
+ struct bt_private_packet_header_field *packet_header_field;
+
+ /* Current packet header field wrapper (NULL if not created yet) */
+ struct bt_private_packet_context_field *packet_context_field;
+
+ /* Current event header field (NULL if not created yet) */
+ struct bt_private_event_header_field *event_header_field;
+
/* Current packet (NULL if not created yet) */
- struct bt_ctf_packet *packet;
+ struct bt_private_packet *packet;
+
+ /* Current stream (NULL if not set yet) */
+ struct bt_private_stream *stream;
+
+ /* Current event (NULL if not created yet) */
+ struct bt_private_event *event;
- /* Database of current dynamic scopes (owned by this) */
+ /* Current event notification (NULL if not created yet) */
+ struct bt_private_notification *event_notif;
+
+ /* Database of current dynamic scopes */
struct {
- struct bt_ctf_field *trace_packet_header;
- struct bt_ctf_field *stream_packet_context;
- struct bt_ctf_field *stream_event_header;
- struct bt_ctf_field *stream_event_context;
- struct bt_ctf_field *event_context;
- struct bt_ctf_field *event_payload;
+ struct bt_private_field *trace_packet_header;
+ struct bt_private_field *stream_packet_context;
+ struct bt_private_field *event_header;
+ struct bt_private_field *event_common_context;
+ struct bt_private_field *event_spec_context;
+ struct bt_private_field *event_payload;
} dscopes;
/* Current state */
/* Current position from addr (bits) */
size_t at;
+
+ /* Position of the last event header from addr (bits) */
+ size_t last_eh_at;
} buf;
/* Binary type reader */
- struct bt_ctf_btr *btr;
+ struct bt_bfcr *bfcr;
/* Current medium data */
struct {
- struct bt_ctf_notif_iter_medium_ops medops;
+ struct bt_notif_iter_medium_ops medops;
size_t max_request_sz;
void *data;
} medium;
+ /* Stream beginning was emitted */
+ bool stream_begin_emitted;
+
/* Current packet size (bits) (-1 if unknown) */
- int64_t cur_packet_size;
+ int64_t cur_exp_packet_total_size;
/* Current content size (bits) (-1 if unknown) */
- int64_t cur_content_size;
-};
+ int64_t cur_exp_packet_content_size;
-static
-int bt_ctf_notif_iter_switch_packet(struct bt_ctf_notif_iter *notit);
+ /* Current stream class ID */
+ int64_t cur_stream_class_id;
-static
-void stack_entry_free_func(gpointer data)
-{
- struct stack_entry *entry = data;
+ /* Current event class ID */
+ int64_t cur_event_class_id;
+
+ /* Current data stream ID */
+ int64_t cur_data_stream_id;
+
+ /*
+ * Offset, in the underlying media, of the current packet's
+ * start (-1 if unknown).
+ */
+ off_t cur_packet_offset;
+
+ /* Default clock's current value */
+ uint64_t default_clock_val;
- bt_put(entry->base);
- g_free(entry);
+ /* End of packet snapshots */
+ struct {
+ uint64_t discarded_events;
+ uint64_t packets;
+ uint64_t beginning_clock;
+ uint64_t end_clock;
+ } snapshots;
+
+ /* Stored values (for sequence lengths, variant tags) */
+ GArray *stored_values;
+};
+
+static inline
+const char *state_string(enum state state)
+{
+ switch (state) {
+ case STATE_INIT:
+ return "STATE_INIT";
+ case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN:
+ return "STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN";
+ case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE:
+ return "STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE";
+ case STATE_AFTER_TRACE_PACKET_HEADER:
+ return "STATE_AFTER_TRACE_PACKET_HEADER";
+ case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN:
+ return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN";
+ case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE:
+ return "STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE";
+ case STATE_AFTER_STREAM_PACKET_CONTEXT:
+ return "STATE_AFTER_STREAM_PACKET_CONTEXT";
+ case STATE_EMIT_NOTIF_NEW_PACKET:
+ return "STATE_EMIT_NOTIF_NEW_PACKET";
+ case STATE_EMIT_NOTIF_NEW_STREAM:
+ return "STATE_EMIT_NOTIF_NEW_STREAM";
+ case STATE_DSCOPE_EVENT_HEADER_BEGIN:
+ return "STATE_DSCOPE_EVENT_HEADER_BEGIN";
+ case STATE_DSCOPE_EVENT_HEADER_CONTINUE:
+ return "STATE_DSCOPE_EVENT_HEADER_CONTINUE";
+ case STATE_AFTER_EVENT_HEADER:
+ return "STATE_AFTER_EVENT_HEADER";
+ case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN:
+ return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN";
+ case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE:
+ return "STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE";
+ case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN:
+ return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN";
+ case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE:
+ return "STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE";
+ case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN:
+ return "STATE_DSCOPE_EVENT_PAYLOAD_BEGIN";
+ case STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE:
+ return "STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE";
+ case STATE_EMIT_NOTIF_EVENT:
+ return "STATE_EMIT_NOTIF_EVENT";
+ case STATE_EMIT_NOTIF_END_OF_PACKET:
+ return "STATE_EMIT_NOTIF_END_OF_PACKET";
+ case STATE_DONE:
+ return "STATE_DONE";
+ case STATE_SKIP_PACKET_PADDING:
+ return "STATE_SKIP_PACKET_PADDING";
+ default:
+ return "(unknown)";
+ }
}
static
-struct stack *stack_new(struct bt_ctf_notif_iter *notit)
+int bt_notif_iter_switch_packet(struct bt_notif_iter *notit);
+
+static
+struct stack *stack_new(struct bt_notif_iter *notit)
{
struct stack *stack = NULL;
stack = g_new0(struct stack, 1);
if (!stack) {
+ BT_LOGE_STR("Failed to allocate one stack.");
goto error;
}
- stack->entries = g_ptr_array_new_with_free_func(stack_entry_free_func);
+ stack->entries = g_array_new(FALSE, TRUE, sizeof(struct stack_entry));
if (!stack->entries) {
+ BT_LOGE_STR("Failed to allocate a GArray.");
goto error;
}
- return stack;
+ BT_LOGD("Created stack: notit-addr=%p, stack-addr=%p", notit, stack);
+ goto end;
+
error:
g_free(stack);
- return NULL;
+ stack = NULL;
+
+end:
+ return stack;
}
static
void stack_destroy(struct stack *stack)
{
- assert(stack);
- g_ptr_array_free(stack->entries, TRUE);
+ BT_ASSERT(stack);
+ BT_LOGD("Destroying stack: addr=%p", stack);
+
+ if (stack->entries) {
+ g_array_free(stack->entries, TRUE);
+ }
+
g_free(stack);
}
static
-int stack_push(struct stack *stack, struct bt_ctf_field *base)
+void stack_push(struct stack *stack, struct bt_private_field *base)
{
- int ret = 0;
struct stack_entry *entry;
- assert(stack);
- assert(base);
- entry = g_new0(struct stack_entry, 1);
- if (!entry) {
- ret = -1;
- goto end;
- }
+ BT_ASSERT(stack);
+ BT_ASSERT(base);
+ BT_LOGV("Pushing base field on stack: stack-addr=%p, "
+ "stack-size-before=%zu, stack-size-after=%zu",
+ stack, stack->size, stack->size + 1);
- entry->base = bt_get(base);
- g_ptr_array_add(stack->entries, entry);
+ if (stack->entries->len == stack->size) {
+ g_array_set_size(stack->entries, stack->size + 1);
+ }
-end:
- return ret;
+ entry = &g_array_index(stack->entries, struct stack_entry, stack->size);
+ entry->base = base;
+ entry->index = 0;
+ stack->size++;
}
static inline
unsigned int stack_size(struct stack *stack)
{
- assert(stack);
-
- return stack->entries->len;
+ BT_ASSERT(stack);
+ return stack->size;
}
static
void stack_pop(struct stack *stack)
{
- assert(stack);
- assert(stack_size(stack));
- g_ptr_array_remove_index(stack->entries, stack->entries->len - 1);
+ BT_ASSERT(stack);
+ BT_ASSERT(stack_size(stack));
+ BT_LOGV("Popping from stack: "
+ "stack-addr=%p, stack-size-before=%zu, stack-size-after=%zu",
+ stack, stack->size, stack->size - 1);
+ stack->size--;
}
static inline
struct stack_entry *stack_top(struct stack *stack)
{
- assert(stack);
- assert(stack_size(stack));
-
- return g_ptr_array_index(stack->entries, stack->entries->len - 1);
+ BT_ASSERT(stack);
+ BT_ASSERT(stack_size(stack));
+ return &g_array_index(stack->entries, struct stack_entry,
+ stack->size - 1);
}
static inline
static
void stack_clear(struct stack *stack)
{
- assert(stack);
-
- if (!stack_empty(stack)) {
- g_ptr_array_remove_range(stack->entries, 0, stack_size(stack));
- }
-
- assert(stack_empty(stack));
+ BT_ASSERT(stack);
+ stack->size = 0;
}
static inline
-enum bt_ctf_notif_iter_status notif_iter_status_from_m_status(
- enum bt_ctf_notif_iter_medium_status m_status)
+enum bt_notif_iter_status notif_iter_status_from_m_status(
+ enum bt_notif_iter_medium_status m_status)
{
- return m_status;
+ /* They are the same */
+ return (int) m_status;
}
static inline
-size_t buf_size_bits(struct bt_ctf_notif_iter *notit)
+size_t buf_size_bits(struct bt_notif_iter *notit)
{
- return BYTES_TO_BITS(notit->buf.sz);
+ return notit->buf.sz * 8;
}
static inline
-size_t buf_available_bits(struct bt_ctf_notif_iter *notit)
+size_t buf_available_bits(struct bt_notif_iter *notit)
{
return buf_size_bits(notit) - notit->buf.at;
}
static inline
-size_t packet_at(struct bt_ctf_notif_iter *notit)
+size_t packet_at(struct bt_notif_iter *notit)
{
return notit->buf.packet_offset + notit->buf.at;
}
static inline
-size_t remaining_content_bits(struct bt_ctf_notif_iter *notit)
-{
- if (notit->cur_content_size == -1) {
- return -1;
- }
-
- return notit->cur_content_size - packet_at(notit);
-}
-
-static inline
-size_t remaining_packet_bits(struct bt_ctf_notif_iter *notit)
-{
- if (notit->cur_packet_size == -1) {
- return -1;
- }
-
- return notit->cur_packet_size - packet_at(notit);
-}
-
-static inline
-void buf_consume_bits(struct bt_ctf_notif_iter *notit, size_t incr)
+void buf_consume_bits(struct bt_notif_iter *notit, size_t incr)
{
+ BT_LOGV("Advancing cursor: notit-addr=%p, cur-before=%zu, cur-after=%zu",
+ notit, notit->buf.at, notit->buf.at + incr);
notit->buf.at += incr;
}
-static inline
-bool buf_has_enough_bits(struct bt_ctf_notif_iter *notit, size_t sz)
-{
- return buf_available_bits(notit) >= sz;
-}
-
static
-enum bt_ctf_notif_iter_status request_medium_bytes(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status request_medium_bytes(
+ struct bt_notif_iter *notit)
{
- uint8_t *buffer_addr;
- size_t buffer_sz;
- enum bt_ctf_notif_iter_medium_status m_status;
+ uint8_t *buffer_addr = NULL;
+ size_t buffer_sz = 0;
+ enum bt_notif_iter_medium_status m_status;
+ BT_LOGV("Calling user function (request bytes): notit-addr=%p, "
+ "request-size=%zu", notit, notit->medium.max_request_sz);
m_status = notit->medium.medops.request_bytes(
notit->medium.max_request_sz, &buffer_addr,
&buffer_sz, notit->medium.data);
- if (m_status == BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK) {
- assert(buffer_sz != 0);
+ BT_LOGV("User function returned: status=%s, buf-addr=%p, buf-size=%zu",
+ bt_notif_iter_medium_status_string(m_status),
+ buffer_addr, buffer_sz);
+ if (m_status == BT_NOTIF_ITER_MEDIUM_STATUS_OK) {
+ BT_ASSERT(buffer_sz != 0);
/* New packet offset is old one + old size (in bits) */
notit->buf.packet_offset += buf_size_bits(notit);
/* Restart at the beginning of the new medium buffer */
notit->buf.at = 0;
+ notit->buf.last_eh_at = SIZE_MAX;
/* New medium buffer size */
notit->buf.sz = buffer_sz;
/* New medium buffer address */
notit->buf.addr = buffer_addr;
+
+ BT_LOGV("User function returned new bytes: "
+ "packet-offset=%zu, cur=%zu, size=%zu, addr=%p",
+ notit->buf.packet_offset, notit->buf.at,
+ notit->buf.sz, notit->buf.addr);
+ BT_LOGV_MEM(buffer_addr, buffer_sz, "Returned bytes at %p:",
+ buffer_addr);
+ } else if (m_status == BT_NOTIF_ITER_MEDIUM_STATUS_EOF) {
+ /*
+ * User returned end of stream: validate that we're not
+ * in the middle of a packet header, packet context, or
+ * event.
+ */
+ if (notit->cur_exp_packet_total_size >= 0) {
+ if (packet_at(notit) ==
+ notit->cur_exp_packet_total_size) {
+ goto end;
+ }
+ } else {
+ if (packet_at(notit) == 0) {
+ goto end;
+ }
+
+ if (notit->buf.last_eh_at != SIZE_MAX &&
+ notit->buf.at == notit->buf.last_eh_at) {
+ goto end;
+ }
+ }
+
+ /* All other states are invalid */
+ BT_LOGW("User function returned %s, but notification iterator is in an unexpected state: "
+ "state=%s, cur-packet-size=%" PRId64 ", cur=%zu, "
+ "packet-cur=%zu, last-eh-at=%zu",
+ bt_notif_iter_medium_status_string(m_status),
+ state_string(notit->state),
+ notit->cur_exp_packet_total_size,
+ notit->buf.at, packet_at(notit),
+ notit->buf.last_eh_at);
+ m_status = BT_NOTIF_ITER_MEDIUM_STATUS_ERROR;
+ } else if (m_status < 0) {
+ BT_LOGW("User function failed: status=%s",
+ bt_notif_iter_medium_status_string(m_status));
}
+end:
return notif_iter_status_from_m_status(m_status);
}
static inline
-enum bt_ctf_notif_iter_status buf_ensure_available_bits(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status buf_ensure_available_bits(
+ struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
- if (buf_available_bits(notit) == 0) {
+ if (unlikely(buf_available_bits(notit) == 0)) {
/*
- * This _cannot_ return BT_CTF_NOTIF_ITER_STATUS_OK
+ * This _cannot_ return BT_NOTIF_ITER_STATUS_OK
* _and_ no bits.
*/
status = request_medium_bytes(notit);
}
static
-enum bt_ctf_notif_iter_status read_dscope_begin_state(
- struct bt_ctf_notif_iter *notit,
- struct bt_ctf_field_type *dscope_field_type,
+enum bt_notif_iter_status read_dscope_begin_state(
+ struct bt_notif_iter *notit,
+ struct ctf_field_class *dscope_fc,
enum state done_state, enum state continue_state,
- struct bt_ctf_field **dscope_field)
+ struct bt_private_field *dscope_field)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- enum bt_ctf_btr_status btr_status;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ enum bt_bfcr_status bfcr_status;
size_t consumed_bits;
- status = buf_ensure_available_bits(notit);
- if (status != BT_CTF_NOTIF_ITER_STATUS_OK) {
- goto end;
- }
-
- bt_put(*dscope_field);
notit->cur_dscope_field = dscope_field;
- consumed_bits = bt_ctf_btr_start(notit->btr, dscope_field_type,
+ BT_LOGV("Starting BFCR: notit-addr=%p, bfcr-addr=%p, fc-addr=%p",
+ notit, notit->bfcr, dscope_fc);
+ consumed_bits = bt_bfcr_start(notit->bfcr, dscope_fc,
notit->buf.addr, notit->buf.at, packet_at(notit),
- notit->buf.sz, &btr_status);
+ notit->buf.sz, &bfcr_status);
+ BT_LOGV("BFCR consumed bits: size=%zu", consumed_bits);
- switch (btr_status) {
- case BT_CTF_BTR_STATUS_OK:
- /* type was read completely */
+ switch (bfcr_status) {
+ case BT_BFCR_STATUS_OK:
+ /* Field class was read completely */
+ BT_LOGV_STR("Field was completely decoded.");
notit->state = done_state;
break;
- case BT_CTF_BTR_STATUS_EOF:
+ case BT_BFCR_STATUS_EOF:
+ BT_LOGV_STR("BFCR needs more data to decode field completely.");
notit->state = continue_state;
break;
default:
- PERR("Binary type reader failed to start\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ BT_LOGW("BFCR failed to start: notit-addr=%p, bfcr-addr=%p, "
+ "status=%s", notit, notit->bfcr,
+ bt_bfcr_status_string(bfcr_status));
+ status = BT_NOTIF_ITER_STATUS_ERROR;
goto end;
}
}
static
-enum bt_ctf_notif_iter_status read_dscope_continue_state(
- struct bt_ctf_notif_iter *notit, enum state done_state)
+enum bt_notif_iter_status read_dscope_continue_state(
+ struct bt_notif_iter *notit, enum state done_state)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- enum bt_ctf_btr_status btr_status;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ enum bt_bfcr_status bfcr_status;
size_t consumed_bits;
+ BT_LOGV("Continuing BFCR: notit-addr=%p, bfcr-addr=%p",
+ notit, notit->bfcr);
+
status = buf_ensure_available_bits(notit);
- if (status != BT_CTF_NOTIF_ITER_STATUS_OK) {
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
+ if (status < 0) {
+ BT_LOGW("Cannot ensure that buffer has at least one byte: "
+ "notif-addr=%p, status=%s",
+ notit, bt_notif_iter_status_string(status));
+ } else {
+ BT_LOGV("Cannot ensure that buffer has at least one byte: "
+ "notif-addr=%p, status=%s",
+ notit, bt_notif_iter_status_string(status));
+ }
+
goto end;
}
- consumed_bits = bt_ctf_btr_continue(notit->btr, notit->buf.addr,
- notit->buf.sz, &btr_status);
+ consumed_bits = bt_bfcr_continue(notit->bfcr, notit->buf.addr,
+ notit->buf.sz, &bfcr_status);
+ BT_LOGV("BFCR consumed bits: size=%zu", consumed_bits);
- switch (btr_status) {
- case BT_CTF_BTR_STATUS_OK:
+ switch (bfcr_status) {
+ case BT_BFCR_STATUS_OK:
/* Type was read completely. */
+ BT_LOGV_STR("Field was completely decoded.");
notit->state = done_state;
break;
- case BT_CTF_BTR_STATUS_EOF:
+ case BT_BFCR_STATUS_EOF:
/* Stay in this continue state. */
+ BT_LOGV_STR("BFCR needs more data to decode field completely.");
break;
default:
- PERR("Binary type reader failed to continue\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ BT_LOGW("BFCR failed to continue: notit-addr=%p, bfcr-addr=%p, "
+ "status=%s", notit, notit->bfcr,
+ bt_bfcr_status_string(bfcr_status));
+ status = BT_NOTIF_ITER_STATUS_ERROR;
goto end;
}
}
static
-void put_event_dscopes(struct bt_ctf_notif_iter *notit)
+void release_event_dscopes(struct bt_notif_iter *notit)
{
- BT_PUT(notit->dscopes.stream_event_header);
- BT_PUT(notit->dscopes.stream_event_context);
- BT_PUT(notit->dscopes.event_context);
- BT_PUT(notit->dscopes.event_payload);
+ notit->dscopes.event_header = NULL;
+
+ if (notit->event_header_field) {
+ bt_private_event_header_field_release(notit->event_header_field);
+ notit->event_header_field = NULL;
+ }
+
+ notit->dscopes.event_common_context = NULL;
+ notit->dscopes.event_spec_context = NULL;
+ notit->dscopes.event_payload = NULL;
}
static
-void put_all_dscopes(struct bt_ctf_notif_iter *notit)
+void release_all_dscopes(struct bt_notif_iter *notit)
{
- BT_PUT(notit->dscopes.trace_packet_header);
- BT_PUT(notit->dscopes.stream_packet_context);
- put_event_dscopes(notit);
+ notit->dscopes.trace_packet_header = NULL;
+
+ if (notit->packet_header_field) {
+ bt_private_packet_header_field_release(notit->packet_header_field);
+ notit->packet_header_field = NULL;
+ }
+
+ notit->dscopes.stream_packet_context = NULL;
+
+ if (notit->packet_context_field) {
+ bt_private_packet_context_field_release(notit->packet_context_field);
+ notit->packet_context_field = NULL;
+ }
+
+ release_event_dscopes(notit);
}
static
-enum bt_ctf_notif_iter_status read_packet_header_begin_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_packet_header_begin_state(
+ struct bt_notif_iter *notit)
{
- struct bt_ctf_field_type *packet_header_type = NULL;
- enum bt_ctf_notif_iter_status ret = BT_CTF_NOTIF_ITER_STATUS_OK;
+ struct ctf_field_class *packet_header_fc = NULL;
+ enum bt_notif_iter_status ret = BT_NOTIF_ITER_STATUS_OK;
- if (bt_ctf_notif_iter_switch_packet(notit)) {
- ret = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ if (bt_notif_iter_switch_packet(notit)) {
+ BT_LOGW("Cannot switch packet: notit-addr=%p", notit);
+ ret = BT_NOTIF_ITER_STATUS_ERROR;
goto end;
}
- /* Packet header type is common to the whole trace. */
- packet_header_type = bt_ctf_trace_get_packet_header_type(
- notit->meta.trace);
- if (!packet_header_type) {
- PERR("Failed to retrieve trace's packet header type\n");
- ret = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ /* Packet header class is common to the whole trace. */
+ packet_header_fc = notit->meta.tc->packet_header_fc;
+ if (!packet_header_fc) {
+ notit->state = STATE_AFTER_TRACE_PACKET_HEADER;
goto end;
}
- ret = read_dscope_begin_state(notit, packet_header_type,
- STATE_AFTER_TRACE_PACKET_HEADER,
- STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE,
- ¬it->dscopes.trace_packet_header);
+ BT_ASSERT(!notit->packet_header_field);
+
+ if (packet_header_fc->in_ir) {
+ /*
+ * Create free packet header field from trace. This
+ * field is going to be moved to the packet once we
+ * create it. We cannot create the packet now because:
+ *
+ * 1. A packet is created from a stream.
+ * 2. A stream is created from a stream class.
+ * 3. We need the packet header field's content to know
+ * the ID of the stream class to select.
+ */
+ notit->packet_header_field =
+ bt_private_packet_header_field_create(
+ notit->meta.tc->ir_tc);
+ if (!notit->packet_header_field) {
+ BT_LOGE_STR("Cannot create packet header field wrapper from trace.");
+ ret = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
+
+ notit->dscopes.trace_packet_header =
+ bt_private_packet_header_field_borrow_field(
+ notit->packet_header_field);
+ BT_ASSERT(notit->dscopes.trace_packet_header);
+ }
+
+ notit->cur_stream_class_id = -1;
+ notit->cur_event_class_id = -1;
+ notit->cur_data_stream_id = -1;
+ BT_LOGV("Decoding packet header field:"
+ "notit-addr=%p, trace-addr=%p, trace-name=\"%s\", fc-addr=%p",
+ notit, notit->meta.tc,
+ notit->meta.tc->name->str, packet_header_fc);
+ ret = read_dscope_begin_state(notit, packet_header_fc,
+ STATE_AFTER_TRACE_PACKET_HEADER,
+ STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE,
+ notit->dscopes.trace_packet_header);
+ if (ret < 0) {
+ BT_LOGW("Cannot decode packet header field: "
+ "notit-addr=%p, trace-addr=%p, "
+ "trace-name=\"%s\", fc-addr=%p",
+ notit, notit->meta.tc,
+ notit->meta.tc->name->str,
+ packet_header_fc);
+ }
+
end:
- BT_PUT(packet_header_type);
return ret;
}
static
-enum bt_ctf_notif_iter_status read_packet_header_continue_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_packet_header_continue_state(
+ struct bt_notif_iter *notit)
{
return read_dscope_continue_state(notit,
- STATE_AFTER_TRACE_PACKET_HEADER);
+ STATE_AFTER_TRACE_PACKET_HEADER);
}
static inline
-bool is_struct_type(struct bt_ctf_field_type *field_type)
+enum bt_notif_iter_status set_current_stream_class(struct bt_notif_iter *notit)
{
- return bt_ctf_field_type_get_type_id(field_type) ==
- BT_CTF_TYPE_ID_STRUCT;
-}
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ struct ctf_stream_class *new_stream_class = NULL;
-static inline
-bool is_variant_type(struct bt_ctf_field_type *field_type)
-{
- return bt_ctf_field_type_get_type_id(field_type) ==
- BT_CTF_TYPE_ID_VARIANT;
-}
+ if (notit->cur_stream_class_id == -1) {
+ /*
+ * No current stream class ID field, therefore only one
+ * stream class.
+ */
+ if (notit->meta.tc->stream_classes->len != 1) {
+ BT_LOGW("Need exactly one stream class since there's "
+ "no stream class ID field: "
+ "notit-addr=%p, trace-name=\"%s\"",
+ notit, notit->meta.tc->name->str);
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
-static inline
-enum bt_ctf_notif_iter_status set_current_stream_class(struct bt_ctf_notif_iter *notit)
-{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- struct bt_ctf_field_type *packet_header_type;
- struct bt_ctf_field_type *stream_id_field_type = NULL;
- uint64_t stream_id;
-
- /* Is there any "stream_id" field in the packet header? */
- packet_header_type = bt_ctf_trace_get_packet_header_type(
- notit->meta.trace);
- if (!packet_header_type) {
- PERR("Failed to retrieve trace's packet header type\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ new_stream_class = notit->meta.tc->stream_classes->pdata[0];
+ notit->cur_stream_class_id = new_stream_class->id;
goto end;
}
- assert(is_struct_type(packet_header_type));
-
- // TODO: optimalize!
- stream_id_field_type =
- bt_ctf_field_type_structure_get_field_type_by_name(
- packet_header_type, "stream_id");
- if (stream_id_field_type) {
- /* Find appropriate stream class using current stream ID */
- struct bt_ctf_field *stream_id_field = NULL;
- int ret;
-
- assert(notit->dscopes.trace_packet_header);
+ new_stream_class = ctf_trace_class_borrow_stream_class_by_id(
+ notit->meta.tc, notit->cur_stream_class_id);
+ if (!new_stream_class) {
+ BT_LOGW("No stream class with ID of stream class ID to use in trace: "
+ "notit-addr=%p, stream-class-id=%" PRIu64 ", "
+ "trace-addr=%p, trace-name=\"%s\"",
+ notit, notit->cur_stream_class_id, notit->meta.tc,
+ notit->meta.tc->name->str);
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
- // TODO: optimalize!
- stream_id_field = bt_ctf_field_structure_get_field(
- notit->dscopes.trace_packet_header, "stream_id");
- assert(stream_id_field);
- ret = bt_ctf_field_unsigned_integer_get_value(
- stream_id_field, &stream_id);
- assert(!ret);
- BT_PUT(stream_id_field);
+ if (notit->meta.sc) {
+ if (new_stream_class != notit->meta.sc) {
+ BT_LOGW("Two packets refer to two different stream classes within the same packet sequence: "
+ "notit-addr=%p, prev-stream-class-addr=%p, "
+ "prev-stream-class-id=%" PRId64 ", "
+ "next-stream-class-addr=%p, "
+ "next-stream-class-id=%" PRId64 ", "
+ "trace-addr=%p, trace-name=\"%s\"",
+ notit, notit->meta.sc,
+ notit->meta.sc->id,
+ new_stream_class,
+ new_stream_class->id,
+ notit->meta.tc,
+ notit->meta.tc->name->str);
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
} else {
- /* Only one stream: pick the first stream class */
- assert(bt_ctf_trace_get_stream_class_count(
- notit->meta.trace) == 1);
- stream_id = 0;
+ notit->meta.sc = new_stream_class;
}
- BT_PUT(notit->meta.stream_class);
+ BT_LOGV("Set current stream class: "
+ "notit-addr=%p, stream-class-addr=%p, "
+ "stream-class-id=%" PRId64,
+ notit, notit->meta.sc, notit->meta.sc->id);
+
+end:
+ return status;
+}
+
+static inline
+enum bt_notif_iter_status set_current_stream(struct bt_notif_iter *notit)
+{
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ struct bt_private_stream *stream = NULL;
+
+ BT_LOGV("Calling user function (get stream): notit-addr=%p, "
+ "stream-class-addr=%p, stream-class-id=%" PRId64,
+ notit, notit->meta.sc,
+ notit->meta.sc->id);
+ stream = bt_object_get_ref(notit->medium.medops.borrow_stream(
+ notit->meta.sc->ir_sc, notit->cur_data_stream_id,
+ notit->medium.data));
+ BT_LOGV("User function returned: stream-addr=%p", stream);
+ if (!stream) {
+ BT_LOGW_STR("User function failed to return a stream object "
+ "for the given stream class.");
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
- // TODO: get by ID
- notit->meta.stream_class = bt_ctf_trace_get_stream_class(
- notit->meta.trace, stream_id);
- if (!notit->meta.stream_class) {
- PERR("Cannot find stream class with ID %" PRIu64 "\n",
- stream_id);
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ if (notit->stream && stream != notit->stream) {
+ BT_LOGW("User function returned a different stream than the "
+ "previous one for the same sequence of packets.");
+ status = BT_NOTIF_ITER_STATUS_ERROR;
goto end;
}
+ BT_OBJECT_MOVE_REF(notit->stream, stream);
+
end:
- BT_PUT(packet_header_type);
- BT_PUT(stream_id_field_type);
+ bt_object_put_ref(stream);
+ return status;
+}
+
+static inline
+enum bt_notif_iter_status set_current_packet(struct bt_notif_iter *notit)
+{
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ struct bt_private_packet *packet = NULL;
+
+ BT_LOGV("Creating packet for packet notification: "
+ "notit-addr=%p", notit);
+ BT_LOGV("Creating packet from stream: "
+ "notit-addr=%p, stream-addr=%p, "
+ "stream-class-addr=%p, "
+ "stream-class-id=%" PRId64,
+ notit, notit->stream, notit->meta.sc,
+ notit->meta.sc->id);
+
+ /* Create packet */
+ BT_ASSERT(notit->stream);
+ packet = bt_private_packet_create(notit->stream);
+ if (!packet) {
+ BT_LOGE("Cannot create packet from stream: "
+ "notit-addr=%p, stream-addr=%p, "
+ "stream-class-addr=%p, "
+ "stream-class-id=%" PRId64,
+ notit, notit->stream, notit->meta.sc,
+ notit->meta.sc->id);
+ goto error;
+ }
+
+ goto end;
+
+error:
+ BT_OBJECT_PUT_REF_AND_RESET(packet);
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+end:
+ BT_OBJECT_MOVE_REF(notit->packet, packet);
return status;
}
static
-enum bt_ctf_notif_iter_status after_packet_header_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status after_packet_header_state(
+ struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status;
+ enum bt_notif_iter_status status;
status = set_current_stream_class(notit);
- if (status == BT_CTF_NOTIF_ITER_STATUS_OK) {
- notit->state = STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN;
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
+ goto end;
}
+ notit->state = STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN;
+
+end:
return status;
}
static
-enum bt_ctf_notif_iter_status read_packet_context_begin_state(
- struct bt_ctf_notif_iter *notit)
-{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- struct bt_ctf_field_type *packet_context_type;
-
- assert(notit->meta.stream_class);
- packet_context_type = bt_ctf_stream_class_get_packet_context_type(
- notit->meta.stream_class);
- if (!packet_context_type) {
- PERR("Failed to retrieve stream class's packet context\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+enum bt_notif_iter_status read_packet_context_begin_state(
+ struct bt_notif_iter *notit)
+{
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ struct ctf_field_class *packet_context_fc;
+
+ BT_ASSERT(notit->meta.sc);
+ packet_context_fc = notit->meta.sc->packet_context_fc;
+ if (!packet_context_fc) {
+ BT_LOGV("No packet packet context field class in stream class: continuing: "
+ "notit-addr=%p, stream-class-addr=%p, "
+ "stream-class-id=%" PRId64,
+ notit, notit->meta.sc,
+ notit->meta.sc->id);
+ notit->state = STATE_AFTER_STREAM_PACKET_CONTEXT;
goto end;
}
- status = read_dscope_begin_state(notit, packet_context_type,
- STATE_AFTER_STREAM_PACKET_CONTEXT,
- STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE,
- ¬it->dscopes.stream_packet_context);
+ BT_ASSERT(!notit->packet_context_field);
+
+ if (packet_context_fc->in_ir) {
+ /*
+ * Create free packet context field from stream class.
+ * This field is going to be moved to the packet once we
+ * create it. We cannot create the packet now because a
+ * packet is created from a stream, and this API must be
+ * able to return the packet header and context fields
+ * without creating a stream
+ * (bt_notif_iter_borrow_packet_header_context_fields()).
+ */
+ notit->packet_context_field =
+ bt_private_packet_context_field_create(
+ notit->meta.sc->ir_sc);
+ if (!notit->packet_context_field) {
+ BT_LOGE_STR("Cannot create packet context field wrapper from stream class.");
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
+
+ notit->dscopes.stream_packet_context =
+ bt_private_packet_context_field_borrow_field(
+ notit->packet_context_field);
+ BT_ASSERT(notit->dscopes.stream_packet_context);
+ }
+
+ BT_LOGV("Decoding packet context field: "
+ "notit-addr=%p, stream-class-addr=%p, "
+ "stream-class-id=%" PRId64 ", fc-addr=%p",
+ notit, notit->meta.sc,
+ notit->meta.sc->id, packet_context_fc);
+ status = read_dscope_begin_state(notit, packet_context_fc,
+ STATE_AFTER_STREAM_PACKET_CONTEXT,
+ STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE,
+ notit->dscopes.stream_packet_context);
+ if (status < 0) {
+ BT_LOGW("Cannot decode packet context field: "
+ "notit-addr=%p, stream-class-addr=%p, "
+ "stream-class-id=%" PRId64 ", fc-addr=%p",
+ notit, notit->meta.sc,
+ notit->meta.sc->id,
+ packet_context_fc);
+ }
end:
- BT_PUT(packet_context_type);
return status;
}
static
-enum bt_ctf_notif_iter_status read_packet_context_continue_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_packet_context_continue_state(
+ struct bt_notif_iter *notit)
{
return read_dscope_continue_state(notit,
STATE_AFTER_STREAM_PACKET_CONTEXT);
}
static
-enum bt_ctf_notif_iter_status set_current_packet_content_sizes(
- struct bt_ctf_notif_iter *notit)
-{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- struct bt_ctf_field *packet_size_field = NULL;
- struct bt_ctf_field *content_size_field = NULL;
- uint64_t content_size = -1, packet_size = -1;
-
- assert(notit->dscopes.stream_packet_context);
-
- packet_size_field = bt_ctf_field_structure_get_field(
- notit->dscopes.stream_packet_context, "packet_size");
- content_size_field = bt_ctf_field_structure_get_field(
- notit->dscopes.stream_packet_context, "content_size");
- if (packet_size_field) {
- int ret = bt_ctf_field_unsigned_integer_get_value(
- packet_size_field, &packet_size);
-
- assert(!ret);
- if (packet_size == 0) {
- PERR("Decoded packet size is 0\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
- goto end;
- } else if ((packet_size % 8) != 0) {
- PERR("Decoded packet size is not a multiple of 8\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+enum bt_notif_iter_status set_current_packet_content_sizes(
+ struct bt_notif_iter *notit)
+{
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+
+ if (notit->cur_exp_packet_total_size == -1) {
+ if (notit->cur_exp_packet_content_size != -1) {
+ BT_LOGW("Content size is set, but packet size is not: "
+ "notit-addr=%p, packet-context-field-addr=%p, "
+ "packet-size=%" PRId64 ", content-size=%" PRId64,
+ notit, notit->dscopes.stream_packet_context,
+ notit->cur_exp_packet_total_size,
+ notit->cur_exp_packet_content_size);
+ status = BT_NOTIF_ITER_STATUS_ERROR;
goto end;
}
+ } else {
+ if (notit->cur_exp_packet_content_size == -1) {
+ notit->cur_exp_packet_content_size =
+ notit->cur_exp_packet_total_size;
+ }
}
- if (content_size_field) {
- int ret = bt_ctf_field_unsigned_integer_get_value(
- content_size_field, &content_size);
-
- assert(!ret);
- } else {
- content_size = packet_size;
+ if (notit->cur_exp_packet_content_size >
+ notit->cur_exp_packet_total_size) {
+ BT_LOGW("Invalid packet or content size: "
+ "content size is greater than packet size: "
+ "notit-addr=%p, packet-context-field-addr=%p, "
+ "packet-size=%" PRId64 ", content-size=%" PRId64,
+ notit, notit->dscopes.stream_packet_context,
+ notit->cur_exp_packet_total_size,
+ notit->cur_exp_packet_content_size);
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
}
- notit->cur_packet_size = packet_size;
- notit->cur_content_size = content_size;
+ BT_LOGV("Set current packet and content sizes: "
+ "notit-addr=%p, packet-size=%" PRIu64 ", content-size=%" PRIu64,
+ notit, notit->cur_exp_packet_total_size,
+ notit->cur_exp_packet_content_size);
end:
- BT_PUT(packet_size_field);
- BT_PUT(content_size_field);
return status;
}
static
-enum bt_ctf_notif_iter_status after_packet_context_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status after_packet_context_state(
+ struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status;
+ enum bt_notif_iter_status status;
status = set_current_packet_content_sizes(notit);
- if (status == BT_CTF_NOTIF_ITER_STATUS_OK) {
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
+ goto end;
+ }
+
+ if (notit->stream_begin_emitted) {
notit->state = STATE_EMIT_NOTIF_NEW_PACKET;
+ } else {
+ notit->state = STATE_EMIT_NOTIF_NEW_STREAM;
}
+end:
return status;
}
static
-enum bt_ctf_notif_iter_status read_event_header_begin_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_event_header_begin_state(
+ struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- struct bt_ctf_field_type *event_header_type = NULL;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ struct ctf_field_class *event_header_fc = NULL;
+
+ /* Reset the position of the last event header */
+ notit->buf.last_eh_at = notit->buf.at;
+ notit->cur_event_class_id = -1;
/* Check if we have some content left */
- if (notit->cur_content_size >= 0) {
- if (packet_at(notit) == notit->cur_content_size) {
+ if (notit->cur_exp_packet_content_size >= 0) {
+ if (unlikely(packet_at(notit) ==
+ notit->cur_exp_packet_content_size)) {
/* No more events! */
+ BT_LOGV("Reached end of packet: notit-addr=%p, "
+ "cur=%zu", notit, packet_at(notit));
notit->state = STATE_EMIT_NOTIF_END_OF_PACKET;
goto end;
- } else if (packet_at(notit) > notit->cur_content_size) {
+ } else if (unlikely(packet_at(notit) >
+ notit->cur_exp_packet_content_size)) {
/* That's not supposed to happen */
- PERR("Cursor passed packet's content size:\n");
- PERR("\tDecoded content size: %zu\n",
- notit->cur_content_size);
- PERR("\tCursor position: %zu\n", packet_at(notit));
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ BT_LOGV("Before decoding event header field: cursor is passed the packet's content: "
+ "notit-addr=%p, content-size=%" PRId64 ", "
+ "cur=%zu", notit,
+ notit->cur_exp_packet_content_size,
+ packet_at(notit));
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
+ } else {
+ /*
+ * "Infinite" content: we're done when the medium has
+ * nothing else for us.
+ */
+ status = buf_ensure_available_bits(notit);
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
+ /*
+ * If this function returns
+ * `BT_NOTIF_ITER_STATUS_EOF`:
+ *
+ * 1. bt_notif_iter_get_next_notification()
+ * emits a "packet end" notification. This
+ * resets the current packet. The state
+ * remains unchanged otherwise.
+ * 2. This function is called again. It returns
+ * `BT_NOTIF_ITER_STATUS_EOF` again.
+ * 3. bt_notif_iter_get_next_notification()
+ * emits a "stream end" notification because
+ * there's no current packet. It sets the
+ * current state to `STATE_DONE`.
+ */
goto end;
}
}
- event_header_type = bt_ctf_stream_class_get_event_header_type(
- notit->meta.stream_class);
- if (!event_header_type) {
- PERR("Failed to retrieve stream class's event header type\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ release_event_dscopes(notit);
+ BT_ASSERT(notit->meta.sc);
+ event_header_fc = notit->meta.sc->event_header_fc;
+ if (!event_header_fc) {
+ notit->state = STATE_AFTER_EVENT_HEADER;
goto end;
}
- put_event_dscopes(notit);
- status = read_dscope_begin_state(notit, event_header_type,
- STATE_AFTER_STREAM_EVENT_HEADER,
- STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE,
- ¬it->dscopes.stream_event_header);
-end:
- BT_PUT(event_header_type);
+ if (event_header_fc->in_ir) {
+ BT_ASSERT(!notit->event_header_field);
+ notit->event_header_field =
+ bt_private_event_header_field_create(
+ notit->meta.sc->ir_sc);
+ if (!notit->event_header_field) {
+ BT_LOGE_STR("Cannot create event header field wrapper from trace.");
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
+ notit->dscopes.event_header =
+ bt_private_event_header_field_borrow_field(
+ notit->event_header_field);
+ BT_ASSERT(notit->dscopes.event_header);
+ }
+
+ BT_LOGV("Decoding event header field: "
+ "notit-addr=%p, stream-class-addr=%p, "
+ "stream-class-id=%" PRId64 ", "
+ "fc-addr=%p",
+ notit, notit->meta.sc,
+ notit->meta.sc->id,
+ event_header_fc);
+ status = read_dscope_begin_state(notit, event_header_fc,
+ STATE_AFTER_EVENT_HEADER,
+ STATE_DSCOPE_EVENT_HEADER_CONTINUE,
+ notit->dscopes.event_header);
+ if (status < 0) {
+ BT_LOGW("Cannot decode event header field: "
+ "notit-addr=%p, stream-class-addr=%p, "
+ "stream-class-id=%" PRId64 ", fc-addr=%p",
+ notit, notit->meta.sc,
+ notit->meta.sc->id,
+ event_header_fc);
+ }
+
+end:
return status;
}
static
-enum bt_ctf_notif_iter_status read_event_header_continue_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_event_header_continue_state(
+ struct bt_notif_iter *notit)
{
return read_dscope_continue_state(notit,
- STATE_AFTER_STREAM_EVENT_HEADER);
+ STATE_AFTER_EVENT_HEADER);
}
static inline
-enum bt_ctf_notif_iter_status set_current_event_class(struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status set_current_event_class(struct bt_notif_iter *notit)
{
- /*
- * The assert() calls in this function are okay because it is
- * assumed here that all the metadata objects have been
- * validated for CTF correctness before decoding actual streams.
- */
-
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- struct bt_ctf_field_type *event_header_type;
- struct bt_ctf_field_type *id_field_type = NULL;
- struct bt_ctf_field_type *v_field_type = NULL;
- uint64_t event_id = -1ULL;
- int ret;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
- event_header_type = bt_ctf_stream_class_get_event_header_type(
- notit->meta.stream_class);
- if (!event_header_type) {
- PERR("Failed to retrieve stream class's event header type\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
- goto end;
- }
+ struct ctf_event_class *new_event_class = NULL;
- /* Is there any "id"/"v" field in the event header? */
- assert(is_struct_type(event_header_type));
- id_field_type = bt_ctf_field_type_structure_get_field_type_by_name(
- event_header_type, "id");
- v_field_type = bt_ctf_field_type_structure_get_field_type_by_name(
- event_header_type, "v");
- assert(notit->dscopes.stream_event_header);
- if (v_field_type) {
+ if (notit->cur_event_class_id == -1) {
/*
- * _ _____ _____
- * | | |_ _|_ _| __ __ _
- * | | | | | || '_ \ / _` |
- * | |___| | | || | | | (_| | S P E C I A L
- * |_____|_| |_||_| |_|\__, | C A S E â„¢
- * |___/
+ * No current event class ID field, therefore only one
+ * event class.
*/
- struct bt_ctf_field *v_field = NULL;
- struct bt_ctf_field *v_struct_field = NULL;
- struct bt_ctf_field *v_struct_id_field = NULL;
-
- // TODO: optimalize!
- v_field = bt_ctf_field_structure_get_field(
- notit->dscopes.stream_event_header, "v");
- assert(v_field);
-
- v_struct_field =
- bt_ctf_field_variant_get_current_field(v_field);
- if (!v_struct_field) {
- goto end_v_field_type;
- }
-
- // TODO: optimalize!
- v_struct_id_field =
- bt_ctf_field_structure_get_field(v_struct_field, "id");
- if (!v_struct_id_field) {
- goto end_v_field_type;
+ if (notit->meta.sc->event_classes->len != 1) {
+ BT_LOGW("Need exactly one event class since there's "
+ "no event class ID field: "
+ "notit-addr=%p, trace-name=\"%s\"",
+ notit, notit->meta.tc->name->str);
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
}
- ret = bt_ctf_field_unsigned_integer_get_value(
- v_struct_id_field, &event_id);
- if (ret) {
- event_id = -1ULL;
- }
+ new_event_class = notit->meta.sc->event_classes->pdata[0];
+ notit->cur_event_class_id = new_event_class->id;
+ goto end;
+ }
-end_v_field_type:
- BT_PUT(v_field);
- BT_PUT(v_struct_field);
- BT_PUT(v_struct_id_field);
+ new_event_class = ctf_stream_class_borrow_event_class_by_id(
+ notit->meta.sc, notit->cur_event_class_id);
+ if (!new_event_class) {
+ BT_LOGW("No event class with ID of event class ID to use in stream class: "
+ "notit-addr=%p, stream-class-id=%" PRIu64 ", "
+ "event-class-id=%" PRIu64 ", "
+ "trace-addr=%p, trace-name=\"%s\"",
+ notit, notit->meta.sc->id, notit->cur_event_class_id,
+ notit->meta.tc, notit->meta.tc->name->str);
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
}
- if (id_field_type && event_id == -1ULL) {
- /* Check "id" field */
- struct bt_ctf_field *id_field = NULL;
- int ret;
+ notit->meta.ec = new_event_class;
+ BT_LOGV("Set current event class: "
+ "notit-addr=%p, event-class-addr=%p, "
+ "event-class-id=%" PRId64 ", "
+ "event-class-name=\"%s\"",
+ notit, notit->meta.ec, notit->meta.ec->id,
+ notit->meta.ec->name->str);
- // TODO: optimalize!
- id_field = bt_ctf_field_structure_get_field(
- notit->dscopes.stream_event_header, "id");
- assert(id_field);
- assert(bt_ctf_field_is_integer(id_field) ||
- bt_ctf_field_is_enumeration(id_field));
+end:
+ return status;
+}
- if (bt_ctf_field_is_integer(id_field)) {
- ret = bt_ctf_field_unsigned_integer_get_value(
- id_field, &event_id);
- } else {
- struct bt_ctf_field *container;
-
- container = bt_ctf_field_enumeration_get_container(
- id_field);
- assert(container);
- ret = bt_ctf_field_unsigned_integer_get_value(
- container, &event_id);
- BT_PUT(container);
- }
- assert(!ret);
- BT_PUT(id_field);
+static inline
+enum bt_notif_iter_status set_current_event_notification(
+ struct bt_notif_iter *notit)
+{
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ struct bt_private_notification *notif = NULL;
+
+ BT_ASSERT(notit->meta.ec);
+ BT_ASSERT(notit->packet);
+ BT_LOGV("Creating event notification from event class and packet: "
+ "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", packet-addr=%p",
+ notit, notit->meta.ec,
+ notit->meta.ec->name->str,
+ notit->packet);
+ BT_ASSERT(notit->notif_iter);
+ notif = bt_private_notification_event_create(notit->notif_iter,
+ notit->meta.ec->ir_ec, notit->packet);
+ if (!notif) {
+ BT_LOGE("Cannot create event notification: "
+ "notit-addr=%p, ec-addr=%p, ec-name=\"%s\", "
+ "packet-addr=%p",
+ notit, notit->meta.ec,
+ notit->meta.ec->name->str,
+ notit->packet);
+ goto error;
}
- if (event_id == -1ULL) {
- /* Event ID not found: single event? */
- assert(bt_ctf_stream_class_get_event_class_count(
- notit->meta.stream_class) == 1);
- event_id = 0;
- }
+ goto end;
- BT_PUT(notit->meta.event_class);
- notit->meta.event_class = bt_ctf_stream_class_get_event_class_by_id(
- notit->meta.stream_class, event_id);
- if (!notit->meta.event_class) {
- PERR("Cannot find event class with ID %" PRIu64 "\n", event_id);
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
- goto end;
- }
+error:
+ BT_OBJECT_PUT_REF_AND_RESET(notif);
+ status = BT_NOTIF_ITER_STATUS_ERROR;
end:
- BT_PUT(event_header_type);
- BT_PUT(id_field_type);
- BT_PUT(v_field_type);
-
+ BT_OBJECT_MOVE_REF(notit->event_notif, notif);
return status;
}
static
-enum bt_ctf_notif_iter_status after_event_header_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status after_event_header_state(
+ struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status;
+ enum bt_notif_iter_status status;
- status = set_current_packet_content_sizes(notit);
- if (status != BT_CTF_NOTIF_ITER_STATUS_OK) {
- PERR("Failed to set current packet and content sizes\n");
+ status = set_current_event_class(notit);
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
goto end;
}
- status = set_current_event_class(notit);
- if (status != BT_CTF_NOTIF_ITER_STATUS_OK) {
- PERR("Failed to set current event class\n");
+ status = set_current_event_notification(notit);
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
goto end;
}
- notit->state = STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN;
+ notit->event = bt_private_notification_event_borrow_event(
+ notit->event_notif);
+ BT_ASSERT(notit->event);
+
+ if (notit->event_header_field) {
+ int ret;
+
+ BT_ASSERT(notit->event);
+ ret = bt_private_event_move_header_field(notit->event,
+ notit->event_header_field);
+ if (ret) {
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
+
+ notit->event_header_field = NULL;
+
+ /*
+ * At this point notit->dscopes.event_header has
+ * the same value as the event header field within
+ * notit->event.
+ */
+ BT_ASSERT(bt_private_event_borrow_header_field(
+ notit->event) == notit->dscopes.event_header);
+ }
+
+ notit->state = STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN;
end:
return status;
}
static
-enum bt_ctf_notif_iter_status read_stream_event_context_begin_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_event_common_context_begin_state(
+ struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- struct bt_ctf_field_type *stream_event_context_type;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ struct ctf_field_class *event_common_context_fc;
- stream_event_context_type = bt_ctf_stream_class_get_event_context_type(
- notit->meta.stream_class);
- if (!stream_event_context_type) {
- PERR("Failed to retrieve stream class's event context type\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ event_common_context_fc = notit->meta.sc->event_common_context_fc;
+ if (!event_common_context_fc) {
+ notit->state = STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN;
goto end;
}
- status = read_dscope_begin_state(notit, stream_event_context_type,
- STATE_DSCOPE_EVENT_CONTEXT_BEGIN,
- STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE,
- ¬it->dscopes.stream_event_context);
+ if (event_common_context_fc->in_ir) {
+ BT_ASSERT(!notit->dscopes.event_common_context);
+ notit->dscopes.event_common_context =
+ bt_private_event_borrow_common_context_field(
+ notit->event);
+ BT_ASSERT(notit->dscopes.event_common_context);
+ }
+
+ BT_LOGV("Decoding event common context field: "
+ "notit-addr=%p, stream-class-addr=%p, "
+ "stream-class-id=%" PRId64 ", "
+ "fc-addr=%p",
+ notit, notit->meta.sc,
+ notit->meta.sc->id,
+ event_common_context_fc);
+ status = read_dscope_begin_state(notit, event_common_context_fc,
+ STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN,
+ STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE,
+ notit->dscopes.event_common_context);
+ if (status < 0) {
+ BT_LOGW("Cannot decode event common context field: "
+ "notit-addr=%p, stream-class-addr=%p, "
+ "stream-class-id=%" PRId64 ", fc-addr=%p",
+ notit, notit->meta.sc,
+ notit->meta.sc->id,
+ event_common_context_fc);
+ }
end:
- BT_PUT(stream_event_context_type);
-
return status;
}
static
-enum bt_ctf_notif_iter_status read_stream_event_context_continue_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_event_common_context_continue_state(
+ struct bt_notif_iter *notit)
{
return read_dscope_continue_state(notit,
- STATE_DSCOPE_EVENT_CONTEXT_BEGIN);
+ STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN);
}
static
-enum bt_ctf_notif_iter_status read_event_context_begin_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_event_spec_context_begin_state(
+ struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- struct bt_ctf_field_type *event_context_type;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ struct ctf_field_class *event_spec_context_fc;
- event_context_type = bt_ctf_event_class_get_context_type(
- notit->meta.event_class);
- if (!event_context_type) {
- PERR("Failed to retrieve event class's context type\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ event_spec_context_fc = notit->meta.ec->spec_context_fc;
+ if (!event_spec_context_fc) {
+ notit->state = STATE_DSCOPE_EVENT_PAYLOAD_BEGIN;
goto end;
}
- status = read_dscope_begin_state(notit, event_context_type,
+ if (event_spec_context_fc->in_ir) {
+ BT_ASSERT(!notit->dscopes.event_spec_context);
+ notit->dscopes.event_spec_context =
+ bt_private_event_borrow_specific_context_field(
+ notit->event);
+ BT_ASSERT(notit->dscopes.event_spec_context);
+ }
+
+ BT_LOGV("Decoding event specific context field: "
+ "notit-addr=%p, event-class-addr=%p, "
+ "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
+ "fc-addr=%p",
+ notit, notit->meta.ec,
+ notit->meta.ec->name->str,
+ notit->meta.ec->id,
+ event_spec_context_fc);
+ status = read_dscope_begin_state(notit, event_spec_context_fc,
STATE_DSCOPE_EVENT_PAYLOAD_BEGIN,
- STATE_DSCOPE_EVENT_CONTEXT_CONTINUE,
- ¬it->dscopes.event_context);
+ STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE,
+ notit->dscopes.event_spec_context);
+ if (status < 0) {
+ BT_LOGW("Cannot decode event specific context field: "
+ "notit-addr=%p, event-class-addr=%p, "
+ "event-class-name=\"%s\", "
+ "event-class-id=%" PRId64 ", fc-addr=%p",
+ notit, notit->meta.ec,
+ notit->meta.ec->name->str,
+ notit->meta.ec->id,
+ event_spec_context_fc);
+ }
end:
- BT_PUT(event_context_type);
-
return status;
}
static
-enum bt_ctf_notif_iter_status read_event_context_continue_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_event_spec_context_continue_state(
+ struct bt_notif_iter *notit)
{
return read_dscope_continue_state(notit,
STATE_DSCOPE_EVENT_PAYLOAD_BEGIN);
}
static
-enum bt_ctf_notif_iter_status read_event_payload_begin_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_event_payload_begin_state(
+ struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
- struct bt_ctf_field_type *event_payload_type;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ struct ctf_field_class *event_payload_fc;
- event_payload_type = bt_ctf_event_class_get_payload_type(
- notit->meta.event_class);
- if (!event_payload_type) {
- PERR("Failed to retrieve event class's payload type\n");
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ event_payload_fc = notit->meta.ec->payload_fc;
+ if (!event_payload_fc) {
+ notit->state = STATE_EMIT_NOTIF_EVENT;
goto end;
}
- status = read_dscope_begin_state(notit, event_payload_type,
+ if (event_payload_fc->in_ir) {
+ BT_ASSERT(!notit->dscopes.event_payload);
+ notit->dscopes.event_payload =
+ bt_private_event_borrow_payload_field(
+ notit->event);
+ BT_ASSERT(notit->dscopes.event_payload);
+ }
+
+ BT_LOGV("Decoding event payload field: "
+ "notit-addr=%p, event-class-addr=%p, "
+ "event-class-name=\"%s\", event-class-id=%" PRId64 ", "
+ "fc-addr=%p",
+ notit, notit->meta.ec,
+ notit->meta.ec->name->str,
+ notit->meta.ec->id,
+ event_payload_fc);
+ status = read_dscope_begin_state(notit, event_payload_fc,
STATE_EMIT_NOTIF_EVENT,
STATE_DSCOPE_EVENT_PAYLOAD_CONTINUE,
- ¬it->dscopes.event_payload);
+ notit->dscopes.event_payload);
+ if (status < 0) {
+ BT_LOGW("Cannot decode event payload field: "
+ "notit-addr=%p, event-class-addr=%p, "
+ "event-class-name=\"%s\", "
+ "event-class-id=%" PRId64 ", fc-addr=%p",
+ notit, notit->meta.ec,
+ notit->meta.ec->name->str,
+ notit->meta.ec->id,
+ event_payload_fc);
+ }
end:
- BT_PUT(event_payload_type);
-
return status;
}
static
-enum bt_ctf_notif_iter_status read_event_payload_continue_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status read_event_payload_continue_state(
+ struct bt_notif_iter *notit)
{
return read_dscope_continue_state(notit, STATE_EMIT_NOTIF_EVENT);
}
static
-enum bt_ctf_notif_iter_status skip_packet_padding_state(
- struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status skip_packet_padding_state(
+ struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
size_t bits_to_skip;
- assert(notit->cur_packet_size > 0);
- bits_to_skip = notit->cur_packet_size - packet_at(notit);
+ BT_ASSERT(notit->cur_exp_packet_total_size > 0);
+ bits_to_skip = notit->cur_exp_packet_total_size - packet_at(notit);
if (bits_to_skip == 0) {
notit->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN;
goto end;
} else {
size_t bits_to_consume;
+
+ BT_LOGV("Trying to skip %zu bits of padding: notit-addr=%p, size=%zu",
+ bits_to_skip, notit, bits_to_skip);
status = buf_ensure_available_bits(notit);
- if (status != BT_CTF_NOTIF_ITER_STATUS_OK) {
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
goto end;
}
bits_to_consume = MIN(buf_available_bits(notit), bits_to_skip);
+ BT_LOGV("Skipping %zu bits of padding: notit-addr=%p, size=%zu",
+ bits_to_consume, notit, bits_to_consume);
buf_consume_bits(notit, bits_to_consume);
- bits_to_skip = notit->cur_packet_size - packet_at(notit);
+ bits_to_skip = notit->cur_exp_packet_total_size -
+ packet_at(notit);
if (bits_to_skip == 0) {
notit->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN;
goto end;
}
static inline
-enum bt_ctf_notif_iter_status handle_state(struct bt_ctf_notif_iter *notit)
+enum bt_notif_iter_status handle_state(struct bt_notif_iter *notit)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+ const enum state state = notit->state;
- PDBG("Handling state %d\n", notit->state);
+ BT_LOGV("Handling state: notit-addr=%p, state=%s",
+ notit, state_string(state));
// TODO: optimalize!
- switch (notit->state) {
+ switch (state) {
case STATE_INIT:
notit->state = STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN;
break;
case STATE_AFTER_STREAM_PACKET_CONTEXT:
status = after_packet_context_state(notit);
break;
+ case STATE_EMIT_NOTIF_NEW_STREAM:
+ notit->state = STATE_EMIT_NOTIF_NEW_PACKET;
+ break;
case STATE_EMIT_NOTIF_NEW_PACKET:
- notit->state = STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN;
+ notit->state = STATE_DSCOPE_EVENT_HEADER_BEGIN;
break;
- case STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN:
+ case STATE_DSCOPE_EVENT_HEADER_BEGIN:
status = read_event_header_begin_state(notit);
break;
- case STATE_DSCOPE_STREAM_EVENT_HEADER_CONTINUE:
+ case STATE_DSCOPE_EVENT_HEADER_CONTINUE:
status = read_event_header_continue_state(notit);
break;
- case STATE_AFTER_STREAM_EVENT_HEADER:
+ case STATE_AFTER_EVENT_HEADER:
status = after_event_header_state(notit);
break;
- case STATE_DSCOPE_STREAM_EVENT_CONTEXT_BEGIN:
- status = read_stream_event_context_begin_state(notit);
+ case STATE_DSCOPE_EVENT_COMMON_CONTEXT_BEGIN:
+ status = read_event_common_context_begin_state(notit);
break;
- case STATE_DSCOPE_STREAM_EVENT_CONTEXT_CONTINUE:
- status = read_stream_event_context_continue_state(notit);
+ case STATE_DSCOPE_EVENT_COMMON_CONTEXT_CONTINUE:
+ status = read_event_common_context_continue_state(notit);
break;
- case STATE_DSCOPE_EVENT_CONTEXT_BEGIN:
- status = read_event_context_begin_state(notit);
+ case STATE_DSCOPE_EVENT_SPEC_CONTEXT_BEGIN:
+ status = read_event_spec_context_begin_state(notit);
break;
- case STATE_DSCOPE_EVENT_CONTEXT_CONTINUE:
- status = read_event_context_continue_state(notit);
+ case STATE_DSCOPE_EVENT_SPEC_CONTEXT_CONTINUE:
+ status = read_event_spec_context_continue_state(notit);
break;
case STATE_DSCOPE_EVENT_PAYLOAD_BEGIN:
status = read_event_payload_begin_state(notit);
status = read_event_payload_continue_state(notit);
break;
case STATE_EMIT_NOTIF_EVENT:
- notit->state = STATE_DSCOPE_STREAM_EVENT_HEADER_BEGIN;
+ notit->state = STATE_DSCOPE_EVENT_HEADER_BEGIN;
break;
case STATE_SKIP_PACKET_PADDING:
status = skip_packet_padding_state(notit);
case STATE_EMIT_NOTIF_END_OF_PACKET:
notit->state = STATE_SKIP_PACKET_PADDING;
break;
+ default:
+ BT_LOGD("Unknown CTF plugin notification iterator state: "
+ "notit-addr=%p, state=%d", notit, notit->state);
+ abort();
}
+ BT_LOGV("Handled state: notit-addr=%p, status=%s, "
+ "prev-state=%s, cur-state=%s",
+ notit, bt_notif_iter_status_string(status),
+ state_string(state), state_string(notit->state));
return status;
}
-
/**
* Resets the internal state of a CTF notification iterator.
- *
- * This function can be used when it is desired to seek to the beginning
- * of another packet. It is expected that the next call to
- * bt_ctf_notif_iter_medium_ops::request_bytes() made by this
- * notification iterator will return the \em first bytes of a \em
- * packet.
- *
- * @param notif_iter CTF notification iterator
*/
-static
-void bt_ctf_notif_iter_reset(struct bt_ctf_notif_iter *notit)
+BT_HIDDEN
+void bt_notif_iter_reset(struct bt_notif_iter *notit)
{
- assert(notit);
+ BT_ASSERT(notit);
+ BT_LOGD("Resetting notification iterator: addr=%p", notit);
stack_clear(notit->stack);
- BT_PUT(notit->meta.stream_class);
- BT_PUT(notit->meta.event_class);
- BT_PUT(notit->packet);
- put_all_dscopes(notit);
+ notit->meta.sc = NULL;
+ notit->meta.ec = NULL;
+ BT_OBJECT_PUT_REF_AND_RESET(notit->packet);
+ BT_OBJECT_PUT_REF_AND_RESET(notit->stream);
+ BT_OBJECT_PUT_REF_AND_RESET(notit->event_notif);
+ release_all_dscopes(notit);
+ notit->cur_dscope_field = NULL;
+
+ if (notit->packet_header_field) {
+ bt_private_packet_header_field_release(notit->packet_header_field);
+ notit->packet_header_field = NULL;
+ }
+
+ if (notit->packet_context_field) {
+ bt_private_packet_context_field_release(notit->packet_context_field);
+ notit->packet_context_field = NULL;
+ }
+
+ if (notit->event_header_field) {
+ bt_private_event_header_field_release(notit->event_header_field);
+ notit->event_header_field = NULL;
+ }
+
notit->buf.addr = NULL;
notit->buf.sz = 0;
notit->buf.at = 0;
+ notit->buf.last_eh_at = SIZE_MAX;
notit->buf.packet_offset = 0;
notit->state = STATE_INIT;
- notit->cur_content_size = -1;
- notit->cur_packet_size = -1;
+ notit->cur_exp_packet_content_size = -1;
+ notit->cur_exp_packet_total_size = -1;
+ notit->cur_packet_offset = -1;
+ notit->cur_stream_class_id = -1;
+ notit->cur_event_class_id = -1;
+ notit->cur_data_stream_id = -1;
+ notit->stream_begin_emitted = false;
}
static
-int bt_ctf_notif_iter_switch_packet(struct bt_ctf_notif_iter *notit)
+int bt_notif_iter_switch_packet(struct bt_notif_iter *notit)
{
int ret = 0;
- assert(notit);
+ /*
+ * We don't put the stream class here because we need to make
+ * sure that all the packets processed by the same notification
+ * iterator refer to the same stream class (the first one).
+ */
+ BT_ASSERT(notit);
+
+ if (notit->cur_exp_packet_total_size != -1) {
+ notit->cur_packet_offset += notit->cur_exp_packet_total_size;
+ }
+
+ BT_LOGV("Switching packet: notit-addr=%p, cur=%zu, "
+ "packet-offset=%" PRId64, notit, notit->buf.at,
+ notit->cur_packet_offset);
stack_clear(notit->stack);
- BT_PUT(notit->meta.stream_class);
- BT_PUT(notit->meta.event_class);
- BT_PUT(notit->packet);
- put_all_dscopes(notit);
+ notit->meta.ec = NULL;
+ BT_OBJECT_PUT_REF_AND_RESET(notit->packet);
+ BT_OBJECT_PUT_REF_AND_RESET(notit->event_notif);
+ release_all_dscopes(notit);
+ notit->cur_dscope_field = NULL;
/*
* Adjust current buffer so that addr points to the beginning of the new
/* Packets are assumed to start on a byte frontier. */
if (notit->buf.at % CHAR_BIT) {
+ BT_LOGW("Cannot switch packet: current position is not a multiple of 8: "
+ "notit-addr=%p, cur=%zu", notit, notit->buf.at);
ret = -1;
goto end;
}
notit->buf.sz -= consumed_bytes;
notit->buf.at = 0;
notit->buf.packet_offset = 0;
+ BT_LOGV("Adjusted buffer: addr=%p, size=%zu",
+ notit->buf.addr, notit->buf.sz);
}
- notit->cur_content_size = -1;
- notit->cur_packet_size = -1;
+ notit->cur_exp_packet_content_size = -1;
+ notit->cur_exp_packet_total_size = -1;
+ notit->cur_stream_class_id = -1;
+ notit->cur_event_class_id = -1;
+ notit->cur_data_stream_id = -1;
+ notit->snapshots.discarded_events = UINT64_C(-1);
+ notit->snapshots.packets = UINT64_C(-1);
+ notit->snapshots.beginning_clock = UINT64_C(-1);
+ notit->snapshots.end_clock = UINT64_C(-1);
+
end:
return ret;
}
static
-struct bt_ctf_field *get_next_field(struct bt_ctf_notif_iter *notit)
+struct bt_private_field *borrow_next_field(struct bt_notif_iter *notit)
{
- struct bt_ctf_field *next_field = NULL;
- struct bt_ctf_field *base_field;
- struct bt_ctf_field_type *base_type;
+ struct bt_private_field *next_field = NULL;
+ struct bt_private_field *base_field;
+ struct bt_private_field_class *base_fc;
size_t index;
- assert(!stack_empty(notit->stack));
+ BT_ASSERT(!stack_empty(notit->stack));
index = stack_top(notit->stack)->index;
base_field = stack_top(notit->stack)->base;
- base_type = bt_ctf_field_get_type(base_field);
- if (!base_type) {
- PERR("Failed to get base field's type\n");
- goto end;
+ BT_ASSERT(base_field);
+ base_fc = bt_private_field_borrow_class(base_field);
+ BT_ASSERT(base_fc);
+
+ switch (bt_field_class_get_type(
+ bt_private_field_class_as_field_class(base_fc))) {
+ case BT_FIELD_CLASS_TYPE_STRUCTURE:
+ {
+ BT_ASSERT(index <
+ bt_field_class_structure_get_member_count(
+ bt_private_field_class_as_field_class(
+ bt_private_field_borrow_class(
+ base_field))));
+ next_field =
+ bt_private_field_structure_borrow_member_field_by_index(
+ base_field, index);
+ break;
}
-
- switch (bt_ctf_field_type_get_type_id(base_type)) {
- case BT_CTF_TYPE_ID_STRUCT:
- next_field = bt_ctf_field_structure_get_field_by_index(
+ case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
+ case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
+ BT_ASSERT(index < bt_field_array_get_length(
+ bt_private_field_as_field(base_field)));
+ next_field = bt_private_field_array_borrow_element_field_by_index(
base_field, index);
break;
- case BT_CTF_TYPE_ID_ARRAY:
- next_field = bt_ctf_field_array_get_field(base_field, index);
- break;
- case BT_CTF_TYPE_ID_SEQUENCE:
- next_field = bt_ctf_field_sequence_get_field(base_field, index);
- break;
- case BT_CTF_TYPE_ID_VARIANT:
- next_field = bt_ctf_field_variant_get_current_field(base_field);
+ case BT_FIELD_CLASS_TYPE_VARIANT:
+ BT_ASSERT(index == 0);
+ next_field = bt_private_field_variant_borrow_selected_option_field(
+ base_field);
break;
default:
- assert(false);
- break;
+ abort();
+ }
+
+ BT_ASSERT(next_field);
+ return next_field;
+}
+
+static
+void update_default_clock(struct bt_notif_iter *notit, uint64_t new_val,
+ uint64_t new_val_size)
+{
+ uint64_t new_val_mask;
+ uint64_t cur_value_masked;
+
+ BT_ASSERT(new_val_size > 0);
+
+ /*
+ * Special case for a 64-bit new value, which is the limit
+ * of a clock value as of this version: overwrite the
+ * current value directly.
+ */
+ if (new_val_size == 64) {
+ notit->default_clock_val = new_val;
+ goto end;
}
- if (!next_field) {
- next_field = NULL;
+ new_val_mask = (1ULL << new_val_size) - 1;
+ cur_value_masked = notit->default_clock_val & new_val_mask;
+
+ if (new_val < cur_value_masked) {
+ /*
+ * It looks like a wrap happened on the number of bits
+ * of the requested new value. Assume that the clock
+ * value wrapped only one time.
+ */
+ notit->default_clock_val += new_val_mask + 1;
}
-end:
- BT_PUT(base_type);
+ /* Clear the low bits of the current clock value. */
+ notit->default_clock_val &= ~new_val_mask;
- return next_field;
+ /* Set the low bits of the current clock value. */
+ notit->default_clock_val |= new_val;
+
+end:
+ BT_LOGV("Updated default clock's value from integer field's value: "
+ "value=%" PRIu64, notit->default_clock_val);
}
static
-enum bt_ctf_btr_status btr_signed_int_cb(int64_t value,
- struct bt_ctf_field_type *type, void *data)
+enum bt_bfcr_status bfcr_unsigned_int_cb(uint64_t value,
+ struct ctf_field_class *fc, void *data)
{
- enum bt_ctf_btr_status status = BT_CTF_BTR_STATUS_OK;
- struct bt_ctf_field *field = NULL;
- struct bt_ctf_field *int_field = NULL;
- struct bt_ctf_notif_iter *notit = data;
- int ret;
+ struct bt_notif_iter *notit = data;
+ enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
+ struct bt_private_field *field = NULL;
+ struct ctf_field_class_int *int_fc = (void *) fc;
- /* create next field */
- field = get_next_field(notit);
- if (!field) {
- PERR("Failed to get next field (signed int)\n");
- status = BT_CTF_BTR_STATUS_ERROR;
- goto end;
+ BT_LOGV("Unsigned integer function called from BFCR: "
+ "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
+ "fc-type=%d, fc-in-ir=%d, value=%" PRIu64,
+ notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
+
+ if (likely(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE)) {
+ goto update_def_clock;
}
- switch(bt_ctf_field_type_get_type_id(type)) {
- case BT_CTF_TYPE_ID_INTEGER:
- /* Integer field is created field */
- BT_MOVE(int_field, field);
+ switch (int_fc->meaning) {
+ case CTF_FIELD_CLASS_MEANING_EVENT_CLASS_ID:
+ notit->cur_event_class_id = value;
break;
- case BT_CTF_TYPE_ID_ENUM:
- int_field = bt_ctf_field_enumeration_get_container(field);
+ case CTF_FIELD_CLASS_MEANING_DATA_STREAM_ID:
+ notit->cur_data_stream_id = value;
break;
- default:
+ case CTF_FIELD_CLASS_MEANING_PACKET_BEGINNING_TIME:
+ notit->snapshots.beginning_clock = value;
+ break;
+ case CTF_FIELD_CLASS_MEANING_PACKET_END_TIME:
+ notit->snapshots.end_clock = value;
break;
+ case CTF_FIELD_CLASS_MEANING_STREAM_CLASS_ID:
+ notit->cur_stream_class_id = value;
+ break;
+ case CTF_FIELD_CLASS_MEANING_MAGIC:
+ if (value != 0xc1fc1fc1) {
+ BT_LOGW("Invalid CTF magic number: notit-addr=%p, "
+ "magic=%" PRIx64, notit, value);
+ status = BT_BFCR_STATUS_ERROR;
+ goto end;
+ }
+
+ break;
+ case CTF_FIELD_CLASS_MEANING_PACKET_COUNTER_SNAPSHOT:
+ notit->snapshots.packets = value;
+ break;
+ case CTF_FIELD_CLASS_MEANING_DISC_EV_REC_COUNTER_SNAPSHOT:
+ notit->snapshots.discarded_events = value;
+ break;
+ case CTF_FIELD_CLASS_MEANING_EXP_PACKET_TOTAL_SIZE:
+ notit->cur_exp_packet_total_size = value;
+ break;
+ case CTF_FIELD_CLASS_MEANING_EXP_PACKET_CONTENT_SIZE:
+ notit->cur_exp_packet_content_size = value;
+ break;
+ default:
+ abort();
+ }
+
+update_def_clock:
+ if (unlikely(int_fc->mapped_clock_class)) {
+ update_default_clock(notit, value, int_fc->base.size);
+ }
+
+ if (unlikely(int_fc->storing_index >= 0)) {
+ g_array_index(notit->stored_values, uint64_t,
+ (uint64_t) int_fc->storing_index) = value;
}
- if (!int_field) {
- PERR("Failed to get integer field\n");
- status = BT_CTF_BTR_STATUS_ERROR;
+ if (unlikely(!fc->in_ir)) {
goto end;
}
- ret = bt_ctf_field_signed_integer_set_value(int_field, value);
- assert(!ret);
+ field = borrow_next_field(notit);
+ BT_ASSERT(field);
+ BT_ASSERT(bt_private_field_borrow_class(field) == fc->ir_fc);
+ BT_ASSERT(bt_field_get_class_type(
+ bt_private_field_as_field(field)) ==
+ BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
+ bt_field_get_class_type(bt_private_field_as_field(field)) ==
+ BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
+ bt_private_field_unsigned_integer_set_value(field, value);
stack_top(notit->stack)->index++;
end:
- BT_PUT(field);
- BT_PUT(int_field);
-
return status;
}
static
-enum bt_ctf_btr_status btr_unsigned_int_cb(uint64_t value,
- struct bt_ctf_field_type *type, void *data)
+enum bt_bfcr_status bfcr_unsigned_int_char_cb(uint64_t value,
+ struct ctf_field_class *fc, void *data)
{
- enum bt_ctf_btr_status status = BT_CTF_BTR_STATUS_OK;
- struct bt_ctf_field *field = NULL;
- struct bt_ctf_field *int_field = NULL;
- struct bt_ctf_notif_iter *notit = data;
int ret;
-
- /* Create next field */
- field = get_next_field(notit);
- if (!field) {
- PERR("Failed to get next field (unsigned int)\n");
- status = BT_CTF_BTR_STATUS_ERROR;
+ struct bt_notif_iter *notit = data;
+ enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
+ struct bt_private_field *string_field = NULL;
+ struct ctf_field_class_int *int_fc = (void *) fc;
+ char str[2] = {'\0', '\0'};
+
+ BT_LOGV("Unsigned integer character function called from BFCR: "
+ "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
+ "fc-type=%d, fc-in-ir=%d, value=%" PRIu64,
+ notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
+ BT_ASSERT(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE);
+ BT_ASSERT(!int_fc->mapped_clock_class);
+ BT_ASSERT(int_fc->storing_index < 0);
+
+ if (unlikely(!fc->in_ir)) {
goto end;
}
- switch(bt_ctf_field_type_get_type_id(type)) {
- case BT_CTF_TYPE_ID_INTEGER:
- /* Integer field is created field */
- BT_MOVE(int_field, field);
- break;
- case BT_CTF_TYPE_ID_ENUM:
- int_field = bt_ctf_field_enumeration_get_container(field);
- break;
- default:
- break;
+ if (notit->done_filling_string) {
+ goto end;
}
- if (!int_field) {
- PERR("Failed to get integer field\n");
- status = BT_CTF_BTR_STATUS_ERROR;
+ if (value == 0) {
+ notit->done_filling_string = true;
goto end;
}
- ret = bt_ctf_field_unsigned_integer_set_value(int_field, value);
- assert(!ret);
- stack_top(notit->stack)->index++;
+ string_field = stack_top(notit->stack)->base;
+ BT_ASSERT(bt_field_get_class_type(
+ bt_private_field_as_field(string_field)) ==
+ BT_FIELD_CLASS_TYPE_STRING);
-end:
- BT_PUT(field);
- BT_PUT(int_field);
+ /* Append character */
+ str[0] = (char) value;
+ ret = bt_private_field_string_append_with_length(string_field, str, 1);
+ if (ret) {
+ BT_LOGE("Cannot append character to string field's value: "
+ "notit-addr=%p, field-addr=%p, ret=%d",
+ notit, string_field, ret);
+ status = BT_BFCR_STATUS_ERROR;
+ goto end;
+ }
+end:
return status;
}
static
-enum bt_ctf_btr_status btr_floating_point_cb(double value,
- struct bt_ctf_field_type *type, void *data)
+enum bt_bfcr_status bfcr_signed_int_cb(int64_t value,
+ struct ctf_field_class *fc, void *data)
{
- enum bt_ctf_btr_status status = BT_CTF_BTR_STATUS_OK;
- struct bt_ctf_field *field = NULL;
- struct bt_ctf_notif_iter *notit = data;
- int ret;
+ enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
+ struct bt_private_field *field = NULL;
+ struct bt_notif_iter *notit = data;
+ struct ctf_field_class_int *int_fc = (void *) fc;
+
+ BT_LOGV("Signed integer function called from BFCR: "
+ "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
+ "fc-type=%d, fc-in-ir=%d, value=%" PRId64,
+ notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
+ BT_ASSERT(int_fc->meaning == CTF_FIELD_CLASS_MEANING_NONE);
+
+ if (unlikely(int_fc->storing_index >= 0)) {
+ g_array_index(notit->stored_values, uint64_t,
+ (uint64_t) int_fc->storing_index) = (uint64_t) value;
+ }
- /* Create next field */
- field = get_next_field(notit);
- if (!field) {
- PERR("Failed to get next field (floating point number)\n");
- status = BT_CTF_BTR_STATUS_ERROR;
+ if (unlikely(!fc->in_ir)) {
goto end;
}
- ret = bt_ctf_field_floating_point_set_value(field, value);
- assert(!ret);
+ field = borrow_next_field(notit);
+ BT_ASSERT(field);
+ BT_ASSERT(bt_private_field_borrow_class(field) == fc->ir_fc);
+ BT_ASSERT(bt_field_get_class_type(
+ bt_private_field_as_field(field)) ==
+ BT_FIELD_CLASS_TYPE_SIGNED_INTEGER ||
+ bt_field_get_class_type(bt_private_field_as_field(field)) ==
+ BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
+ bt_private_field_signed_integer_set_value(field, value);
stack_top(notit->stack)->index++;
end:
- BT_PUT(field);
+ return status;
+}
+static
+enum bt_bfcr_status bfcr_floating_point_cb(double value,
+ struct ctf_field_class *fc, void *data)
+{
+ enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
+ struct bt_private_field *field = NULL;
+ struct bt_notif_iter *notit = data;
+
+ BT_LOGV("Floating point number function called from BFCR: "
+ "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
+ "fc-type=%d, fc-in-ir=%d, value=%f",
+ notit, notit->bfcr, fc, fc->type, fc->in_ir, value);
+ BT_ASSERT(fc->in_ir);
+ field = borrow_next_field(notit);
+ BT_ASSERT(field);
+ BT_ASSERT(bt_private_field_borrow_class(field) == fc->ir_fc);
+ BT_ASSERT(bt_field_get_class_type(
+ bt_private_field_as_field(field)) ==
+ BT_FIELD_CLASS_TYPE_REAL);
+ bt_private_field_real_set_value(field, value);
+ stack_top(notit->stack)->index++;
return status;
}
static
-enum bt_ctf_btr_status btr_string_begin_cb(
- struct bt_ctf_field_type *type, void *data)
+enum bt_bfcr_status bfcr_string_begin_cb(
+ struct ctf_field_class *fc, void *data)
{
- enum bt_ctf_btr_status status = BT_CTF_BTR_STATUS_OK;
- struct bt_ctf_field *field = NULL;
- struct bt_ctf_notif_iter *notit = data;
+ struct bt_private_field *field = NULL;
+ struct bt_notif_iter *notit = data;
int ret;
- /* Create next field */
- field = get_next_field(notit);
- if (!field) {
- PERR("Failed to get next field (string)\n");
- status = BT_CTF_BTR_STATUS_ERROR;
- goto end;
- }
+ BT_LOGV("String (beginning) function called from BFCR: "
+ "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
+ "fc-type=%d, fc-in-ir=%d",
+ notit, notit->bfcr, fc, fc->type, fc->in_ir);
+
+ BT_ASSERT(fc->in_ir);
+ field = borrow_next_field(notit);
+ BT_ASSERT(field);
+ BT_ASSERT(bt_private_field_borrow_class(field) == fc->ir_fc);
+ BT_ASSERT(bt_field_get_class_type(
+ bt_private_field_as_field(field)) ==
+ BT_FIELD_CLASS_TYPE_STRING);
+ ret = bt_private_field_string_clear(field);
+ BT_ASSERT(ret == 0);
/*
- * Push on stack. Not a compound type per se, but we know that only
- * btr_string_cb() may be called between this call and a subsequent
- * call to btr_string_end_cb().
+ * Push on stack. Not a compound class per se, but we know that
+ * only bfcr_string_cb() may be called between this call and a
+ * subsequent call to bfcr_string_end_cb().
*/
- ret = stack_push(notit->stack, field);
- if (ret) {
- PERR("Failed to push string field onto the stack\n");
- status = BT_CTF_BTR_STATUS_ERROR;
- goto end;
- }
-
-end:
- BT_PUT(field);
-
- return status;
+ stack_push(notit->stack, field);
+ return BT_BFCR_STATUS_OK;
}
static
-enum bt_ctf_btr_status btr_string_cb(const char *value,
- size_t len, struct bt_ctf_field_type *type, void *data)
+enum bt_bfcr_status bfcr_string_cb(const char *value,
+ size_t len, struct ctf_field_class *fc, void *data)
{
- enum bt_ctf_btr_status status = BT_CTF_BTR_STATUS_OK;
- struct bt_ctf_field *field = NULL;
- struct bt_ctf_notif_iter *notit = data;
+ enum bt_bfcr_status status = BT_BFCR_STATUS_OK;
+ struct bt_private_field *field = NULL;
+ struct bt_notif_iter *notit = data;
int ret;
- /* Get string field */
+ BT_LOGV("String (substring) function called from BFCR: "
+ "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
+ "fc-type=%d, fc-in-ir=%d, string-length=%zu",
+ notit, notit->bfcr, fc, fc->type, fc->in_ir,
+ len);
+ BT_ASSERT(fc->in_ir);
field = stack_top(notit->stack)->base;
- assert(field);
+ BT_ASSERT(field);
- /* Append current string */
- ret = bt_ctf_field_string_append_len(field, value, len);
+ /* Append current substring */
+ ret = bt_private_field_string_append_with_length(field, value, len);
if (ret) {
- PERR("Failed to append a string to a string field\n");
- status = BT_CTF_BTR_STATUS_ERROR;
+ BT_LOGE("Cannot append substring to string field's value: "
+ "notit-addr=%p, field-addr=%p, string-length=%zu, "
+ "ret=%d", notit, field, len, ret);
+ status = BT_BFCR_STATUS_ERROR;
goto end;
}
}
static
-enum bt_ctf_btr_status btr_string_end_cb(
- struct bt_ctf_field_type *type, void *data)
+enum bt_bfcr_status bfcr_string_end_cb(
+ struct ctf_field_class *fc, void *data)
{
- struct bt_ctf_notif_iter *notit = data;
+ struct bt_notif_iter *notit = data;
+
+ BT_LOGV("String (end) function called from BFCR: "
+ "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
+ "fc-type=%d, fc-in-ir=%d",
+ notit, notit->bfcr, fc, fc->type, fc->in_ir);
+ BT_ASSERT(fc->in_ir);
/* Pop string field */
stack_pop(notit->stack);
/* Go to next field */
stack_top(notit->stack)->index++;
-
- return BT_CTF_BTR_STATUS_OK;
+ return BT_BFCR_STATUS_OK;
}
-enum bt_ctf_btr_status btr_compound_begin_cb(
- struct bt_ctf_field_type *type, void *data)
+enum bt_bfcr_status bfcr_compound_begin_cb(
+ struct ctf_field_class *fc, void *data)
{
- enum bt_ctf_btr_status status = BT_CTF_BTR_STATUS_OK;
- struct bt_ctf_notif_iter *notit = data;
- struct bt_ctf_field *field;
- int ret;
+ struct bt_notif_iter *notit = data;
+ struct bt_private_field *field;
- /* Create field */
- if (stack_empty(notit->stack)) {
- /* Root: create dynamic scope field */
- *notit->cur_dscope_field = bt_ctf_field_create(type);
- field = *notit->cur_dscope_field;
+ BT_LOGV("Compound (beginning) function called from BFCR: "
+ "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
+ "fc-type=%d, fc-in-ir=%d",
+ notit, notit->bfcr, fc, fc->type, fc->in_ir);
- /*
- * Field will be put at the end of this function
- * (stack_push() will take one reference, but this
- * reference is lost upon the equivalent stack_pop()
- * later), so also get it for our context to own it.
- */
- bt_get(*notit->cur_dscope_field);
- } else {
- field = get_next_field(notit);
+ if (!fc->in_ir) {
+ goto end;
}
- if (!field) {
- PERR("Failed to get next field or create dynamic scope field\n");
- status = BT_CTF_BTR_STATUS_ERROR;
- goto end;
+ /* Borrow field */
+ if (stack_empty(notit->stack)) {
+ /* Root: already set by read_dscope_begin_state() */
+ field = notit->cur_dscope_field;
+ } else {
+ field = borrow_next_field(notit);
+ BT_ASSERT(field);
}
/* Push field */
- ret = stack_push(notit->stack, field);
- if (ret) {
- PERR("Failed to push compound field onto the stack\n");
- status = BT_CTF_BTR_STATUS_ERROR;
- goto end;
+ BT_ASSERT(field);
+ BT_ASSERT(bt_private_field_borrow_class(field) == fc->ir_fc);
+ stack_push(notit->stack, field);
+
+ /*
+ * Change BFCR "unsigned int" callback if it's a text
+ * array/sequence.
+ */
+ if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY ||
+ fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) {
+ struct ctf_field_class_array_base *array_fc = (void *) fc;
+
+ if (array_fc->is_text) {
+ int ret;
+
+ BT_ASSERT(bt_field_get_class_type(
+ bt_private_field_as_field(field)) ==
+ BT_FIELD_CLASS_TYPE_STRING);
+ notit->done_filling_string = false;
+ ret = bt_private_field_string_clear(field);
+ BT_ASSERT(ret == 0);
+ bt_bfcr_set_unsigned_int_cb(notit->bfcr,
+ bfcr_unsigned_int_char_cb);
+ }
}
end:
- BT_PUT(field);
-
- return status;
+ return BT_BFCR_STATUS_OK;
}
-enum bt_ctf_btr_status btr_compound_end_cb(
- struct bt_ctf_field_type *type, void *data)
+enum bt_bfcr_status bfcr_compound_end_cb(
+ struct ctf_field_class *fc, void *data)
{
- struct bt_ctf_notif_iter *notit = data;
+ struct bt_notif_iter *notit = data;
+
+ BT_LOGV("Compound (end) function called from BFCR: "
+ "notit-addr=%p, bfcr-addr=%p, fc-addr=%p, "
+ "fc-type=%d, fc-in-ir=%d",
+ notit, notit->bfcr, fc, fc->type, fc->in_ir);
- assert(!stack_empty(notit->stack));
+ if (!fc->in_ir) {
+ goto end;
+ }
+
+ BT_ASSERT(!stack_empty(notit->stack));
+ BT_ASSERT(bt_private_field_borrow_class(stack_top(notit->stack)->base) ==
+ fc->ir_fc);
+
+ /*
+ * Reset BFCR "unsigned int" callback if it's a text
+ * array/sequence.
+ */
+ if (fc->type == CTF_FIELD_CLASS_TYPE_ARRAY ||
+ fc->type == CTF_FIELD_CLASS_TYPE_SEQUENCE) {
+ struct ctf_field_class_array_base *array_fc = (void *) fc;
+
+ if (array_fc->is_text) {
+ BT_ASSERT(bt_field_get_class_type(
+ bt_private_field_as_field(
+ stack_top(notit->stack)->base)) ==
+ BT_FIELD_CLASS_TYPE_STRING);
+ bt_bfcr_set_unsigned_int_cb(notit->bfcr,
+ bfcr_unsigned_int_cb);
+ }
+ }
/* Pop stack */
stack_pop(notit->stack);
stack_top(notit->stack)->index++;
}
- return BT_CTF_BTR_STATUS_OK;
+end:
+ return BT_BFCR_STATUS_OK;
}
static
-struct bt_ctf_field *resolve_field(struct bt_ctf_notif_iter *notit,
- struct bt_ctf_field_path *path)
+int64_t bfcr_get_sequence_length_cb(struct ctf_field_class *fc, void *data)
{
- struct bt_ctf_field *field = NULL;
- unsigned int i;
-
- switch (bt_ctf_field_path_get_root_scope(path)) {
- case BT_CTF_SCOPE_TRACE_PACKET_HEADER:
- field = notit->dscopes.trace_packet_header;
- break;
- case BT_CTF_SCOPE_STREAM_PACKET_CONTEXT:
- field = notit->dscopes.stream_packet_context;
- break;
- case BT_CTF_SCOPE_STREAM_EVENT_HEADER:
- field = notit->dscopes.stream_event_header;
- break;
- case BT_CTF_SCOPE_STREAM_EVENT_CONTEXT:
- field = notit->dscopes.stream_event_context;
- break;
- case BT_CTF_SCOPE_EVENT_CONTEXT:
- field = notit->dscopes.event_context;
- break;
- case BT_CTF_SCOPE_EVENT_FIELDS:
- field = notit->dscopes.event_payload;
- break;
- default:
- break;
- }
+ struct bt_private_field *seq_field;
+ struct bt_notif_iter *notit = data;
+ struct ctf_field_class_sequence *seq_fc = (void *) fc;
+ int64_t length = -1;
+ int ret;
- if (!field) {
- goto end;
+ length = (uint64_t) g_array_index(notit->stored_values, uint64_t,
+ seq_fc->stored_length_index);
+ seq_field = stack_top(notit->stack)->base;
+ BT_ASSERT(seq_field);
+ ret = bt_private_field_dynamic_array_set_length(seq_field, (uint64_t) length);
+ if (ret) {
+ BT_LOGE("Cannot set dynamic array field's length field: "
+ "notit-addr=%p, field-addr=%p, "
+ "length=%" PRIu64, notit, seq_field, length);
}
- bt_get(field);
+ return length;
+}
- for (i = 0; i < bt_ctf_field_path_get_index_count(path); ++i) {
- struct bt_ctf_field *next_field = NULL;
- struct bt_ctf_field_type *field_type;
- int index = bt_ctf_field_path_get_index(path, i);
+static
+struct ctf_field_class *bfcr_borrow_variant_selected_field_class_cb(
+ struct ctf_field_class *fc, void *data)
+{
+ int ret;
+ uint64_t i;
+ int64_t option_index = -1;
+ struct bt_notif_iter *notit = data;
+ struct ctf_field_class_variant *var_fc = (void *) fc;
+ struct ctf_named_field_class *selected_option = NULL;
+ struct ctf_field_class *ret_fc = NULL;
+ union {
+ uint64_t u;
+ int64_t i;
+ } tag;
+
+ /* Get variant's tag */
+ tag.u = g_array_index(notit->stored_values, uint64_t,
+ var_fc->stored_tag_index);
- field_type = bt_ctf_field_get_type(field);
- if (!field_type) {
- BT_PUT(field);
- goto end;
+ /*
+ * Check each range to find the selected option's index.
+ */
+ if (var_fc->tag_fc->base.is_signed) {
+ for (i = 0; i < var_fc->ranges->len; i++) {
+ struct ctf_field_class_variant_range *range =
+ ctf_field_class_variant_borrow_range_by_index(
+ var_fc, i);
+
+ if (tag.i >= range->range.lower.i &&
+ tag.i <= range->range.upper.i) {
+ option_index = (int64_t) range->option_index;
+ break;
+ }
}
-
- if (is_struct_type(field_type)) {
- next_field = bt_ctf_field_structure_get_field_by_index(
- field, index);
- } else if (is_variant_type(field_type)) {
- next_field =
- bt_ctf_field_variant_get_current_field(field);
+ } else {
+ for (i = 0; i < var_fc->ranges->len; i++) {
+ struct ctf_field_class_variant_range *range =
+ ctf_field_class_variant_borrow_range_by_index(
+ var_fc, i);
+
+ if (tag.u >= range->range.lower.u &&
+ tag.u <= range->range.upper.u) {
+ option_index = (int64_t) range->option_index;
+ break;
+ }
}
+ }
+
+ if (option_index < 0) {
+ BT_LOGW("Cannot find variant field class's option: "
+ "notit-addr=%p, var-fc-addr=%p, u-tag=%" PRIu64 ", "
+ "i-tag=%" PRId64, notit, var_fc, tag.u, tag.i);
+ goto end;
+ }
+
+ selected_option = ctf_field_class_variant_borrow_option_by_index(
+ var_fc, (uint64_t) option_index);
- BT_PUT(field);
- BT_PUT(field_type);
+ if (selected_option->fc->in_ir) {
+ struct bt_private_field *var_field = stack_top(notit->stack)->base;
- if (!next_field) {
+ ret = bt_private_field_variant_select_option_field(
+ var_field, option_index);
+ if (ret) {
+ BT_LOGW("Cannot select variant field's option field: "
+ "notit-addr=%p, var-field-addr=%p, "
+ "opt-index=%" PRId64, notit, var_field,
+ option_index);
goto end;
}
-
- /* Move next field -> field */
- BT_MOVE(field, next_field);
}
+ ret_fc = selected_option->fc;
+
end:
- return field;
+ return ret_fc;
}
static
-int64_t btr_get_sequence_length_cb(struct bt_ctf_field_type *type, void *data)
+void set_event_default_clock_value(struct bt_notif_iter *notit)
{
- int64_t ret = -1;
- int iret;
- struct bt_ctf_field_path *field_path;
- struct bt_ctf_notif_iter *notit = data;
- struct bt_ctf_field *length_field = NULL;
- uint64_t length;
+ struct bt_private_event *event =
+ bt_private_notification_event_borrow_event(
+ notit->event_notif);
+ struct bt_stream_class *sc = bt_private_stream_class_as_stream_class(
+ notit->meta.sc->ir_sc);
- field_path = bt_ctf_field_type_sequence_get_length_field_path(type);
- if (!field_path) {
- goto end;
- }
+ BT_ASSERT(event);
- length_field = resolve_field(notit, field_path);
- if (!length_field) {
- goto end;
+ if (bt_stream_class_borrow_default_clock_class(sc)) {
+ bt_private_event_set_default_clock_value(event,
+ notit->default_clock_val);
}
+}
- iret = bt_ctf_field_unsigned_integer_get_value(length_field, &length);
- if (iret) {
+static
+void notify_new_stream(struct bt_notif_iter *notit,
+ struct bt_private_notification **notification)
+{
+ enum bt_notif_iter_status status;
+ struct bt_private_notification *ret = NULL;
+
+ status = set_current_stream(notit);
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
+ BT_OBJECT_PUT_REF_AND_RESET(ret);
goto end;
}
- iret = bt_ctf_field_sequence_set_length(stack_top(notit->stack)->base,
- length_field);
- if (iret) {
- goto end;
+ BT_ASSERT(notit->stream);
+ BT_ASSERT(notit->notif_iter);
+ ret = bt_private_notification_stream_begin_create(notit->notif_iter,
+ notit->stream);
+ if (!ret) {
+ BT_LOGE("Cannot create stream beginning notification: "
+ "notit-addr=%p, stream-addr=%p",
+ notit, notit->stream);
+ return;
}
- ret = (int64_t) length;
end:
- BT_PUT(length_field);
- BT_PUT(field_path);
-
- return ret;
+ *notification = ret;
}
static
-struct bt_ctf_field_type *btr_get_variant_type_cb(
- struct bt_ctf_field_type *type, void *data)
+void notify_end_of_stream(struct bt_notif_iter *notit,
+ struct bt_private_notification **notification)
{
- struct bt_ctf_field_path *path;
- struct bt_ctf_notif_iter *notit = data;
- struct bt_ctf_field *tag_field = NULL;
- struct bt_ctf_field *selected_field = NULL;
- struct bt_ctf_field_type *selected_field_type = NULL;
-
- path = bt_ctf_field_type_variant_get_tag_field_path(type);
- if (!path) {
- goto end;
- }
+ struct bt_private_notification *ret;
- tag_field = resolve_field(notit, path);
- if (!tag_field) {
- goto end;
+ if (!notit->stream) {
+ BT_LOGE("Cannot create stream for stream notification: "
+ "notit-addr=%p", notit);
+ return;
}
- /*
- * We found the enumeration tag field instance which should be
- * able to select a current field for this variant. This
- * callback function we're in is called _after_
- * compound_begin(), so the current stack top's base field is
- * the variant field in question. We get the selected field here
- * thanks to this tag field (thus creating the selected field),
- * which will also provide us with its type. Then, this field
- * will remain the current selected one until the next callback
- * function call which is used to fill the current selected
- * field.
- */
- selected_field = bt_ctf_field_variant_get_field(
- stack_top(notit->stack)->base, tag_field);
- if (!selected_field) {
- goto end;
+ BT_ASSERT(notit->notif_iter);
+ ret = bt_private_notification_stream_end_create(notit->notif_iter,
+ notit->stream);
+ if (!ret) {
+ BT_LOGE("Cannot create stream beginning notification: "
+ "notit-addr=%p, stream-addr=%p",
+ notit, notit->stream);
+ return;
}
-
- selected_field_type = bt_ctf_field_get_type(selected_field);
-
-end:
- BT_PUT(tag_field);
- BT_PUT(selected_field);
-
- return selected_field_type;
+ *notification = ret;
}
static
-struct bt_ctf_event *create_event(struct bt_ctf_notif_iter *notit)
+void notify_new_packet(struct bt_notif_iter *notit,
+ struct bt_private_notification **notification)
{
int ret;
- struct bt_ctf_event *event;
+ enum bt_notif_iter_status status;
+ struct bt_private_notification *notif = NULL;
+ struct bt_stream_class *sc;
- /* Create event object. */
- event = bt_ctf_event_create(notit->meta.event_class);
- if (!event) {
- goto error;
+ status = set_current_packet(notit);
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
+ goto end;
}
- /* Set header, stream event context, context, and payload fields. */
- ret = bt_ctf_event_set_header(event,
- notit->dscopes.stream_event_header);
- if (ret) {
- goto error;
- }
+ BT_ASSERT(notit->packet);
+ sc = bt_private_stream_class_as_stream_class(notit->meta.sc->ir_sc);
+ BT_ASSERT(sc);
- ret = bt_ctf_event_set_stream_event_context(event,
- notit->dscopes.stream_event_context);
- if (ret) {
- goto error;
+ if (bt_stream_class_packets_have_discarded_event_counter_snapshot(sc)) {
+ BT_ASSERT(notit->snapshots.discarded_events != UINT64_C(-1));
+ bt_private_packet_set_discarded_event_counter_snapshot(
+ notit->packet, notit->snapshots.discarded_events);
}
- ret = bt_ctf_event_set_event_context(event,
- notit->dscopes.event_context);
- if (ret) {
- goto error;
+ if (bt_stream_class_packets_have_packet_counter_snapshot(sc)) {
+ BT_ASSERT(notit->snapshots.packets != UINT64_C(-1));
+ bt_private_packet_set_packet_counter_snapshot(
+ notit->packet, notit->snapshots.packets);
}
- ret = bt_ctf_event_set_payload_field(event,
- notit->dscopes.event_payload);
- if (ret) {
- goto error;
+ if (bt_stream_class_packets_have_default_beginning_clock_value(sc)) {
+ BT_ASSERT(notit->snapshots.beginning_clock != UINT64_C(-1));
+ bt_private_packet_set_default_beginning_clock_value(
+ notit->packet, notit->snapshots.beginning_clock);
}
- /* Associate with current packet. */
- assert(notit->packet);
- ret = bt_ctf_event_set_packet(event, notit->packet);
- if (ret) {
- goto error;
+ if (bt_stream_class_packets_have_default_end_clock_value(sc)) {
+ BT_ASSERT(notit->snapshots.end_clock != UINT64_C(-1));
+ bt_private_packet_set_default_end_clock_value(
+ notit->packet, notit->snapshots.end_clock);
}
- goto end;
-error:
- BT_PUT(event);
-end:
- return event;
-}
-
-static
-void create_packet(struct bt_ctf_notif_iter *notit)
-{
- int ret;
- struct bt_ctf_stream *stream = NULL;
- struct bt_ctf_packet *packet = NULL;
+ if (notit->packet_header_field) {
+ ret = bt_private_packet_move_header_field(
+ notit->packet, notit->packet_header_field);
+ if (ret) {
+ goto end;
+ }
- /* Ask the user for the stream */
- stream = notit->medium.medops.get_stream(notit->meta.stream_class,
- notit->medium.data);
- if (!stream) {
- goto error;
- }
+ notit->packet_header_field = NULL;
- /* Create packet */
- packet = bt_ctf_packet_create(stream);
- if (!packet) {
- goto error;
+ /*
+ * At this point notit->dscopes.trace_packet_header has
+ * the same value as the packet header field within
+ * notit->packet.
+ */
+ BT_ASSERT(bt_private_packet_borrow_header_field(
+ notit->packet) ==
+ notit->dscopes.trace_packet_header);
}
- /* Set packet's context and header fields */
- if (notit->dscopes.trace_packet_header) {
- ret = bt_ctf_packet_set_header(packet,
- notit->dscopes.trace_packet_header);
+ if (notit->packet_context_field) {
+ ret = bt_private_packet_move_context_field(
+ notit->packet, notit->packet_context_field);
if (ret) {
- goto error;
+ goto end;
}
- }
- if (notit->dscopes.stream_packet_context) {
- ret = bt_ctf_packet_set_context(packet,
- notit->dscopes.stream_packet_context);
- if (ret) {
- goto error;
- }
+ notit->packet_context_field = NULL;
+
+ /*
+ * At this point notit->dscopes.trace_packet_header has
+ * the same value as the packet header field within
+ * notit->packet.
+ */
+ BT_ASSERT(bt_private_packet_borrow_context_field(
+ notit->packet) ==
+ notit->dscopes.stream_packet_context);
+ }
+
+ BT_ASSERT(notit->notif_iter);
+ notif = bt_private_notification_packet_begin_create(notit->notif_iter,
+ notit->packet);
+ if (!notif) {
+ BT_LOGE("Cannot create packet beginning notification: "
+ "notit-addr=%p, packet-addr=%p",
+ notit, notit->packet);
+ goto end;
}
- goto end;
-error:
- BT_PUT(packet);
+ *notification = notif;
+
end:
- BT_MOVE(notit->packet, packet);
+ return;
}
static
-void notify_new_packet(struct bt_ctf_notif_iter *notit,
- struct bt_notification **notification)
+void notify_end_of_packet(struct bt_notif_iter *notit,
+ struct bt_private_notification **notification)
{
- struct bt_notification *ret;
+ struct bt_private_notification *notif;
- /* Initialize the iterator's current packet */
- create_packet(notit);
if (!notit->packet) {
return;
}
- ret = bt_notification_packet_start_create(notit->packet);
- if (!ret) {
- return;
+ /* Update default clock from packet's end time */
+ if (notit->snapshots.end_clock != UINT64_C(-1)) {
+ notit->default_clock_val = notit->snapshots.end_clock;
}
- *notification = ret;
-}
-
-static
-void notify_end_of_packet(struct bt_ctf_notif_iter *notit,
- struct bt_notification **notification)
-{
- struct bt_notification *ret;
- if (!notit->packet) {
- return;
- }
-
- ret = bt_notification_packet_end_create(notit->packet);
- if (!ret) {
+ BT_ASSERT(notit->notif_iter);
+ notif = bt_private_notification_packet_end_create(notit->notif_iter,
+ notit->packet);
+ if (!notif) {
+ BT_LOGE("Cannot create packet end notification: "
+ "notit-addr=%p, packet-addr=%p",
+ notit, notit->packet);
return;
- }
- BT_PUT(notit->packet);
- *notification = ret;
-}
-
-static
-void notify_event(struct bt_ctf_notif_iter *notit,
- struct bt_notification **notification)
-{
- struct bt_ctf_event *event;
- struct bt_notification *ret = NULL;
- /* Create event */
- event = create_event(notit);
- if (!event) {
- goto end;
}
- ret = bt_notification_event_create(event);
- if (!ret) {
- goto end;
- }
- *notification = ret;
-end:
- BT_PUT(event);
+ BT_OBJECT_PUT_REF_AND_RESET(notit->packet);
+ *notification = notif;
}
-static
-void notify_eos(struct bt_ctf_notif_iter *notit,
- struct bt_notification **notification)
-{
- struct bt_ctf_event *event;
- struct bt_notification *ret = NULL;
-
- /* Create event */
- event = create_event(notit);
- if (!event) {
- goto end;
- }
-
- ret = bt_notification_stream_end_create(event);
- if (!ret) {
- goto end;
- }
- *notification = ret;
-end:
- BT_PUT(event);
-}
-
-struct bt_ctf_notif_iter *bt_ctf_notif_iter_create(struct bt_ctf_trace *trace,
+BT_HIDDEN
+struct bt_notif_iter *bt_notif_iter_create(struct ctf_trace_class *tc,
size_t max_request_sz,
- struct bt_ctf_notif_iter_medium_ops medops,
- void *data, FILE *err_stream)
-{
- struct bt_ctf_notif_iter *notit = NULL;
- struct bt_ctf_btr_cbs cbs = {
- .types = {
- .signed_int = btr_signed_int_cb,
- .unsigned_int = btr_unsigned_int_cb,
- .floating_point = btr_floating_point_cb,
- .string_begin = btr_string_begin_cb,
- .string = btr_string_cb,
- .string_end = btr_string_end_cb,
- .compound_begin = btr_compound_begin_cb,
- .compound_end = btr_compound_end_cb,
+ struct bt_notif_iter_medium_ops medops, void *data)
+{
+ struct bt_notif_iter *notit = NULL;
+ struct bt_bfcr_cbs cbs = {
+ .classes = {
+ .signed_int = bfcr_signed_int_cb,
+ .unsigned_int = bfcr_unsigned_int_cb,
+ .floating_point = bfcr_floating_point_cb,
+ .string_begin = bfcr_string_begin_cb,
+ .string = bfcr_string_cb,
+ .string_end = bfcr_string_end_cb,
+ .compound_begin = bfcr_compound_begin_cb,
+ .compound_end = bfcr_compound_end_cb,
},
.query = {
- .get_sequence_length = btr_get_sequence_length_cb,
- .get_variant_type = btr_get_variant_type_cb,
+ .get_sequence_length = bfcr_get_sequence_length_cb,
+ .borrow_variant_selected_field_class = bfcr_borrow_variant_selected_field_class_cb,
},
};
- assert(trace);
- assert(medops.request_bytes);
- notit = g_new0(struct bt_ctf_notif_iter, 1);
+ BT_ASSERT(tc);
+ BT_ASSERT(medops.request_bytes);
+ BT_ASSERT(medops.borrow_stream);
+ BT_LOGD("Creating CTF plugin notification iterator: "
+ "trace-addr=%p, trace-name=\"%s\", max-request-size=%zu, "
+ "data=%p", tc, tc->name->str, max_request_sz, data);
+ notit = g_new0(struct bt_notif_iter, 1);
if (!notit) {
- PERR("Failed to allocate memory for CTF notification iterator\n");
+ BT_LOGE_STR("Failed to allocate one CTF plugin notification iterator.");
goto end;
}
-
- notit->meta.trace = trace;
- bt_get(notit->meta.trace);
+ notit->meta.tc = tc;
notit->medium.medops = medops;
notit->medium.max_request_sz = max_request_sz;
notit->medium.data = data;
- notit->err_stream = err_stream;
notit->stack = stack_new(notit);
+ notit->stored_values = g_array_new(FALSE, TRUE, sizeof(uint64_t));
+ g_array_set_size(notit->stored_values, tc->stored_value_count);
+
if (!notit->stack) {
- PERR("Failed to create stack\n");
- bt_ctf_notif_iter_destroy(notit);
- notit = NULL;
- goto end;
+ BT_LOGE_STR("Failed to create field stack.");
+ goto error;
}
- notit->btr = bt_ctf_btr_create(cbs, notit, err_stream);
- if (!notit->btr) {
- PERR("Failed to create binary type reader\n");
- bt_ctf_notif_iter_destroy(notit);
- notit = NULL;
- goto end;
+ notit->bfcr = bt_bfcr_create(cbs, notit);
+ if (!notit->bfcr) {
+ BT_LOGE_STR("Failed to create binary class reader (BFCR).");
+ goto error;
}
- bt_ctf_notif_iter_reset(notit);
+ bt_notif_iter_reset(notit);
+ BT_LOGD("Created CTF plugin notification iterator: "
+ "trace-addr=%p, trace-name=\"%s\", max-request-size=%zu, "
+ "data=%p, notit-addr=%p",
+ tc, tc->name->str, max_request_sz, data,
+ notit);
+ notit->cur_packet_offset = 0;
end:
return notit;
+
+error:
+ bt_notif_iter_destroy(notit);
+ notit = NULL;
+ goto end;
}
-void bt_ctf_notif_iter_destroy(struct bt_ctf_notif_iter *notit)
+void bt_notif_iter_destroy(struct bt_notif_iter *notit)
{
- BT_PUT(notit->meta.trace);
- BT_PUT(notit->meta.stream_class);
- BT_PUT(notit->meta.event_class);
- BT_PUT(notit->packet);
- put_all_dscopes(notit);
+ BT_OBJECT_PUT_REF_AND_RESET(notit->packet);
+ BT_OBJECT_PUT_REF_AND_RESET(notit->stream);
+ release_all_dscopes(notit);
+
+ BT_LOGD("Destroying CTF plugin notification iterator: addr=%p", notit);
if (notit->stack) {
+ BT_LOGD_STR("Destroying field stack.");
stack_destroy(notit->stack);
}
- if (notit->btr) {
- bt_ctf_btr_destroy(notit->btr);
+ if (notit->bfcr) {
+ BT_LOGD("Destroying BFCR: bfcr-addr=%p", notit->bfcr);
+ bt_bfcr_destroy(notit->bfcr);
+ }
+
+ if (notit->stored_values) {
+ g_array_free(notit->stored_values, TRUE);
}
g_free(notit);
}
-enum bt_ctf_notif_iter_status bt_ctf_notif_iter_get_next_notification(
- struct bt_ctf_notif_iter *notit,
- struct bt_notification **notification)
+enum bt_notif_iter_status bt_notif_iter_get_next_notification(
+ struct bt_notif_iter *notit,
+ struct bt_self_notification_iterator *notif_iter,
+ struct bt_private_notification **notification)
{
- enum bt_ctf_notif_iter_status status = BT_CTF_NOTIF_ITER_STATUS_OK;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+
+ BT_ASSERT(notit);
+ BT_ASSERT(notification);
+
+ if (notit->state == STATE_DONE) {
+ status = BT_NOTIF_ITER_STATUS_EOF;
+ goto end;
+ }
+
+ notit->notif_iter = notif_iter;
- assert(notit);
- assert(notification);
+ BT_LOGV("Getting next notification: notit-addr=%p", notit);
while (true) {
status = handle_state(notit);
- if (status != BT_CTF_NOTIF_ITER_STATUS_OK) {
- if (status == BT_CTF_NOTIF_ITER_STATUS_EOF) {
- PDBG("Medium operation reported end of stream\n");
+ if (status == BT_NOTIF_ITER_STATUS_AGAIN) {
+ BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_AGAIN.");
+ goto end;
+ }
+
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
+ if (status == BT_NOTIF_ITER_STATUS_EOF) {
+ enum state next_state = notit->state;
+
+ BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_EOF.");
+
+ if (notit->packet) {
+ notify_end_of_packet(notit,
+ notification);
+ } else {
+ notify_end_of_stream(notit,
+ notification);
+ next_state = STATE_DONE;
+ }
+
+ if (!*notification) {
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
+
+ status = BT_NOTIF_ITER_STATUS_OK;
+ notit->state = next_state;
} else {
- PERR("Failed to handle state:\n");
- PERR("\tState: %d\n", notit->state);
+ BT_LOGW("Cannot handle state: "
+ "notit-addr=%p, state=%s",
+ notit, state_string(notit->state));
}
+
goto end;
}
switch (notit->state) {
+ case STATE_EMIT_NOTIF_NEW_STREAM:
+ /* notify_new_stream() logs errors */
+ notify_new_stream(notit, notification);
+
+ if (!*notification) {
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ }
+
+ notit->stream_begin_emitted = true;
+ goto end;
case STATE_EMIT_NOTIF_NEW_PACKET:
- PDBG("Emitting new packet notification\n");
+ /* notify_new_packet() logs errors */
notify_new_packet(notit, notification);
+
if (!*notification) {
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ status = BT_NOTIF_ITER_STATUS_ERROR;
}
+
goto end;
case STATE_EMIT_NOTIF_EVENT:
- PDBG("Emitting event notification\n");
- notify_event(notit, notification);
- if (!*notification) {
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
- }
+ BT_ASSERT(notit->event_notif);
+ set_event_default_clock_value(notit);
+ *notification = notit->event_notif;
+ notit->event_notif = NULL;
goto end;
case STATE_EMIT_NOTIF_END_OF_PACKET:
- PDBG("Emitting end of packet notification\n");
+ /* notify_end_of_packet() logs errors */
notify_end_of_packet(notit, notification);
+
if (!*notification) {
- status = BT_CTF_NOTIF_ITER_STATUS_ERROR;
+ status = BT_NOTIF_ITER_STATUS_ERROR;
}
+
goto end;
default:
/* Non-emitting state: continue */
end:
return status;
}
+
+BT_HIDDEN
+enum bt_notif_iter_status bt_notif_iter_borrow_packet_header_context_fields(
+ struct bt_notif_iter *notit,
+ struct bt_private_field **packet_header_field,
+ struct bt_private_field **packet_context_field)
+{
+ int ret;
+ enum bt_notif_iter_status status = BT_NOTIF_ITER_STATUS_OK;
+
+ BT_ASSERT(notit);
+
+ if (notit->state == STATE_EMIT_NOTIF_NEW_PACKET) {
+ /* We're already there */
+ goto set_fields;
+ }
+
+ while (true) {
+ status = handle_state(notit);
+ if (status == BT_NOTIF_ITER_STATUS_AGAIN) {
+ BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_AGAIN.");
+ goto end;
+ }
+ if (status != BT_NOTIF_ITER_STATUS_OK) {
+ if (status == BT_NOTIF_ITER_STATUS_EOF) {
+ BT_LOGV_STR("Medium returned BT_NOTIF_ITER_STATUS_EOF.");
+ } else {
+ BT_LOGW("Cannot handle state: "
+ "notit-addr=%p, state=%s",
+ notit, state_string(notit->state));
+ }
+ goto end;
+ }
+
+ switch (notit->state) {
+ case STATE_EMIT_NOTIF_NEW_PACKET:
+ /*
+ * Packet header and context fields are
+ * potentially decoded (or they don't exist).
+ */
+ goto set_fields;
+ case STATE_INIT:
+ case STATE_EMIT_NOTIF_NEW_STREAM:
+ case STATE_DSCOPE_TRACE_PACKET_HEADER_BEGIN:
+ case STATE_DSCOPE_TRACE_PACKET_HEADER_CONTINUE:
+ case STATE_AFTER_TRACE_PACKET_HEADER:
+ case STATE_DSCOPE_STREAM_PACKET_CONTEXT_BEGIN:
+ case STATE_DSCOPE_STREAM_PACKET_CONTEXT_CONTINUE:
+ case STATE_AFTER_STREAM_PACKET_CONTEXT:
+ /* Non-emitting state: continue */
+ break;
+ default:
+ /*
+ * We should never get past the
+ * STATE_EMIT_NOTIF_NEW_PACKET state.
+ */
+ BT_LOGF("Unexpected state: notit-addr=%p, state=%s",
+ notit, state_string(notit->state));
+ abort();
+ }
+ }
+
+set_fields:
+ ret = set_current_packet_content_sizes(notit);
+ if (ret) {
+ status = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
+
+ if (packet_header_field) {
+ *packet_header_field = notit->dscopes.trace_packet_header;
+ }
+
+ if (packet_context_field) {
+ *packet_context_field = notit->dscopes.stream_packet_context;
+ }
+
+end:
+ return status;
+}
+
+BT_HIDDEN
+void bt_notif_iter_set_medops_data(struct bt_notif_iter *notit,
+ void *medops_data)
+{
+ BT_ASSERT(notit);
+ notit->medium.data = medops_data;
+}
+
+BT_HIDDEN
+enum bt_notif_iter_status bt_notif_iter_seek(
+ struct bt_notif_iter *notit, off_t offset)
+{
+ enum bt_notif_iter_status ret = BT_NOTIF_ITER_STATUS_OK;
+ enum bt_notif_iter_medium_status medium_status;
+
+ BT_ASSERT(notit);
+ if (offset < 0) {
+ BT_LOGE("Cannot seek to negative offset: offset=%jd", offset);
+ ret = BT_NOTIF_ITER_STATUS_INVAL;
+ goto end;
+ }
+
+ if (!notit->medium.medops.seek) {
+ ret = BT_NOTIF_ITER_STATUS_UNSUPPORTED;
+ BT_LOGD("Aborting seek as the iterator's underlying media does not implement seek support.");
+ goto end;
+ }
+
+ medium_status = notit->medium.medops.seek(
+ BT_NOTIF_ITER_SEEK_WHENCE_SET, offset, notit->medium.data);
+ if (medium_status != BT_NOTIF_ITER_MEDIUM_STATUS_OK) {
+ if (medium_status == BT_NOTIF_ITER_MEDIUM_STATUS_EOF) {
+ ret = BT_NOTIF_ITER_STATUS_EOF;
+ } else {
+ ret = BT_NOTIF_ITER_STATUS_ERROR;
+ goto end;
+ }
+ }
+
+ bt_notif_iter_reset(notit);
+ notit->cur_packet_offset = offset;
+
+end:
+ return ret;
+}
+
+BT_HIDDEN
+off_t bt_notif_iter_get_current_packet_offset(struct bt_notif_iter *notit)
+{
+ BT_ASSERT(notit);
+ return notit->cur_packet_offset;
+}
+
+BT_HIDDEN
+off_t bt_notif_iter_get_current_packet_size(
+ struct bt_notif_iter *notit)
+{
+ BT_ASSERT(notit);
+ return notit->cur_exp_packet_total_size;
+}
+
+BT_HIDDEN
+void bt_notif_trace_class_changed(struct bt_notif_iter *notit)
+{
+ if (notit->meta.tc->stored_value_count > notit->stored_values->len) {
+ g_array_set_size(notit->stored_values,
+ notit->meta.tc->stored_value_count);
+ }
+}
+
+BT_HIDDEN
+enum bt_notif_iter_status bt_notif_iter_get_packet_properties(
+ struct bt_notif_iter *notit,
+ struct bt_notif_iter_packet_properties *props)
+{
+ BT_ASSERT(notit);
+ BT_ASSERT(props);
+
+ props->exp_packet_total_size =
+ (uint64_t) notit->cur_exp_packet_total_size;
+ props->exp_packet_content_size =
+ (uint64_t) notit->cur_exp_packet_content_size;
+ BT_ASSERT(props->stream_class_id >= 0);
+ props->stream_class_id = (uint64_t) notit->cur_stream_class_id;
+ props->data_stream_id = notit->cur_data_stream_id;
+ props->snapshots.discarded_events = notit->snapshots.discarded_events;
+ props->snapshots.packets = notit->snapshots.packets;
+ props->snapshots.beginning_clock = notit->snapshots.beginning_clock;
+ props->snapshots.end_clock = notit->snapshots.end_clock;
+ return BT_NOTIF_ITER_STATUS_OK;
+}