[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.
 *
 * 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/types.h>
#include <babeltrace/format.h>
#include <babeltrace/format-internal.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_callsite;

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 */
	char path[PATH_MAX];			/* Path to stream. '\0' for mmap traces */
};

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_CALLSITE_SET_FIELD(ctf_callsite, field)			\
	do {								\
		(ctf_callsite)->field_mask |= CTF_CALLSITE_ ## field;	\
	} while (0)

#define CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)			\
		((ctf_callsite)->field_mask & CTF_CALLSITE_ ## field)

#define CTF_CALLSITE_GET_FIELD(ctf_callsite, field)			\
	({								\
		assert(CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field));	\
		(ctf_callsite)->(field);				\
	})

struct ctf_callsite {
	GQuark name;		/* event name associated with callsite */
	char *func;
	char *file;
	uint64_t line;
	uint64_t ip;
	struct bt_list_head node;
	enum {					/* Fields populated mask */
		CTF_CALLSITE_name	=	(1U << 0),
		CTF_CALLSITE_func	=	(1U << 1),
		CTF_CALLSITE_file	=	(1U << 2),
		CTF_CALLSITE_line	=	(1U << 3),
		CTF_CALLSITE_ip		=	(1U << 4),
	} field_mask;
};

struct ctf_callsite_dups {
	struct bt_list_head head;
};

#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 bt_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;
	char *metadata_string;
	int metadata_packetized;
	GHashTable *callsites;
	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 */
};

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