include/babeltrace/trace-ir/packet-const.h

   1 #ifndef BABELTRACE_TRACE_IR_PACKET_CONST_H
   2 #define BABELTRACE_TRACE_IR_PACKET_CONST_H
   3
   4 /*
   5  * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * The Common Trace Format (CTF) Specification is available at
  26  * http://www.efficios.com/ctf
  27  */
  28
  29 #include <stdint.h>
  30
  31 /* For enum bt_property_availability */
  32 #include <babeltrace/property.h>
  33
  34 /* For enum bt_clock_snapshot_state */
  35 #include <babeltrace/trace-ir/clock-snapshot-const.h>
  36
  37 /*
  38  * For bt_packet, bt_packet_header_field, bt_packet_context_field,
  39  * bt_stream, bt_clock_snapshot
  40  */
  41 #include <babeltrace/types.h>
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 enum bt_packet_status {
  48         BT_PACKET_STATUS_OK = 0,
  49         BT_PACKET_STATUS_NOMEM = -12,
  50 };
  51
  52 extern const bt_stream *bt_packet_borrow_stream_const(
  53                 const bt_packet *packet);
  54
  55 extern
  56 const bt_field *bt_packet_borrow_header_field_const(
  57                 const bt_packet *packet);
  58
  59 extern
  60 const bt_field *bt_packet_borrow_context_field_const(
  61                 const bt_packet *packet);
  62
  63 extern
  64 enum bt_clock_snapshot_state
  65 bt_packet_borrow_default_beginning_clock_snapshot_const(
  66                 const bt_packet *packet,
  67                 const bt_clock_snapshot **clock_snapshot);
  68
  69 extern
  70 enum bt_clock_snapshot_state bt_packet_borrow_default_end_clock_snapshot_const(
  71                 const bt_packet *packet,
  72                 const bt_clock_snapshot **clock_snapshot);
  73
  74 extern
  75 enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
  76                 const bt_packet *packet, uint64_t *value);
  77
  78 extern
  79 enum bt_property_availability bt_packet_get_packet_counter_snapshot(
  80                 const bt_packet *packet, uint64_t *value);
  81
  82 extern void bt_packet_get_ref(const bt_packet *packet);
  83
  84 extern void bt_packet_put_ref(const bt_packet *packet);
  85
  86 #define BT_PACKET_PUT_REF_AND_RESET(_var)               \
  87         do {                                            \
  88                 bt_packet_put_ref(_var);                \
  89                 (_var) = NULL;                          \
  90         } while (0)
  91
  92 #define BT_PACKET_MOVE_REF(_var_dst, _var_src)          \
  93         do {                                            \
  94                 bt_packet_put_ref(_var_dst);            \
  95                 (_var_dst) = (_var_src);                \
  96                 (_var_src) = NULL;                      \
  97         } while (0)
  98
  99 #ifdef __cplusplus
 100 }
 101 #endif
 102
 103 #endif /* BABELTRACE_TRACE_IR_PACKET_CONST_H */