[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 <babeltrace/uuid.h>
#include <assert.h>
#include <glib.h>

struct ctf_trace;
struct ctf_stream_declaration;
struct ctf_event_declaration;
struct ctf_clock;

struct ctf_stream_definition {
	struct ctf_stream_declaration *stream_class;
	uint64_t real_timestamp;		/* Current timestamp, in ns */
	uint64_t cycles_timestamp;		/* Current timestamp, in cycles */
	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_event_definition pointers indexed by id */
	struct definition_scope *parent_def_scope;	/* for initialization */
	int stream_definitions_created;

	struct ctf_clock *current_clock;

	/* Event discarded information */
	uint64_t events_discarded;
	uint64_t prev_real_timestamp;		/* Start-of-last-packet timestamp in ns */
	uint64_t prev_real_timestamp_end;	/* End-of-last-packet timestamp in ns */
	uint64_t prev_cycles_timestamp;		/* Start-of-last-packet timestamp in cycles */
	uint64_t prev_cycles_timestamp_end;	/* End-of-last-packet timestamp in cycles */
};

struct ctf_event_definition {
	struct ctf_stream_definition *stream;
	struct definition_struct *event_context;
	struct definition_struct *event_fields;
};

#define CTF_CLOCK_SET_FIELD(ctf_clock, field)				\
	do {								\
		(ctf_clock)->field_mask |= CTF_CLOCK_ ## field;		\
	} while (0)

#define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)			\
		((ctf_clock)->field_mask & CTF_CLOCK_ ## field)

#define CTF_CLOCK_GET_FIELD(ctf_clock, field)				\
	({								\
		assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field));	\
		(ctf_clock)->(field);					\
	})

struct ctf_clock {
	GQuark name;
	GQuark uuid;
	char *description;
	uint64_t freq;	/* frequency, in HZ */
	/* precision in seconds is: precision * (1/freq) */
	uint64_t precision;
	/*
	 * The offset from Epoch is: offset_s + (offset * (1/freq))
	 * Coarse clock offset from Epoch (in seconds).
	 */
	uint64_t offset_s;
	/* Fine clock offset from Epoch, in (1/freq) units. */
	uint64_t offset;
	int absolute;

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

#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);					\
	})

#define TRACER_ENV_LEN	128

/* tracer-specific environment */
struct ctf_tracer_env {
	int vpid;		/* negative if unset */

	/* All strings below: "" if unset. */
	char procname[TRACER_ENV_LEN];
	char hostname[TRACER_ENV_LEN];
	char domain[TRACER_ENV_LEN];
	char sysname[TRACER_ENV_LEN];
	char release[TRACER_ENV_LEN];
	char version[TRACER_ENV_LEN];
};

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_declaration pointers */
	struct ctf_stream_definition *metadata;
	GHashTable *clocks;
	struct ctf_clock *single_clock;		/* currently supports only one clock */
	struct trace_collection *collection;	/* Container of this trace */
	GPtrArray *event_declarations;		/* Array of all the struct bt_ctf_event_decl */

	struct declaration_struct *packet_header_decl;

	uint64_t major;
	uint64_t minor;
	unsigned char uuid[BABELTRACE_UUID_LEN];
	int byte_order;		/* trace BYTE_ORDER. 0 if unset. */
	struct ctf_tracer_env env;

	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];

	struct bt_context *ctx;
	struct bt_trace_handle *handle;
};

