[babeltrace.git] / plugins / ctf / common / metadata / ast.h

#ifndef _CTF_AST_H
#define _CTF_AST_H

/*
 * ctf-ast.h
 *
 * Copyright 2011-2012 - 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 <stdint.h>
#include <stdio.h>
#include <glib.h>
#include <babeltrace/list.h>
#include <babeltrace/ctf-ir/trace.h>
#include <babeltrace/babeltrace-internal.h>

// the parameter name (of the reentrant 'yyparse' function)
// data is a pointer to a 'SParserParam' structure
//#define YYPARSE_PARAM	scanner

struct ctf_node;
struct ctf_parser;
struct ctf_visitor_generate_ir;

#define EINCOMPLETE	1000

#define FOREACH_CTF_NODES(F) \
	F(NODE_UNKNOWN) \
	F(NODE_ROOT) \
	F(NODE_ERROR) \
	F(NODE_EVENT) \
	F(NODE_STREAM) \
	F(NODE_ENV) \
	F(NODE_TRACE) \
	F(NODE_CLOCK) \
	F(NODE_CALLSITE) \
	F(NODE_CTF_EXPRESSION) \
	F(NODE_UNARY_EXPRESSION) \
	F(NODE_TYPEDEF) \
	F(NODE_TYPEALIAS_TARGET) \
	F(NODE_TYPEALIAS_ALIAS) \
	F(NODE_TYPEALIAS) \
	F(NODE_TYPE_SPECIFIER) \
	F(NODE_TYPE_SPECIFIER_LIST) \
	F(NODE_POINTER) \
	F(NODE_TYPE_DECLARATOR) \
	F(NODE_FLOATING_POINT) \
	F(NODE_INTEGER) \
	F(NODE_STRING) \
	F(NODE_ENUMERATOR) \
	F(NODE_ENUM) \
	F(NODE_STRUCT_OR_VARIANT_DECLARATION) \
	F(NODE_VARIANT) \
	F(NODE_STRUCT)

enum node_type {
#define ENTRY(S)	S,
	FOREACH_CTF_NODES(ENTRY)
#undef ENTRY
	NR_NODE_TYPES,
};

struct ctf_node {
	/*
	 * Parent node is only set on demand by specific visitor.
	 */
	struct ctf_node *parent;
	struct bt_list_head siblings;
	struct bt_list_head tmp_head;
	unsigned int lineno;
	/*
	 * We mark nodes visited in the generate-ir phase (last
	 * phase). We only mark the 1-depth level nodes as visited
	 * (never the root node, and not their sub-nodes). This allows
	 * skipping already visited nodes when doing incremental
	 * metadata append.
	 */
	int visited;

	enum node_type type;
	union {
		struct {
		} unknown;
		struct {
			/*
			 * Children nodes are ctf_expression, typedef,
			 * typealias and type_specifier_list.
			 */
			struct bt_list_head declaration_list;
			struct bt_list_head trace;
			struct bt_list_head env;
			struct bt_list_head stream;
			struct bt_list_head event;
			struct bt_list_head clock;
			struct bt_list_head callsite;
		} root;
		struct {
			/*
			 * Children nodes are ctf_expression, typedef,
			 * typealias and type_specifier_list.
			 */
			struct bt_list_head declaration_list;
		} event;
		struct {
			/*
			 * Children nodes are ctf_expression, typedef,
			 * typealias and type_specifier_list.
			 */
			struct bt_list_head declaration_list;
		} stream;
		struct {
			/*
			 * Children nodes are ctf_expression, typedef,
			 * typealias and type_specifier_list.
			 */
			struct bt_list_head declaration_list;
		} env;
		struct {
			/*
			 * Children nodes are ctf_expression, typedef,
			 * typealias and type_specifier_list.
			 */
			struct bt_list_head declaration_list;
		} trace;
		struct {
			/*
			 * Children nodes are ctf_expression, typedef,
			 * typealias and type_specifier_list.
			 */
			struct bt_list_head declaration_list;
		} clock;
		struct {
			/*
			 * Children nodes are ctf_expression, typedef,
			 * typealias and type_specifier_list.
			 */
			struct bt_list_head declaration_list;
		} callsite;
		struct {
			struct bt_list_head left;	/* Should be string */
			struct bt_list_head right;	/* Unary exp. or type */
		} ctf_expression;
		struct {
			enum {
				UNARY_UNKNOWN = 0,
				UNARY_STRING,
				UNARY_SIGNED_CONSTANT,
				UNARY_UNSIGNED_CONSTANT,
				UNARY_SBRAC,
			} type;
			union {
				/*
				 * string for identifier, id_type, keywords,
				 * string literals and character constants.
				 */
				char *string;
				int64_t signed_constant;
				uint64_t unsigned_constant;
				struct ctf_node *sbrac_exp;
			} u;
			enum {
				UNARY_LINK_UNKNOWN = 0,
				UNARY_DOTLINK,
				UNARY_ARROWLINK,
				UNARY_DOTDOTDOT,
			} link;
		} unary_expression;
		struct {
			struct ctf_node *type_specifier_list;
			struct bt_list_head type_declarators;
		} _typedef;
		/* new type is "alias", existing type "target" */
		struct {
			struct ctf_node *type_specifier_list;
			struct bt_list_head type_declarators;
		} typealias_target;
		struct {
			struct ctf_node *type_specifier_list;
			struct bt_list_head type_declarators;
		} typealias_alias;
		struct {
			struct ctf_node *target;
			struct ctf_node *alias;
		} typealias;
		struct {
			enum {
				TYPESPEC_UNKNOWN = 0,
				TYPESPEC_VOID,
				TYPESPEC_CHAR,
				TYPESPEC_SHORT,
				TYPESPEC_INT,
				TYPESPEC_LONG,
				TYPESPEC_FLOAT,
				TYPESPEC_DOUBLE,
				TYPESPEC_SIGNED,
				TYPESPEC_UNSIGNED,
				TYPESPEC_BOOL,
				TYPESPEC_COMPLEX,
				TYPESPEC_IMAGINARY,
				TYPESPEC_CONST,
				TYPESPEC_ID_TYPE,
				TYPESPEC_FLOATING_POINT,
				TYPESPEC_INTEGER,
				TYPESPEC_STRING,
				TYPESPEC_STRUCT,
				TYPESPEC_VARIANT,
				TYPESPEC_ENUM,
			} type;
			/* For struct, variant and enum */
			struct ctf_node *node;
			const char *id_type;
		} type_specifier;
		struct {
			/* list of type_specifier */
			struct bt_list_head head;
		} type_specifier_list;
		struct {
			unsigned int const_qualifier;
		} pointer;
		struct {
			struct bt_list_head pointers;
			enum {
				TYPEDEC_UNKNOWN = 0,
				TYPEDEC_ID,	/* identifier */
				TYPEDEC_NESTED,	/* (), array or sequence */
			} type;
			union {
				char *id;
				struct {
					/* typedec has no pointer list */
					struct ctf_node *type_declarator;
					/*
					 * unary expression (value) or
					 * type_specifier_list.
					 */
					struct bt_list_head length;
					/* for abstract type declarator */
					unsigned int abstract_array;
				} nested;
			} u;
			struct ctf_node *bitfield_len;
		} type_declarator;
		struct {
			/* Children nodes are ctf_expression. */
			struct bt_list_head expressions;
		} floating_point;
		struct {
			/* Children nodes are ctf_expression. */
			struct bt_list_head expressions;
		} integer;
		struct {
			/* Children nodes are ctf_expression. */
			struct bt_list_head expressions;
		} string;
		struct {
			char *id;
			/*
			 * Range list or single value node. Contains unary
			 * expressions.
			 */
			struct bt_list_head values;
		} enumerator;
		struct {
			char *enum_id;
			/*
			 * Either NULL, or points to unary expression or
			 * type_specifier_list.
			 */
			struct ctf_node *container_type;
			struct bt_list_head enumerator_list;
			int has_body;
		} _enum;
		struct {
			struct ctf_node *type_specifier_list;
			struct bt_list_head type_declarators;
		} struct_or_variant_declaration;
		struct {
			char *name;
			char *choice;
			/* list of typedef, typealias and declarations */
			struct bt_list_head declaration_list;
			int has_body;
		} variant;
		struct {
			char *name;
			/* list of typedef, typealias and declarations */
			struct bt_list_head declaration_list;
			int has_body;
			struct bt_list_head min_align;	/* align() attribute */
		} _struct;
	} u;
};

