include/babeltrace/trace-ir/event.h

   1 #ifndef BABELTRACE_TRACE_IR_EVENT_H
   2 #define BABELTRACE_TRACE_IR_EVENT_H
   3
   4 /*
   5  * BabelTrace - Trace IR: Event
   6  *
   7  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The Common Trace Format (CTF) Specification is available at
  30  * http://www.efficios.com/ctf
  31  */
  32
  33 #include <stdint.h>
  34 #include <stddef.h>
  35
  36 /* For enum bt_clock_value_status */
  37 #include <babeltrace/trace-ir/clock-value.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 struct bt_event;
  44 struct bt_event_header_field;
  45 struct bt_clock_value;
  46 struct bt_event_class;
  47 struct bt_field;
  48 struct bt_packet;
  49
  50 extern struct bt_event_class *bt_event_borrow_class(struct bt_event *event);
  51
  52 extern struct bt_packet *bt_event_borrow_packet(struct bt_event *event);
  53
  54 extern struct bt_stream *bt_event_borrow_stream(struct bt_event *event);
  55
  56 extern struct bt_field *bt_event_borrow_header_field(struct bt_event *event);
  57
  58 extern int bt_event_move_header(struct bt_event *event,
  59                 struct bt_event_header_field *header);
  60
  61 extern struct bt_field *bt_event_borrow_common_context_field(
  62                 struct bt_event *event);
  63
  64 extern struct bt_field *bt_event_borrow_specific_context_field(
  65                 struct bt_event *event);
  66
  67 extern struct bt_field *bt_event_borrow_payload_field(struct bt_event *event);
  68
  69 extern int bt_event_set_default_clock_value(struct bt_event *event,
  70                 uint64_t value_cycles);
  71
  72 extern enum bt_clock_value_status bt_event_borrow_default_clock_value(
  73                 struct bt_event *event, struct bt_clock_value **clock_value);
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif
  78
  79 #endif /* BABELTRACE_TRACE_IR_EVENT_H */