[babeltrace.git] / include / babeltrace / ctf / metadata.h

#ifndef _BABELTRACE_CTF_METADATA_H
#define _BABELTRACE_CTF_METADATA_H

/*
 * BabelTrace
 *
 * CTF Metadata Header
 *
 * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@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.
 */

#include <babeltrace/types.h>
#include <sys/types.h>
#include <dirent.h>
#include <uuid/uuid.h>
#include <assert.h>
#include <glib.h>

struct ctf_trace;
struct ctf_stream;
struct ctf_event;

#define CTF_TRACE_SET_FIELD(ctf_trace, field)				\
	do {								\
		(ctf_trace)->field_mask |= CTF_TRACE_ ## field;		\
	} while (0)

#define CTF_TRACE_FIELD_IS_SET(ctf_trace, field)			\
		((ctf_trace)->field_mask & CTF_TRACE_ ## field)

#define CTF_TRACE_GET_FIELD(ctf_trace, field)				\
	({								\
		assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field));	\
		(ctf_trace)->(field);					\
	})


struct ctf_trace {
	/* root scope */
	struct declaration_scope *root_declaration_scope;

	struct declaration_scope *declaration_scope;
	GPtrArray *streams;			/* Array of struct ctf_stream pointers*/

	uint64_t major;
	uint64_t minor;
	uuid_t uuid;
	int byte_order;

	enum {					/* Fields populated mask */
		CTF_TRACE_major	=	(1U << 0),
		CTF_TRACE_minor =	(1U << 1),
		CTF_TRACE_uuid	=	(1U << 2),
	} field_mask;

	/* Information about trace backing directory and files */
	DIR *dir;
	int flags;		/* open flags */
};

#define CTF_STREAM_SET_FIELD(ctf_stream, field)				\
	do {								\
		(ctf_stream)->field_mask |= CTF_STREAM_ ## field;	\
	} while (0)

#define CTF_STREAM_FIELD_IS_SET(ctf_stream, field)			\
		((ctf_stream)->field_mask & CTF_STREAM_ ## field)

#define CTF_STREAM_GET_FIELD(ctf_stream, field)				\
	({								\
		assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field));	\
		(ctf_stream)->(field);					\
	})

struct ctf_stream {
	struct ctf_trace *trace;
	/* parent is lexical scope conaining the stream scope */
	struct declaration_scope *declaration_scope;
	/* innermost definition scope. to be used as parent of event. */
	struct definition_scope *definition_scope;
	GPtrArray *events_by_id;		/* Array of struct ctf_event pointers indexed by id */
	GHashTable *event_quark_to_id;		/* GQuark to numeric id */

	/* Declarations only used when parsing */
	struct declaration_struct *packet_context_decl;
	struct declaration_struct *event_header_decl;
	struct declaration_struct *event_context_decl;

	/* Definitions used afterward */
	struct definition_struct *packet_context;
	struct definition_struct *event_header;
	struct definition_struct *event_context;

	uint64_t stream_id;

	enum {					/* Fields populated mask */
		CTF_STREAM_stream_id =	(1 << 0),
	} field_mask;

	/* Information about stream backing file */
	int fd;
	char *mmap;				/* current stream mmap */
	struct stream_pos pos;			/* current stream position */
};

#define CTF_EVENT_SET_FIELD(ctf_event, field)				\
	do {								\
		(ctf_event)->field_mask |= CTF_EVENT_ ## field;		\
	} while (0)

#define CTF_EVENT_FIELD_IS_SET(ctf_event, field)			\
		((ctf_event)->field_mask & CTF_EVENT_ ## field)

#define CTF_EVENT_GET_FIELD(ctf_event, field)				\
	({								\
		assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field));	\
		(ctf_event)->(field);					\
	})

struct ctf_event {
	/* stream mapped by stream_id */
	struct ctf_stream *stream;
	/* parent is lexical scope conaining the event scope */
	struct declaration_scope *declaration_scope;

	/* Declarations only used when parsing */
	struct declaration_struct *context_decl;
	struct declaration_struct *fields_decl;

	/* Definitions used afterward */
	struct definition_struct *context;
	struct definition_struct *fields;

	GQuark name;
	uint64_t id;		/* Numeric identifier within the stream */
	uint64_t stream_id;

	enum {					/* Fields populated mask */
		CTF_EVENT_name	=	(1 << 0),
		CTF_EVENT_id 	= 	(1 << 1),
		CTF_EVENT_stream_id = 	(1 << 2),
	} field_mask;
};

