[babeltrace.git] / include / babeltrace / ctf-ir / event-class-internal.h

#ifndef BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H
#define BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H

/*
 * Babeltrace - CTF IR: Event class internal
 *
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <babeltrace/ctf-ir/field-types.h>
#include <babeltrace/ctf-ir/fields.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/values.h>
#include <babeltrace/ctf-ir/trace-internal.h>
#include <babeltrace/ctf-ir/stream-class.h>
#include <babeltrace/ctf-ir/stream.h>
#include <babeltrace/ctf-ir/event-class.h>
#include <babeltrace/object-internal.h>
#include <glib.h>

struct bt_event_class {
	struct bt_object base;
	/* Structure type containing the event's context */
	struct bt_field_type *context;
	/* Structure type containing the event's fields */
	struct bt_field_type *fields;
	int frozen;

	/*
	 * This flag indicates if the event class is valid. A valid
	 * event class is _always_ frozen. However, an event class
	 * may be frozen, but not valid yet. This is okay, as long as
	 * no events are created out of this event class.
	 */
	int valid;

	/* Attributes */
	GString *name;
	int64_t id;
	enum bt_event_class_log_level log_level;
	GString *emf_uri;
};

BT_HIDDEN
void bt_event_class_freeze(struct bt_event_class *event_class);

BT_HIDDEN
int bt_event_class_serialize(struct bt_event_class *event_class,
		struct metadata_context *context);

BT_HIDDEN
void bt_event_class_set_native_byte_order(
		struct bt_event_class *event_class,
		int byte_order);

static inline
struct bt_stream_class *bt_event_class_borrow_stream_class(
		struct bt_event_class *event_class)
{
	assert(event_class);
	return (void *) bt_object_borrow_parent(event_class);
}

static inline
const char *bt_event_class_log_level_string(
		enum bt_event_class_log_level level)
{
	switch (level) {
	case BT_EVENT_CLASS_LOG_LEVEL_UNKNOWN:
		return "BT_EVENT_CLASS_LOG_LEVEL_UNKNOWN";
	case BT_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED:
		return "BT_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED";
	case BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY:
		return "BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY";
	case BT_EVENT_CLASS_LOG_LEVEL_ALERT:
		return "BT_EVENT_CLASS_LOG_LEVEL_ALERT";
	case BT_EVENT_CLASS_LOG_LEVEL_CRITICAL:
		return "BT_EVENT_CLASS_LOG_LEVEL_CRITICAL";
	case BT_EVENT_CLASS_LOG_LEVEL_ERROR:
		return "BT_EVENT_CLASS_LOG_LEVEL_ERROR";
	case BT_EVENT_CLASS_LOG_LEVEL_WARNING:
		return "BT_EVENT_CLASS_LOG_LEVEL_WARNING";
	case BT_EVENT_CLASS_LOG_LEVEL_NOTICE:
		return "BT_EVENT_CLASS_LOG_LEVEL_NOTICE";
	case BT_EVENT_CLASS_LOG_LEVEL_INFO:
		return "BT_EVENT_CLASS_LOG_LEVEL_INFO";
	case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM:
		return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM";
	case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM:
		return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM";
	case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS:
		return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS";
	case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE:
		return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE";
	case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT:
		return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT";
	case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION:
		return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION";
	case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE:
		return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE";
	case BT_EVENT_CLASS_LOG_LEVEL_DEBUG:
		return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG";
	default:
		return "(unknown)";
	}
};

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