message.h

#ifndef BABELTRACE2_GRAPH_MESSAGE_H
#define BABELTRACE2_GRAPH_MESSAGE_H
 
/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * 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.
 */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#include <babeltrace2/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum bt_message_type {
    BT_MESSAGE_TYPE_STREAM_BEGINNING        = 1 << 0,
 
    BT_MESSAGE_TYPE_STREAM_END          = 1 << 1,
 
    BT_MESSAGE_TYPE_EVENT               = 1 << 2,
 
    BT_MESSAGE_TYPE_PACKET_BEGINNING        = 1 << 3,
 
    BT_MESSAGE_TYPE_PACKET_END          = 1 << 4,
 
    BT_MESSAGE_TYPE_DISCARDED_EVENTS        = 1 << 5,
 
    BT_MESSAGE_TYPE_DISCARDED_PACKETS       = 1 << 6,
 
    BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY = 1 << 7,
} bt_message_type;
 
extern bt_message_type bt_message_get_type(const bt_message *message);
 
typedef enum bt_message_stream_clock_snapshot_state {
    BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN    = 1,
 
    BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_UNKNOWN  = 0,
} bt_message_stream_clock_snapshot_state;
 
extern
bt_message *bt_message_stream_beginning_create(
        bt_self_message_iterator *self_message_iterator,
        const bt_stream *stream);
 
extern bt_stream *bt_message_stream_beginning_borrow_stream(
        bt_message *message);
 
extern const bt_stream *bt_message_stream_beginning_borrow_stream_const(
        const bt_message *message);
 
extern
void bt_message_stream_beginning_set_default_clock_snapshot(
        bt_message *message, uint64_t value);
 
extern bt_message_stream_clock_snapshot_state
bt_message_stream_beginning_borrow_default_clock_snapshot_const(
        const bt_message *message,
        const bt_clock_snapshot **clock_snapshot);
 
extern const bt_clock_class *
bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(
        const bt_message *message);
 
extern
bt_message *bt_message_stream_end_create(
        bt_self_message_iterator *self_message_iterator,
        const bt_stream *stream);
 
extern bt_stream *bt_message_stream_end_borrow_stream(
        bt_message *message);
 
extern const bt_stream *bt_message_stream_end_borrow_stream_const(
        const bt_message *message);
 
extern
void bt_message_stream_end_set_default_clock_snapshot(
        bt_message *message, uint64_t value);
 
extern bt_message_stream_clock_snapshot_state
bt_message_stream_end_borrow_default_clock_snapshot_const(
        const bt_message *message,
        const bt_clock_snapshot **clock_snapshot);
 
extern const bt_clock_class *
bt_message_stream_end_borrow_stream_class_default_clock_class_const(
        const bt_message *message);
 
extern
bt_message *bt_message_event_create(
        bt_self_message_iterator *self_message_iterator,
        const bt_event_class *event_class,
        const bt_stream *stream);
 
extern
bt_message *bt_message_event_create_with_default_clock_snapshot(
        bt_self_message_iterator *self_message_iterator,
        const bt_event_class *event_class,
        const bt_stream *stream, uint64_t clock_snapshot_value);
 
extern
bt_message *bt_message_event_create_with_packet(
        bt_self_message_iterator *self_message_iterator,
        const bt_event_class *event_class,
        const bt_packet *packet);
 
extern
bt_message *bt_message_event_create_with_packet_and_default_clock_snapshot(
        bt_self_message_iterator *self_message_iterator,
        const bt_event_class *event_class,
        const bt_packet *packet, uint64_t clock_snapshot_value);
 
extern bt_event *bt_message_event_borrow_event(
        bt_message *message);
 
extern const bt_event *bt_message_event_borrow_event_const(
        const bt_message *message);
 
extern const bt_clock_snapshot *
bt_message_event_borrow_default_clock_snapshot_const(const bt_message *message);
 
extern const bt_clock_class *
bt_message_event_borrow_stream_class_default_clock_class_const(
        const bt_message *message);
 
extern
bt_message *bt_message_packet_beginning_create(
        bt_self_message_iterator *self_message_iterator,
        const bt_packet *packet);
 
extern
bt_message *bt_message_packet_beginning_create_with_default_clock_snapshot(
        bt_self_message_iterator *self_message_iterator,
        const bt_packet *packet, uint64_t clock_snapshot_value);
 
extern bt_packet *bt_message_packet_beginning_borrow_packet(
        bt_message *message);
 
extern const bt_packet *bt_message_packet_beginning_borrow_packet_const(
        const bt_message *message);
 
