[babeltrace.git] / src / ctf-writer / utils.h

#ifndef BABELTRACE_CTF_WRITER_UTILS_INTERNAL_H
#define BABELTRACE_CTF_WRITER_UTILS_INTERNAL_H

/*
 * 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 "common/macros.h"
#include <babeltrace2-ctf-writer/field-types.h>
#include <babeltrace2-ctf-writer/event.h>
#include <stdint.h>

#include "field-path.h"

#define BT_CTF_TO_COMMON(_obj)		(&(_obj)->common)
#define BT_CTF_FROM_COMMON(_obj)	((void *) _obj)

struct bt_ctf_search_query {
	gpointer value;
	int found;
};

static inline
const char *bt_ctf_field_type_id_string(enum bt_ctf_field_type_id type_id)
{
	switch (type_id) {
	case BT_CTF_FIELD_TYPE_ID_UNKNOWN:
		return "BT_CTF_FIELD_TYPE_ID_UNKNOWN";
	case BT_CTF_FIELD_TYPE_ID_INTEGER:
		return "BT_CTF_FIELD_TYPE_ID_INTEGER";
	case BT_CTF_FIELD_TYPE_ID_FLOAT:
		return "BT_CTF_FIELD_TYPE_ID_FLOAT";
	case BT_CTF_FIELD_TYPE_ID_ENUM:
		return "BT_CTF_FIELD_TYPE_ID_ENUM";
	case BT_CTF_FIELD_TYPE_ID_STRING:
		return "BT_CTF_FIELD_TYPE_ID_STRING";
	case BT_CTF_FIELD_TYPE_ID_STRUCT:
		return "BT_CTF_FIELD_TYPE_ID_STRUCT";
	case BT_CTF_FIELD_TYPE_ID_ARRAY:
		return "BT_CTF_FIELD_TYPE_ID_ARRAY";
	case BT_CTF_FIELD_TYPE_ID_SEQUENCE:
		return "BT_CTF_FIELD_TYPE_ID_SEQUENCE";
	case BT_CTF_FIELD_TYPE_ID_VARIANT:
		return "BT_CTF_FIELD_TYPE_ID_VARIANT";
	default:
		return "(unknown)";
	}
};

static inline
const char *bt_ctf_byte_order_string(enum bt_ctf_byte_order bo)
{
	switch (bo) {
	case BT_CTF_BYTE_ORDER_UNKNOWN:
		return "BT_CTF_BYTE_ORDER_UNKNOWN";
	case BT_CTF_BYTE_ORDER_UNSPECIFIED:
		return "BT_CTF_BYTE_ORDER_UNSPECIFIED";
	case BT_CTF_BYTE_ORDER_NATIVE:
		return "BT_CTF_BYTE_ORDER_NATIVE";
	case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN:
		return "BT_CTF_BYTE_ORDER_LITTLE_ENDIAN";
	case BT_CTF_BYTE_ORDER_BIG_ENDIAN:
		return "BT_CTF_BYTE_ORDER_BIG_ENDIAN";
	case BT_CTF_BYTE_ORDER_NETWORK:
		return "BT_CTF_BYTE_ORDER_NETWORK";
	default:
		return "(unknown)";
	}
};

static inline
const char *bt_ctf_string_encoding_string(enum bt_ctf_string_encoding encoding)
{
	switch (encoding) {
	case BT_CTF_STRING_ENCODING_UNKNOWN:
		return "BT_CTF_STRING_ENCODING_UNKNOWN";
	case BT_CTF_STRING_ENCODING_NONE:
		return "BT_CTF_STRING_ENCODING_NONE";
	case BT_CTF_STRING_ENCODING_UTF8:
		return "BT_CTF_STRING_ENCODING_UTF8";
	case BT_CTF_STRING_ENCODING_ASCII:
		return "BT_CTF_STRING_ENCODING_ASCII";
	default:
		return "(unknown)";
	}
};

static inline
const char *bt_ctf_integer_base_string(enum bt_ctf_integer_base base)
{
	switch (base) {
	case BT_CTF_INTEGER_BASE_UNKNOWN:
		return "BT_CTF_INTEGER_BASE_UNKNOWN";
	case BT_CTF_INTEGER_BASE_UNSPECIFIED:
		return "BT_CTF_INTEGER_BASE_UNSPECIFIED";
	case BT_CTF_INTEGER_BASE_BINARY:
		return "BT_CTF_INTEGER_BASE_BINARY";
	case BT_CTF_INTEGER_BASE_OCTAL:
		return "BT_CTF_INTEGER_BASE_OCTAL";
	case BT_CTF_INTEGER_BASE_DECIMAL:
		return "BT_CTF_INTEGER_BASE_DECIMAL";
	case BT_CTF_INTEGER_BASE_HEXADECIMAL:
		return "BT_CTF_INTEGER_BASE_HEXADECIMAL";
	default:
		return "(unknown)";
	}
}

static inline
const char *bt_ctf_scope_string(enum bt_ctf_scope scope)
{
	switch (scope) {
	case BT_CTF_SCOPE_UNKNOWN:
		return "BT_CTF_SCOPE_UNKNOWN";
	case BT_CTF_SCOPE_TRACE_PACKET_HEADER:
		return "BT_CTF_SCOPE_TRACE_PACKET_HEADER";
	case BT_CTF_SCOPE_STREAM_PACKET_CONTEXT:
		return "BT_CTF_SCOPE_STREAM_PACKET_CONTEXT";
	case BT_CTF_SCOPE_STREAM_EVENT_HEADER:
		return "BT_CTF_SCOPE_STREAM_EVENT_HEADER";
	case BT_CTF_SCOPE_STREAM_EVENT_CONTEXT:
		return "BT_CTF_SCOPE_STREAM_EVENT_CONTEXT";
	case BT_CTF_SCOPE_EVENT_CONTEXT:
		return "BT_CTF_SCOPE_EVENT_CONTEXT";
	case BT_CTF_SCOPE_EVENT_PAYLOAD:
		return "BT_CTF_SCOPE_EVENT_PAYLOAD";
	case BT_CTF_SCOPE_ENV:
		return "BT_CTF_SCOPE_ENV";
	default:
		return "(unknown)";
	}
}

static inline
const char *bt_ctf_event_class_log_level_string(
		enum bt_ctf_event_class_log_level level)
{
	switch (level) {
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_UNKNOWN:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_UNKNOWN";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_EMERGENCY:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_EMERGENCY";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_ALERT:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_ALERT";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_CRITICAL:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_CRITICAL";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_ERROR:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_ERROR";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_WARNING:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_WARNING";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_NOTICE:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_NOTICE";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_INFO:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_INFO";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE";
	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG:
		return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG";
	default:
		return "(unknown)";
	}
};

static inline
GString *bt_ctf_field_path_string(struct bt_ctf_field_path *path)
{
	GString *str = g_string_new(NULL);
	size_t i;

	BT_ASSERT_DBG(path);

	if (!str) {
		goto end;
	}

	g_string_append_printf(str, "[%s", bt_ctf_scope_string(
		bt_ctf_field_path_get_root_scope(path)));

	for (i = 0; i < bt_ctf_field_path_get_index_count(path); i++) {
		int index = bt_ctf_field_path_get_index(path, i);

		g_string_append_printf(str, ", %d", index);
	}

	g_string_append(str, "]");

end:
	return str;
}

#endif /* BABELTRACE_CTF_WRITER_UTILS_INTERNAL_H */
Commit	Line	Data
086dc475 PP	1	#ifndef BABELTRACE_CTF_WRITER_UTILS_INTERNAL_H
	2	#define BABELTRACE_CTF_WRITER_UTILS_INTERNAL_H
	3
	4	/*
086dc475 PP	5	* Permission is hereby granted, free of charge, to any person obtaining a copy
	6	* of this software and associated documentation files (the "Software"), to deal
	7	* in the Software without restriction, including without limitation the rights
	8	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	9	* copies of the Software, and to permit persons to whom the Software is
	10	* furnished to do so, subject to the following conditions:
	11	*
	12	* The above copyright notice and this permission notice shall be included in
	13	* all copies or substantial portions of the Software.
	14	*
	15	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	16	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	18	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	19	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	20	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	21	* SOFTWARE.
	22	*/
	23