#endif /* _BABELTRACE_CTF_METADATA_H */
Commit	Line	Data
c054553d MD	1	#ifndef _BABELTRACE_CTF_METADATA_H
	2	#define _BABELTRACE_CTF_METADATA_H
	3
	4	/*
	5	* BabelTrace
	6	*
	7	* CTF Metadata Header
	8	*
	9	* Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@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
	22	#include <babeltrace/types.h>
bbefb8dd MD	23	#include <sys/types.h>
bbefb8dd MD	24	#include <dirent.h>
96513a7f MD	25	#include <uuid/uuid.h>
96513a7f MD	26	#include <assert.h>
c054553d MD	27	#include <glib.h>
	28
	29	struct ctf_trace;
	30	struct ctf_stream;
	31	struct ctf_event;
	32
a0720417	33	#define CTF_TRACE_SET_FIELD(ctf_trace, field) \
96513a7f	34	do { \
96513a7f MD	35	(ctf_trace)->field_mask \|= CTF_TRACE_ ## field; \
	36	} while (0)
	37
	38	#define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
	39	((ctf_trace)->field_mask & CTF_TRACE_ ## field)
	40
	41	#define CTF_TRACE_GET_FIELD(ctf_trace, field) \
	42	({ \
	43	assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
	44	(ctf_trace)->(field); \
	45	})
	46
05628561	47
c054553d	48	struct ctf_trace {
05628561	49	/* root scope */
f6625916	50	struct declaration_scope *root_declaration_scope;
05628561	51
f6625916	52	struct declaration_scope *declaration_scope;
05628561	53	GPtrArray streams; / Array of struct ctf_stream pointers*/
fe21b943 MD	54
	55	uint64_t major;
	56	uint64_t minor;
96513a7f	57	uuid_t uuid;
ab4cf058	58	int byte_order;
96513a7f MD	59
	60	enum { /* Fields populated mask */
	61	CTF_TRACE_major = (1U << 0),
	62	CTF_TRACE_minor = (1U << 1),
	63	CTF_TRACE_uuid = (1U << 2),
96513a7f	64	} field_mask;
bbefb8dd MD	65
	66	/* Information about trace backing directory and files */
	67	DIR *dir;
	68	int flags; /* open flags */
c054553d MD	69	};
c054553d MD	70
a0720417	71	#define CTF_STREAM_SET_FIELD(ctf_stream, field) \
96513a7f	72	do { \
96513a7f MD	73	(ctf_stream)->field_mask \|= CTF_STREAM_ ## field; \
	74	} while (0)
	75
	76	#define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
	77	((ctf_stream)->field_mask & CTF_STREAM_ ## field)
	78
	79	#define CTF_STREAM_GET_FIELD(ctf_stream, field) \
	80	({ \
	81	assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
	82	(ctf_stream)->(field); \
	83	})
	84
c054553d	85	struct ctf_stream {
96513a7f	86	struct ctf_trace *trace;
05628561	87	/* parent is lexical scope conaining the stream scope */
f6625916	88	struct declaration_scope *declaration_scope;
41253107	89	/* innermost definition scope. to be used as parent of event. */
e1151715	90	struct definition_scope *definition_scope;
05628561	91	GPtrArray events_by_id; / Array of struct ctf_event pointers indexed by id */
96513a7f	92	GHashTable event_quark_to_id; / GQuark to numeric id */
fe21b943	93
9e29e16e MD	94	/* Declarations only used when parsing */
	95	struct declaration_struct *packet_context_decl;
	96	struct declaration_struct *event_header_decl;
	97	struct declaration_struct *event_context_decl;
	98
	99	/* Definitions used afterward */
	100	struct definition_struct *packet_context;
e1151715 MD	101	struct definition_struct *event_header;
e1151715 MD	102	struct definition_struct *event_context;
96513a7f MD	103
	104	uint64_t stream_id;
	105
	106	enum { /* Fields populated mask */
	107	CTF_STREAM_stream_id = (1 << 0),
	108	} field_mask;
bbefb8dd MD	109
	110	/* Information about stream backing file */
	111	int fd;
	112	char mmap; / current stream mmap */
	113	struct stream_pos pos; /* current stream position */
c054553d MD	114	};
c054553d MD	115
05628561	116	#define CTF_EVENT_SET_FIELD(ctf_event, field) \
96513a7f	117	do { \
96513a7f MD	118	(ctf_event)->field_mask \|= CTF_EVENT_ ## field; \
	119	} while (0)
	120
	121	#define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
	122	((ctf_event)->field_mask & CTF_EVENT_ ## field)
	123
	124	#define CTF_EVENT_GET_FIELD(ctf_event, field) \
	125	({ \
	126	assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
	127	(ctf_event)->(field); \
	128	})
	129
c054553d	130	struct ctf_event {
05628561 MD	131	/* stream mapped by stream_id */
	132	struct ctf_stream *stream;
	133	/* parent is lexical scope conaining the event scope */
f6625916	134	struct declaration_scope *declaration_scope;
9e29e16e MD	135
	136	/* Declarations only used when parsing */
	137	struct declaration_struct *context_decl;
	138	struct declaration_struct *fields_decl;
	139
	140	/* Definitions used afterward */
e1151715 MD	141	struct definition_struct *context;
e1151715 MD	142	struct definition_struct *fields;
96513a7f MD	143
	144	GQuark name;
	145	uint64_t id; /* Numeric identifier within the stream */
	146	uint64_t stream_id;
	147
	148	enum { /* Fields populated mask */
	149	CTF_EVENT_name = (1 << 0),
	150	CTF_EVENT_id = (1 << 1),
	151	CTF_EVENT_stream_id = (1 << 2),
	152	} field_mask;
c054553d MD	153	};
	154
	155	#endif /* _BABELTRACE_CTF_METADATA_H */