lib: merge common CTF IR part with the remaining implementation
[babeltrace.git] / lib / ctf-ir / packet.c
index 227a7fd9c959776e19f0d5ede7f8a84a5f1e431e..43506ef8c1bc54404c5e67e178ed611b2771cfeb 100644 (file)
@@ -62,32 +62,63 @@ struct bt_field *bt_packet_borrow_context(struct bt_packet *packet)
 }
 
 BT_HIDDEN
-void _bt_packet_freeze(struct bt_packet *packet)
+void _bt_packet_set_is_frozen(struct bt_packet *packet, bool is_frozen)
 {
-       if (!packet || packet->frozen) {
+       if (!packet) {
                return;
        }
 
-       BT_LOGD("Freezing packet: addr=%p", packet);
+       BT_LOGD("Setting packet's frozen state: addr=%p, frozen=%d",
+               packet, is_frozen);
 
        if (packet->header) {
-               BT_LOGD_STR("Freezing packet's header field.");
-               bt_field_set_is_frozen_recursive((void *) packet->header->field, true);
+               BT_LOGD("Setting packet's header field's frozen state: "
+                       "frozen=%d", is_frozen);
+               bt_field_set_is_frozen_recursive((void *) packet->header->field,
+                       is_frozen);
        }
 
        if (packet->context) {
-               BT_LOGD_STR("Freezing packet's context field.");
-               bt_field_set_is_frozen_recursive((void *) packet->context->field, true);
+               BT_LOGD("Setting packet's context field's frozen state: "
+                       "frozen=%d", is_frozen);
+               bt_field_set_is_frozen_recursive((void *) packet->context->field,
+                       is_frozen);
        }
 
-       packet->frozen = 1;
+       packet->frozen = is_frozen;
+}
+
+static inline
+void bt_packet_reset_avail(struct bt_packet *packet)
+{
+       /* Previous packet */
+       packet->prev_packet_info.avail =
+               BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_NOT_AVAILABLE;
+       packet->prev_packet_info.discarded_event_counter.avail =
+               BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+       packet->prev_packet_info.seq_num.avail =
+               BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+       packet->prev_packet_info.default_end_cv.avail =
+               BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+
+       /* Current packet */
+       packet->discarded_event_counter.avail =
+               BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+       packet->seq_num.avail =
+               BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+
+       /* Computed */
+       packet->discarded_event_count.avail =
+               BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+       packet->discarded_packet_count.avail =
+               BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
 }
 
 static inline
 void bt_packet_reset(struct bt_packet *packet)
 {
        BT_ASSERT(packet);
-       packet->frozen = false;
+       bt_packet_set_is_frozen(packet, false);
 
        if (packet->header) {
                bt_field_set_is_frozen_recursive(
@@ -100,6 +131,16 @@ void bt_packet_reset(struct bt_packet *packet)
                        (void *) packet->context->field, false);
                bt_field_reset_recursive((void *) packet->context->field);
        }
+
+       bt_clock_value_set_reset(&packet->begin_cv_set);
+       bt_clock_value_set_reset(&packet->end_cv_set);
+       bt_packet_reset_avail(packet);
+       bt_packet_invalidate_properties(packet);
+
+       if (packet->prev_packet_info.default_end_cv.cv) {
+               bt_clock_value_recycle(packet->prev_packet_info.default_end_cv.cv);
+               packet->prev_packet_info.default_end_cv.cv = NULL;
+       }
 }
 
 static
@@ -161,7 +202,7 @@ void bt_packet_recycle(struct bt_packet *packet)
        BT_ASSERT(stream);
        packet->stream = NULL;
        bt_object_pool_recycle_object(&stream->packet_pool, packet);
-       bt_put(stream);
+       bt_object_put_no_null_check(&stream->base);
 }
 
 BT_HIDDEN
@@ -191,6 +232,8 @@ void bt_packet_destroy(struct bt_packet *packet)
                }
        }
 
