include/babeltrace/ctf-ir/event-class-internal.h

   1 #ifndef BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H
   3
   4 /*
   5  * Babeltrace - CTF IR: Event class internal
   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
  30 #include <babeltrace/ctf-ir/field-types.h>
  31 #include <babeltrace/ctf-ir/fields.h>
  32 #include <babeltrace/babeltrace-internal.h>
  33 #include <babeltrace/values.h>
  34 #include <babeltrace/ctf-ir/trace-internal.h>
  35 #include <babeltrace/ctf-ir/stream-class.h>
  36 #include <babeltrace/ctf-ir/stream.h>
  37 #include <babeltrace/ctf-ir/event-class.h>
  38 #include <babeltrace/object-internal.h>
  39 #include <babeltrace/assert-internal.h>
  40 #include <glib.h>
  41
  42 struct bt_event_class {
  43         struct bt_object base;
  44         /* Structure type containing the event's context */
  45         struct bt_field_type *context;
  46         /* Structure type containing the event's fields */
  47         struct bt_field_type *fields;
  48         int frozen;
  49
  50         /*
  51          * This flag indicates if the event class is valid. A valid
  52          * event class is _always_ frozen. However, an event class
  53          * may be frozen, but not valid yet. This is okay, as long as
  54          * no events are created out of this event class.
  55          */
  56         int valid;
  57
  58         /* Attributes */
  59         GString *name;
  60         int64_t id;
  61         enum bt_event_class_log_level log_level;
  62         GString *emf_uri;
  63 };
  64
  65 BT_HIDDEN
  66 void bt_event_class_freeze(struct bt_event_class *event_class);
  67
  68 BT_HIDDEN
  69 int bt_event_class_serialize(struct bt_event_class *event_class,
  70                 struct metadata_context *context);
  71
  72 BT_HIDDEN
  73 void bt_event_class_set_native_byte_order(
  74                 struct bt_event_class *event_class,
  75                 int byte_order);
  76
  77 static inline
  78 struct bt_stream_class *bt_event_class_borrow_stream_class(
  79                 struct bt_event_class *event_class)
  80 {
  81         BT_ASSERT(event_class);
  82         return (void *) bt_object_borrow_parent(event_class);
  83 }
  84
  85 static inline
  86 const char *bt_event_class_log_level_string(
  87                 enum bt_event_class_log_level level)
  88 {
  89         switch (level) {
  90         case BT_EVENT_CLASS_LOG_LEVEL_UNKNOWN:
  91                 return "BT_EVENT_CLASS_LOG_LEVEL_UNKNOWN";
  92         case BT_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED:
  93                 return "BT_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED";
  94         case BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY:
  95                 return "BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY";
  96         case BT_EVENT_CLASS_LOG_LEVEL_ALERT:
  97                 return "BT_EVENT_CLASS_LOG_LEVEL_ALERT";
  98         case BT_EVENT_CLASS_LOG_LEVEL_CRITICAL:
  99                 return "BT_EVENT_CLASS_LOG_LEVEL_CRITICAL";
 100         case BT_EVENT_CLASS_LOG_LEVEL_ERROR:
 101                 return "BT_EVENT_CLASS_LOG_LEVEL_ERROR";
 102         case BT_EVENT_CLASS_LOG_LEVEL_WARNING:
 103                 return "BT_EVENT_CLASS_LOG_LEVEL_WARNING";
 104         case BT_EVENT_CLASS_LOG_LEVEL_NOTICE:
 105                 return "BT_EVENT_CLASS_LOG_LEVEL_NOTICE";
 106         case BT_EVENT_CLASS_LOG_LEVEL_INFO:
 107                 return "BT_EVENT_CLASS_LOG_LEVEL_INFO";
 108         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM:
 109                 return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM";
 110         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM:
 111                 return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM";
 112         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS:
 113                 return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS";
 114         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE:
 115                 return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE";
 116         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT:
 117                 return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT";
 118         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION:
 119                 return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION";
 120         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE:
 121                 return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE";
 122         case BT_EVENT_CLASS_LOG_LEVEL_DEBUG:
 123                 return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG";
 124         default:
 125                 return "(unknown)";
 126         }
 127 };
 128
 129 BT_HIDDEN
 130 int bt_event_class_validate_single_clock_class(
 131                 struct bt_event_class *event_class,
 132                 struct bt_clock_class **expected_clock_class);
 133
 134 #endif /* BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H */