struct ctf_ast {
	struct ctf_node root;
};

const char *node_type(struct ctf_node *node);

BT_HIDDEN
struct ctf_visitor_generate_ir *ctf_visitor_generate_ir_create(FILE *efd,
		uint64_t clock_class_offset_ns);

void ctf_visitor_generate_ir_destroy(struct ctf_visitor_generate_ir *visitor);

BT_HIDDEN
struct bt_ctf_trace *ctf_visitor_generate_ir_get_trace(
		struct ctf_visitor_generate_ir *visitor);

BT_HIDDEN
int ctf_visitor_generate_ir_visit_node(struct ctf_visitor_generate_ir *visitor,
		struct ctf_node *node);

BT_HIDDEN
int ctf_visitor_semantic_check(FILE *fd, int depth, struct ctf_node *node);

BT_HIDDEN
int ctf_visitor_parent_links(FILE *fd, int depth, struct ctf_node *node);

#endif /* _CTF_AST_H */
Commit	Line	Data
e98a2d6e PP	1	#ifndef _CTF_AST_H
	2	#define _CTF_AST_H
	3
	4	/*
	5	* ctf-ast.h
	6	*
	7	* Copyright 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*/
	19
	20	#include <stdint.h>
	21	#include <stdio.h>
	22	#include <glib.h>
	23	#include <babeltrace/list.h>
	24	#include <babeltrace/ctf-ir/trace.h>