85e7137b	24	#include "common/macros.h"
3996bc53 PP	25	#include <babeltrace2-ctf-writer/field-types.h>
3996bc53 PP	26	#include <babeltrace2-ctf-writer/event.h>
086dc475 PP	27	#include <stdint.h>
086dc475 PP	28
57952005 MJ	29	#include "field-path.h"
57952005 MJ	30
086dc475 PP	31	#define BT_CTF_TO_COMMON(_obj) (&(_obj)->common)
	32	#define BT_CTF_FROM_COMMON(_obj) ((void *) _obj)
	33
	34	struct bt_ctf_search_query {
	35	gpointer value;
	36	int found;
	37	};
	38
086dc475 PP	39	static inline
	40	const char *bt_ctf_field_type_id_string(enum bt_ctf_field_type_id type_id)
	41	{
	42	switch (type_id) {
	43	case BT_CTF_FIELD_TYPE_ID_UNKNOWN:
	44	return "BT_CTF_FIELD_TYPE_ID_UNKNOWN";
	45	case BT_CTF_FIELD_TYPE_ID_INTEGER:
	46	return "BT_CTF_FIELD_TYPE_ID_INTEGER";
	47	case BT_CTF_FIELD_TYPE_ID_FLOAT:
	48	return "BT_CTF_FIELD_TYPE_ID_FLOAT";
	49	case BT_CTF_FIELD_TYPE_ID_ENUM:
	50	return "BT_CTF_FIELD_TYPE_ID_ENUM";
	51	case BT_CTF_FIELD_TYPE_ID_STRING:
	52	return "BT_CTF_FIELD_TYPE_ID_STRING";
	53	case BT_CTF_FIELD_TYPE_ID_STRUCT:
	54	return "BT_CTF_FIELD_TYPE_ID_STRUCT";
	55	case BT_CTF_FIELD_TYPE_ID_ARRAY:
	56	return "BT_CTF_FIELD_TYPE_ID_ARRAY";
	57	case BT_CTF_FIELD_TYPE_ID_SEQUENCE:
	58	return "BT_CTF_FIELD_TYPE_ID_SEQUENCE";
	59	case BT_CTF_FIELD_TYPE_ID_VARIANT:
	60	return "BT_CTF_FIELD_TYPE_ID_VARIANT";
	61	default:
	62	return "(unknown)";
	63	}
	64	};
	65
	66	static inline
	67	const char *bt_ctf_byte_order_string(enum bt_ctf_byte_order bo)
	68	{
	69	switch (bo) {
	70	case BT_CTF_BYTE_ORDER_UNKNOWN:
	71	return "BT_CTF_BYTE_ORDER_UNKNOWN";
	72	case BT_CTF_BYTE_ORDER_UNSPECIFIED:
	73	return "BT_CTF_BYTE_ORDER_UNSPECIFIED";
	74	case BT_CTF_BYTE_ORDER_NATIVE:
	75	return "BT_CTF_BYTE_ORDER_NATIVE";
	76	case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN:
	77	return "BT_CTF_BYTE_ORDER_LITTLE_ENDIAN";
	78	case BT_CTF_BYTE_ORDER_BIG_ENDIAN:
	79	return "BT_CTF_BYTE_ORDER_BIG_ENDIAN";
	80	case BT_CTF_BYTE_ORDER_NETWORK:
	81	return "BT_CTF_BYTE_ORDER_NETWORK";
	82	default:
	83	return "(unknown)";
	84	}
	85	};
	86
	87	static inline
	88	const char *bt_ctf_string_encoding_string(enum bt_ctf_string_encoding encoding)
	89	{
	90	switch (encoding) {
	91	case BT_CTF_STRING_ENCODING_UNKNOWN:
	92	return "BT_CTF_STRING_ENCODING_UNKNOWN";
	93	case BT_CTF_STRING_ENCODING_NONE:
	94	return "BT_CTF_STRING_ENCODING_NONE";
	95	case BT_CTF_STRING_ENCODING_UTF8:
	96	return "BT_CTF_STRING_ENCODING_UTF8";
	97	case BT_CTF_STRING_ENCODING_ASCII:
	98	return "BT_CTF_STRING_ENCODING_ASCII";
	99	default:
	100	return "(unknown)";
	101	}
	102	};
