-#ifndef BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H
-#define BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H
-
-/*
- * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
- * Author: Jérémie Galarneau <jeremie.galarneau@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
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- * The Common Trace Format (CTF) Specification is available at
- * http://www.efficios.com/ctf
- */
-
-#include <babeltrace/assert-internal.h>
-#include <babeltrace/assert-pre-internal.h>
-#include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/ctf-writer/event-class-internal.h>
-#include <babeltrace/ctf-writer/event-internal.h>
-#include <babeltrace/ctf-writer/field-types.h>
-#include <babeltrace/ctf-writer/field-wrapper-internal.h>
-#include <babeltrace/ctf-writer/fields-internal.h>
-#include <babeltrace/ctf-writer/fields.h>
-#include <babeltrace/ctf-writer/stream-class.h>
-#include <babeltrace/ctf-writer/stream-internal.h>
-#include <babeltrace/ctf-writer/stream.h>
-#include <babeltrace/ctf-writer/validation-internal.h>
-#include <babeltrace/ctf-writer/object-internal.h>
-#include <babeltrace/ctf-writer/values-internal.h>
-#include <babeltrace/ctfser-internal.h>
-
-struct bt_ctf_stream_class;
-struct bt_ctf_stream_pos;
-struct metadata_context;
-
-struct bt_ctf_event_common {
- struct bt_ctf_object base;
- struct bt_ctf_event_class_common *class;
- struct bt_ctf_field_wrapper *header_field;
- struct bt_ctf_field_common *stream_event_context_field;
- struct bt_ctf_field_common *context_field;
- struct bt_ctf_field_common *payload_field;
- int frozen;
-};
-
-BT_HIDDEN
-int _bt_ctf_event_common_validate(struct bt_ctf_event_common *event);
-
-BT_HIDDEN
-void _bt_ctf_event_common_set_is_frozen(struct bt_ctf_event_common *event,
- bool is_frozen);
-
-#ifdef BT_DEV_MODE
-# define bt_ctf_event_common_validate _bt_ctf_event_common_validate
-# define bt_ctf_event_common_set_is_frozen _bt_ctf_event_common_set_is_frozen
-#else
-# define bt_ctf_event_common_validate(_event) 0
-# define bt_ctf_event_common_set_is_frozen(_event, _is_frozen)
-#endif
-
-#define BT_ASSERT_PRE_EVENT_COMMON_HOT(_event, _name) \
- BT_ASSERT_PRE_HOT((_event), (_name), ": event-addr=%p", (_event))
-
-static inline
-struct bt_ctf_event_class_common *bt_ctf_event_common_borrow_class(
- struct bt_ctf_event_common *event)
-{
- BT_ASSERT(event);
- return event->class;
-}
-
-typedef void *(*create_field_func)(void *);
-typedef void (*release_field_func)(void *);
-typedef void *(*create_header_field_func)(void *, void *);
-typedef void (*release_header_field_func)(void *, void *);
-
-BT_HIDDEN
-int bt_ctf_event_common_initialize(struct bt_ctf_event_common *event,
- struct bt_ctf_event_class_common *event_class,
- struct bt_ctf_clock_class *init_expected_clock_class,
- bool is_shared_with_parent, bt_ctf_object_release_func release_func,
- bt_ctf_validation_flag_copy_field_type_func field_type_copy_func,
- bool must_be_in_trace,
- int (*map_clock_classes_func)(struct bt_ctf_stream_class_common *stream_class,
- struct bt_ctf_field_type_common *packet_context_field_type,
- struct bt_ctf_field_type_common *event_header_field_type),
- create_field_func create_field_func,
- release_field_func release_field_func,
- create_header_field_func create_header_field_func,
- release_header_field_func release_header_field_func);
-
-static inline
-struct bt_ctf_field_common *bt_ctf_event_common_borrow_payload(
- struct bt_ctf_event_common *event)
-{
- struct bt_ctf_field_common *payload = NULL;
-
- BT_ASSERT_PRE_NON_NULL(event, "Event");
-
- if (!event->payload_field) {
- BT_LOGV("Event has no current payload field: addr=%p, "
- "event-class-name=\"%s\", event-class-id=%" PRId64,
- event, bt_ctf_event_class_common_get_name(event->class),
- bt_ctf_event_class_common_get_id(event->class));
- goto end;
- }
-
- payload = event->payload_field;
-
-end:
- return payload;
-}
-
-static inline
-struct bt_ctf_field_common *bt_ctf_event_common_borrow_header(
- struct bt_ctf_event_common *event)
-{
- struct bt_ctf_field_common *header = NULL;
-
- BT_ASSERT_PRE_NON_NULL(event, "Event");
-
- if (!event->header_field) {
- BT_LOGV("Event has no current header field: addr=%p, "
- "event-class-name=\"%s\", event-class-id=%" PRId64,
- event, bt_ctf_event_class_common_get_name(event->class),
- bt_ctf_event_class_common_get_id(event->class));
- goto end;
- }
-
- header = event->header_field->field;
-
-end:
- return header;
-}
-
-static inline
-struct bt_ctf_field_common *bt_ctf_event_common_borrow_context(
- struct bt_ctf_event_common *event)
-{
- struct bt_ctf_field_common *context = NULL;
-
- BT_ASSERT_PRE_NON_NULL(event, "Event");
-
- if (!event->context_field) {
- BT_LOGV("Event has no current context field: addr=%p, "
- "event-class-name=\"%s\", event-class-id=%" PRId64,
- event, bt_ctf_event_class_common_get_name(event->class),
- bt_ctf_event_class_common_get_id(event->class));
- goto end;
- }
-
- context = event->context_field;
-
-end:
- return context;
-}
-
-static inline
-struct bt_ctf_field_common *bt_ctf_event_common_borrow_stream_event_context(
- struct bt_ctf_event_common *event)
-{
- struct bt_ctf_field_common *stream_event_context = NULL;
-
- BT_ASSERT_PRE_NON_NULL(event, "Event");
-
- if (!event->stream_event_context_field) {
- BT_LOGV("Event has no current stream event context field: addr=%p, "
- "event-class-name=\"%s\", event-class-id=%" PRId64,
- event, bt_ctf_event_class_common_get_name(event->class),
- bt_ctf_event_class_common_get_id(event->class));
- goto end;
- }
-
- stream_event_context = event->stream_event_context_field;
-
-end:
- return stream_event_context;
-}
-
-static inline
-void bt_ctf_event_common_finalize(struct bt_ctf_object *obj,
- void (*field_release_func)(void *),
- void (*header_field_release_func)(void *, struct bt_ctf_event_common *))
-{
- struct bt_ctf_event_common *event = (void *) obj;
-
- BT_LOGD("Destroying event: addr=%p, "
- "event-class-name=\"%s\", event-class-id=%" PRId64,
- event,
- event->class ? bt_ctf_event_class_common_get_name(event->class) : NULL,
- event->class ? bt_ctf_event_class_common_get_id(event->class) : INT64_C(-1));
-
- if (event->header_field) {
- BT_LOGD_STR("Releasing event's header field.");
- header_field_release_func(event->header_field, event);
- }
-
- if (event->stream_event_context_field) {
- BT_LOGD_STR("Releasing event's stream event context field.");
- field_release_func(event->stream_event_context_field);
- }
-
- if (event->context_field) {
- BT_LOGD_STR("Releasing event's context field.");
- field_release_func(event->context_field);
- }
-
- if (event->payload_field) {
- BT_LOGD_STR("Releasing event's payload field.");
- field_release_func(event->payload_field);
- }
-
- /*
- * Leave this after calling header_field_release_func() because
- * this function receives the event object and could need its
- * class to perform some cleanup.
- */
- if (!event->base.parent) {
- /*
- * Event was keeping a reference to its class since it shared no
- * common ancestor with it to guarantee they would both have the
- * same lifetime.
- */
- bt_ctf_object_put_ref(event->class);
- }
-}
-
-struct bt_ctf_event {
- struct bt_ctf_event_common common;
-};
-
-struct bt_ctf_event_class {
- struct bt_ctf_event_class_common common;
-};
-
-BT_HIDDEN
-int bt_ctf_event_class_serialize(struct bt_ctf_event_class *event_class,
- struct metadata_context *context);
-
-BT_HIDDEN
-int bt_ctf_event_serialize(struct bt_ctf_event *event,
- struct bt_ctfser *pos,
- enum bt_ctf_byte_order native_byte_order);
-
-static inline
-struct bt_ctf_stream_class *bt_ctf_event_class_borrow_stream_class(
- struct bt_ctf_event_class *event_class)
-{
- return BT_CTF_FROM_COMMON(bt_ctf_event_class_common_borrow_stream_class(
- BT_CTF_TO_COMMON(event_class)));
-}
-
-#endif /* BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H */
projects / babeltrace.git / blobdiff