#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_declaration {
	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_declaration 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_definition 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_declaration {
	/* stream mapped by stream_id */
	struct ctf_stream_declaration *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;
	int loglevel;
	GQuark model_emf_uri;

	enum {					/* Fields populated mask */
		CTF_EVENT_name	=		(1 << 0),
		CTF_EVENT_id 	= 		(1 << 1),
		CTF_EVENT_stream_id = 		(1 << 2),
		CTF_EVENT_loglevel =		(1 << 4),
		CTF_EVENT_model_emf_uri =	(1 << 5),
	} 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>
1b1d76c0	27	#include <babeltrace/uuid.h>
145b8090 MD	28	#include <assert.h>
	29	#include <glib.h>
	30
	31	struct ctf_trace;
f380e105	32	struct ctf_stream_declaration;
4716614a	33	struct ctf_event_declaration;
25ccc85b	34	struct ctf_clock;
145b8090	35
9e88d150	36	struct ctf_stream_definition {
f380e105	37	struct ctf_stream_declaration *stream_class;
03798a93 JD	38	uint64_t real_timestamp; /* Current timestamp, in ns */
03798a93 JD	39	uint64_t cycles_timestamp; /* Current timestamp, in cycles */
c87a8eb2	40	uint64_t event_id; /* Current event ID */
5e2eb0ae	41	int has_timestamp;
661c4ce8	42	uint64_t stream_id;
145b8090 MD	43
	44	struct definition_struct *trace_packet_header;
	45	struct definition_struct *stream_packet_context;
	46	struct definition_struct *stream_event_header;
	47	struct definition_struct *stream_event_context;
c716f83b	48	GPtrArray events_by_id; / Array of struct ctf_event_definition pointers indexed by id */
145b8090 MD	49	struct definition_scope parent_def_scope; / for initialization */
145b8090 MD	50	int stream_definitions_created;
fca04958	51
25ccc85b MD	52	struct ctf_clock *current_clock;
25ccc85b MD	53
fca04958	54	/* Event discarded information */
4c4ba021	55	uint64_t events_discarded;
03798a93 JD	56	uint64_t prev_real_timestamp; /* Start-of-last-packet timestamp in ns */
	57	uint64_t prev_real_timestamp_end; /* End-of-last-packet timestamp in ns */
	58	uint64_t prev_cycles_timestamp; /* Start-of-last-packet timestamp in cycles */
	59	uint64_t prev_cycles_timestamp_end; /* End-of-last-packet timestamp in cycles */
145b8090 MD	60	};
145b8090 MD	61
c716f83b	62	struct ctf_event_definition {
d3ded99d	63	struct ctf_stream_definition *stream;
145b8090 MD	64	struct definition_struct *event_context;
	65	struct definition_struct *event_fields;
	66	};
	67
50cb9c56 MD	68	#define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
	69	do { \
	70	(ctf_clock)->field_mask \|= CTF_CLOCK_ ## field; \
	71	} while (0)
	72
	73	#define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
	74	((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
	75
	76	#define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
	77	({ \
	78	assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
	79	(ctf_clock)->(field); \
	80	})
	81
	82	struct ctf_clock {
	83	GQuark name;
	84	GQuark uuid;
	85	char *description;
	86	uint64_t freq; /* frequency, in HZ */
	87	/* precision in seconds is: precision * (1/freq) */
	88	uint64_t precision;
	89	/*
	90	* The offset from Epoch is: offset_s + (offset * (1/freq))
	91	* Coarse clock offset from Epoch (in seconds).
	92	*/
	93	uint64_t offset_s;
	94	/* Fine clock offset from Epoch, in (1/freq) units. */
	95	uint64_t offset;
11ac6674	96	int absolute;
50cb9c56 MD	97
	98	enum { /* Fields populated mask */
	99	CTF_CLOCK_name = (1U << 0),
bf94ab2b	100	CTF_CLOCK_freq = (1U << 1),
50cb9c56 MD	101	} field_mask;
	102	};
	103
145b8090 MD	104	#define CTF_TRACE_SET_FIELD(ctf_trace, field) \
	105	do { \
	106	(ctf_trace)->field_mask \|= CTF_TRACE_ ## field; \
	107	} while (0)
	108
	109	#define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
	110	((ctf_trace)->field_mask & CTF_TRACE_ ## field)
	111
	112	#define CTF_TRACE_GET_FIELD(ctf_trace, field) \
	113	({ \
	114	assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
	115	(ctf_trace)->(field); \
	116	})
	117
cadd09e9 MD	118	#define TRACER_ENV_LEN 128
	119
	120	/* tracer-specific environment */
	121	struct ctf_tracer_env {
	122	int vpid; /* negative if unset */
	123
	124	/* All strings below: "" if unset. */
	125	char procname[TRACER_ENV_LEN];
32cfb8ad	126	char hostname[TRACER_ENV_LEN];
cadd09e9 MD	127	char domain[TRACER_ENV_LEN];
	128	char sysname[TRACER_ENV_LEN];
	129	char release[TRACER_ENV_LEN];
	130	char version[TRACER_ENV_LEN];
	131	};
	132
145b8090 MD	133	struct ctf_trace {
	134	struct trace_descriptor parent;
	135	/* root scope */
	136	struct declaration_scope *root_declaration_scope;
	137
	138	struct declaration_scope *declaration_scope;
	139	/* innermost definition scope. to be used as parent of stream. */
	140	struct definition_scope *definition_scope;
f380e105	141	GPtrArray streams; / Array of struct ctf_stream_declaration pointers */
9e88d150	142	struct ctf_stream_definition *metadata;
50cb9c56	143	GHashTable *clocks;
25ccc85b	144	struct ctf_clock single_clock; / currently supports only one clock */
fa709ab2	145	struct trace_collection collection; / Container of this trace */
e003ab50	146	GPtrArray event_declarations; / Array of all the struct bt_ctf_event_decl */
145b8090	147
145b8090 MD	148	struct declaration_struct *packet_header_decl;
	149
	150	uint64_t major;
	151	uint64_t minor;
ce9cc1bc	152	unsigned char uuid[BABELTRACE_UUID_LEN];
145b8090	153	int byte_order; /* trace BYTE_ORDER. 0 if unset. */
cadd09e9	154	struct ctf_tracer_env env;
145b8090 MD	155
	156	enum { /* Fields populated mask */
	157	CTF_TRACE_major = (1U << 0),
	158	CTF_TRACE_minor = (1U << 1),
	159	CTF_TRACE_uuid = (1U << 2),
	160	CTF_TRACE_byte_order = (1U << 3),
	161	CTF_TRACE_packet_header = (1U << 4),
	162	} field_mask;
	163
	164	/* Information about trace backing directory and files */
	165	DIR *dir;
	166	int dirfd;
	167	int flags; /* open flags */
	168
	169	/* Heap of streams, ordered to always get the lowest timestam */
	170	struct ptr_heap *stream_heap;
82662ad4	171	char path[PATH_MAX];
98a04903 JD	172
	173	struct bt_context *ctx;
	174	struct bt_trace_handle *handle;
145b8090 MD	175	};
	176
	177	#define CTF_STREAM_SET_FIELD(ctf_stream, field) \
	178	do { \
	179	(ctf_stream)->field_mask \|= CTF_STREAM_ ## field; \
	180	} while (0)
	181
	182	#define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
	183	((ctf_stream)->field_mask & CTF_STREAM_ ## field)
	184
	185	#define CTF_STREAM_GET_FIELD(ctf_stream, field) \
	186	({ \
	187	assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
	188	(ctf_stream)->(field); \
	189	})
	190
f380e105	191	struct ctf_stream_declaration {
145b8090 MD	192	struct ctf_trace *trace;
	193	/* parent is lexical scope conaining the stream scope */
	194	struct declaration_scope *declaration_scope;
	195	/* innermost definition scope. to be used as parent of event. */
	196	struct definition_scope *definition_scope;
4716614a	197	GPtrArray events_by_id; / Array of struct ctf_event_declaration pointers indexed by id */
145b8090 MD	198	GHashTable event_quark_to_id; / GQuark to numeric id */
145b8090 MD	199
145b8090 MD	200	struct declaration_struct *packet_context_decl;
	201	struct declaration_struct *event_header_decl;
	202	struct declaration_struct *event_context_decl;
	203
	204	uint64_t stream_id;
	205
	206	enum { /* Fields populated mask */
	207	CTF_STREAM_stream_id = (1 << 0),
	208	} field_mask;
	209
9e88d150	210	GPtrArray streams; / Array of struct ctf_stream_definition pointers */
145b8090 MD	211	};
	212
	213	#define CTF_EVENT_SET_FIELD(ctf_event, field) \
	214	do { \
	215	(ctf_event)->field_mask \|= CTF_EVENT_ ## field; \
	216	} while (0)
	217
	218	#define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
	219	((ctf_event)->field_mask & CTF_EVENT_ ## field)
	220
	221	#define CTF_EVENT_GET_FIELD(ctf_event, field) \
	222	({ \
	223	assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
	224	(ctf_event)->(field); \
	225	})
	226
4716614a	227	struct ctf_event_declaration {
145b8090	228	/* stream mapped by stream_id */
f380e105	229	struct ctf_stream_declaration *stream;
145b8090 MD	230	/* parent is lexical scope conaining the event scope */
	231	struct declaration_scope *declaration_scope;
	232
145b8090 MD	233	struct declaration_struct *context_decl;
	234	struct declaration_struct *fields_decl;
	235
	236	GQuark name;
	237	uint64_t id; /* Numeric identifier within the stream */
	238	uint64_t stream_id;
306eeaa6	239	int loglevel;
f6714e20	240	GQuark model_emf_uri;
145b8090 MD	241
145b8090 MD	242	enum { /* Fields populated mask */
d86d62f8 MD	243	CTF_EVENT_name = (1 << 0),
	244	CTF_EVENT_id = (1 << 1),
	245	CTF_EVENT_stream_id = (1 << 2),
306eeaa6	246	CTF_EVENT_loglevel = (1 << 4),
f6714e20	247	CTF_EVENT_model_emf_uri = (1 << 5),
145b8090 MD	248	} field_mask;
	249	};
	250
	251	#endif /* _BABELTRACE_CTF_IR_METADATA_H */