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

#ifndef _BABELTRACE_CTF_IR_METADATA_H
#define _BABELTRACE_CTF_IR_METADATA_H

/*
 * BabelTrace
 *
 * CTF Intermediate Representation 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 <babeltrace/format.h>
#include <babeltrace/ctf/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_class;
struct ctf_stream;
struct ctf_event;

struct ctf_stream {
	struct ctf_stream_class *stream_class;
	uint64_t timestamp;			/* Current timestamp, in ns */
	uint64_t event_id;			/* Current event ID */
	int has_timestamp;
	uint64_t stream_id;

	struct definition_struct *trace_packet_header;
	struct definition_struct *stream_packet_context;
	struct definition_struct *stream_event_header;
	struct definition_struct *stream_event_context;
	GPtrArray *events_by_id;		/* Array of struct ctf_stream_event pointers indexed by id */
	struct definition_scope *parent_def_scope;	/* for initialization */
	int stream_definitions_created;
};

struct ctf_stream_event {
	struct definition_struct *event_context;
	struct definition_struct *event_fields;
};

#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 {
	struct trace_descriptor parent;
	/* root scope */
	struct declaration_scope *root_declaration_scope;

	struct declaration_scope *declaration_scope;
	/* innermost definition scope. to be used as parent of stream. */
	struct definition_scope *definition_scope;
	GPtrArray *streams;			/* Array of struct ctf_stream_class pointers */
	struct ctf_stream *metadata;

	struct declaration_struct *packet_header_decl;

	uint64_t major;
	uint64_t minor;
	uuid_t uuid;
	int byte_order;		/* trace BYTE_ORDER. 0 if unset. */

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

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

	/* Heap of streams, ordered to always get the lowest timestam */
	struct ptr_heap *stream_heap;
	char path[PATH_MAX];
};

#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_class {
	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 */

	struct declaration_struct *packet_context_decl;
	struct declaration_struct *event_header_decl;
	struct declaration_struct *event_context_decl;

	uint64_t stream_id;

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

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

#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_class *stream;
	/* parent is lexical scope conaining the event scope */
	struct declaration_scope *declaration_scope;

	struct declaration_struct *context_decl;
	struct declaration_struct *fields_decl;

	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_IR_METADATA_H */
Commit	Line	Data
145b8090 MD	1	#ifndef _BABELTRACE_CTF_IR_METADATA_H
	2	#define _BABELTRACE_CTF_IR_METADATA_H
	3
	4	/*
	5	* BabelTrace
	6	*
	7	* CTF Intermediate Representation 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>
	23	#include <babeltrace/format.h>
	24	#include <babeltrace/ctf/types.h>
	25	#include <sys/types.h>
	26	#include <dirent.h>
	27	#include <uuid/uuid.h>
	28	#include <assert.h>
	29	#include <glib.h>
	30
	31	struct ctf_trace;
	32	struct ctf_stream_class;
	33	struct ctf_stream;
	34	struct ctf_event;
	35
	36	struct ctf_stream {
	37	struct ctf_stream_class *stream_class;
	38	uint64_t timestamp; /* Current timestamp, in ns */
c87a8eb2	39	uint64_t event_id; /* Current event ID */
5e2eb0ae	40	int has_timestamp;
661c4ce8	41	uint64_t stream_id;
145b8090 MD	42
	43	struct definition_struct *trace_packet_header;
	44	struct definition_struct *stream_packet_context;
	45	struct definition_struct *stream_event_header;
	46	struct definition_struct *stream_event_context;
42dc00b7	47	GPtrArray events_by_id; / Array of struct ctf_stream_event pointers indexed by id */
145b8090 MD	48	struct definition_scope parent_def_scope; / for initialization */
	49	int stream_definitions_created;
	50	};
	51
42dc00b7	52	struct ctf_stream_event {
145b8090 MD	53	struct definition_struct *event_context;
	54	struct definition_struct *event_fields;
	55	};
	56