103
104	static inline
105	const char *bt_ctf_integer_base_string(enum bt_ctf_integer_base base)
106	{
107	switch (base) {
108	case BT_CTF_INTEGER_BASE_UNKNOWN:
109	return "BT_CTF_INTEGER_BASE_UNKNOWN";
110	case BT_CTF_INTEGER_BASE_UNSPECIFIED:
111	return "BT_CTF_INTEGER_BASE_UNSPECIFIED";
112	case BT_CTF_INTEGER_BASE_BINARY:
113	return "BT_CTF_INTEGER_BASE_BINARY";
114	case BT_CTF_INTEGER_BASE_OCTAL:
115	return "BT_CTF_INTEGER_BASE_OCTAL";
116	case BT_CTF_INTEGER_BASE_DECIMAL:
117	return "BT_CTF_INTEGER_BASE_DECIMAL";
118	case BT_CTF_INTEGER_BASE_HEXADECIMAL:
119	return "BT_CTF_INTEGER_BASE_HEXADECIMAL";
120	default:
121	return "(unknown)";
122	}
123	}
124
125	static inline
126	const char *bt_ctf_scope_string(enum bt_ctf_scope scope)
127	{
128	switch (scope) {
129	case BT_CTF_SCOPE_UNKNOWN:
130	return "BT_CTF_SCOPE_UNKNOWN";
131	case BT_CTF_SCOPE_TRACE_PACKET_HEADER:
132	return "BT_CTF_SCOPE_TRACE_PACKET_HEADER";
133	case BT_CTF_SCOPE_STREAM_PACKET_CONTEXT:
134	return "BT_CTF_SCOPE_STREAM_PACKET_CONTEXT";
135	case BT_CTF_SCOPE_STREAM_EVENT_HEADER:
136	return "BT_CTF_SCOPE_STREAM_EVENT_HEADER";
137	case BT_CTF_SCOPE_STREAM_EVENT_CONTEXT:
138	return "BT_CTF_SCOPE_STREAM_EVENT_CONTEXT";
139	case BT_CTF_SCOPE_EVENT_CONTEXT:
140	return "BT_CTF_SCOPE_EVENT_CONTEXT";
141	case BT_CTF_SCOPE_EVENT_PAYLOAD:
142	return "BT_CTF_SCOPE_EVENT_PAYLOAD";
143	case BT_CTF_SCOPE_ENV:
144	return "BT_CTF_SCOPE_ENV";
145	default:
146	return "(unknown)";
147	}
148	}
149
150	static inline
151	const char *bt_ctf_event_class_log_level_string(
152	enum bt_ctf_event_class_log_level level)
153	{
154	switch (level) {
155	case BT_CTF_EVENT_CLASS_LOG_LEVEL_UNKNOWN:
156	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_UNKNOWN";
157	case BT_CTF_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED:
158	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED";
159	case BT_CTF_EVENT_CLASS_LOG_LEVEL_EMERGENCY:
160	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_EMERGENCY";
161	case BT_CTF_EVENT_CLASS_LOG_LEVEL_ALERT:
162	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_ALERT";
163	case BT_CTF_EVENT_CLASS_LOG_LEVEL_CRITICAL:
164	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_CRITICAL";
165	case BT_CTF_EVENT_CLASS_LOG_LEVEL_ERROR:
166	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_ERROR";
167	case BT_CTF_EVENT_CLASS_LOG_LEVEL_WARNING:
168	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_WARNING";
169	case BT_CTF_EVENT_CLASS_LOG_LEVEL_NOTICE:
170	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_NOTICE";
171	case BT_CTF_EVENT_CLASS_LOG_LEVEL_INFO:
172	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_INFO";
173	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM:
174	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM";
175	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM:
176	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM";
177	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS:
178	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS";
179	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE:
180	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE";
181	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT:
182	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT";
183	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION:
184	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION";
185	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE:
186	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE";
187	case BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG:
188	return "BT_CTF_EVENT_CLASS_LOG_LEVEL_DEBUG";
189	default:
190	return "(unknown)";
191	}
192	};
193
194	static inline
195	GString bt_ctf_field_path_string(struct bt_ctf_field_path path)
196	{
197	GString *str = g_string_new(NULL);
198	size_t i;
199
ec4a3354	200	BT_ASSERT_DBG(path);
086dc475 PP	201
	202	if (!str) {
	203	goto end;
	204	}
	205
003f30da	206	g_string_append_printf(str, "[%s", bt_ctf_scope_string(
086dc475 PP	207	bt_ctf_field_path_get_root_scope(path)));
	208
	209	for (i = 0; i < bt_ctf_field_path_get_index_count(path); i++) {
	210	int index = bt_ctf_field_path_get_index(path, i);
	211
	212	g_string_append_printf(str, ", %d", index);
	213	}
	214
	215	g_string_append(str, "]");
	216
	217	end:
	218	return str;
	219	}
	220
	221	#endif /* BABELTRACE_CTF_WRITER_UTILS_INTERNAL_H */