Commit | Line | Data |
---|---|---|
b64eb60f MW |
1 | /* -*-c-*- |
2 | * | |
3 | * Main test vector driver | |
4 | * | |
5 | * (c) 2023 Straylight/Edgeware | |
6 | */ | |
7 | ||
8 | /*----- Licensing notice --------------------------------------------------* | |
9 | * | |
10 | * This file is part of the mLib utilities library. | |
11 | * | |
12 | * mLib is free software: you can redistribute it and/or modify it under | |
13 | * the terms of the GNU Library General Public License as published by | |
14 | * the Free Software Foundation; either version 2 of the License, or (at | |
15 | * your option) any later version. | |
16 | * | |
17 | * mLib is distributed in the hope that it will be useful, but WITHOUT | |
18 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
19 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public | |
20 | * License for more details. | |
21 | * | |
22 | * You should have received a copy of the GNU Library General Public | |
23 | * License along with mLib. If not, write to the Free Software | |
24 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, | |
25 | * USA. | |
26 | */ | |
27 | ||
28 | /*----- Header files ------------------------------------------------------*/ | |
29 | ||
30 | #include <assert.h> | |
31 | #include <ctype.h> | |
882a39c1 | 32 | #include <errno.h> |
b64eb60f MW |
33 | #include <string.h> |
34 | ||
35 | #include "alloc.h" | |
b64eb60f MW |
36 | #include "tvec.h" |
37 | ||
38 | /*----- Output ------------------------------------------------------------*/ | |
39 | ||
31d0247c MW |
40 | /* --- @tvec_strlevel@ --- * |
41 | * | |
42 | * Arguments: @unsigned level@ = level code | |
43 | * | |
44 | * Returns: A human-readable description. | |
45 | * | |
46 | * Use: Converts a level code into something that you can print in a | |
47 | * message. | |
48 | */ | |
49 | ||
50 | const char *tvec_strlevel(unsigned level) | |
51 | { | |
52 | switch (level) { | |
53 | #define CASE(tag, name, val) \ | |
54 | case TVLEV_##tag: return (name); | |
55 | TVEC_LEVELS(CASE) | |
56 | #undef CASE | |
57 | default: return ("??"); | |
58 | } | |
59 | } | |
60 | ||
c91413e6 | 61 | /* --- @tvec_report@, @tvec_report_v@ --- * |
67b5031e MW |
62 | * |
63 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
31d0247c | 64 | * @unsigned level@ = severity level (@TVlEV_...@) |
67b5031e MW |
65 | * @const char *msg@, @va_list ap@ = error message |
66 | * | |
c91413e6 | 67 | * Returns: --- |
67b5031e | 68 | * |
c91413e6 MW |
69 | * Use: Report an message with a given severity. Messages with level |
70 | * @TVLEV_ERR@ or higher force a nonzero exit code. | |
67b5031e MW |
71 | */ |
72 | ||
c91413e6 | 73 | void tvec_report(struct tvec_state *tv, unsigned level, const char *msg, ...) |
882a39c1 MW |
74 | { |
75 | va_list ap; | |
76 | ||
c91413e6 | 77 | va_start(ap, msg); tvec_report_v(tv, level, msg, &ap); va_end(ap); |
882a39c1 | 78 | } |
c91413e6 MW |
79 | |
80 | void tvec_report_v(struct tvec_state *tv, unsigned level, | |
81 | const char *msg, va_list *ap) | |
67b5031e | 82 | { |
c91413e6 MW |
83 | tv->output->ops->report(tv->output, level, msg, ap); |
84 | if (level >= TVLEV_ERR) tv->f |= TVSF_ERROR; | |
67b5031e MW |
85 | } |
86 | ||
c91413e6 | 87 | /* --- @tvec_error@, @tvec_notice@ --- * |
67b5031e MW |
88 | * |
89 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
c91413e6 | 90 | * @const char *msg@, @va_list ap@ = error message |
67b5031e | 91 | * |
c91413e6 MW |
92 | * Returns: The @tvec_error@ function returns @-1@ as a trivial |
93 | * convenience; @tvec_notice@ does not return a value. | |
67b5031e | 94 | * |
c91413e6 MW |
95 | * Use: Report an error or a notice. Errors are distinct from test |
96 | * failures, and indicate that a problem was encountered which | |
97 | * compromised the activity of testing. Notices are important | |
98 | * information which doesn't fit into any other obvious | |
99 | * category. | |
67b5031e | 100 | */ |
b64eb60f | 101 | |
c91413e6 MW |
102 | int tvec_error(struct tvec_state *tv, const char *msg, ...) |
103 | { | |
104 | va_list ap; | |
105 | ||
106 | va_start(ap, msg); tvec_report_v(tv, TVLEV_ERR, msg, &ap); va_end(ap); | |
107 | return (-1); | |
108 | } | |
109 | ||
b64eb60f MW |
110 | void tvec_notice(struct tvec_state *tv, const char *msg, ...) |
111 | { | |
112 | va_list ap; | |
c91413e6 MW |
113 | |
114 | va_start(ap, msg); tvec_report_v(tv, TVLEV_NOTE, msg, &ap); va_end(ap); | |
b64eb60f | 115 | } |
b64eb60f | 116 | |
67b5031e | 117 | /*----- Test processing ---------------------------------------------------*/ |
b64eb60f | 118 | |
31d0247c MW |
119 | /* --- @tvec_skipgroup@, @tvec_skipgroup_v@ --- * |
120 | * | |
121 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
122 | * @const char *excuse@, @va_list *ap@ = reason why skipped | |
123 | * | |
124 | * Returns: --- | |
125 | * | |
126 | * Use: Skip the current group. This should only be called from a | |
127 | * test environment @setup@ function; a similar effect occurs if | |
128 | * the @setup@ function fails. | |
129 | */ | |
130 | ||
b64eb60f MW |
131 | void tvec_skipgroup(struct tvec_state *tv, const char *excuse, ...) |
132 | { | |
133 | va_list ap; | |
67b5031e | 134 | |
b64eb60f MW |
135 | va_start(ap, excuse); tvec_skipgroup_v(tv, excuse, &ap); va_end(ap); |
136 | } | |
31d0247c | 137 | |
b64eb60f MW |
138 | void tvec_skipgroup_v(struct tvec_state *tv, const char *excuse, va_list *ap) |
139 | { | |
c91413e6 MW |
140 | if (!(tv->f&TVSF_SKIP)) { |
141 | tv->f |= TVSF_SKIP; tv->grps[TVOUT_SKIP]++; | |
142 | tv->output->ops->skipgroup(tv->output, excuse, ap); | |
143 | } | |
b64eb60f MW |
144 | } |
145 | ||
31d0247c MW |
146 | /* --- @set_outcome@ --- * |
147 | * | |
148 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
149 | * @unsigned out@ = the new outcome | |
150 | * | |
151 | * Returns: --- | |
152 | * | |
153 | * Use: Sets the outcome bits in the test state flags, and clears | |
154 | * @TVSF_ACTIVE@. | |
155 | */ | |
156 | ||
b64eb60f | 157 | static void set_outcome(struct tvec_state *tv, unsigned out) |
31d0247c MW |
158 | { tv->f = (tv->f&~(TVSF_ACTIVE | TVSF_OUTMASK)) | (out << TVSF_OUTSHIFT); } |
159 | ||
160 | /* --- @tvec_skip@, @tvec_skip_v@ --- * | |
161 | * | |
162 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
163 | * @const char *excuse@, @va_list *ap@ = reason why test skipped | |
164 | * | |
165 | * Returns: --- | |
166 | * | |
167 | * Use: Skip the current test. This should only be called from a | |
168 | * test environment @run@ function; a similar effect occurs if | |
169 | * the @before@ function fails. | |
170 | */ | |
b64eb60f MW |
171 | |
172 | void tvec_skip(struct tvec_state *tv, const char *excuse, ...) | |
173 | { | |
174 | va_list ap; | |
175 | va_start(ap, excuse); tvec_skip_v(tv, excuse, &ap); va_end(ap); | |
176 | } | |
31d0247c | 177 | |
b64eb60f MW |
178 | void tvec_skip_v(struct tvec_state *tv, const char *excuse, va_list *ap) |
179 | { | |
180 | assert(tv->f&TVSF_ACTIVE); | |
181 | set_outcome(tv, TVOUT_SKIP); | |
182 | tv->output->ops->skip(tv->output, excuse, ap); | |
183 | } | |
184 | ||
31d0247c MW |
185 | /* --- @tvec_fail@, @tvec_fail_v@ --- * |
186 | * | |
187 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
188 | * @const char *detail@, @va_list *ap@ = description of test | |
189 | * | |
190 | * Returns: --- | |
191 | * | |
192 | * Use: Report the current test as a failure. This function can be | |
193 | * called multiple times for a single test, e.g., if the test | |
194 | * environment's @run@ function invokes the test function | |
195 | * repeatedly; but a single test that fails repeatedly still | |
196 | * only counts as a single failure in the statistics. The | |
197 | * @detail@ string and its format parameters can be used to | |
198 | * distinguish which of several invocations failed; it can | |
199 | * safely be left null if the test function is run only once. | |
200 | */ | |
201 | ||
b64eb60f MW |
202 | void tvec_fail(struct tvec_state *tv, const char *detail, ...) |
203 | { | |
204 | va_list ap; | |
205 | va_start(ap, detail); tvec_fail_v(tv, detail, &ap); va_end(ap); | |
206 | } | |
31d0247c | 207 | |
b64eb60f MW |
208 | void tvec_fail_v(struct tvec_state *tv, const char *detail, va_list *ap) |
209 | { | |
210 | assert((tv->f&TVSF_ACTIVE) || | |
211 | (tv->f&TVSF_OUTMASK) == (TVOUT_LOSE << TVSF_OUTSHIFT)); | |
212 | set_outcome(tv, TVOUT_LOSE); tv->output->ops->fail(tv->output, detail, ap); | |
213 | } | |
214 | ||
31d0247c MW |
215 | /* --- @tvec_dumpreg@ --- * |
216 | * | |
217 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
218 | * @unsigned disp@ = the register disposition (@TVRD_...@) | |
219 | * @const union tvec_regval *tv@ = register value, or null | |
220 | * @const struct tvec_regdef *rd@ = register definition | |
221 | * | |
222 | * Returns: --- | |
223 | * | |
224 | * Use: Dump a register value to the output. This is the lowest- | |
225 | * level function for dumping registers, and calls the output | |
226 | * formatter directly. | |
227 | * | |
228 | * Usually @tvec_mismatch@ is much more convenient. Low-level | |
229 | * access is required for reporting `virtual' registers | |
230 | * corresponding to test environment settings. | |
231 | */ | |
232 | ||
e63124bc MW |
233 | void tvec_dumpreg(struct tvec_state *tv, |
234 | unsigned disp, const union tvec_regval *r, | |
235 | const struct tvec_regdef *rd) | |
236 | { tv->output->ops->dumpreg(tv->output, disp, r, rd); } | |
b64eb60f | 237 | |
31d0247c MW |
238 | /* --- @tvec_mismatch@ --- * |
239 | * | |
240 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
241 | * @unsigned f@ = flags (@TVMF_...@) | |
242 | * | |
243 | * Returns: --- | |
244 | * | |
245 | * Use: Dumps registers suitably to report a mismatch. The flag bits | |
246 | * @TVMF_IN@ and @TVF_OUT@ select input-only and output | |
247 | * registers. If both are reset then nothing happens. | |
248 | * Suppressing the output registers may be useful, e.g., if the | |
249 | * test function crashed rather than returning outputs. | |
250 | */ | |
251 | ||
e63124bc | 252 | void tvec_mismatch(struct tvec_state *tv, unsigned f) |
b64eb60f | 253 | { |
b64eb60f | 254 | const struct tvec_regdef *rd; |
e63124bc | 255 | const struct tvec_reg *rin, *rout; |
b64eb60f | 256 | |
e63124bc MW |
257 | for (rd = tv->test->regs; rd->name; rd++) { |
258 | if (rd->i >= tv->nrout) { | |
259 | if (!(f&TVMF_IN)) continue; | |
260 | rin = TVEC_REG(tv, in, rd->i); | |
261 | tvec_dumpreg(tv, TVRD_INPUT, rin->f&TVRF_LIVE ? &rin->v : 0, rd); | |
262 | } else { | |
263 | if (!(f&TVMF_OUT)) continue; | |
264 | rin = TVEC_REG(tv, in, rd->i); rout = TVEC_REG(tv, out, rd->i); | |
265 | if (!(rin->f&TVRF_LIVE)) | |
266 | tvec_dumpreg(tv, TVRD_OUTPUT, rout->f&TVRF_LIVE ? &rout->v : 0, rd); | |
267 | else if ((rout->f&TVRF_LIVE) && rd->ty->eq(&rin->v, &rout->v, rd)) | |
268 | tvec_dumpreg(tv, TVRD_MATCH, &rin->v, rd); | |
269 | else { | |
270 | tvec_dumpreg(tv, TVRD_FOUND, rout->f&TVRF_LIVE ? &rout->v : 0, rd); | |
271 | tvec_dumpreg(tv, TVRD_EXPECT, &rin->v, rd); | |
272 | } | |
273 | } | |
b64eb60f | 274 | } |
b64eb60f MW |
275 | } |
276 | ||
67b5031e | 277 | /*----- Parsing -----------------------------------------------------------*/ |
b64eb60f | 278 | |
31d0247c MW |
279 | /* --- @tvec_syntax@, @tvec_syntax_v@ --- * |
280 | * | |
281 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
282 | * @int ch@ = the character found (in @fgetc@ format) | |
283 | * @const char *expect@, @va_list ap@ = what was expected | |
284 | * | |
285 | * Returns: %$-1$%. | |
286 | * | |
287 | * Use: Report a syntax error quoting @ch@ and @expect@. If @ch@ is | |
288 | * a newline, then back up so that it can be read again (e.g., | |
289 | * by @tvec_flushtoeol@ or @tvec_nexttoken@, which will also | |
290 | * advance the line number). | |
291 | */ | |
292 | ||
67b5031e MW |
293 | int tvec_syntax(struct tvec_state *tv, int ch, const char *expect, ...) |
294 | { | |
295 | va_list ap; | |
296 | ||
297 | va_start(ap, expect); tvec_syntax_v(tv, ch, expect, &ap); va_end(ap); | |
298 | return (-1); | |
299 | } | |
31d0247c | 300 | |
67b5031e MW |
301 | int tvec_syntax_v(struct tvec_state *tv, int ch, |
302 | const char *expect, va_list *ap) | |
303 | { | |
304 | dstr d = DSTR_INIT; | |
305 | char found[8]; | |
306 | ||
307 | switch (ch) { | |
308 | case EOF: strcpy(found, "#eof"); break; | |
309 | case '\n': strcpy(found, "#eol"); ungetc(ch, tv->fp); break; | |
310 | default: | |
311 | if (isprint(ch)) sprintf(found, "`%c'", ch); | |
312 | else sprintf(found, "#\\x%02x", ch); | |
313 | break; | |
314 | } | |
315 | dstr_vputf(&d, expect, ap); | |
316 | tvec_error(tv, "syntax error: expected %s but found %s", d.buf, found); | |
317 | dstr_destroy(&d); return (-1); | |
318 | } | |
e63124bc | 319 | |
31d0247c MW |
320 | /* --- @tvec_dupreg@ --- * |
321 | * | |
322 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
323 | * @const char *name@ = register or pseudoregister name | |
324 | * | |
325 | * Returns: %$-1$%. | |
326 | * | |
327 | * Use: Reports an error that the register or pseudoregister has been | |
328 | * assigned already in the current test. | |
329 | */ | |
330 | ||
331 | int tvec_dupreg(struct tvec_state *tv, const char *name) | |
332 | { return (tvec_error(tv, "register `%s' is already set", name)); } | |
333 | ||
334 | /* --- @tvec_skipspc@ --- * | |
335 | * | |
336 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
337 | * | |
338 | * Returns: --- | |
339 | * | |
340 | * Use: Advance over any whitespace characters other than newlines. | |
341 | * This will stop at `;', end-of-file, or any other kind of | |
342 | * non-whitespace; and it won't consume a newline. | |
343 | */ | |
344 | ||
b64eb60f MW |
345 | void tvec_skipspc(struct tvec_state *tv) |
346 | { | |
347 | int ch; | |
348 | ||
349 | for (;;) { | |
350 | ch = getc(tv->fp); | |
351 | if (ch == EOF) break; | |
352 | else if (ch == '\n' || !isspace(ch)) { ungetc(ch, tv->fp); break; } | |
353 | } | |
354 | } | |
355 | ||
31d0247c MW |
356 | /* --- @tvec_flushtoeol@ --- * |
357 | * | |
358 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
359 | * @unsigned f@ = flags (@TVFF_...@) | |
360 | * | |
361 | * Returns: Zero on success, @-1@ on error. | |
362 | * | |
363 | * Use: Advance to the start of the next line, consuming the | |
364 | * preceding newline. | |
365 | * | |
366 | * A syntax error is reported if no newline character is found, | |
367 | * i.e., the file ends in mid-line. A syntax error is also | |
368 | * reported if material other than whitespace or a comment is | |
369 | * found before the end of the line end, and @TVFF_ALLOWANY@ is | |
370 | * not set in @f@. The line number count is updated | |
371 | * appropriately. | |
372 | */ | |
373 | ||
882a39c1 | 374 | int tvec_flushtoeol(struct tvec_state *tv, unsigned f) |
b64eb60f | 375 | { |
882a39c1 | 376 | int ch, rc = 0; |
b64eb60f MW |
377 | |
378 | for (;;) { | |
379 | ch = getc(tv->fp); | |
380 | switch (ch) { | |
882a39c1 MW |
381 | case '\n': tv->lno++; return (rc); |
382 | case EOF: return (rc); | |
b64eb60f MW |
383 | case ';': f |= TVFF_ALLOWANY; break; |
384 | default: | |
882a39c1 | 385 | if (!(f&TVFF_ALLOWANY) && !isspace(ch)) { |
b64eb60f | 386 | tvec_syntax(tv, ch, "end-of-line"); |
882a39c1 MW |
387 | rc = -1; f |= TVFF_ALLOWANY; |
388 | } | |
b64eb60f MW |
389 | break; |
390 | } | |
391 | } | |
392 | } | |
393 | ||
31d0247c MW |
394 | /* --- @tvec_nexttoken@ --- * |
395 | * | |
396 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
397 | * | |
398 | * Returns: Zero if there is a next token which can be read; @-1@ if no | |
399 | * token is available. | |
400 | * | |
401 | * Use: Advance to the next whitespace-separated token, which may be | |
402 | * on the next line. | |
403 | * | |
404 | * Tokens are separated by non-newline whitespace, comments, and | |
405 | * newlines followed by whitespace; a newline /not/ followed by | |
406 | * whitespace instead begins the next assignment, and two | |
407 | * newlines separated only by whitespace terminate the data for | |
408 | * a test. | |
409 | * | |
410 | * If this function returns zero, then the next character in the | |
411 | * file begins a suitable token which can be read and | |
412 | * processed. If it returns @-1@ then there is no such token, | |
413 | * and the file position is left correctly. The line number | |
414 | * count is updated appropriately. | |
415 | */ | |
416 | ||
b64eb60f MW |
417 | int tvec_nexttoken(struct tvec_state *tv) |
418 | { | |
419 | enum { TAIL, NEWLINE, INDENT, COMMENT }; | |
420 | int ch; | |
421 | unsigned s = TAIL; | |
422 | ||
423 | for (;;) { | |
424 | ch = getc(tv->fp); | |
425 | switch (ch) { | |
426 | case EOF: | |
427 | return (-1); | |
428 | ||
429 | case ';': | |
430 | s = COMMENT; | |
431 | break; | |
432 | ||
433 | case '\n': | |
434 | if (s == NEWLINE || s == INDENT) { ungetc(ch, tv->fp); return (-1); } | |
435 | else { tv->lno++; s = NEWLINE; } | |
436 | break; | |
437 | ||
438 | default: | |
439 | if (isspace(ch)) | |
440 | { if (s == NEWLINE) s = INDENT; } | |
441 | else if (s != COMMENT) { | |
442 | ungetc(ch, tv->fp); | |
443 | if (s == NEWLINE) return (-1); | |
444 | else return (0); | |
445 | } | |
446 | break; | |
447 | } | |
448 | } | |
449 | } | |
450 | ||
31d0247c MW |
451 | /* --- @tvec_readword@, @tvec_readword_v@ --- * |
452 | * | |
453 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
454 | * @dstr *d@ = string to append the word to | |
455 | * @const char *delims@ = additional delimiters to stop at | |
456 | * @const char *expect@, @va_list ap@ = what was expected | |
457 | * | |
458 | * Returns: Zero on success, @-1@ on failure. | |
459 | * | |
460 | * Use: A `word' consists of characters other than whitespace, null | |
461 | * characters, and other than those listed in @delims@; | |
462 | * furthermore, a word does not begin with a `;'. (If you want | |
463 | * reading to stop at comments not preceded by whitespace, then | |
464 | * include `;' in @delims@. This is a common behaviour.) | |
465 | * | |
466 | * If there is no word beginning at the current file position, | |
467 | * then return @-1@; furthermore, if @expect@ is not null, then | |
468 | * report an appropriate error via @tvec_syntax@. | |
469 | * | |
470 | * Otherwise, the word is accumulated in @d@ and zero is | |
471 | * returned; if @d@ was not empty at the start of the call, the | |
472 | * newly read word is separated from the existing material by a | |
473 | * single space character. Since null bytes are never valid | |
474 | * word constituents, a null terminator is written to @d@, and | |
475 | * it is safe to treat the string in @d@ as being null- | |
476 | * terminated. | |
477 | */ | |
478 | ||
b64eb60f MW |
479 | int tvec_readword(struct tvec_state *tv, dstr *d, const char *delims, |
480 | const char *expect, ...) | |
481 | { | |
482 | va_list ap; | |
483 | int rc; | |
484 | ||
485 | va_start(ap, expect); | |
486 | rc = tvec_readword_v(tv, d, delims, expect, &ap); | |
487 | va_end(ap); | |
488 | return (rc); | |
489 | } | |
31d0247c | 490 | |
b64eb60f MW |
491 | int tvec_readword_v(struct tvec_state *tv, dstr *d, const char *delims, |
492 | const char *expect, va_list *ap) | |
493 | { | |
494 | int ch; | |
495 | ||
496 | ch = getc(tv->fp); | |
e63124bc | 497 | if (!ch || ch == '\n' || ch == EOF || ch == ';' || |
b64eb60f | 498 | (delims && strchr(delims, ch))) { |
882a39c1 | 499 | if (expect) return (tvec_syntax(tv, ch, expect, ap)); |
b64eb60f MW |
500 | else { ungetc(ch, tv->fp); return (-1); } |
501 | } | |
502 | if (d->len) DPUTC(d, ' '); | |
503 | do { | |
504 | DPUTC(d, ch); | |
505 | ch = getc(tv->fp); | |
e63124bc MW |
506 | } while (ch && ch != EOF && !isspace(ch) && |
507 | (!delims || !strchr(delims, ch))); | |
b64eb60f MW |
508 | DPUTZ(d); if (ch != EOF) ungetc(ch, tv->fp); |
509 | return (0); | |
510 | } | |
511 | ||
67b5031e MW |
512 | /*----- Main machinery ----------------------------------------------------*/ |
513 | ||
514 | struct groupstate { | |
31d0247c | 515 | void *ctx; /* test environment context */ |
67b5031e MW |
516 | }; |
517 | #define GROUPSTATE_INIT { 0 } | |
518 | ||
31d0247c MW |
519 | /* --- @tvec_initregs@, @tvec_releaseregs@ --- * |
520 | * | |
521 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
522 | * | |
523 | * Returns: --- | |
524 | * | |
525 | * Use: Initialize or release, respectively, the registers required | |
526 | * by the current test. All of the registers, both input and | |
527 | * output, are effected. Initialized registers are not marked | |
528 | * live. | |
529 | */ | |
e63124bc | 530 | |
c91413e6 | 531 | void tvec_initregs(struct tvec_state *tv) |
b64eb60f MW |
532 | { |
533 | const struct tvec_regdef *rd; | |
534 | struct tvec_reg *r; | |
535 | ||
536 | for (rd = tv->test->regs; rd->name; rd++) { | |
537 | assert(rd->i < tv->nreg); r = TVEC_REG(tv, in, rd->i); | |
538 | rd->ty->init(&r->v, rd); r->f = 0; | |
539 | if (rd->i < tv->nrout) | |
540 | { r = TVEC_REG(tv, out, rd->i); rd->ty->init(&r->v, rd); r->f = 0; } | |
541 | } | |
b64eb60f MW |
542 | } |
543 | ||
c91413e6 | 544 | void tvec_releaseregs(struct tvec_state *tv) |
b64eb60f MW |
545 | { |
546 | const struct tvec_regdef *rd; | |
547 | struct tvec_reg *r; | |
548 | ||
549 | for (rd = tv->test->regs; rd->name; rd++) { | |
550 | assert(rd->i < tv->nreg); r = TVEC_REG(tv, in, rd->i); | |
551 | rd->ty->release(&r->v, rd); r->f = 0; | |
552 | if (rd->i < tv->nrout) | |
553 | { r = TVEC_REG(tv, out, rd->i); rd->ty->release(&r->v, rd); r->f = 0; } | |
554 | } | |
555 | } | |
556 | ||
31d0247c MW |
557 | /* --- @tvec_resetoutputs@ --- * |
558 | * | |
559 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
560 | * | |
561 | * Returns: --- | |
562 | * | |
563 | * Use: Reset (releases and reinitializes) the output registers in | |
564 | * the test state. This is mostly of use to test environment | |
565 | * @run@ functions, between invocations of the test function. | |
566 | * Output registers are marked live if and only if the | |
567 | * corresponding input register is live. | |
568 | */ | |
569 | ||
570 | void tvec_resetoutputs(struct tvec_state *tv) | |
571 | { | |
572 | const struct tvec_regdef *rd; | |
573 | struct tvec_reg *r; | |
574 | ||
575 | for (rd = tv->test->regs; rd->name; rd++) { | |
576 | assert(rd->i < tv->nreg); | |
577 | if (rd->i >= tv->nrout) continue; | |
578 | r = TVEC_REG(tv, out, rd->i); | |
579 | rd->ty->release(&r->v, rd); | |
580 | rd->ty->init(&r->v, rd); | |
581 | r->f = TVEC_REG(tv, in, rd->i)->f&TVRF_LIVE; | |
582 | } | |
583 | } | |
584 | ||
585 | /* --- @tvec_checkregs@ --- * | |
586 | * | |
587 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
588 | * | |
589 | * Returns: Zero on success, @-1@ on mismatch. | |
590 | * | |
591 | * Use: Compare the active output registers (according to the current | |
592 | * test group definition) with the corresponding input register | |
593 | * values. A mismatch occurs if the two values differ | |
594 | * (according to the register type's @eq@ method), or if the | |
595 | * input is live but the output is dead. | |
596 | * | |
597 | * This function only checks for a mismatch and returns the | |
598 | * result; it takes no other action. In particular, it doesn't | |
599 | * report a failure, or dump register values. | |
600 | */ | |
601 | ||
e63124bc | 602 | int tvec_checkregs(struct tvec_state *tv) |
b64eb60f MW |
603 | { |
604 | const struct tvec_regdef *rd; | |
605 | const struct tvec_reg *rin, *rout; | |
b64eb60f | 606 | |
b64eb60f MW |
607 | for (rd = tv->test->regs; rd->name; rd++) { |
608 | if (rd->i >= tv->nrout) continue; | |
609 | rin = TVEC_REG(tv, in, rd->i); rout = TVEC_REG(tv, out, rd->i); | |
610 | if (!rin->f&TVRF_LIVE) continue; | |
e63124bc MW |
611 | if (!(rout->f&TVRF_LIVE) || !rd->ty->eq(&rin->v, &rout->v, rd)) |
612 | return (-1); | |
b64eb60f | 613 | } |
e63124bc | 614 | return (0); |
b64eb60f MW |
615 | } |
616 | ||
31d0247c MW |
617 | /* --- @tvec_check@, @tvec_check_v@ --- * |
618 | * | |
619 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
620 | * @const char *detail@, @va_list *ap@ = description of test | |
621 | * | |
622 | * Returns: --- | |
623 | * | |
624 | * Use: Check the register values, reporting a failure and dumping | |
625 | * the registers in the event of a mismatch. This just wraps up | |
626 | * @tvec_checkregs@, @tvec_fail@ and @tvec_mismatch@ in the | |
627 | * obvious way. | |
628 | */ | |
629 | ||
e63124bc MW |
630 | void tvec_check(struct tvec_state *tv, const char *detail, ...) |
631 | { | |
632 | va_list ap; | |
633 | va_start(ap, detail); tvec_check_v(tv, detail, &ap); va_end(ap); | |
634 | } | |
31d0247c | 635 | |
e63124bc | 636 | void tvec_check_v(struct tvec_state *tv, const char *detail, va_list *ap) |
b64eb60f | 637 | { |
e63124bc MW |
638 | if (tvec_checkregs(tv)) |
639 | { tvec_fail_v(tv, detail, ap); tvec_mismatch(tv, TVMF_IN | TVMF_OUT); } | |
b64eb60f MW |
640 | } |
641 | ||
31d0247c MW |
642 | /* --- @open_test@ --- * |
643 | * | |
644 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
645 | * | |
646 | * Returns: --- | |
647 | * | |
648 | * Use: Note that we are now collecting data for a new test. The | |
649 | * current line number is recorded in @test_lno@. The | |
650 | * @TVSF_OPEN@ flag is set, and @TVSF_XFAIL@ is reset. | |
651 | * | |
652 | * If a test is already open, then do nothing. | |
653 | */ | |
654 | ||
20ba6b0b MW |
655 | static void open_test(struct tvec_state *tv) |
656 | { | |
657 | if (!(tv->f&TVSF_OPEN)) { | |
658 | tv->test_lno = tv->lno; | |
659 | tv->f |= TVSF_OPEN; tv->f &= ~TVSF_XFAIL; | |
660 | } | |
661 | } | |
662 | ||
31d0247c MW |
663 | /* --- @begin_test@ --- * |
664 | * | |
665 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
666 | * | |
667 | * Returns: --- | |
668 | * | |
669 | * Use: Note that we're about to try running a state. This is called | |
670 | * before the test environment's @before@ function. Mark the | |
671 | * test as active, clear the outcome, and inform the output | |
672 | * driver. | |
673 | */ | |
674 | ||
b64eb60f MW |
675 | static void begin_test(struct tvec_state *tv) |
676 | { | |
e63124bc | 677 | tv->f |= TVSF_ACTIVE; tv->f &= ~TVSF_OUTMASK; |
b64eb60f MW |
678 | tv->output->ops->btest(tv->output); |
679 | } | |
680 | ||
31d0247c MW |
681 | /* --- @tvec_endtest@ --- * |
682 | * | |
683 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
684 | * | |
685 | * Returns: --- | |
686 | * | |
687 | * Use: End an ad-hoc test case, The statistics are updated and the | |
688 | * outcome is reported to the output formatter. | |
689 | */ | |
690 | ||
b64eb60f MW |
691 | void tvec_endtest(struct tvec_state *tv) |
692 | { | |
693 | unsigned out; | |
694 | ||
20ba6b0b MW |
695 | if (!(tv->f&TVSF_ACTIVE)) /* nothing to do */; |
696 | else if (tv->f&TVSF_XFAIL) set_outcome(tv, TVOUT_XFAIL); | |
697 | else set_outcome(tv, TVOUT_WIN); | |
698 | out = (tv->f&TVSF_OUTMASK) >> TVSF_OUTSHIFT; | |
b64eb60f MW |
699 | assert(out < TVOUT_LIMIT); tv->curr[out]++; |
700 | tv->output->ops->etest(tv->output, out); | |
701 | tv->f &= ~TVSF_OPEN; | |
702 | } | |
703 | ||
31d0247c MW |
704 | /* --- @tvec_xfail@ --- * |
705 | * | |
706 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
707 | * | |
708 | * Returns: --- | |
709 | * | |
710 | * Use: Mark the current test as an `expected failure'. That is, the | |
711 | * behaviour -- if everything works as expected -- is known to | |
712 | * be incorrect, perhaps as a result of a longstanding bug, so | |
713 | * calling it a `success' would be inappropriate. A failure, as | |
714 | * reported by @tvec_fail@, means that the behaviour is not as | |
715 | * expected -- either the long-standing bug has been fixed, or a | |
716 | * new bug has been introduced -- so investigation is required. | |
717 | * | |
718 | * An expected failure doesn't cause the test group or the | |
719 | * session as a whole to fail, but it isn't counted as a win | |
720 | * either. | |
721 | */ | |
722 | ||
723 | void tvec_xfail(struct tvec_state *tv) | |
724 | { tv->f |= TVSF_XFAIL; } | |
725 | ||
726 | /* --- @check@ --- * | |
727 | * | |
728 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
729 | * @struct groupstate *g@ = private test group state | |
730 | * | |
731 | * Returns: --- | |
732 | * | |
733 | * Use: Run the current test. | |
734 | * | |
735 | * This function is called once the data for a test has been | |
736 | * collected. It's responsible for checking that all of the | |
737 | * necessary registers have been assigned values. It marks the | |
738 | * output registers as live if the corresponding inputs are | |
739 | * live. It calls the environment's @before@, @run@, and | |
740 | * @after@ functions if provided; if there is no @run@ function, | |
741 | * it calls @tvec_check@ to verify the output values. | |
742 | */ | |
743 | ||
e63124bc | 744 | static void check(struct tvec_state *tv, struct groupstate *g) |
b64eb60f | 745 | { |
e63124bc | 746 | const struct tvec_test *t = tv->test; |
c81c35df | 747 | const struct tvec_env *env = t->env; |
b64eb60f MW |
748 | const struct tvec_regdef *rd; |
749 | ||
750 | if (!(tv->f&TVSF_OPEN)) return; | |
751 | ||
e63124bc | 752 | for (rd = t->regs; rd->name; rd++) { |
b64eb60f MW |
753 | if (TVEC_REG(tv, in, rd->i)->f&TVRF_LIVE) |
754 | { if (rd->i < tv->nrout) TVEC_REG(tv, out, rd->i)->f |= TVRF_LIVE; } | |
882a39c1 | 755 | else if (!(rd->f&TVRF_OPT)) { |
b64eb60f | 756 | tvec_error(tv, "required register `%s' not set in test `%s'", |
e63124bc | 757 | rd->name, t->name); |
882a39c1 MW |
758 | goto end; |
759 | } | |
b64eb60f MW |
760 | } |
761 | ||
e63124bc MW |
762 | if (!(tv->f&TVSF_SKIP)) { |
763 | begin_test(tv); | |
c91413e6 MW |
764 | if (env && env->before) env->before(tv, g->ctx); |
765 | if (!(tv->f&TVSF_ACTIVE)) | |
766 | /* setup forced a skip */; | |
767 | else if (env && env->run) | |
768 | env->run(tv, t->fn, g->ctx); | |
e63124bc | 769 | else { |
c91413e6 MW |
770 | t->fn(tv->in, tv->out, g->ctx); |
771 | tvec_check(tv, 0); | |
e63124bc | 772 | } |
e63124bc MW |
773 | tvec_endtest(tv); |
774 | } | |
31d0247c | 775 | if (env && env->after) env->after(tv, g->ctx); |
b64eb60f | 776 | |
882a39c1 | 777 | end: |
c91413e6 | 778 | tv->f &= ~TVSF_OPEN; tvec_releaseregs(tv); tvec_initregs(tv); |
b64eb60f MW |
779 | } |
780 | ||
31d0247c MW |
781 | /* --- @begin_test_group@ --- * |
782 | * | |
783 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
784 | * @struct groupstate *g@ = private test group state | |
785 | * | |
786 | * Returns: --- | |
787 | * | |
788 | * Use: Begins a test group. Expects @tv->test@ to have been set | |
789 | * already. Calls the output driver, initializes the registers, | |
790 | * clears the @tv->curr@ counters, allocates the environment | |
791 | * context and calls the environment @setup@ function. | |
792 | */ | |
793 | ||
e63124bc | 794 | static void begin_test_group(struct tvec_state *tv, struct groupstate *g) |
b64eb60f | 795 | { |
e63124bc MW |
796 | const struct tvec_test *t = tv->test; |
797 | const struct tvec_env *env = t->env; | |
b64eb60f MW |
798 | unsigned i; |
799 | ||
800 | tv->output->ops->bgroup(tv->output); | |
31d0247c | 801 | tv->f &= ~(TVSF_SKIP | TVSF_MUFFLE); |
c91413e6 | 802 | tvec_initregs(tv); |
b64eb60f | 803 | for (i = 0; i < TVOUT_LIMIT; i++) tv->curr[i] = 0; |
e63124bc | 804 | if (env && env->ctxsz) g->ctx = xmalloc(env->ctxsz); |
c91413e6 | 805 | if (env && env->setup) env->setup(tv, env, 0, g->ctx); |
b64eb60f MW |
806 | } |
807 | ||
31d0247c MW |
808 | /* --- @report_group@ --- * |
809 | * | |
810 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
811 | * | |
812 | * Returns: --- | |
813 | * | |
814 | * Use: Reports the result of the test group to the output driver. | |
815 | * | |
816 | * If all of the tests have been skipped then report this as a | |
817 | * group skip. Otherwise, determine and report the group | |
818 | * outcome. | |
819 | */ | |
820 | ||
3efcfd2d | 821 | static void report_group(struct tvec_state *tv) |
b64eb60f MW |
822 | { |
823 | unsigned i, out, nrun; | |
824 | ||
825 | for (i = 0, nrun = 0; i < TVOUT_LIMIT; i++) | |
826 | { nrun += tv->curr[i]; tv->all[i] += tv->curr[i]; } | |
827 | ||
828 | if (tv->curr[TVOUT_SKIP] == nrun) | |
829 | { out = TVOUT_SKIP; tvec_skipgroup(tv, nrun ? 0 : "no tests to run"); } | |
830 | else { | |
831 | if (tv->curr[TVOUT_LOSE]) out = TVOUT_LOSE; | |
832 | else out = TVOUT_WIN; | |
3efcfd2d | 833 | tv->grps[out]++; tv->output->ops->egroup(tv->output); |
b64eb60f MW |
834 | } |
835 | } | |
836 | ||
31d0247c MW |
837 | /* --- @end_test_group@ --- * |
838 | * | |
839 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
840 | * @struct groupstate *g@ = private test group state | |
841 | * | |
842 | * Returns: --- | |
843 | * | |
844 | * Use: Handles the end of a test group. Called at the end of the | |
845 | * input file or when a new test group header is found. | |
846 | * | |
847 | * If a test is open, call @check@ to see whether it worked. If | |
848 | * the test group is not being skipped, report the group | |
849 | * result. Call the test environment @teardown@ function. Free | |
850 | * the environment context and release the registers. | |
851 | * | |
852 | * If there's no test group active, then nothing happens. | |
853 | */ | |
854 | ||
e63124bc | 855 | static void end_test_group(struct tvec_state *tv, struct groupstate *g) |
b64eb60f | 856 | { |
e63124bc MW |
857 | const struct tvec_test *t = tv->test; |
858 | const struct tvec_env *env; | |
859 | ||
860 | if (!t) return; | |
861 | if (tv->f&TVSF_OPEN) check(tv, g); | |
3efcfd2d | 862 | if (!(tv->f&TVSF_SKIP)) report_group(tv); |
e63124bc | 863 | env = t->env; if (env && env->teardown) env->teardown(tv, g->ctx); |
c91413e6 | 864 | tvec_releaseregs(tv); tv->test = 0; xfree(g->ctx); g->ctx = 0; |
b64eb60f MW |
865 | } |
866 | ||
31d0247c MW |
867 | /* --- @tvec_read@ --- * |
868 | * | |
869 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
870 | * @const char *infile@ = the name of the input file | |
871 | * @FILE *fp@ = stream to read from | |
872 | * | |
873 | * Returns: Zero on success, @-1@ on error. | |
874 | * | |
875 | * Use: Read test vector data from @fp@ and exercise test functions. | |
876 | * THe return code doesn't indicate test failures: it's only | |
877 | * concerned with whether there were problems with the input | |
878 | * file or with actually running the tests. | |
879 | */ | |
880 | ||
20ba6b0b MW |
881 | enum { WIN, XFAIL, NOUT }; |
882 | static const struct tvec_uassoc outcome_assoc[] = { | |
883 | { "success", WIN }, | |
884 | { "win", WIN }, | |
885 | { "expected-failure", XFAIL }, | |
886 | { "xfail", XFAIL }, | |
887 | TVEC_ENDENUM | |
888 | }; | |
889 | static const struct tvec_urange outcome_range = { 0, NOUT - 1 }; | |
890 | static const struct tvec_uenuminfo outcome_enum = | |
891 | { "test-outcome", outcome_assoc, &outcome_range }; | |
892 | static const struct tvec_regdef outcome_regdef = | |
893 | { "outcome", 0, &tvty_uenum, 0, { &outcome_enum } }; | |
894 | ||
882a39c1 | 895 | int tvec_read(struct tvec_state *tv, const char *infile, FILE *fp) |
b64eb60f MW |
896 | { |
897 | dstr d = DSTR_INIT; | |
898 | const struct tvec_test *test; | |
e63124bc | 899 | const struct tvec_env *env; |
b64eb60f MW |
900 | const struct tvec_regdef *rd; |
901 | struct tvec_reg *r; | |
e63124bc | 902 | struct groupstate g = GROUPSTATE_INIT; |
20ba6b0b | 903 | union tvec_regval rv; |
e63124bc | 904 | int ch, ret, rc = 0; |
b64eb60f | 905 | |
31d0247c | 906 | /* Set the initial location. */ |
b64eb60f MW |
907 | tv->infile = infile; tv->lno = 1; tv->fp = fp; |
908 | ||
909 | for (;;) { | |
31d0247c MW |
910 | |
911 | /* Get the next character and dispatch. Note that we're always at the | |
912 | * start of a line here. | |
913 | */ | |
b64eb60f MW |
914 | ch = getc(tv->fp); |
915 | switch (ch) { | |
916 | ||
917 | case EOF: | |
31d0247c MW |
918 | /* End of the file. Exit the loop. */ |
919 | ||
b64eb60f MW |
920 | goto end; |
921 | ||
922 | case '[': | |
31d0247c MW |
923 | /* A test group header. */ |
924 | ||
925 | /* End the current group, if there is one. */ | |
e63124bc | 926 | end_test_group(tv, &g); |
31d0247c MW |
927 | |
928 | /* Read the group name. There may be leading and trailing | |
929 | * whitespace. | |
930 | */ | |
b64eb60f MW |
931 | tvec_skipspc(tv); |
932 | DRESET(&d); tvec_readword(tv, &d, "];", "group name"); | |
882a39c1 MW |
933 | tvec_skipspc(tv); |
934 | ch = getc(tv->fp); if (ch != ']') tvec_syntax(tv, ch, "`]'"); | |
31d0247c MW |
935 | |
936 | /* Find the matching test definition. */ | |
b64eb60f MW |
937 | for (test = tv->tests; test->name; test++) |
938 | if (STRCMP(d.buf, ==, test->name)) goto found_test; | |
31d0247c MW |
939 | |
940 | /* There wasn't one. Report the error. Muffle errors about the | |
941 | * contents of this section because they won't be interesting. | |
942 | */ | |
943 | tvec_error(tv, "unknown test group `%s'", d.buf); | |
944 | tv->f |= TVSF_MUFFLE; goto flush_line; | |
945 | ||
b64eb60f | 946 | found_test: |
31d0247c MW |
947 | /* Eat trailing whitespace and comments. */ |
948 | tvec_flushtoeol(tv, 0); | |
949 | ||
950 | /* Set up the new test group. */ | |
951 | tv->test = test; begin_test_group(tv, &g); | |
b64eb60f MW |
952 | break; |
953 | ||
954 | case '\n': | |
31d0247c MW |
955 | /* A newline, so this was a completely empty line. Advance the line |
956 | * counter, and run the current test. | |
957 | */ | |
958 | ||
b64eb60f | 959 | tv->lno++; |
e63124bc | 960 | if (tv->f&TVSF_OPEN) check(tv, &g); |
b64eb60f MW |
961 | break; |
962 | ||
31d0247c MW |
963 | case ';': |
964 | /* A semicolon. Skip the comment. */ | |
965 | ||
966 | tvec_flushtoeol(tv, TVFF_ALLOWANY); | |
967 | break; | |
968 | ||
b64eb60f | 969 | default: |
31d0247c MW |
970 | /* Something else. */ |
971 | ||
b64eb60f | 972 | if (isspace(ch)) { |
31d0247c MW |
973 | /* Whitespace. Skip and see what we find. */ |
974 | ||
975 | tvec_skipspc(tv); ch = getc(tv->fp); | |
976 | ||
977 | /* If the file ends, then we're done. If we find a comment then we | |
978 | * skip it. If there's some non-whitespace, then report an error. | |
979 | * Otherwise the line was effectively blank, so run the test. | |
980 | */ | |
882a39c1 MW |
981 | if (ch == EOF) goto end; |
982 | else if (ch == ';') tvec_flushtoeol(tv, TVFF_ALLOWANY); | |
983 | else if (tvec_flushtoeol(tv, 0)) rc = -1; | |
e63124bc | 984 | else check(tv, &g); |
31d0247c MW |
985 | } else { |
986 | /* Some non-whitespace thing. */ | |
987 | ||
988 | /* Put the character back and read a word, which ought to be a | |
989 | * register name. | |
990 | */ | |
b64eb60f | 991 | ungetc(ch, tv->fp); |
882a39c1 MW |
992 | DRESET(&d); |
993 | if (tvec_readword(tv, &d, "=:;", "register name")) goto flush_line; | |
31d0247c MW |
994 | |
995 | /* Now there should be a separator. */ | |
b64eb60f | 996 | tvec_skipspc(tv); ch = getc(tv->fp); |
882a39c1 MW |
997 | if (ch != '=' && ch != ':') |
998 | { tvec_syntax(tv, ch, "`=' or `:'"); goto flush_line; } | |
b64eb60f | 999 | tvec_skipspc(tv); |
31d0247c MW |
1000 | |
1001 | /* If there's no test, then report an error. Set the muffle flag, | |
1002 | * because there's no point in complaining about every assignment | |
1003 | * in this block. | |
1004 | */ | |
1005 | if (!tv->test) { | |
1006 | if (!(tv->f&TVSF_MUFFLE)) tvec_error(tv, "no current test"); | |
1007 | tv->f |= TVSF_MUFFLE; goto flush_line; | |
1008 | } | |
1009 | ||
1010 | /* Open the test. This is syntactically a stanza of settings, so | |
1011 | * it's fair to report on missing register assignments. | |
1012 | */ | |
1013 | open_test(tv); | |
1014 | ||
b64eb60f | 1015 | if (d.buf[0] == '@') { |
31d0247c | 1016 | /* A special register assignment. */ |
e63124bc | 1017 | env = tv->test->env; |
31d0247c MW |
1018 | |
1019 | /* See if it's one of the core settings. */ | |
20ba6b0b | 1020 | if (STRCMP(d.buf, ==, "@outcome")) { |
31d0247c MW |
1021 | |
1022 | /* Parse the value. */ | |
20ba6b0b MW |
1023 | if (tvty_uenum.parse(&rv, &outcome_regdef, tv)) |
1024 | ret = -1; | |
1025 | else { | |
31d0247c MW |
1026 | |
1027 | /* Act on the result. */ | |
1028 | if (rv.u == XFAIL) tvec_xfail(tv); | |
20ba6b0b MW |
1029 | ret = 1; |
1030 | } | |
31d0247c MW |
1031 | } |
1032 | ||
1033 | /* If there's no environment, this is an unknown setting. */ | |
1034 | else if (!env || !env->set) ret = 0; | |
1035 | ||
1036 | /* Otherwise pass the setting on to the environment. */ | |
1037 | else ret = env->set(tv, d.buf, g.ctx); | |
1038 | ||
1039 | /* If it wasn't understood, report an error and flush. */ | |
e63124bc MW |
1040 | if (ret <= 0) { |
1041 | if (!ret) | |
1042 | tvec_error(tv, "unknown special register `%s'", d.buf); | |
882a39c1 MW |
1043 | goto flush_line; |
1044 | } | |
b64eb60f | 1045 | } else { |
31d0247c MW |
1046 | /* A standard register. */ |
1047 | ||
1048 | /* Find the definition. */ | |
b64eb60f MW |
1049 | for (rd = tv->test->regs; rd->name; rd++) |
1050 | if (STRCMP(rd->name, ==, d.buf)) goto found_reg; | |
1051 | tvec_error(tv, "unknown register `%s' for test `%s'", | |
1052 | d.buf, tv->test->name); | |
882a39c1 | 1053 | goto flush_line; |
31d0247c | 1054 | |
b64eb60f | 1055 | found_reg: |
31d0247c | 1056 | /* Complain if the register is already set. */ |
b64eb60f | 1057 | r = TVEC_REG(tv, in, rd->i); |
31d0247c MW |
1058 | if (r->f&TVRF_LIVE) |
1059 | { tvec_dupreg(tv, rd->name); goto flush_line; } | |
1060 | ||
1061 | /* Parse a value and mark the register as live. */ | |
882a39c1 MW |
1062 | if (rd->ty->parse(&r->v, rd, tv)) goto flush_line; |
1063 | r->f |= TVRF_LIVE; | |
b64eb60f MW |
1064 | } |
1065 | } | |
1066 | break; | |
1067 | } | |
882a39c1 MW |
1068 | continue; |
1069 | ||
1070 | flush_line: | |
31d0247c MW |
1071 | /* This is a general parse-failure handler. Skip to the next line and |
1072 | * remember that things didn't go so well. | |
1073 | */ | |
882a39c1 | 1074 | tvec_flushtoeol(tv, TVFF_ALLOWANY); rc = -1; |
b64eb60f | 1075 | } |
31d0247c MW |
1076 | |
1077 | /* We reached the end. If that was actually an I/O error then report it. | |
1078 | */ | |
882a39c1 MW |
1079 | if (ferror(tv->fp)) |
1080 | { tvec_error(tv, "error reading input: %s", strerror(errno)); rc = -1; } | |
31d0247c | 1081 | |
b64eb60f | 1082 | end: |
31d0247c MW |
1083 | /* Process the final test, if there was one, and wrap up the final |
1084 | * group. | |
1085 | */ | |
e63124bc | 1086 | end_test_group(tv, &g); |
31d0247c MW |
1087 | |
1088 | /* Clean up. */ | |
b64eb60f MW |
1089 | tv->infile = 0; tv->fp = 0; |
1090 | dstr_destroy(&d); | |
882a39c1 | 1091 | return (rc); |
b64eb60f MW |
1092 | } |
1093 | ||
e63124bc | 1094 | /*----- Session lifecycle -------------------------------------------------*/ |
6999eaf7 | 1095 | |
31d0247c MW |
1096 | /* --- @tvec_begin@ --- * |
1097 | * | |
1098 | * Arguments: @struct tvec_state *tv_out@ = state structure to fill in | |
1099 | * @const struct tvec_config *config@ = test configuration | |
1100 | * @struct tvec_output *o@ = output driver | |
1101 | * | |
1102 | * Returns: --- | |
1103 | * | |
1104 | * Use: Initialize a state structure ready to do some testing. | |
1105 | */ | |
1106 | ||
e63124bc | 1107 | void tvec_begin(struct tvec_state *tv_out, |
c5e0e403 | 1108 | const struct tvec_config *config, |
e63124bc MW |
1109 | struct tvec_output *o) |
1110 | { | |
1111 | unsigned i; | |
6999eaf7 | 1112 | |
e63124bc | 1113 | tv_out->f = 0; |
6999eaf7 | 1114 | |
c5e0e403 MW |
1115 | assert(config->nrout <= config->nreg); |
1116 | tv_out->nrout = config->nrout; tv_out->nreg = config->nreg; | |
1117 | tv_out->regsz = config->regsz; | |
e63124bc MW |
1118 | tv_out->in = xmalloc(tv_out->nreg*tv_out->regsz); |
1119 | tv_out->out = xmalloc(tv_out->nrout*tv_out->regsz); | |
1120 | for (i = 0; i < tv_out->nreg; i++) { | |
1121 | TVEC_REG(tv_out, in, i)->f = 0; | |
1122 | if (i < tv_out->nrout) TVEC_REG(tv_out, out, i)->f = 0; | |
1123 | } | |
6999eaf7 | 1124 | |
e63124bc MW |
1125 | for (i = 0; i < TVOUT_LIMIT; i++) |
1126 | tv_out->curr[i] = tv_out->all[i] = tv_out->grps[i] = 0; | |
6999eaf7 | 1127 | |
c5e0e403 | 1128 | tv_out->tests = config->tests; tv_out->test = 0; |
e63124bc | 1129 | tv_out->infile = 0; tv_out->lno = 0; tv_out->fp = 0; |
3efcfd2d | 1130 | tv_out->output = o; tv_out->output->ops->bsession(tv_out->output, tv_out); |
e63124bc | 1131 | } |
6999eaf7 | 1132 | |
31d0247c MW |
1133 | /* --- @tvec_end@ --- * |
1134 | * | |
1135 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
1136 | * | |
1137 | * Returns: A proposed exit code. | |
1138 | * | |
1139 | * Use: Conclude testing and suggests an exit code to be returned to | |
1140 | * the calling program. (The exit code comes from the output | |
1141 | * driver's @esession@ method.) | |
1142 | */ | |
1143 | ||
e63124bc MW |
1144 | int tvec_end(struct tvec_state *tv) |
1145 | { | |
1146 | int rc = tv->output->ops->esession(tv->output); | |
6999eaf7 | 1147 | |
31d0247c | 1148 | if (tv->test) tvec_releaseregs(tv); |
e63124bc MW |
1149 | tv->output->ops->destroy(tv->output); |
1150 | xfree(tv->in); xfree(tv->out); | |
1151 | return (rc); | |
6999eaf7 MW |
1152 | } |
1153 | ||
e63124bc MW |
1154 | /*----- Serialization and deserialization ---------------------------------*/ |
1155 | ||
31d0247c MW |
1156 | /* --- @tvec_serialize@ --- * |
1157 | * | |
1158 | * Arguments: @const struct tvec_reg *rv@ = vector of registers | |
1159 | * @buf *b@ = buffer to write on | |
1160 | * @const struct tvec_regdef *regs@ = vector of register | |
1161 | * descriptions, terminated by an entry with a null | |
1162 | * @name@ slot | |
1163 | * @unsigned nr@ = number of entries in the @rv@ vector | |
1164 | * @size_t regsz@ = true size of each element of @rv@ | |
1165 | * | |
1166 | * Returns: Zero on success, @-1@ on failure. | |
1167 | * | |
1168 | * Use: Serialize a collection of register values. | |
1169 | * | |
1170 | * The serialized output is written to the buffer @b@. Failure | |
1171 | * can be caused by running out of buffer space, or a failing | |
1172 | * type handler. | |
1173 | */ | |
1174 | ||
e63124bc MW |
1175 | int tvec_serialize(const struct tvec_reg *rv, buf *b, |
1176 | const struct tvec_regdef *regs, | |
1177 | unsigned nr, size_t regsz) | |
6999eaf7 | 1178 | { |
e63124bc MW |
1179 | unsigned char *bitmap; |
1180 | size_t i, bitoff, nbits, bitsz; | |
1181 | const struct tvec_regdef *rd; | |
1182 | const struct tvec_reg *r; | |
6999eaf7 | 1183 | |
e63124bc MW |
1184 | bitoff = BLEN(b); |
1185 | for (rd = regs, nbits = 0; rd->name; rd++, nbits++); | |
1186 | bitsz = (nbits + 7)/8; | |
6999eaf7 | 1187 | |
e63124bc MW |
1188 | bitmap = buf_get(b, bitsz); if (!bitmap) return (-1); |
1189 | memset(bitmap, 0, bitsz); | |
1190 | for (rd = regs, i = 0; rd->name; rd++, i++) { | |
1191 | if (rd->i >= nr) continue; | |
1192 | r = TVEC_GREG(rv, rd->i, regsz); if (!(r->f&TVRF_LIVE)) continue; | |
c91413e6 | 1193 | bitmap = BBASE(b) + bitoff; bitmap[i/8] |= 1 << i%8; |
e63124bc MW |
1194 | if (rd->ty->tobuf(b, &r->v, rd)) return (-1); |
1195 | } | |
1196 | return (0); | |
1197 | } | |
6999eaf7 | 1198 | |
31d0247c MW |
1199 | /* --- @tvec_deserialize@ --- * |
1200 | * | |
1201 | * Arguments: @struct tvec_reg *rv@ = vector of registers | |
1202 | * @buf *b@ = buffer to write on | |
1203 | * @const struct tvec_regdef *regs@ = vector of register | |
1204 | * descriptions, terminated by an entry with a null | |
1205 | * @name@ slot | |
1206 | * @unsigned nr@ = number of entries in the @rv@ vector | |
1207 | * @size_t regsz@ = true size of each element of @rv@ | |
1208 | * | |
1209 | * Returns: Zero on success, @-1@ on failure. | |
1210 | * | |
1211 | * Use: Deserialize a collection of register values. | |
1212 | * | |
1213 | * The size of the register vector @nr@ and the register | |
1214 | * definitions @regs@ must match those used when producing the | |
1215 | * serialization. For each serialized register value, | |
1216 | * deserialize and store the value into the appropriate register | |
1217 | * slot, and set the @TVRF_LIVE@ flag on the register. See | |
1218 | * @tvec_serialize@ for a description of the format. | |
1219 | * | |
1220 | * Failure results only from a failing register type handler. | |
1221 | */ | |
1222 | ||
e63124bc MW |
1223 | int tvec_deserialize(struct tvec_reg *rv, buf *b, |
1224 | const struct tvec_regdef *regs, | |
1225 | unsigned nr, size_t regsz) | |
1226 | { | |
1227 | const unsigned char *bitmap; | |
1228 | size_t i, nbits, bitsz; | |
1229 | const struct tvec_regdef *rd; | |
1230 | struct tvec_reg *r; | |
6999eaf7 | 1231 | |
e63124bc MW |
1232 | for (rd = regs, nbits = 0; rd->name; rd++, nbits++); |
1233 | bitsz = (nbits + 7)/8; | |
6999eaf7 | 1234 | |
e63124bc MW |
1235 | bitmap = buf_get(b, bitsz); if (!bitmap) return (-1); |
1236 | for (rd = regs, i = 0; rd->name; rd++, i++) { | |
1237 | if (rd->i >= nr) continue; | |
c91413e6 | 1238 | if (!(bitmap[i/8]&(1 << i%8))) continue; |
e63124bc MW |
1239 | r = TVEC_GREG(rv, rd->i, regsz); |
1240 | if (rd->ty->frombuf(b, &r->v, rd)) return (-1); | |
1241 | r->f |= TVRF_LIVE; | |
1242 | } | |
6999eaf7 MW |
1243 | return (0); |
1244 | } | |
1245 | ||
b64eb60f MW |
1246 | /*----- Ad-hoc testing ----------------------------------------------------*/ |
1247 | ||
1248 | static const struct tvec_regdef no_regs = { 0, 0, 0, 0, { 0 } }; | |
1249 | ||
b64eb60f MW |
1250 | static void fakefn(const struct tvec_reg *in, struct tvec_reg *out, void *p) |
1251 | { assert(!"fake test function"); } | |
1252 | ||
31d0247c MW |
1253 | /* --- @tvec_adhoc@ --- * |
1254 | * | |
1255 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
1256 | * @struct tvec_test *t@ = space for a test definition | |
1257 | * | |
1258 | * Returns: --- | |
1259 | * | |
1260 | * Use: Begin ad-hoc testing, i.e., without reading a file of | |
1261 | * test-vector data. | |
1262 | * | |
1263 | * The structure at @t@ will be used to record information about | |
1264 | * the tests underway, which would normally come from a static | |
1265 | * test definition. The other functions in this section assume | |
1266 | * that @tvec_adhoc@ has been called. | |
1267 | */ | |
1268 | ||
b64eb60f MW |
1269 | void tvec_adhoc(struct tvec_state *tv, struct tvec_test *t) |
1270 | { | |
e63124bc | 1271 | t->name = "<unset>"; t->regs = &no_regs; t->env = 0; t->fn = fakefn; |
b64eb60f MW |
1272 | tv->tests = t; |
1273 | } | |
1274 | ||
31d0247c MW |
1275 | /* --- @tvec_begingroup@ --- * |
1276 | * | |
1277 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
1278 | * @const char *name@ = name for this test group | |
1279 | * @const char *file@, @unsigned @lno@ = calling file and line | |
1280 | * | |
1281 | * Returns: --- | |
1282 | * | |
1283 | * Use: Begin an ad-hoc test group with the given name. The @file@ | |
1284 | * and @lno@ can be anything, but it's usually best if they | |
1285 | * refer to the source code performing the test: the macro | |
1286 | * @TVEC_BEGINGROUP@ does this automatically. | |
1287 | */ | |
1288 | ||
b64eb60f MW |
1289 | void tvec_begingroup(struct tvec_state *tv, const char *name, |
1290 | const char *file, unsigned lno) | |
1291 | { | |
1292 | struct tvec_test *t = (/*unconst*/ struct tvec_test *)tv->tests; | |
1293 | ||
1294 | t->name = name; tv->test = t; | |
1295 | tv->infile = file; tv->lno = tv->test_lno = lno; | |
e63124bc | 1296 | begin_test_group(tv, 0); |
b64eb60f MW |
1297 | } |
1298 | ||
31d0247c MW |
1299 | /* --- @tvec_endgroup@ --- * |
1300 | * | |
1301 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
1302 | * | |
1303 | * Returns: --- | |
1304 | * | |
1305 | * Use: End an ad-hoc test group. The statistics are updated and the | |
1306 | * outcome is reported to the output formatter. | |
1307 | */ | |
1308 | ||
b64eb60f MW |
1309 | void tvec_endgroup(struct tvec_state *tv) |
1310 | { | |
3efcfd2d | 1311 | if (!(tv->f&TVSF_SKIP)) report_group(tv); |
b64eb60f MW |
1312 | tv->test = 0; |
1313 | } | |
1314 | ||
31d0247c MW |
1315 | /* --- @tvec_begintest@ --- * |
1316 | * | |
1317 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
1318 | * @const char *file@, @unsigned @lno@ = calling file and line | |
1319 | * | |
1320 | * Returns: --- | |
1321 | * | |
1322 | * Use: Begin an ad-hoc test case. The @file@ and @lno@ can be | |
1323 | * anything, but it's usually best if they refer to the source | |
1324 | * code performing the test: the macro @TVEC_BEGINGROUP@ does | |
1325 | * this automatically. | |
1326 | */ | |
1327 | ||
b64eb60f MW |
1328 | void tvec_begintest(struct tvec_state *tv, const char *file, unsigned lno) |
1329 | { | |
1330 | tv->infile = file; tv->lno = tv->test_lno = lno; | |
31d0247c | 1331 | open_test(tv); begin_test(tv); |
b64eb60f MW |
1332 | } |
1333 | ||
1334 | struct adhoc_claim { | |
1335 | unsigned f; | |
1336 | #define ACF_FRESH 1u | |
1337 | const char *saved_file; unsigned saved_lno; | |
1338 | }; | |
1339 | ||
1340 | static void adhoc_claim_setup(struct tvec_state *tv, | |
1341 | struct adhoc_claim *ck, | |
1342 | const struct tvec_regdef *regs, | |
1343 | const char *file, unsigned lno) | |
1344 | { | |
1345 | struct tvec_test *t = (/*unconst*/ struct tvec_test *)tv->test; | |
1346 | ||
1347 | ck->f = 0; | |
1348 | ||
1349 | if (!(tv->f&TVSF_OPEN)) | |
1350 | { ck->f |= ACF_FRESH; tvec_begintest(tv, file, lno); } | |
1351 | ||
1352 | ck->saved_file = tv->infile; if (file) tv->infile = file; | |
1353 | ck->saved_lno = tv->test_lno; if (file) tv->test_lno = lno; | |
1354 | t->regs = regs ? regs : &no_regs; | |
b64eb60f MW |
1355 | } |
1356 | ||
1357 | static void adhoc_claim_teardown(struct tvec_state *tv, | |
1358 | struct adhoc_claim *ck) | |
1359 | { | |
1360 | struct tvec_test *t = (/*unconst*/ struct tvec_test *)tv->test; | |
1361 | ||
1362 | t->regs = &no_regs; | |
1363 | tv->infile = ck->saved_file; tv->test_lno = ck->saved_lno; | |
1364 | ||
1365 | if (ck->f&ACF_FRESH) tvec_endtest(tv); | |
1366 | } | |
1367 | ||
31d0247c MW |
1368 | /* --- @tvec_claim@, @tvec_claim_v@, @TVEC_CLAIM@ --- * |
1369 | * | |
1370 | * Arguments: @struct tvec_state *tv@ = test-vector state | |
1371 | * @int ok@ = a flag | |
1372 | * @const char *file@, @unsigned @lno@ = calling file and line | |
1373 | * @const char *msg@, @va_list *ap@ = message to report on | |
1374 | * failure | |
1375 | * | |
1376 | * Returns: The value @ok@. | |
1377 | * | |
1378 | * Use: Check that a claimed condition holds, as (part of) a test. | |
1379 | * If no test case is underway (i.e., if @TVSF_OPEN@ is reset in | |
1380 | * @tv->f@), then a new test case is begun and ended. The | |
1381 | * @file@ and @lno@ are passed to the output formatter to be | |
1382 | * reported in case of a failure. If @ok@ is nonzero, then | |
1383 | * nothing else happens; so, in particular, if @tvec_claim@ | |
1384 | * established a new test case, then the test case succeeds. If | |
1385 | * @ok@ is zero, then a failure is reported, quoting @msg@. | |
1386 | * | |
1387 | * The @TVEC_CLAIM@ macro is similar, only it (a) identifies the | |
1388 | * file and line number of the call site automatically, and (b) | |
1389 | * implicitly quotes the source text of the @ok@ condition in | |
1390 | * the failure message. | |
1391 | */ | |
1392 | ||
3efcfd2d MW |
1393 | int tvec_claim_v(struct tvec_state *tv, int ok, |
1394 | const char *file, unsigned lno, | |
1395 | const char *msg, va_list *ap) | |
b64eb60f MW |
1396 | { |
1397 | struct adhoc_claim ck; | |
b64eb60f MW |
1398 | |
1399 | adhoc_claim_setup(tv, &ck, 0, file, lno); | |
3efcfd2d | 1400 | if (!ok) tvec_fail_v(tv, msg, ap); |
b64eb60f MW |
1401 | adhoc_claim_teardown(tv, &ck); |
1402 | return (ok); | |
1403 | } | |
1404 | ||
3efcfd2d MW |
1405 | int tvec_claim(struct tvec_state *tv, int ok, |
1406 | const char *file, unsigned lno, const char *msg, ...) | |
1407 | { | |
1408 | va_list ap; | |
1409 | ||
1410 | va_start(ap, msg); tvec_claim_v(tv, ok, file, lno, msg, &ap); va_end(ap); | |
1411 | return (ok); | |
1412 | } | |
1413 | ||
b64eb60f MW |
1414 | int tvec_claimeq(struct tvec_state *tv, |
1415 | const struct tvec_regty *ty, const union tvec_misc *arg, | |
1416 | const char *file, unsigned lno, const char *expr) | |
1417 | { | |
1418 | struct tvec_regdef regs[2]; | |
1419 | struct adhoc_claim ck; | |
1420 | int ok; | |
1421 | ||
1422 | tv->in[0].f = tv->out[0].f = TVRF_LIVE; | |
1423 | ||
1424 | regs[0].name = "value"; regs[0].i = 0; | |
1425 | regs[0].ty = ty; regs[0].f = 0; | |
1426 | if (arg) regs[0].arg = *arg; | |
1427 | else regs[0].arg.p = 0; | |
1428 | ||
1429 | regs[1].name = 0; | |
1430 | ||
1431 | adhoc_claim_setup(tv, &ck, regs, file, lno); | |
1432 | ok = ty->eq(&tv->in[0].v, &tv->out[0].v, ®s[0]); | |
e63124bc | 1433 | if (!ok) |
c91413e6 | 1434 | { tvec_fail(tv, "%s", expr); tvec_mismatch(tv, TVMF_IN | TVMF_OUT); } |
b64eb60f MW |
1435 | adhoc_claim_teardown(tv, &ck); |
1436 | return (ok); | |
1437 | } | |
1438 | ||
b64eb60f | 1439 | /*----- That's all, folks -------------------------------------------------*/ |