1e649dff	25	#include <babeltrace/babeltrace-internal.h>
e98a2d6e PP	26
	27	// the parameter name (of the reentrant 'yyparse' function)
	28	// data is a pointer to a 'SParserParam' structure
	29	//#define YYPARSE_PARAM scanner
	30
	31	struct ctf_node;
	32	struct ctf_parser;
1e649dff PP	33	struct ctf_visitor_generate_ir;
	34
	35	#define EINCOMPLETE 1000
e98a2d6e PP	36
	37	#define FOREACH_CTF_NODES(F) \
	38	F(NODE_UNKNOWN) \
	39	F(NODE_ROOT) \
	40	F(NODE_ERROR) \
	41	F(NODE_EVENT) \
	42	F(NODE_STREAM) \
	43	F(NODE_ENV) \
	44	F(NODE_TRACE) \
	45	F(NODE_CLOCK) \
	46	F(NODE_CALLSITE) \
	47	F(NODE_CTF_EXPRESSION) \
	48	F(NODE_UNARY_EXPRESSION) \
	49	F(NODE_TYPEDEF) \
	50	F(NODE_TYPEALIAS_TARGET) \
	51	F(NODE_TYPEALIAS_ALIAS) \
	52	F(NODE_TYPEALIAS) \
	53	F(NODE_TYPE_SPECIFIER) \
	54	F(NODE_TYPE_SPECIFIER_LIST) \
	55	F(NODE_POINTER) \
	56	F(NODE_TYPE_DECLARATOR) \
	57	F(NODE_FLOATING_POINT) \
	58	F(NODE_INTEGER) \
	59	F(NODE_STRING) \
	60	F(NODE_ENUMERATOR) \
	61	F(NODE_ENUM) \
	62	F(NODE_STRUCT_OR_VARIANT_DECLARATION) \
	63	F(NODE_VARIANT) \
	64	F(NODE_STRUCT)
	65
	66	enum node_type {
	67	#define ENTRY(S) S,
	68	FOREACH_CTF_NODES(ENTRY)
	69	#undef ENTRY
	70	NR_NODE_TYPES,
	71	};
	72
	73	struct ctf_node {
	74	/*
	75	* Parent node is only set on demand by specific visitor.
	76	*/
	77	struct ctf_node *parent;
	78	struct bt_list_head siblings;
	79	struct bt_list_head tmp_head;
	80	unsigned int lineno;
	81	/*
	82	* We mark nodes visited in the generate-ir phase (last
	83	* phase). We only mark the 1-depth level nodes as visited
	84	* (never the root node, and not their sub-nodes). This allows
	85	* skipping already visited nodes when doing incremental
	86	* metadata append.
	87	*/
	88	int visited;
	89
	90	enum node_type type;
	91	union {
	92	struct {
	93	} unknown;
	94	struct {
	95	/*
	96	* Children nodes are ctf_expression, typedef,
	97	* typealias and type_specifier_list.
	98	*/
	99	struct bt_list_head declaration_list;
100	struct bt_list_head trace;
101	struct bt_list_head env;
102	struct bt_list_head stream;
103	struct bt_list_head event;
104	struct bt_list_head clock;
105	struct bt_list_head callsite;
106	} root;
107	struct {
108	/*
109	* Children nodes are ctf_expression, typedef,
110	* typealias and type_specifier_list.
111	*/
112	struct bt_list_head declaration_list;
113	} event;
114	struct {
115	/*
116	* Children nodes are ctf_expression, typedef,
117	* typealias and type_specifier_list.
118	*/
119	struct bt_list_head declaration_list;
120	} stream;
121	struct {
122	/*
123	* Children nodes are ctf_expression, typedef,
124	* typealias and type_specifier_list.
125	*/
126	struct bt_list_head declaration_list;
127	} env;
128	struct {
129	/*
130	* Children nodes are ctf_expression, typedef,
131	* typealias and type_specifier_list.
132	*/
133	struct bt_list_head declaration_list;
134	} trace;
135	struct {
136	/*
137	* Children nodes are ctf_expression, typedef,
138	* typealias and type_specifier_list.
139	*/
140	struct bt_list_head declaration_list;
141	} clock;
142	struct {
143	/*
144	* Children nodes are ctf_expression, typedef,
145	* typealias and type_specifier_list.
146	*/
147	struct bt_list_head declaration_list;
148	} callsite;
149	struct {
150	struct bt_list_head left; /* Should be string */
151	struct bt_list_head right; /* Unary exp. or type */
152	} ctf_expression;
153	struct {
154	enum {
155	UNARY_UNKNOWN = 0,
156	UNARY_STRING,
157	UNARY_SIGNED_CONSTANT,
158	UNARY_UNSIGNED_CONSTANT,
159	UNARY_SBRAC,
160	} type;
161	union {
162	/*
163	* string for identifier, id_type, keywords,
164	* string literals and character constants.
165	*/
166	char *string;
167	int64_t signed_constant;
168	uint64_t unsigned_constant;
169	struct ctf_node *sbrac_exp;
170	} u;
171	enum {
172	UNARY_LINK_UNKNOWN = 0,
173	UNARY_DOTLINK,
174	UNARY_ARROWLINK,
175	UNARY_DOTDOTDOT,
176	} link;
177	} unary_expression;
178	struct {
179	struct ctf_node *type_specifier_list;
180	struct bt_list_head type_declarators;
181	} _typedef;
182	/* new type is "alias", existing type "target" */
183	struct {
184	struct ctf_node *type_specifier_list;
185	struct bt_list_head type_declarators;
186	} typealias_target;
187	struct {
188	struct ctf_node *type_specifier_list;
189	struct bt_list_head type_declarators;
190	} typealias_alias;
191	struct {
192	struct ctf_node *target;
193	struct ctf_node *alias;
194	} typealias;
195	struct {
196	enum {
197	TYPESPEC_UNKNOWN = 0,
198	TYPESPEC_VOID,
199	TYPESPEC_CHAR,
200	TYPESPEC_SHORT,
201	TYPESPEC_INT,
202	TYPESPEC_LONG,
203	TYPESPEC_FLOAT,
204	TYPESPEC_DOUBLE,
205	TYPESPEC_SIGNED,
206	TYPESPEC_UNSIGNED,
207	TYPESPEC_BOOL,
208	TYPESPEC_COMPLEX,
209	TYPESPEC_IMAGINARY,
210	TYPESPEC_CONST,
211	TYPESPEC_ID_TYPE,
212	TYPESPEC_FLOATING_POINT,
213	TYPESPEC_INTEGER,
214	TYPESPEC_STRING,
215	TYPESPEC_STRUCT,
216	TYPESPEC_VARIANT,
217	TYPESPEC_ENUM,
218	} type;
219	/* For struct, variant and enum */
220	struct ctf_node *node;
221	const char *id_type;
222	} type_specifier;
223	struct {
224	/* list of type_specifier */
225	struct bt_list_head head;
226	} type_specifier_list;
227	struct {
228	unsigned int const_qualifier;
229	} pointer;
230	struct {
231	struct bt_list_head pointers;
232	enum {
233	TYPEDEC_UNKNOWN = 0,
234	TYPEDEC_ID, /* identifier */
235	TYPEDEC_NESTED, /* (), array or sequence */
236	} type;
237	union {
238	char *id;
239	struct {
240	/* typedec has no pointer list */
241	struct ctf_node *type_declarator;
242	/*
243	* unary expression (value) or
244	* type_specifier_list.
245	*/
246	struct bt_list_head length;
247	/* for abstract type declarator */
248	unsigned int abstract_array;
249	} nested;
250	} u;
251	struct ctf_node *bitfield_len;
252	} type_declarator;
253	struct {
254	/* Children nodes are ctf_expression. */
255	struct bt_list_head expressions;
256	} floating_point;
257	struct {
258	/* Children nodes are ctf_expression. */
259	struct bt_list_head expressions;
260	} integer;
261	struct {
262	/* Children nodes are ctf_expression. */
263	struct bt_list_head expressions;
264	} string;
265	struct {
266	char *id;
267	/*
268	* Range list or single value node. Contains unary
269	* expressions.
270	*/
271	struct bt_list_head values;
272	} enumerator;
273	struct {
274	char *enum_id;
275	/*
276	* Either NULL, or points to unary expression or
277	* type_specifier_list.
278	*/
279	struct ctf_node *container_type;
280	struct bt_list_head enumerator_list;
281	int has_body;
282	} _enum;
283	struct {
284	struct ctf_node *type_specifier_list;
285	struct bt_list_head type_declarators;
286	} struct_or_variant_declaration;
287	struct {
288	char *name;
289	char *choice;
290	/* list of typedef, typealias and declarations */
291	struct bt_list_head declaration_list;
292	int has_body;
293	} variant;
294	struct {
295	char *name;
296	/* list of typedef, typealias and declarations */
297	struct bt_list_head declaration_list;
298	int has_body;
299	struct bt_list_head min_align; /* align() attribute */
300	} _struct;
301	} u;
302	};
303
304	struct ctf_ast {
305	struct ctf_node root;
306	};
307
308	const char node_type(struct ctf_node node);
309
1e649dff PP	310	BT_HIDDEN
	311	struct ctf_visitor_generate_ir ctf_visitor_generate_ir_create(FILE efd,
	312	uint64_t clock_class_offset_ns);
	313
	314	void ctf_visitor_generate_ir_destroy(struct ctf_visitor_generate_ir *visitor);
e98a2d6e PP	315
e98a2d6e PP	316	BT_HIDDEN
1e649dff PP	317	struct bt_ctf_trace *ctf_visitor_generate_ir_get_trace(
1e649dff PP	318	struct ctf_visitor_generate_ir *visitor);
e98a2d6e PP	319
e98a2d6e PP	320	BT_HIDDEN
1e649dff PP	321	int ctf_visitor_generate_ir_visit_node(struct ctf_visitor_generate_ir *visitor,
1e649dff PP	322	struct ctf_node *node);
e98a2d6e PP	323
e98a2d6e PP	324	BT_HIDDEN
1e649dff	325	int ctf_visitor_semantic_check(FILE fd, int depth, struct ctf_node node);
e98a2d6e PP	326
e98a2d6e PP	327	BT_HIDDEN
1e649dff	328	int ctf_visitor_parent_links(FILE fd, int depth, struct ctf_node node);
e98a2d6e PP	329
e98a2d6e PP	330	#endif /* _CTF_AST_H */