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

   1 #ifndef BABELTRACE_TRACE_IR_EVENT_CLASS_H
   2 #define BABELTRACE_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 #include <stdint.h>
  31
  32 /* For bt_event_class_log_level */
  33 #include <babeltrace2/trace-ir/event-class-const.h>
  34
  35 /* For bt_event_class, bt_stream_class */
  36 #include <babeltrace2/types.h>
  37
  38 /* For __BT_FUNC_STATUS_* */
  39 #define __BT_FUNC_STATUS_ENABLE
  40 #include <babeltrace2/func-status.h>
  41 #undef __BT_FUNC_STATUS_ENABLE
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 extern bt_event_class *bt_event_class_create(
  48                 bt_stream_class *stream_class);
  49
  50 extern bt_event_class *bt_event_class_create_with_id(
  51                 bt_stream_class *stream_class, uint64_t id);
  52
  53 extern bt_stream_class *bt_event_class_borrow_stream_class(
  54                 bt_event_class *event_class);
  55
  56 typedef enum bt_event_class_set_name_status {
  57         BT_EVENT_CLASS_SET_NAME_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  58         BT_EVENT_CLASS_SET_NAME_STATUS_OK               = __BT_FUNC_STATUS_OK,
  59 } bt_event_class_set_name_status;
  60
  61 extern bt_event_class_set_name_status bt_event_class_set_name(
  62                 bt_event_class *event_class, const char *name);
  63
  64 extern void bt_event_class_set_log_level(bt_event_class *event_class,
  65                 bt_event_class_log_level log_level);
  66
  67 typedef enum bt_event_class_set_emf_uri_status {
  68         BT_EVENT_CLASS_SET_EMF_URI_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
  69         BT_EVENT_CLASS_SET_EMF_URI_STATUS_OK            = __BT_FUNC_STATUS_OK,
  70 } bt_event_class_set_emf_uri_status;
  71
  72 extern bt_event_class_set_emf_uri_status bt_event_class_set_emf_uri(
  73                 bt_event_class *event_class, const char *emf_uri);
  74
  75 typedef enum bt_event_class_set_field_class_status {
  76         BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  77         BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK                = __BT_FUNC_STATUS_OK,
  78 } bt_event_class_set_field_class_status;
  79
  80 extern bt_event_class_set_field_class_status
  81 bt_event_class_set_specific_context_field_class(bt_event_class *event_class,
  82                 bt_field_class *field_class);
  83
  84 extern bt_field_class *
  85 bt_event_class_borrow_specific_context_field_class(bt_event_class *event_class);
  86
  87 extern bt_event_class_set_field_class_status
  88 bt_event_class_set_payload_field_class(
  89                 bt_event_class *event_class,
  90                 bt_field_class *field_class);
  91
  92 extern bt_field_class *bt_event_class_borrow_payload_field_class(
  93                 bt_event_class *event_class);
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif
  98
  99 #include <babeltrace2/undef-func-status.h>
 100
 101 #endif /* BABELTRACE_TRACE_IR_EVENT_CLASS_H */