xref: /illumos-gate/usr/src/cmd/fm/eversholt/common/tree.h (revision 7c478bd9)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  *
26  * tree.h -- public definitions for tree module
27  *
28  * the parse tree is made up of struct node's.  the struct is
29  * a "variant record" with a type, the filename and line number
30  * related to the node, and then type-specific node data.
31  */
32 
33 #ifndef	_ESC_COMMON_TREE_H
34 #define	_ESC_COMMON_TREE_H
35 
36 #pragma ident	"%Z%%M%	%I%	%E% SMI"
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 struct node {
43 	enum nodetype {
44 		T_NOTHING = 1000,	/* used to keep going on error cases */
45 		T_NAME,			/* identifiers, sometimes chained */
46 		T_GLOBID,		/* globals (e.g. $a) */
47 		T_EVENT,		/* class@path{expr} */
48 		T_ENGINE,		/* upset threshold engine (e.g. SERD) */
49 		T_ASRU,			/* ASRU declaration */
50 		T_FRU,			/* FRU declaration */
51 		T_TIMEVAL,		/* num w/time suffix (ns internally) */
52 		T_NUM,			/* num (ull internally) */
53 		T_QUOTE,		/* quoted string */
54 		T_FUNC,			/* func(arglist) */
55 		T_NVPAIR,		/* name=value pair in decl */
56 		T_ASSIGN,		/* assignment statement */
57 		T_CONDIF,		/* a and T_CONDELSE in (a ? b : c ) */
58 		T_CONDELSE,		/* lists b and c in (a ? b : c ) */
59 		T_NOT,			/* boolean ! operator */
60 		T_AND,			/* boolean && operator */
61 		T_OR,			/* boolean || operator */
62 		T_EQ,			/* boolean == operator */
63 		T_NE,			/* boolean != operator */
64 		T_SUB,			/* integer - operator */
65 		T_ADD,			/* integer + operator */
66 		T_MUL,			/* integer * operator */
67 		T_DIV,			/* integer / operator */
68 		T_MOD,			/* integer % operator */
69 		T_LT,			/* boolean < operator */
70 		T_LE,			/* boolean <= operator */
71 		T_GT,			/* boolean > operator */
72 		T_GE,			/* boolean >= operator */
73 		T_BITAND,		/* bitwise & operator */
74 		T_BITOR,		/* bitwise | operator */
75 		T_BITXOR,		/* bitwise ^ operator */
76 		T_BITNOT,		/* bitwise ~ operator */
77 		T_LSHIFT,		/* bitwise << operator */
78 		T_RSHIFT,		/* bitwise >> operator */
79 		T_ARROW,		/* lhs (N)->(K) rhs */
80 		T_LIST,			/* comma-separated list */
81 		T_FAULT,		/* fault declaration */
82 		T_UPSET,		/* upset declaration */
83 		T_DEFECT,		/* defect declaration */
84 		T_ERROR,		/* error declaration */
85 		T_EREPORT,		/* ereport declaration */
86 		T_SERD,			/* SERD engine declaration */
87 		T_PROP,			/* prop statement */
88 		T_MASK,			/* mask statement */
89 		T_CONFIG		/* config statement */
90 	} t;
91 
92 	/*
93 	 * regardless of the type of node, filename and line number
94 	 * information from the original .esc file is tracked here.
95 	 */
96 	const char *file;
97 	int line;
98 
99 	/*
100 	 * the variant part of a struct node...
101 	 */
102 	union {
103 		struct {
104 			/*
105 			 * info kept for T_NAME, used in several ways:
106 			 *
107 			 *	1 for simple variable names.
108 			 *		example: j
109 			 *
110 			 *	2 for event class names, with component
111 			 *	  names chained together via the "next"
112 			 *	  pointers.
113 			 *		example: fault.fan.broken
114 			 *
115 			 *	3 for component pathnames, with component
116 			 *	  names chained together via the "next"
117 			 *	  pointers and iterators or instance numbers
118 			 *	  attached via the "child" pointers.
119 			 *		example: sysboard[0]/cpu[n]
120 			 *
121 			 * case 3 is the most interesting.
122 			 *	- if child is set, there's an iterator
123 			 *	- if child is a T_NAME, it is x[j] or x<j> and
124 			 *	  iterator type tells you vertical or horizontal
125 			 *	- if child is a T_NUM, it is x[0] or x<0> or
126 			 *	  x0 and iterator type tells you which one
127 			 *	- if cp pointer is set, then we recently
128 			 *	  matched it to a config cache entry and one
129 			 *	  can ignore child for now because it still
130 			 *	  represents the *pattern* you're matching.
131 			 *	  cp represents what you matched.  ptree()
132 			 *	  knows that if cp is set, to print that number
133 			 *	  instead of following child.
134 			 *
135 			 * when T_NAME nodes are chained:
136 			 * the "last" pointer takes you to the end of the
137 			 * chain, but only the first component's last pointer
138 			 * is kept up to date.  it is used to determine
139 			 * where to append newly-created T_NAME nodes (see
140 			 * tree_name_append()).
141 			 */
142 			const char *s;		/* the name itself */
143 
144 			struct node *child;
145 			struct node *next;
146 			struct node *last;
147 
148 			/* opaque pointer used during config matching */
149 			struct config *cp;
150 
151 			enum nametype {
152 				N_UNSPEC,
153 				N_FAULT,
154 				N_UPSET,
155 				N_DEFECT,
156 				N_ERROR,
157 				N_EREPORT,
158 				N_SERD
159 			} t:3;
160 			enum itertype {
161 				IT_NONE,
162 				IT_VERTICAL,
163 				IT_HORIZONTAL,
164 				IT_ENAME
165 			} it:2;
166 			unsigned childgen:1;	/* child was auto-generated */
167 		} name;
168 
169 		struct {
170 			/*
171 			 * info kept for T_GLOBID
172 			 */
173 			const char *s;		/* the name itself */
174 		} globid;
175 
176 		/*
177 		 * info kept for T_TIMEVAL and T_NUM
178 		 *
179 		 * timevals are kept in nanoseconds.
180 		 */
181 		unsigned long long ull;
182 
183 		struct {
184 			/*
185 			 * info kept for T_QUOTE
186 			 */
187 			const char *s;		/* the quoted string */
188 		} quote;
189 
190 		struct {
191 			/*
192 			 * info kept for T_FUNC
193 			 */
194 			const char *s;		/* name of function */
195 			struct node *arglist;
196 			void *cachedval;	/* runtime cache of value */
197 		} func;
198 
199 		struct {
200 			/*
201 			 * info kept for T_PROP and T_MASK statements
202 			 * as well as declarations for:
203 			 *	T_FAULT
204 			 *	T_UPSET
205 			 *	T_DEFECT
206 			 *	T_ERROR
207 			 *	T_EREPORT
208 			 *	T_ASRU
209 			 *	T_FRU
210 			 *	T_CONFIG
211 			 */
212 			struct node *np;
213 			struct node *nvpairs;	/* for declarations */
214 			struct lut *lutp;	/* for declarations */
215 			struct node *next;	/* for Props & Masks lists */
216 			struct node *expr;	/* for if statements */
217 			unsigned char flags;	/* see STMT_ flags below */
218 		} stmt;			/* used for stmt */
219 
220 		struct {
221 			/*
222 			 * info kept for T_EVENT
223 			 */
224 			struct node *ename;	/* event class name */
225 			struct node *epname;	/* component path name */
226 			struct node *eexprlist;	/* constraint expression */
227 			struct node *declp;	/* event declaration */
228 		} event;
229 
230 		struct {
231 			/*
232 			 * info kept for T_ARROW
233 			 */
234 			struct node *lhs;	/* left side of arrow */
235 			struct node *rhs;	/* right side of arrow */
236 			struct node *nnp;	/* N value */
237 			struct node *knp;	/* K value */
238 			struct node *prop;	/* arrow is part of this prop */
239 		} arrow;
240 
241 		struct {
242 			/*
243 			 * info kept for everything else (T_ADD, T_LIST, etc.)
244 			 */
245 			struct node *left;
246 			struct node *right;
247 		} expr;
248 	} u;
249 };
250 
251 /* flags we keep with stmts */
252 #define	STMT_REF	0x01	/* declared item is referenced */
253 #define	STMT_CYMARK	0x02	/* declared item is marked for cycle check */
254 #define	STMT_CYCLE	0x04	/* cycle detected and already reported */
255 
256 #define	TIMEVAL_EVENTUALLY (1000000000ULL*60*60*24*365*100)	/* 100 years */
257 
258 void tree_init(void);
259 void tree_fini(void);
260 struct node *newnode(enum nodetype t, const char *file, int line);
261 void tree_free(struct node *root);
262 struct node *tree_root(struct node *np);
263 struct node *tree_nothing(void);
264 struct node *tree_expr(enum nodetype t, struct node *left, struct node *right);
265 struct node *tree_event(struct node *ename, struct node *epname,
266     struct node *eexprlist);
267 struct node *tree_if(struct node *expr, struct node *stmts,
268     const char *file, int line);
269 struct node *tree_name(const char *s, enum itertype it,
270     const char *file, int line);
271 struct node *tree_iname(const char *s, const char *file, int line);
272 struct node *tree_globid(const char *s, const char *file, int line);
273 struct node *tree_name_append(struct node *np1, struct node *np2);
274 struct node *tree_name_repairdash(struct node *np1, const char *s);
275 struct node *tree_name_iterator(struct node *np1, struct node *np2);
276 struct node *tree_timeval(const char *s, const char *suffix,
277     const char *file, int line);
278 struct node *tree_num(const char *s, const char *file, int line);
279 struct node *tree_quote(const char *s, const char *file, int line);
280 struct node *tree_func(const char *s, struct node *np,
281     const char *file, int line);
282 struct node *tree_pname(struct node *np);
283 struct node *tree_arrow(struct node *lhs, struct node *nnp, struct node *knp,
284     struct node *rhs);
285 struct lut *tree_s2np_lut_add(struct lut *root, const char *s, struct node *np);
286 struct node *tree_s2np_lut_lookup(struct lut *root, const char *s);
287 struct lut *tree_name2np_lut_add(struct lut *root,
288     struct node *namep, struct node *np);
289 struct node *tree_name2np_lut_lookup(struct lut *root, struct node *namep);
290 struct node *tree_name2np_lut_lookup_name(struct lut *root, struct node *namep);
291 struct lut *tree_event2np_lut_add(struct lut *root,
292     struct node *enp, struct node *np);
293 struct node *tree_event2np_lut_lookup(struct lut *root, struct node *enp);
294 struct node *tree_event2np_lut_lookup_event(struct lut *root,
295     struct node *enp);
296 struct node *tree_decl(enum nodetype t, struct node *enp, struct node *nvpairs,
297     const char *file, int line);
298 struct node *tree_stmt(enum nodetype t, struct node *np,
299     const char *file, int line);
300 void tree_report();
301 int tree_namecmp(struct node *np1, struct node *np2);
302 int tree_eventcmp(struct node *np1, struct node *np2);
303 
304 struct lut *Faults;
305 struct lut *Upsets;
306 struct lut *Defects;
307 struct lut *Errors;
308 struct lut *Ereports;
309 struct lut *Ereportenames;
310 struct lut *SERDs;
311 struct lut *ASRUs;
312 struct lut *FRUs;
313 struct lut *Configs;
314 struct node *Props;
315 struct node *Lastprops;
316 struct node *Masks;
317 struct node *Lastmasks;
318 struct node *Problems;
319 struct node *Lastproblems;
320 
321 #ifdef	__cplusplus
322 }
323 #endif
324 
325 #endif	/* _ESC_COMMON_TREE_H */
326