+       bt_clock_value_set_finalize(&packet->begin_cv_set);
+       bt_clock_value_set_finalize(&packet->end_cv_set);
        BT_LOGD_STR("Putting packet's stream.");
        bt_put(packet->stream);
        g_free(packet);
@@ -208,9 +251,9 @@ struct bt_packet *bt_packet_new(struct bt_stream *stream)
                "stream-name=\"%s\", stream-class-addr=%p, "
                "stream-class-name=\"%s\", stream-class-id=%" PRId64,
                stream, bt_stream_get_name(stream),
-               stream->common.stream_class,
-               bt_stream_class_common_get_name(stream->common.stream_class),
-               bt_stream_class_common_get_id(stream->common.stream_class));
+               stream->stream_class,
+               bt_stream_class_get_name(stream->stream_class),
+               bt_stream_class_get_id(stream->stream_class));
        stream_class = bt_stream_borrow_class(stream);
        BT_ASSERT(stream_class);
        trace = bt_stream_class_borrow_trace(stream_class);
@@ -225,12 +268,12 @@ struct bt_packet *bt_packet_new(struct bt_stream *stream)
                (bt_object_release_func) bt_packet_recycle);
        packet->stream = bt_get(stream);
 
-       if (trace->common.packet_header_field_type) {
+       if (trace->packet_header_field_type) {
                BT_LOGD("Creating initial packet header field: ft-addr=%p",
-                       trace->common.packet_header_field_type);
+                       trace->packet_header_field_type);
                packet->header = bt_field_wrapper_create(
                        &trace->packet_header_field_pool,
-                       (void *) trace->common.packet_header_field_type);
+                       (void *) trace->packet_header_field_type);
                if (!packet->header) {
                        BT_LOGE("Cannot create packet header field wrapper.");
                        BT_PUT(packet);
@@ -238,12 +281,12 @@ struct bt_packet *bt_packet_new(struct bt_stream *stream)
                }
        }
 
-       if (stream->common.stream_class->packet_context_field_type) {
+       if (stream->stream_class->packet_context_field_type) {
                BT_LOGD("Creating initial packet context field: ft-addr=%p",
-                       stream->common.stream_class->packet_context_field_type);
+                       stream->stream_class->packet_context_field_type);
                packet->context = bt_field_wrapper_create(
                        &stream_class->packet_context_field_pool,
-                       (void *) stream->common.stream_class->packet_context_field_type);
+                       (void *) stream->stream_class->packet_context_field_type);
                if (!packet->context) {
                        BT_LOGE("Cannot create packet context field wrapper.");
                        BT_PUT(packet);
@@ -251,36 +294,258 @@ struct bt_packet *bt_packet_new(struct bt_stream *stream)
                }
        }
 
+       if (bt_clock_value_set_initialize(&packet->begin_cv_set)) {
+               BT_PUT(packet);
+               goto end;
+       }
+
+       if (bt_clock_value_set_initialize(&packet->end_cv_set)) {
+               BT_PUT(packet);
+               goto end;
+       }
+
+       bt_packet_reset_avail(packet);
        BT_LOGD("Created packet object: addr=%p", packet);
 
 end:
        return packet;
 }
 
