include/babeltrace2/trace-ir/event-class.h

   1 #ifndef BABELTRACE2_TRACE_IR_EVENT_CLASS_H
   2 #define BABELTRACE2_TRACE_IR_EVENT_CLASS_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  *
  26  * The Common Trace Format (CTF) Specification is available at
  27  * http://www.efficios.com/ctf
  28  */
  29
  30 #ifndef __BT_IN_BABELTRACE_H
  31 # error "Please include <babeltrace2/babeltrace.h> instead."
  32 #endif
  33
  34 #include <stdint.h>
  35
  36 /* For bt_event_class_log_level */
  37 #include <babeltrace2/trace-ir/event-class-const.h>
  38
  39 /* For bt_event_class, bt_stream_class */
  40 #include <babeltrace2/types.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 extern bt_event_class *bt_event_class_create(
  47                 bt_stream_class *stream_class);
  48
  49 extern bt_event_class *bt_event_class_create_with_id(
  50                 bt_stream_class *stream_class, uint64_t id);
  51
  52 extern bt_stream_class *bt_event_class_borrow_stream_class(
  53                 bt_event_class *event_class);
  54
  55 typedef enum bt_event_class_set_name_status {
  56         BT_EVENT_CLASS_SET_NAME_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  57         BT_EVENT_CLASS_SET_NAME_STATUS_OK               = __BT_FUNC_STATUS_OK,
  58 } bt_event_class_set_name_status;
  59
  60 extern bt_event_class_set_name_status bt_event_class_set_name(
  61                 bt_event_class *event_class, const char *name);
  62
  63 extern void bt_event_class_set_log_level(bt_event_class *event_class,
  64                 bt_event_class_log_level log_level);
  65
  66 typedef enum bt_event_class_set_emf_uri_status {
  67         BT_EVENT_CLASS_SET_EMF_URI_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
  68         BT_EVENT_CLASS_SET_EMF_URI_STATUS_OK            = __BT_FUNC_STATUS_OK,
  69 } bt_event_class_set_emf_uri_status;
  70
  71 extern bt_event_class_set_emf_uri_status bt_event_class_set_emf_uri(
  72                 bt_event_class *event_class, const char *emf_uri);
  73
  74 typedef enum bt_event_class_set_field_class_status {
  75         BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  76         BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK                = __BT_FUNC_STATUS_OK,
  77 } bt_event_class_set_field_class_status;
  78
  79 extern bt_event_class_set_field_class_status
  80 bt_event_class_set_specific_context_field_class(bt_event_class *event_class,
  81                 bt_field_class *field_class);
  82
  83 extern bt_field_class *
  84 bt_event_class_borrow_specific_context_field_class(bt_event_class *event_class);
  85
  86 extern bt_event_class_set_field_class_status
  87 bt_event_class_set_payload_field_class(
  88                 bt_event_class *event_class,
  89                 bt_field_class *field_class);
  90
  91 extern bt_field_class *bt_event_class_borrow_payload_field_class(
  92                 bt_event_class *event_class);
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif
  97
  98 #endif /* BABELTRACE2_TRACE_IR_EVENT_CLASS_H */