145b8090 MD	57	#define CTF_TRACE_SET_FIELD(ctf_trace, field) \
	58	do { \
	59	(ctf_trace)->field_mask \|= CTF_TRACE_ ## field; \
	60	} while (0)
	61
	62	#define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
	63	((ctf_trace)->field_mask & CTF_TRACE_ ## field)
	64
	65	#define CTF_TRACE_GET_FIELD(ctf_trace, field) \
	66	({ \
	67	assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
	68	(ctf_trace)->(field); \
	69	})
	70
	71
	72	struct ctf_trace {
	73	struct trace_descriptor parent;
	74	/* root scope */
	75	struct declaration_scope *root_declaration_scope;
	76
	77	struct declaration_scope *declaration_scope;
	78	/* innermost definition scope. to be used as parent of stream. */
	79	struct definition_scope *definition_scope;
	80	GPtrArray streams; / Array of struct ctf_stream_class pointers */
2d0bea29	81	struct ctf_stream *metadata;
145b8090	82
145b8090 MD	83	struct declaration_struct *packet_header_decl;
	84
	85	uint64_t major;
	86	uint64_t minor;
	87	uuid_t uuid;
	88	int byte_order; /* trace BYTE_ORDER. 0 if unset. */
	89
	90	enum { /* Fields populated mask */
	91	CTF_TRACE_major = (1U << 0),
	92	CTF_TRACE_minor = (1U << 1),
	93	CTF_TRACE_uuid = (1U << 2),
	94	CTF_TRACE_byte_order = (1U << 3),
	95	CTF_TRACE_packet_header = (1U << 4),
	96	} field_mask;
	97
	98	/* Information about trace backing directory and files */
	99	DIR *dir;
	100	int dirfd;
	101	int flags; /* open flags */
	102
	103	/* Heap of streams, ordered to always get the lowest timestam */
	104	struct ptr_heap *stream_heap;
82662ad4	105	char path[PATH_MAX];
145b8090 MD	106	};
	107
	108	#define CTF_STREAM_SET_FIELD(ctf_stream, field) \
	109	do { \
	110	(ctf_stream)->field_mask \|= CTF_STREAM_ ## field; \
	111	} while (0)
	112
	113	#define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
	114	((ctf_stream)->field_mask & CTF_STREAM_ ## field)
	115
	116	#define CTF_STREAM_GET_FIELD(ctf_stream, field) \
	117	({ \
	118	assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
	119	(ctf_stream)->(field); \
	120	})
	121
	122	struct ctf_stream_class {
	123	struct ctf_trace *trace;
	124	/* parent is lexical scope conaining the stream scope */
	125	struct declaration_scope *declaration_scope;
	126	/* innermost definition scope. to be used as parent of event. */
	127	struct definition_scope *definition_scope;
	128	GPtrArray events_by_id; / Array of struct ctf_event pointers indexed by id */
	129	GHashTable event_quark_to_id; / GQuark to numeric id */
	130
145b8090 MD	131	struct declaration_struct *packet_context_decl;
	132	struct declaration_struct *event_header_decl;
	133	struct declaration_struct *event_context_decl;
	134
	135	uint64_t stream_id;
	136
	137	enum { /* Fields populated mask */
	138	CTF_STREAM_stream_id = (1 << 0),
	139	} field_mask;
	140
2d0bea29	141	GPtrArray streams; / Array of struct ctf_stream pointers */
145b8090 MD	142	};
	143
	144	#define CTF_EVENT_SET_FIELD(ctf_event, field) \
	145	do { \
	146	(ctf_event)->field_mask \|= CTF_EVENT_ ## field; \
	147	} while (0)
	148
	149	#define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
	150	((ctf_event)->field_mask & CTF_EVENT_ ## field)
	151
	152	#define CTF_EVENT_GET_FIELD(ctf_event, field) \
	153	({ \
	154	assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
	155	(ctf_event)->(field); \
	156	})
	157
	158	struct ctf_event {
	159	/* stream mapped by stream_id */
	160	struct ctf_stream_class *stream;
	161	/* parent is lexical scope conaining the event scope */
	162	struct declaration_scope *declaration_scope;
	163
145b8090 MD	164	struct declaration_struct *context_decl;
	165	struct declaration_struct *fields_decl;
	166
	167	GQuark name;
	168	uint64_t id; /* Numeric identifier within the stream */
	169	uint64_t stream_id;
	170
	171	enum { /* Fields populated mask */
	172	CTF_EVENT_name = (1 << 0),
	173	CTF_EVENT_id = (1 << 1),
	174	CTF_EVENT_stream_id = (1 << 2),
	175	} field_mask;
	176	};
	177
	178	#endif /* _BABELTRACE_CTF_IR_METADATA_H */