-struct bt_packet *bt_packet_create(struct bt_stream *stream)
+static inline
+uint64_t get_uint_field_value(struct bt_field *parent_field, const char *name)
+{
+       uint64_t val = UINT64_C(-1);
+       struct bt_field *field = bt_field_structure_borrow_field_by_name(
+               parent_field, name);
+       int ret;
+
+       if (!field) {
+               goto end;
+       }
+
+       BT_ASSERT(bt_field_is_integer(field));
+       BT_ASSERT(!bt_field_type_integer_is_signed(
+               bt_field_borrow_type(field)));
+       ret = bt_field_integer_unsigned_get_value(field, &val);
+       BT_ASSERT(ret == 0);
+
+end:
+       return val;
+}
+
+static inline
+void set_packet_prop_uint64(struct bt_packet_prop_uint64 *prop, uint64_t val)
+{
+       BT_ASSERT(prop);
+       prop->value = val;
+       prop->avail = BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE;
+}
+
+static inline
+int set_packet_default_clock_value(struct bt_field *pkt_ctx_field,
+               const char *field_name, struct bt_clock_value_set *cv_set)
+{
+       int ret = 0;
+       uint64_t val = UINT64_C(-1);
+       struct bt_field *field = bt_field_structure_borrow_field_by_name(
+               pkt_ctx_field, field_name);
+       struct bt_clock_class *clock_class;
+
+       if (!field) {
+               goto end;
+       }
+
+       BT_ASSERT(bt_field_is_integer(field));
+       BT_ASSERT(!bt_field_type_integer_is_signed(
+               bt_field_borrow_type(field)));
+       clock_class = bt_field_type_integer_borrow_mapped_clock_class(
+               bt_field_borrow_type(field));
+       if (!clock_class) {
+               goto end;
+       }
+
+       ret = bt_field_integer_unsigned_get_value(field, &val);
+       BT_ASSERT(ret == 0);
+       ret = bt_clock_value_set_set_clock_value(cv_set, clock_class,
+               val, true);
+
+end:
+       return ret;
+}
+
+BT_HIDDEN
+int bt_packet_set_properties(struct bt_packet *packet)
+{
+       struct bt_field *pkt_context_field;
+       uint64_t val;
+       int ret = 0;
+
+       BT_ASSERT(!packet->props_are_set);
+
+       pkt_context_field = bt_packet_borrow_context(packet);
+       if (!pkt_context_field) {
+               goto end;
+       }
+
+       /* Discarded event counter */
+       val = get_uint_field_value(pkt_context_field, "events_discarded");
+       if (val != UINT64_C(-1)) {
+               set_packet_prop_uint64(&packet->discarded_event_counter, val);
+       }
+
+       /* Sequence number */
+       val = get_uint_field_value(pkt_context_field, "packet_seq_num");
+       if (val != UINT64_C(-1)) {
+               set_packet_prop_uint64(&packet->seq_num, val);
+       }
+
+       /* Beginning and end times */
+       ret = set_packet_default_clock_value(pkt_context_field,
+               "timestamp_begin", &packet->begin_cv_set);
+       if (ret) {
+               goto end;
+       }
+
+       ret = set_packet_default_clock_value(pkt_context_field,
+               "timestamp_end", &packet->end_cv_set);
+       if (ret) {
+               goto end;
+       }
+
+       /* Information from previous packet */
+       if (packet->prev_packet_info.avail ==
+                       BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_AVAILABLE) {
+               /* Discarded event count */
+               if (packet->prev_packet_info.discarded_event_counter.avail ==
+                               BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE) {
+                       BT_ASSERT(packet->discarded_event_counter.avail ==
+                               BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE);
+                       set_packet_prop_uint64(&packet->discarded_event_count,
+                               packet->discarded_event_counter.value -
+                               packet->prev_packet_info.discarded_event_counter.value);
+               }
+
+               /* Discarded packet count */
+               if (packet->prev_packet_info.seq_num.avail ==
+                               BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE) {
+                       BT_ASSERT(packet->seq_num.avail ==
+                               BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE);
+                       set_packet_prop_uint64(&packet->discarded_packet_count,
+                               packet->seq_num.value -
+                               packet->prev_packet_info.seq_num.value - 1);
+               }
+       }
+
+end:
+       return ret;
+}
+
+static
+int snapshot_prev_packet_properties(struct bt_packet *packet,
+               enum bt_packet_previous_packet_availability prev_packet_avail,
+               struct bt_packet *prev_packet)
+{
+       int ret = 0;
+       struct bt_clock_value *prev_packet_default_end_cv;
+
+       if (!prev_packet) {
+               goto end;
+       }
+
+       if (!prev_packet->props_are_set) {
+               ret = bt_packet_set_properties(prev_packet);
+               if (ret) {
+                       BT_LIB_LOGE("Cannot update previous packet's properties: "
+                               "%![prev-packet-]+a", prev_packet);
+                       goto end;
+               }
+       }
+
+       packet->prev_packet_info.avail = prev_packet_avail;
+       prev_packet_default_end_cv = prev_packet->end_cv_set.default_cv;
+
+       /* End time */
+       if (prev_packet_default_end_cv) {
+               /* Copy clock value */
+               packet->prev_packet_info.default_end_cv.cv =
+                       bt_clock_value_create(
+                               prev_packet_default_end_cv->clock_class);
+               if (!packet->prev_packet_info.default_end_cv.cv) {
+                       BT_LIB_LOGE("Cannot create a clock value from a clock class: "
+                               "%![cc-]+K",
+                               prev_packet_default_end_cv->clock_class);
+                       ret = -1;
+                       goto end;
+               }
+
+               bt_clock_value_set_raw_value(
+                       packet->prev_packet_info.default_end_cv.cv,
+                       prev_packet_default_end_cv->value);
+               packet->prev_packet_info.default_end_cv.avail =
+                       BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE;
+       }
+
+       /* Discarded event counter */
+       packet->prev_packet_info.discarded_event_counter =
+               prev_packet->discarded_event_counter;
+
+       /* Sequence number */
+       packet->prev_packet_info.seq_num = prev_packet->seq_num;
+
+end:
+       return ret;
+}
+
+struct bt_packet *bt_packet_create(struct bt_stream *stream,
+               enum bt_packet_previous_packet_availability prev_packet_avail,
+               struct bt_packet *prev_packet)
 {
        struct bt_packet *packet = NULL;
+       int ret;
 
        BT_ASSERT_PRE_NON_NULL(stream, "Stream");
+       BT_ASSERT_PRE(!prev_packet || prev_packet->stream == stream,
+               "New packet's and previous packet's stream are not the same: "
+               "%![new-packet-stream-]+s, %![prev-packet]+a, "
+               "%![prev-packet-stream]+s", stream, prev_packet,
+               prev_packet->stream);
+       BT_ASSERT_PRE(
+               prev_packet_avail == BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_AVAILABLE ||
+               prev_packet_avail == BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_NOT_AVAILABLE ||
+               prev_packet_avail == BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_NONE,
+               "Invalid previous packet availability value: val=%d",
+               prev_packet_avail);
+       BT_ASSERT_PRE(!prev_packet ||
+               prev_packet_avail == BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_AVAILABLE,
+               "Previous packet is available, but previous packet is NULL.");
        packet = bt_object_pool_create_object(&stream->packet_pool);
-       if (!packet) {
+       if (unlikely(!packet)) {
                BT_LIB_LOGE("Cannot allocate one packet from stream's packet pool: "
                        "%![stream-]+s", stream);
-               goto error;
+               goto end;
        }
 
-       if (!packet->stream) {
-               packet->stream = bt_get(stream);
+       if (unlikely(!packet->stream)) {
+               packet->stream = stream;
+               bt_object_get_no_null_check_no_parent_check(
+                       &packet->stream->base);
        }
 
-       goto end;
+       ret = snapshot_prev_packet_properties(packet, prev_packet_avail,
+               prev_packet);
+       if (ret) {
+               /* Recycle */
+               BT_PUT(packet);
+               goto end;
+       }
 
-error:
-       if (packet) {
-               bt_packet_recycle(packet);
-               packet = NULL;
+       if (prev_packet) {
+               bt_packet_validate_properties(prev_packet);
+               bt_packet_set_is_frozen(prev_packet, true);
        }
 
+       goto end;
+
 end:
        return packet;
 }
@@ -293,10 +558,10 @@ int bt_packet_move_header(struct bt_packet *packet,
 
        BT_ASSERT_PRE_NON_NULL(packet, "Event");
        BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
-       BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet);
+       BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
        trace = bt_stream_class_borrow_trace(
                bt_stream_borrow_class(packet->stream));
-       BT_ASSERT_PRE(trace->common.packet_header_field_type,
+       BT_ASSERT_PRE(trace->packet_header_field_type,
                "Trace has no packet header field type: %!+t",
                trace);
 
@@ -319,9 +584,9 @@ int bt_packet_move_context(struct bt_packet *packet,
 
        BT_ASSERT_PRE_NON_NULL(packet, "Event");
        BT_ASSERT_PRE_NON_NULL(field_wrapper, "Context field");
-       BT_ASSERT_PRE_HOT(packet, "Packet", ": +%!+a", packet);
+       BT_ASSERT_PRE_HOT(packet, "Packet", ": %!+a", packet);
        stream_class = bt_stream_borrow_class(packet->stream);
-       BT_ASSERT_PRE(stream_class->common.packet_context_field_type,
+       BT_ASSERT_PRE(stream_class->packet_context_field_type,
                "Stream class has no packet context field type: %!+S",
                stream_class);
 
@@ -335,3 +600,91 @@ int bt_packet_move_context(struct bt_packet *packet,
        packet->context = field_wrapper;
        return 0;
 }
+
+enum bt_packet_property_availability
+bt_packet_borrow_default_beginning_clock_value(struct bt_packet *packet,
+               struct bt_clock_value **clock_value)
+{
+       enum bt_packet_property_availability avail =
+               BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE;
+
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value");
+       *clock_value = packet->begin_cv_set.default_cv;
+       if (!*clock_value) {
+               avail = BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+       }
+
+       return avail;
+}
+
+enum bt_packet_property_availability
+bt_packet_borrow_default_end_clock_value(struct bt_packet *packet,
+               struct bt_clock_value **clock_value)
+{
+       enum bt_packet_property_availability avail =
+               BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE;
+
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value");
+       *clock_value = packet->end_cv_set.default_cv;
+       if (!*clock_value) {
+               avail = BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+       }
+
+       return avail;
+}
+
+enum bt_packet_previous_packet_availability
+bt_packet_get_previous_packet_availability(struct bt_packet *packet)
+{
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       return packet->prev_packet_info.avail;
+}
+
+enum bt_packet_property_availability
+bt_packet_borrow_previous_packet_default_end_clock_value(
+               struct bt_packet *packet, struct bt_clock_value **clock_value)
+{
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value");
+       *clock_value = packet->prev_packet_info.default_end_cv.cv;
+       return packet->prev_packet_info.default_end_cv.avail;
+}
+
+enum bt_packet_property_availability bt_packet_get_discarded_event_counter(
+               struct bt_packet *packet, uint64_t *counter)
+{
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_NON_NULL(counter, "Counter");
+       *counter = packet->discarded_event_counter.value;
+       return packet->discarded_event_counter.avail;
+}
+
+enum bt_packet_property_availability bt_packet_get_sequence_number(
+               struct bt_packet *packet, uint64_t *sequence_number)
+{
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_NON_NULL(sequence_number, "Sequence number");
+       *sequence_number = packet->seq_num.value;
+       return packet->seq_num.avail;
+}
+
+enum bt_packet_property_availability bt_packet_get_discarded_event_count(
+               struct bt_packet *packet, uint64_t *count)
+{
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_NON_NULL(count, "Count");
+       *count = packet->discarded_event_count.value;
+       return packet->discarded_event_count.avail;
+}
+
+enum bt_packet_property_availability bt_packet_get_discarded_packet_count(
+               struct bt_packet *packet, uint64_t *count)
+{
+       BT_ASSERT_PRE_NON_NULL(packet, "Packet");
+       BT_ASSERT_PRE_NON_NULL(count, "Count");
+       *count = packet->discarded_packet_count.value;
+       return packet->discarded_packet_count.avail;
+}
+
This page took 0.029719 seconds and 4 git commands to generate.