extern const bt_clock_snapshot *
bt_message_packet_beginning_borrow_default_clock_snapshot_const(
        const bt_message *message);
 
extern const bt_clock_class *
bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
        const bt_message *message);
 
extern
bt_message *bt_message_packet_end_create(
        bt_self_message_iterator *self_message_iterator,
        const bt_packet *packet);
 
extern
bt_message *bt_message_packet_end_create_with_default_clock_snapshot(
        bt_self_message_iterator *self_message_iterator,
        const bt_packet *packet, uint64_t clock_snapshot_value);
 
extern bt_packet *bt_message_packet_end_borrow_packet(
        bt_message *message);
 
extern const bt_packet *bt_message_packet_end_borrow_packet_const(
        const bt_message *message);
 
extern const bt_clock_snapshot *
bt_message_packet_end_borrow_default_clock_snapshot_const(
        const bt_message *message);
 
extern const bt_clock_class *
bt_message_packet_end_borrow_stream_class_default_clock_class_const(
        const bt_message *message);
 
extern bt_message *bt_message_discarded_events_create(
        bt_self_message_iterator *self_message_iterator,
        const bt_stream *stream);
 
extern bt_message *bt_message_discarded_events_create_with_default_clock_snapshots(
        bt_self_message_iterator *self_message_iterator,
        const bt_stream *stream,
        uint64_t beginning_clock_snapshot_value,
        uint64_t end_clock_snapshot_value);
 
extern bt_stream *bt_message_discarded_events_borrow_stream(
        bt_message *message);
 
extern const bt_stream *
bt_message_discarded_events_borrow_stream_const(const bt_message *message);
 
extern const bt_clock_snapshot *
bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
        const bt_message *message);
 
extern const bt_clock_snapshot *
bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
        const bt_message *message);
 
extern const bt_clock_class *
bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
        const bt_message *message);
 
extern void bt_message_discarded_events_set_count(bt_message *message,
        uint64_t count);
 
extern bt_property_availability bt_message_discarded_events_get_count(
        const bt_message *message, uint64_t *count);
 
extern bt_message *bt_message_discarded_packets_create(
        bt_self_message_iterator *self_message_iterator,
        const bt_stream *stream);
 
extern bt_message *bt_message_discarded_packets_create_with_default_clock_snapshots(
        bt_self_message_iterator *self_message_iterator,
        const bt_stream *stream, uint64_t beginning_clock_snapshot_value,
        uint64_t end_clock_snapshot_value);
 
extern bt_stream *bt_message_discarded_packets_borrow_stream(
        bt_message *message);
 
extern const bt_stream *
bt_message_discarded_packets_borrow_stream_const(const bt_message *message);
 
extern const bt_clock_snapshot *
bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
        const bt_message *message);
 
extern const bt_clock_snapshot *
bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
        const bt_message *message);
 
extern const bt_clock_class *
bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
        const bt_message *message);
 
extern void bt_message_discarded_packets_set_count(bt_message *message,
        uint64_t count);
 
extern bt_property_availability bt_message_discarded_packets_get_count(
        const bt_message *message, uint64_t *count);
 
extern
bt_message *bt_message_message_iterator_inactivity_create(
        bt_self_message_iterator *self_message_iterator,
        const bt_clock_class *clock_class,
        uint64_t clock_snapshot_value);
 
extern const bt_clock_snapshot *
bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(
        const bt_message *message);
 
extern void bt_message_get_ref(const bt_message *message);
 
extern void bt_message_put_ref(const bt_message *message);
 
#define BT_MESSAGE_PUT_REF_AND_RESET(_message)      \
    do {                        \
        bt_message_put_ref(_message);       \
        (_message) = NULL;          \
    } while (0)
 
#define BT_MESSAGE_MOVE_REF(_dst, _src)     \
    do {                    \
        bt_message_put_ref(_dst);   \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
typedef enum bt_get_greatest_operative_mip_version_status {
    BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK         = __BT_FUNC_STATUS_OK,
 
    BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_NO_MATCH       = __BT_FUNC_STATUS_NO_MATCH,
 
    BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR      = __BT_FUNC_STATUS_ERROR,
} bt_get_greatest_operative_mip_version_status;
 
extern bt_get_greatest_operative_mip_version_status
bt_get_greatest_operative_mip_version(
        const bt_component_descriptor_set *component_descriptors,
        bt_logging_level logging_level, uint64_t *mip_version);
 
extern uint64_t bt_get_maximal_mip_version(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_GRAPH_MESSAGE_H */