include/babeltrace/trace-ir/packet.h

   1 #ifndef BABELTRACE_TRACE_IR_PACKET_H
   2 #define BABELTRACE_TRACE_IR_PACKET_H
   3
   4 /*
   5  * Copyright 2016 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_value_status */
  35 #include <babeltrace/trace-ir/clock-value.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 struct bt_packet;
  42 struct bt_packet_header_field;
  43 struct bt_packet_context_field;
  44 struct bt_stream;
  45 struct bt_clock_value;
  46
  47 extern struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet);
  48
  49 extern
  50 struct bt_field *bt_packet_borrow_header_field(struct bt_packet *packet);
  51
  52 extern
  53 struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet);
  54
  55 extern
  56 enum bt_clock_value_status bt_packet_borrow_default_beginning_clock_value(
  57                 struct bt_packet *packet, struct bt_clock_value **clock_value);
  58
  59 extern
  60 enum bt_clock_value_status bt_packet_borrow_default_end_clock_valeu(
  61                 struct bt_packet *packet, struct bt_clock_value **clock_value);
  62
  63 extern
  64 enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
  65                 struct bt_packet *packet, uint64_t *value);
  66
  67 extern
  68 enum bt_property_availability bt_packet_get_packet_counter_snapshot(
  69                 struct bt_packet *packet, uint64_t *value);
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif
  74
  75 #endif /* BABELTRACE_TRACE_IR_PACKET_H */