5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is furnished to do
10 * so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #include <sys/types.h>
28 bool opts_memchk = true;
29 bool opts_debug = false;
36 * TODO: Windows version
37 * this implements a unique bi-directional popen-like function that
38 * allows reading data from both stdout and stderr. And writing to
42 * FILE *handles[3] = task_popen("ls", "-l", "r");
43 * if (!handles) { perror("failed to open stdin/stdout/stderr to ls");
44 * // handles[0] = stdin
45 * // handles[1] = stdout
46 * // handles[2] = stderr
48 * task_pclose(handles); // to close
51 #include <sys/types.h>
64 FILE ** task_popen(const char *command, const char *mode) {
70 popen_t *data = mem_a(sizeof(popen_t));
73 * Parse the command now into a list for execv, this is a pain
76 char *line = (char*)command;
80 while (*line != '\0') {
81 while (*line == ' ' || *line == '\t' || *line == '\n')
85 while (*line != '\0' && *line != ' ' &&
86 *line != '\t' && *line != '\n') line++;
92 if ((trypipe = pipe(inhandle)) < 0) goto task_popen_error_0;
93 if ((trypipe = pipe(outhandle)) < 0) goto task_popen_error_1;
94 if ((trypipe = pipe(errhandle)) < 0) goto task_popen_error_2;
96 if ((data->pid = fork()) > 0) {
100 close(errhandle [1]);
102 data->pipes [0] = inhandle [1];
103 data->pipes [1] = outhandle[0];
104 data->pipes [2] = errhandle[0];
105 data->handles[0] = fdopen(inhandle [1], "w");
106 data->handles[1] = fdopen(outhandle[0], mode);
107 data->handles[2] = fdopen(errhandle[0], mode);
112 return data->handles;
113 } else if (data->pid == 0) {
119 /* see piping documentation for this sillyness :P */
120 close(0), dup(inhandle [0]);
121 close(1), dup(outhandle[1]);
122 close(2), dup(errhandle[1]);
128 goto task_popen_error_3;
133 return data->handles;
135 task_popen_error_3: close(errhandle[0]), close(errhandle[1]);
136 task_popen_error_2: close(outhandle[0]), close(outhandle[1]);
137 task_popen_error_1: close(inhandle [0]), close(inhandle [1]);
145 int task_pclose(FILE **handles) {
146 popen_t *data = (popen_t*)handles;
149 close(data->pipes[0]); /* stdin */
150 close(data->pipes[1]); /* stdout */
151 close(data->pipes[2]); /* stderr */
153 waitpid(data->pid, &status, 0);
161 #define TASK_COMPILE 0
162 #define TASK_EXECUTE 1
165 * Task template system:
166 * templates are rules for a specific test, used to create a "task" that
167 * is executed with those set of rules (arguments, and what not). Tests
168 * that don't have a template with them cannot become tasks, since without
169 * the information for that test there is no way to properly "test" them.
170 * Rules for these templates are described in a template file, using a
171 * task template language.
173 * The language is a basic finite statemachine, top-down single-line
174 * description language.
176 * The languge is composed entierly of "tags" which describe a string of
177 * text for a task. Think of it much like a configuration file. Except
178 * it's been designed to allow flexibility and future support for prodecual
181 * The following "tags" are suported by the language
184 * Used to set a description of the current test, this must be
185 * provided, this tag is NOT optional.
188 * Used to set a failure message, this message will be displayed
189 * if the test fails, this tag is optional
192 * Used to set a success message, this message will be displayed
193 * if the test succeeds, this tag is optional.
196 * Used to set the procedure for the given task, there are two
199 * This simply performs compilation only
201 * This will perform compilation and execution
203 * This must be provided, this tag is NOT optional.
206 * Used to set the compilation flags for the given task, this
207 * must be provided, this tag is NOT optional.
210 * Used to set the execution flags for the given task. This tag
211 * must be provided if T == -execute, otherwise it's erroneous
212 * as compilation only takes place.
215 * Used to describe a string of text that should be matched from
216 * the output of executing the task. If this doesn't match the
217 * task fails. This tag must be provided if T == -execute, otherwise
218 * it's erroneous as compilation only takes place.
221 * Used to specify the INPUT source file to operate on, this must be
222 * provided, this tag is NOT optional
226 * These tags have one-time use, using them more than once will result
227 * in template compilation errors.
229 * Lines beginning with # or // in the template file are comments and
230 * are ignored by the template parser.
232 * Whitespace is optional, with exception to the colon ':' between the
233 * tag and it's assignment value/
235 * The template compiler will detect erronrous tags (optional tags
236 * that need not be set), as well as missing tags, and error accordingly
237 * this will result in the task failing.
241 char *failuremessage;
242 char *successmessage;
252 * This is very much like a compiler code generator :-). This generates
253 * a value from some data observed from the compiler.
255 bool task_template_generate(task_template_t *template, char tag, const char *file, size_t line, const char *value) {
256 char **destval = NULL;
262 case 'D': destval = &template->description; break;
263 case 'F': destval = &template->failuremessage; break;
264 case 'S': destval = &template->successmessage; break;
265 case 'T': destval = &template->proceduretype; break;
266 case 'C': destval = &template->compileflags; break;
267 case 'E': destval = &template->executeflags; break;
268 case 'M': destval = &template->comparematch; break;
269 case 'I': destval = &template->sourcefile; break;
271 con_printmsg(LVL_ERROR, __FILE__, __LINE__, "internal error",
272 "invalid tag `%c:` during code generation\n",
279 * Ensure if for the given tag, there already exists a
283 con_printmsg(LVL_ERROR, file, line, "compile error",
284 "tag `%c:` already assigned value: %s\n",
291 * Strip any whitespace that might exist in the value for assignments
294 if (value && *value && (*value == ' ' || *value == '\t'))
298 * Value will contain a newline character at the end, we need to strip
299 * this otherwise kaboom, seriously, kaboom :P
301 *strrchr(value, '\n')='\0';
304 * Now allocate and set the actual value for the specific tag. Which
305 * was properly selected and can be accessed with *destval.
307 *destval = util_strdup(value);
312 bool task_template_parse(const char *file, task_template_t *template, FILE *fp) {
321 /* top down parsing */
322 while (util_getline(&back, &size, fp) != EOF) {
323 /* skip whitespace */
325 if (*data && (*data == ' ' || *data == '\t'))
330 * Handle comments inside task template files. We're strict
331 * about the language for fun :-)
334 if (data[1] != '/') {
335 con_printmsg(LVL_ERROR, file, line, "template parse error",
336 "invalid character `/`, perhaps you meant `//` ?");
345 * Empty newlines are acceptable as well, so we handle that here
346 * despite being just odd since there should't be that many
347 * empty lines to begin with.
355 * Now begin the actual "tag" stuff. This works as you expect
366 if (data[1] != ':') {
367 con_printmsg(LVL_ERROR, file, line, "template parse error",
368 "expected `:` after `%c`",
373 if (!task_template_generate(template, *data, file, line, &data[3])) {
374 con_printmsg(LVL_ERROR, file, line, "template compile error",
375 "failed to generate for given task\n"
382 con_printmsg(LVL_ERROR, file, line, "template parse error",
383 "invalid tag `%c`", *data
386 /* no break required */
389 /* update line and free old sata */
405 * Nullifies the template data: used during initialization of a new
408 void task_template_nullify(task_template_t *template) {
412 template->description = NULL;
413 template->failuremessage = NULL;
414 template->successmessage = NULL;
415 template->proceduretype = NULL;
416 template->compileflags = NULL;
417 template->executeflags = NULL;
418 template->comparematch = NULL;
419 template->sourcefile = NULL;
420 template->tempfilename = NULL;
423 task_template_t *task_template_compile(const char *file, const char *dir) {
424 /* a page should be enough */
426 FILE *tempfile = NULL;
427 task_template_t *template = NULL;
429 memset (fullfile, 0, sizeof(fullfile));
430 snprintf(fullfile, sizeof(fullfile), "%s/%s", dir, file);
432 tempfile = fopen(fullfile, "r");
433 template = mem_a(sizeof(task_template_t));
434 task_template_nullify(template);
437 * Esnure the file even exists for the task, this is pretty useless
441 con_err("template file: %s does not exist or invalid permissions\n",
447 if (!task_template_parse(file, template, tempfile)) {
448 con_err("template parse error: error during parsing\n");
453 * Regardless procedure type, the following tags must exist:
459 if (!template->description) {
460 con_err("template compile error: %s missing `D:` tag\n", file);
463 if (!template->proceduretype) {
464 con_err("template compile error: %s missing `T:` tag\n", file);
467 if (!template->compileflags) {
468 con_err("template compile error: %s missing `C:` tag\n", file);
471 if (!template->sourcefile) {
472 con_err("template compile error: %s missing `I:` tag\n", file);
477 * Now lets compile the template, compilation is really just
478 * the process of validating the input.
480 if (!strcmp(template->proceduretype, "-compile")) {
481 if (template->executeflags)
482 con_err("template compile warning: %s erroneous tag `E:` when only compiling\n", file);
483 if (template->comparematch)
484 con_err("template compile warning: %s erroneous tag `M:` when only compiling\n", file);
486 } else if (!strcmp(template->proceduretype, "-execute")) {
487 if (!template->executeflags) {
488 con_err("template compile error: %s missing `E:` tag (use `$null` for exclude)\n", file);
491 if (!template->comparematch) {
492 con_err("template compile error: %s missing `M:` tag (use `$null` for exclude)\n", file);
496 con_err("template compile error: %s invalid procedure type: %s\n", file, template->proceduretype);
506 * The file might not exist and we jump here when that doesn't happen
507 * so the check to see if it's not null here is required.
516 void task_template_destroy(task_template_t **template) {
520 if ((*template)->description) mem_d((*template)->description);
521 if ((*template)->failuremessage) mem_d((*template)->failuremessage);
522 if ((*template)->successmessage) mem_d((*template)->successmessage);
523 if ((*template)->proceduretype) mem_d((*template)->proceduretype);
524 if ((*template)->compileflags) mem_d((*template)->compileflags);
525 if ((*template)->executeflags) mem_d((*template)->executeflags);
526 if ((*template)->comparematch) mem_d((*template)->comparematch);
527 if ((*template)->sourcefile) mem_d((*template)->sourcefile);
530 * Nullify all the template members otherwise NULL comparision
531 * checks will fail if template pointer is reused.
534 task_template_nullify(*template);
539 * Now comes the task manager, this system allows adding tasks in and out
540 * of a task list. This is the executor of the tasks essentially as well.
543 task_template_t *template;
549 task_t *task_tasks = NULL;
552 * Read a directory and searches for all template files in it
553 * which is later used to run all tests.
555 bool task_propogate(const char *curdir) {
558 struct dirent *files;
559 struct stat directory;
562 dir = opendir(curdir);
564 while ((files = readdir(dir))) {
565 memset (buffer, 0,sizeof(buffer));
566 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
568 if (stat(buffer, &directory) == -1) {
569 con_err("internal error: stat failed, aborting\n");
573 /* skip directories */
574 if (S_ISDIR(directory.st_mode))
578 * We made it here, which concludes the file/directory is not
579 * actually a directory, so it must be a file :)
581 if (strstr(files->d_name, ".tmpl")) {
582 con_out("compiling task template: %s/%s\n", curdir, files->d_name);
583 task_template_t *template = task_template_compile(files->d_name, curdir);
585 con_err("error compiling task template: %s\n", files->d_name);
590 * Generate a temportary file name for the output binary
591 * so we don't trample over an existing one.
593 template->tempfilename = tempnam(curdir, "TMPDAT");
596 * Generate the command required to open a pipe to a process
597 * which will be refered to with a handle in the task for
598 * reading the data from the pipe.
600 char buf[4096]; /* one page should be enough */
601 memset (buf,0,sizeof(buf));
602 snprintf(buf, sizeof(buf), "%s %s/%s %s -o %s",
603 task_bins[TASK_COMPILE],
605 template->sourcefile,
606 template->compileflags,
607 template->tempfilename
611 * The task template was compiled, now lets create a task from
612 * the template data which has now been propogated.
615 task.template = template;
616 if (!(task.runhandles = task_popen(buf, "r"))) {
617 con_err("error opening pipe to process for test: %s\n", template->description);
623 * Open up some file desciptors for logging the stdout/stderr
626 memset (buf,0,sizeof(buf));
627 snprintf(buf, sizeof(buf), "%s/%s.stdout", curdir, template->sourcefile);
628 task.stderrlog = fopen(buf, "w");
630 memset (buf,0,sizeof(buf));
631 snprintf(buf, sizeof(buf), "%s/%s.stderr", curdir, template->sourcefile);
632 task.stdoutlog = fopen(buf, "w");
634 con_out("executing test: `%s` [%s]\n", template->description, buf);
636 vec_push(task_tasks, task);
645 * Removes all temporary 'progs.dat' files created during compilation
648 void task_cleanup(const char *curdir) {
650 struct dirent *files;
653 dir = opendir(curdir);
655 while ((files = readdir(dir))) {
656 memset(buffer, 0, sizeof(buffer));
657 if (strstr(files->d_name, "TMP")) {
658 snprintf(buffer, sizeof(buffer), "%s/%s", curdir, files->d_name);
660 con_err("error removing temporary file: %s\n", buffer);
662 con_out("removed temporary file: %s\n", buffer);
669 void task_destroy(const char *curdir) {
671 * Free all the data in the task list and finally the list itself
672 * then proceed to cleanup anything else outside the program like
676 for (i = 0; i < vec_size(task_tasks); i++) {
678 * Close any open handles to files or processes here. It's mighty
679 * annoying to have to do all this cleanup work.
681 if (task_tasks[i].runhandles) task_pclose(task_tasks[i].runhandles);
682 if (task_tasks[i].stdoutlog) fclose (task_tasks[i].stdoutlog);
683 if (task_tasks[i].stderrlog) fclose (task_tasks[i].stderrlog);
685 task_template_destroy(&task_tasks[i].template);
687 vec_free(task_tasks);
690 * Cleanup outside stuff like temporary files.
692 task_cleanup(curdir);
696 * This executes the QCVM task for a specificly compiled progs.dat
697 * using the template passed into it for call-flags and user defined
700 bool task_execute(task_template_t *template) {
701 bool success = false;
704 memset (buffer,0,sizeof(buffer));
707 * Drop the execution flags for the QCVM if none where
708 * actually specified.
710 if (!strcmp(template->executeflags, "$null")) {
711 snprintf(buffer, sizeof(buffer), "%s %s",
712 task_bins[TASK_EXECUTE],
713 template->tempfilename
716 snprintf(buffer, sizeof(buffer), "%s %s %s",
717 task_bins[TASK_EXECUTE],
718 template->executeflags,
719 template->tempfilename
723 con_out("executing qcvm: `%s` [%s]\n",
724 template->description,
728 execute = popen(buffer, "r");
733 * Now lets read the lines and compare them to the matches we expect
734 * and handle accordingly.
739 while (util_getline(&data, &size, execute) != EOF) {}
741 if (!strcmp(data, "No main function found\n")) {
742 con_err("test failure: `%s` [%s] (No main function found)\n",
743 template->description,
744 (template->failuremessage) ?
745 template->failuremessage : "unknown"
752 * Trim newlines from data since they will just break our
753 * ability to properly validate matches.
755 if (strrchr(data, '\n'))
756 *strrchr(data, '\n') = '\0';
759 if (!strcmp(template->comparematch, "$null"))
763 * We only care about the last line from the output for now
764 * implementing multi-line match is TODO.
766 if (!strcmp(data, template->comparematch))
774 * This schedualizes all tasks and actually runs them individually
775 * this is generally easy for just -compile variants. For compile and
776 * execution this takes more work since a task needs to be generated
777 * from thin air and executed INLINE.
779 void task_schedualize(const char *curdir) {
780 bool execute = false;
781 bool compiled = true;
787 for (i = 0; i < vec_size(task_tasks); i++) {
789 * Generate a task from thin air if it requires execution in
792 if (!strcmp(task_tasks[i].template->proceduretype, "-execute"))
796 * Read data from stdout first and pipe that stuff into a log file
797 * then we do the same for stderr.
799 while (util_getline(&data, &size, task_tasks[i].runhandles[1]) != EOF) {
801 fwrite(data, 1, size, task_tasks[i].stdoutlog);
803 while (util_getline(&data, &size, task_tasks[i].runhandles[2]) != EOF) {
807 * If a string contains an error we just dissalow execution
810 * TODO: make this more percise, e.g if we print a warning
811 * that refers to a variable named error, or something like
812 * that .. then this will blowup :P
814 if (strstr(data, "error")) {
818 fwrite(data, 1, size, task_tasks[i].stderrlog);
825 * If we can execute we do so after all data has been read and
826 * this paticular task has coupled execution in its procedure type
832 * If we made it here that concludes the task is to be executed
833 * in the virtual machine.
835 if (!task_execute(task_tasks[i].template)) {
836 con_err("test failure: `%s` [%s]\n",
837 task_tasks[i].template->description,
838 (task_tasks[i].template->failuremessage) ?
839 task_tasks[i].template->failuremessage : "unknown"
844 con_out("test succeed: `%s` [%s]\n",
845 task_tasks[i].template->description,
846 (task_tasks[i].template->successmessage) ?
847 task_tasks[i].template->successmessage : "unknown"
854 int main(int argc, char **argv) {
856 if (!task_propogate("tests")) {
857 con_err("error: failed to propogate tasks\n");
858 task_destroy("tests");
862 * If we made it here all tasks where propogated from their resultant
863 * template file. So we can start the FILO scheduler, this has been
864 * designed in the most thread-safe way possible for future threading
865 * it's designed to prevent lock contention, and possible syncronization
868 task_schedualize("tests");
869 task_destroy("tests");