tools/tesh/run_context.c

   1 /* run_context -- stuff in which TESH runs a command                        */
   2
   3 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include "tesh.h"
  10
  11 #include <signal.h>
  12 #include <sys/types.h>
  13 #include <sys/wait.h>
  14 #include <sys/stat.h>
  15 #include <unistd.h>
  16
  17 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(tesh);
  18
  19 int fg_job = 0;
  20 xbt_dynar_t bg_jobs = NULL;
  21 rctx_t armageddon_initiator = NULL;
  22 xbt_os_mutex_t armageddon_mutex = NULL;
  23 struct {
  24   int num;
  25   struct sigaction act;
  26 } oldact[3];                    /* SIGINT, SIGQUIT, SIGTERM */
  27
  28 xbt_os_thread_t sigwaiter_thread;
  29 xbt_os_mutex_t sigwaiter_mutex;
  30 xbt_os_cond_t sigwaiter_cond;
  31 int armageddon_requested = 0;
  32 int caught_signum = 0;
  33
  34 /*
  35  * Module management
  36  */
  37
  38 static void armageddon_sighandler(int signum)
  39 {
  40   xbt_os_mutex_acquire(sigwaiter_mutex);
  41   caught_signum = signum;
  42   armageddon_requested = 1;
  43   xbt_os_cond_signal(sigwaiter_cond);
  44   xbt_os_mutex_release(sigwaiter_mutex);
  45 }
  46
  47 static void *armageddon_sigwaiter(_XBT_GNUC_UNUSED void *arg)
  48 {
  49   xbt_os_mutex_acquire(sigwaiter_mutex);
  50   /* Inform main thread that it started. */
  51   xbt_os_cond_signal(sigwaiter_cond);
  52   /* Wait for ending signal... */
  53   xbt_os_cond_wait(sigwaiter_cond, sigwaiter_mutex);
  54   if (armageddon_requested) {
  55     XBT_ERROR("Test suite `%s': caught signal %d", testsuite_name, caught_signum);
  56     rctx_armageddon(rctx, 3);
  57   }
  58   xbt_os_mutex_release(sigwaiter_mutex);
  59   return NULL;
  60 }
  61
  62 static void wait_it(rctx_t rctx)
  63 {
  64   XBT_VERB("Join thread %p which were running background cmd <%s>",
  65         rctx->runner, rctx->filepos);
  66   xbt_os_thread_join(rctx->runner, NULL);
  67 }
  68
  69 static void kill_it(void *r)
  70 {
  71   rctx_t rctx = *(rctx_t *) r;
  72   wait_it(rctx);
  73   rctx_free(rctx);
  74 }
  75
  76 void rctx_init(void)
  77 {
  78   struct sigaction newact;
  79   int i;
  80   fg_job = 0;
  81   bg_jobs = xbt_dynar_new_sync(sizeof(rctx_t), kill_it);
  82   armageddon_mutex = xbt_os_mutex_init();
  83   armageddon_initiator = NULL;
  84   sigwaiter_mutex = xbt_os_mutex_init();
  85   sigwaiter_cond = xbt_os_cond_init();
  86   xbt_os_mutex_acquire(sigwaiter_mutex);
  87   sigwaiter_thread = xbt_os_thread_create("Armaggedon request waiter",
  88                                           armageddon_sigwaiter, NULL, NULL);
  89   /* Wait for thread to start... */
  90   xbt_os_cond_wait(sigwaiter_cond, sigwaiter_mutex);
  91   xbt_os_mutex_release(sigwaiter_mutex);
  92   memset(&newact, 0, sizeof(newact));
  93   newact.sa_handler = armageddon_sighandler;
  94   oldact[0].num = SIGINT;
  95   oldact[1].num = SIGQUIT;
  96   oldact[2].num = SIGTERM;
  97   for (i = 0; i < 3; i++)
  98     sigaction(oldact[i].num, &newact, &oldact[i].act);
  99 }
 100
 101 void rctx_exit(void)
 102 {
 103   int i;
 104   for (i = 0; i < 3; i++)
 105     sigaction(oldact[i].num, &oldact[i].act, NULL);
 106   xbt_os_cond_signal(sigwaiter_cond);
 107   xbt_os_thread_join(sigwaiter_thread, NULL);
 108   xbt_dynar_free(&bg_jobs);
 109   xbt_os_cond_destroy(sigwaiter_cond);
 110   xbt_os_mutex_destroy(sigwaiter_mutex);
 111   xbt_os_mutex_destroy(armageddon_mutex);
 112 }
 113
 114 void rctx_wait_bg(void)
 115 {
 116   /* Do not use xbt_dynar_free or it will lock the dynar, preventing armageddon
 117    * from working */
 118   while (xbt_dynar_length(bg_jobs)) {
 119     rctx_t rctx = xbt_dynar_getlast_as(bg_jobs, rctx_t);
 120     wait_it(rctx);
 121     xbt_dynar_pop(bg_jobs, &rctx);
 122     rctx_free(rctx);
 123   }
 124   xbt_dynar_reset(bg_jobs);
 125 }
 126
 127 static void rctx_armageddon_kill_one(rctx_t initiator, const char *filepos,
 128                                      rctx_t rctx)
 129 {
 130   if (rctx != initiator) {
 131     XBT_INFO("Kill <%s> because <%s> failed", rctx->filepos, filepos);
 132     xbt_os_mutex_acquire(rctx->interruption);
 133     if (!rctx->reader_done) {
 134       rctx->interrupted = 1;
 135       kill(rctx->pid, SIGTERM);
 136       usleep(100);
 137       kill(rctx->pid, SIGKILL);
 138     }
 139     xbt_os_mutex_release(rctx->interruption);
 140   }
 141 }
 142
 143 void rctx_armageddon(rctx_t initiator, int exitcode)
 144 {
 145   unsigned int cursor;
 146   rctx_t job;
 147   const char *filepos = initiator && initiator->filepos ?
 148       initiator->filepos : "(master)";
 149
 150   XBT_DEBUG("Armageddon request by <%s> (exit=%d)", filepos, exitcode);
 151   xbt_os_mutex_acquire(armageddon_mutex);
 152   if (armageddon_initiator != NULL) {
 153     XBT_VERB("Armageddon already started. Let it go");
 154     xbt_os_mutex_release(armageddon_mutex);
 155     return;
 156   }
 157   XBT_DEBUG("Armageddon request by <%s> got the lock. Let's go amok",
 158          filepos);
 159   armageddon_initiator = initiator;
 160   xbt_os_mutex_release(armageddon_mutex);
 161
 162   /* Kill foreground command */
 163   if (fg_job)
 164     rctx_armageddon_kill_one(initiator, filepos, rctx);
 165
 166   /* Kill any background commands */
 167   xbt_dynar_foreach(bg_jobs, cursor, job) {
 168     rctx_armageddon_kill_one(initiator, filepos, job);
 169   }
 170
 171   /* Give runner threads a chance to acknowledge the processes deaths */
 172   usleep(10000);
 173   /* Ensure that nobody is running rctx_wait on exit */
 174   if (fg_job)
 175     xbt_os_mutex_acquire(rctx->interruption);
 176   xbt_dynar_foreach(bg_jobs, cursor, job)
 177     xbt_os_mutex_acquire(job->interruption);
 178   XBT_VERB("Shut everything down!");
 179   exit(exitcode);
 180 }
 181
 182 /*
 183  * Memory management
 184  */
 185
 186 void rctx_empty(rctx_t rc)
 187 {
 188   int i;
 189   char **env_it;
 190   void *filepos;
 191
 192   if (rc->cmd)
 193     free(rc->cmd);
 194   rc->cmd = NULL;
 195   /* avoid race with rctx_armageddon log messages */
 196   filepos = rc->filepos;
 197   rc->filepos = NULL;
 198   if (filepos)
 199     free(filepos);
 200   for (i = 0, env_it = environ; *env_it; i++, env_it++);
 201   if (rc->env) {
 202     for (env_it = rctx->env + i; *env_it; env_it++)
 203       free(*env_it);
 204     free(rc->env);
 205   }
 206   rc->env_size = i + 1;
 207   rc->env = malloc(rc->env_size * sizeof(char *));
 208   memcpy(rc->env, environ, rc->env_size * sizeof(char *));
 209
 210   rc->is_empty = 1;
 211   rc->is_background = 0;
 212   rc->is_stoppable = 0;
 213   rc->output = e_output_check;
 214   rc->output_sort = 0;
 215   rc->brokenpipe = 0;
 216   rc->timeout = 0;
 217   rc->interrupted = 0;
 218   xbt_strbuff_empty(rc->input);
 219   xbt_strbuff_empty(rc->output_wanted);
 220   xbt_strbuff_empty(rc->output_got);
 221 }
 222
 223
 224 rctx_t rctx_new()
 225 {
 226   rctx_t res = xbt_new0(s_rctx_t, 1);
 227
 228   res->input = xbt_strbuff_new();
 229   res->output_sort = 0;
 230   res->output_wanted = xbt_strbuff_new();
 231   res->output_got = xbt_strbuff_new();
 232   res->interruption = xbt_os_mutex_init();
 233   rctx_empty(res);
 234   return res;
 235 }
 236
 237 void rctx_free(rctx_t rctx)
 238 {
 239   XBT_DEBUG("RCTX: Free %p", rctx);
 240   rctx_dump(rctx, "free");
 241   if (!rctx)
 242     return;
 243
 244   if (rctx->cmd)
 245     free(rctx->cmd);
 246   if (rctx->filepos)
 247     free(rctx->filepos);
 248   if (rctx->env) {
 249     int i;
 250     char **env_it;
 251     for (i = 0, env_it = environ; *env_it; i++, env_it++);
 252     for (env_it = rctx->env + i; *env_it; env_it++)
 253       free(*env_it);
 254     free(rctx->env);
 255   }
 256   xbt_os_mutex_destroy(rctx->interruption);
 257   xbt_strbuff_free(rctx->input);
 258   xbt_strbuff_free(rctx->output_got);
 259   xbt_strbuff_free(rctx->output_wanted);
 260   free(rctx);
 261 }
 262
 263 void rctx_dump(rctx_t rctx, const char *str)
 264 {
 265   XBT_DEBUG("%s RCTX %p={in%p={%d,%10s}, want={%d,%10s}, out={%d,%10s}}",
 266          str, rctx,
 267          rctx->input, rctx->input->used, rctx->input->data,
 268          rctx->output_wanted->used, rctx->output_wanted->data,
 269          rctx->output_got->used, rctx->output_got->data);
 270   XBT_DEBUG("%s RCTX %p=[cmd%p=%10s, pid=%d]",
 271          str, rctx, rctx->cmd, rctx->cmd, rctx->pid);
 272
 273 }
 274
 275 /*
 276  * Getting instructions from the file
 277  */
 278
 279 void rctx_pushline(const char *filepos, char kind, char *line)
 280 {
 281
 282   switch (kind) {
 283   case '$':
 284   case '&':
 285     if (rctx->cmd) {
 286       if (!rctx->is_empty) {
 287         XBT_ERROR
 288             ("[%s] More than one command in this chunk of lines (previous: %s).\n"
 289              " Cannot guess which input/output belongs to which command.",
 290              filepos, rctx->cmd);
 291         XBT_ERROR("Test suite `%s': NOK (syntax error)", testsuite_name);
 292         rctx_armageddon(rctx, 1);
 293         return;
 294       }
 295       rctx_start();
 296       XBT_VERB("[%s] More than one command in this chunk of lines", filepos);
 297     }
 298     if (kind == '&')
 299       rctx->is_background = 1;
 300     else
 301       rctx->is_background = 0;
 302
 303     rctx->cmd = xbt_strdup(line);
 304     rctx->filepos = xbt_strdup(filepos);
 305     if(option){
 306         rctx->cmd = bprintf("%s %s",rctx->cmd,option);
 307     }
 308     XBT_INFO("[%s] %s%s", filepos, rctx->cmd,
 309           ((rctx->is_background) ? " (background command)" : ""));
 310
 311     break;
 312
 313   case '<':
 314     rctx->is_empty = 0;
 315     xbt_strbuff_append(rctx->input, line);
 316     xbt_strbuff_append(rctx->input, "\n");
 317     break;
 318
 319   case '>':
 320     rctx->is_empty = 0;
 321     xbt_strbuff_append(rctx->output_wanted, line);
 322     xbt_strbuff_append(rctx->output_wanted, "\n");
 323     break;
 324
 325   case '!':
 326     if (rctx->cmd)
 327       rctx_start();
 328
 329     if (!strncmp(line, "timeout no", strlen("timeout no"))) {
 330       XBT_VERB("[%s] (disable timeout)", filepos);
 331       timeout_value = -1;
 332     } else if (!strncmp(line, "timeout ", strlen("timeout "))) {
 333       timeout_value = atoi(line + strlen("timeout"));
 334       XBT_VERB("[%s] (new timeout value: %d)", filepos, timeout_value);
 335
 336     } else if (!strncmp(line, "expect signal ", strlen("expect signal "))) {
 337       rctx->expected_signal = strdup(line + strlen("expect signal "));
 338       xbt_str_trim(rctx->expected_signal, " \n");
 339       XBT_VERB("[%s] (next command must raise signal %s)",
 340             filepos, rctx->expected_signal);
 341
 342     } else if (!strncmp(line, "expect return ", strlen("expect return "))) {
 343       rctx->expected_return = atoi(line + strlen("expect return "));
 344       XBT_VERB("[%s] (next command must return code %d)",
 345             filepos, rctx->expected_return);
 346
 347     } else if (!strncmp(line, "output sort", strlen("output sort"))) {
 348       sort_len = atoi(line + strlen("output sort"));
 349       if (sort_len==0)
 350         sort_len=SORT_LEN_DEFAULT;
 351       rctx->output_sort = 1;
 352       XBT_VERB("[%s] (sort output of next command)", filepos);
 353
 354     } else if (!strncmp(line, "output ignore", strlen("output ignore"))) {
 355       rctx->output = e_output_ignore;
 356       XBT_VERB("[%s] (ignore output of next command)", filepos);
 357
 358     } else if (!strncmp(line, "output display", strlen("output display"))) {
 359       rctx->output = e_output_display;
 360       XBT_VERB("[%s] (ignore output of next command)", filepos);
 361
 362     } else if (!strncmp(line, "setenv ", strlen("setenv "))) {
 363       int len = strlen("setenv ");
 364       char *eq = strchr(line + len, '=');
 365       char *key = bprintf("%.*s", (int) (eq - line - len), line + len);
 366       xbt_dict_set(env, key, xbt_strdup(eq + 1), xbt_free_f);
 367       free(key);
 368
 369       rctx->env = realloc(rctx->env, ++(rctx->env_size) * sizeof(char *));
 370       rctx->env[rctx->env_size - 2] = xbt_strdup(line + len);
 371       rctx->env[rctx->env_size - 1] = NULL;
 372       XBT_VERB("[%s] setenv %s", filepos, line + len);
 373
 374     } else {
 375       XBT_ERROR("%s: Malformed metacommand: %s", filepos, line);
 376       XBT_ERROR("Test suite `%s': NOK (syntax error)", testsuite_name);
 377       rctx_armageddon(rctx, 1);
 378       return;
 379     }
 380     break;
 381   }
 382 }
 383
 384 /*
 385  * Actually doing the job
 386  */
 387
 388 /* The IO of the childs are handled by the two following threads
 389    (one pair per child) */
 390
 391 static void *thread_writer(void *r)
 392 {
 393   int posw;
 394   rctx_t rctx = (rctx_t) r;
 395   for (posw = 0; posw < rctx->input->used && !rctx->brokenpipe;) {
 396     int got;
 397     XBT_DEBUG("Still %d chars to write", rctx->input->used - posw);
 398     got =
 399         write(rctx->child_to, rctx->input->data + posw,
 400               rctx->input->used - posw);
 401     if (got > 0)
 402       posw += got;
 403     if (got < 0) {
 404       if (errno == EPIPE) {
 405         rctx->brokenpipe = 1;
 406       } else if (errno != EINTR && errno != EAGAIN && errno != EPIPE) {
 407         perror("Error while writing input to child");
 408         XBT_ERROR("Test suite `%s': NOK (system error)", testsuite_name);
 409         rctx_armageddon(rctx, 4);
 410         return NULL;
 411       }
 412     }
 413     XBT_DEBUG("written %d chars so far", posw);
 414
 415     if (got <= 0)
 416       usleep(100);
 417   }
 418   rctx->input->data[0] = '\0';
 419   rctx->input->used = 0;
 420   close(rctx->child_to);
 421
 422   return NULL;
 423 }
 424
 425 static void *thread_reader(void *r)
 426 {
 427   rctx_t rctx = (rctx_t) r;
 428   char *buffout = malloc(4096);
 429   int posr, got_pid;
 430
 431   do {
 432     posr = read(rctx->child_from, buffout, 4095);
 433     if (posr < 0 && errno != EINTR && errno != EAGAIN) {
 434       perror("Error while reading output of child");
 435       XBT_ERROR("Test suite `%s': NOK (system error)", testsuite_name);
 436       rctx_armageddon(rctx, 4);
 437       return NULL;
 438     }
 439     if (posr > 0) {
 440       buffout[posr] = '\0';
 441       xbt_strbuff_append(rctx->output_got, buffout);
 442     } else {
 443       usleep(100);
 444     }
 445   } while (!rctx->timeout && posr != 0);
 446   free(buffout);
 447
 448   /* let this thread wait for the child so that the main thread can detect the timeout without blocking on the wait */
 449   got_pid = waitpid(rctx->pid, &rctx->status, 0);
 450   if (got_pid != rctx->pid) {
 451     perror(bprintf
 452            ("(%s) Cannot wait for the child %s (got pid %d where pid %d were expected;status=%d)",
 453             xbt_thread_self_name(), rctx->cmd, (int) got_pid,
 454             (int) rctx->pid, rctx->status));
 455     XBT_ERROR("Test suite `%s': NOK (system error)", testsuite_name);
 456     rctx_armageddon(rctx, 4);
 457     return NULL;
 458   }
 459
 460   rctx->reader_done = 1;
 461   return NULL;
 462 }
 463
 464 /* Special command: mkfile is a built-in creating a file with the input data as content */
 465 static void rctx_mkfile(void)
 466 {
 467   char *filename = xbt_strdup(rctx->cmd + strlen("mkfile "));
 468   FILE *OUT;
 469   int err;
 470   xbt_str_trim(filename, NULL);
 471   OUT = fopen(filename, "w");
 472   if (!OUT) {
 473     THROWF(system_error, errno, "%s: Cannot create file %s: %s",
 474            rctx->filepos, filename, strerror(errno));
 475   }
 476   err = (fprintf(OUT, "%s", rctx->input->data) < 0);
 477   err = (fclose(OUT) == -1) || err;
 478   if (err) {
 479     THROWF(system_error, errno, "%s: Cannot write file %s: %s",
 480            rctx->filepos, filename, strerror(errno));
 481   }
 482   free(filename);
 483 }
 484
 485 /* function to be called from the child to start the actual process */
 486 static void start_command(rctx_t rctx)
 487 {
 488   xbt_dynar_t cmd;
 489   char *binary_name = NULL;
 490   unsigned int it;
 491   char *str;
 492   char **args;
 493   int errcode;
 494
 495   if (!strncmp(rctx->cmd, "mkfile ", strlen("mkfile "))) {
 496     rctx_mkfile();
 497     /* Valgrind detects memory leaks here.
 498      * To correct those leaks, we must free objects allocated in main() or in
 499      * handle_suite(), but we have no more reference to them at this point.
 500      * A quick and dirty hack to make valgrind happy it to uncomment the
 501      * following line.
 502      */
 503     /* execlp("true", "true", (const char *)0); */
 504     exit(0);                    /* end the working child */
 505   }
 506
 507   cmd = xbt_str_split_quoted(rctx->cmd);
 508   xbt_dynar_get_cpy(cmd, 0, &binary_name);
 509   args = xbt_new(char *, xbt_dynar_length(cmd) + 1);
 510   xbt_dynar_foreach(cmd, it, str) {
 511     args[it] = xbt_strdup(str);
 512   }
 513   args[it] = NULL;
 514   xbt_dynar_free_container(&cmd);
 515
 516   /* To search for the right executable path when not trivial */
 517   struct stat stat_buf;
 518
 519   /* build the command line */
 520   if (stat(binary_name, &stat_buf)) {
 521     /* Damn. binary not in current dir. We'll have to dig the PATH to find it */
 522     int i;
 523
 524     for (i = 0; environ[i]; i++) {
 525       if (!strncmp("PATH=", environ[i], 5)) {
 526         xbt_dynar_t path = xbt_str_split(environ[i] + 5, ":");
 527
 528         xbt_dynar_foreach(path, it, str) {
 529           if (binary_name)
 530             free(binary_name);
 531           binary_name = bprintf("%s/%s", str, args[0]);
 532           if (!stat(binary_name, &stat_buf)) {
 533             /* Found. */
 534             XBT_DEBUG("Looked in the PATH for the binary. Found %s",
 535                    binary_name);
 536             xbt_dynar_free(&path);
 537             break;
 538           }
 539         }
 540         xbt_dynar_free(&path);
 541         if (stat(binary_name, &stat_buf)) {
 542           /* not found */
 543           printf("TESH_ERROR Command %s not found\n", args[0]);
 544           exit(127);
 545         }
 546         break;
 547       }
 548     }
 549   } else {
 550     binary_name = xbt_strdup(args[0]);
 551   }
 552
 553   errcode = execve(binary_name, args, rctx->env);
 554   printf("TESH_ERROR %s: Cannot start %s: %s\n", rctx->filepos, rctx->cmd,
 555          strerror(errcode));
 556   exit(127);
 557 }
 558
 559 /* Start a new child, plug the pipes as expected and fire up the
 560    helping threads. Is also waits for the child to end if this is a
 561    foreground job, or fire up a thread to wait otherwise. */
 562 void rctx_start(void)
 563 {
 564   int child_in[2];
 565   int child_out[2];
 566
 567   XBT_DEBUG("Cmd before rewriting %s", rctx->cmd);
 568   rctx->cmd = xbt_str_varsubst(rctx->cmd, env);
 569   XBT_VERB("Start %s %s", rctx->cmd,
 570         (rctx->is_background ? "(background job)" : ""));
 571   xbt_os_mutex_acquire(armageddon_mutex);
 572   if (armageddon_initiator) {
 573     XBT_VERB("Armageddon in progress. Do not start job.");
 574     xbt_os_mutex_release(armageddon_mutex);
 575     return;
 576   }
 577   if (pipe(child_in) || pipe(child_out)) {
 578     perror("Cannot open the pipes");
 579     XBT_ERROR("Test suite `%s': NOK (system error)", testsuite_name);
 580     xbt_os_mutex_release(armageddon_mutex);
 581     rctx_armageddon(rctx, 4);
 582   }
 583
 584   rctx->pid = fork();
 585   if (rctx->pid < 0) {
 586     perror("Cannot fork the command");
 587     XBT_ERROR("Test suite `%s': NOK (system error)", testsuite_name);
 588     xbt_os_mutex_release(armageddon_mutex);
 589     rctx_armageddon(rctx, 4);
 590     return;
 591   }
 592
 593   if (rctx->pid) {              /* father */
 594     close(child_in[0]);
 595     rctx->child_to = child_in[1];
 596
 597     close(child_out[1]);
 598     rctx->child_from = child_out[0];
 599
 600     if (timeout_value > 0)
 601       rctx->end_time = time(NULL) + timeout_value;
 602     else
 603       rctx->end_time = -1;
 604
 605     rctx->reader_done = 0;
 606     rctx->reader =
 607         xbt_os_thread_create("reader", thread_reader, (void *) rctx, NULL);
 608     rctx->writer =
 609         xbt_os_thread_create("writer", thread_writer, (void *) rctx, NULL);
 610
 611   } else {                      /* child */
 612     close(child_in[1]);
 613     dup2(child_in[0], 0);
 614     close(child_in[0]);
 615
 616     close(child_out[0]);
 617     dup2(child_out[1], 1);
 618     dup2(child_out[1], 2);
 619     close(child_out[1]);
 620
 621     start_command(rctx);
 622   }
 623
 624   rctx->is_stoppable = 1;
 625
 626   if (!rctx->is_background) {
 627     fg_job = 1;
 628     xbt_os_mutex_release(armageddon_mutex);
 629     rctx_wait(rctx);
 630     fg_job = 0;
 631   } else {
 632     /* Damn. Copy the rctx and launch a thread to handle it */
 633     rctx_t old = rctx;
 634     xbt_os_thread_t runner;
 635
 636     rctx = rctx_new();
 637     XBT_DEBUG("RCTX: new bg=%p, new fg=%p", old, rctx);
 638
 639     XBT_DEBUG("Launch a thread to wait for %s %d", old->cmd, old->pid);
 640     runner = xbt_os_thread_create(old->cmd, rctx_wait, (void *) old, NULL);
 641     old->runner = runner;
 642     XBT_VERB("Launched thread %p to wait for %s %d", runner, old->cmd,
 643           old->pid);
 644     xbt_dynar_push(bg_jobs, &old);
 645     xbt_os_mutex_release(armageddon_mutex);
 646   }
 647 }
 648
 649 /* Helper function to sort the output */
 650 static int cmpstringp(const void *p1, const void *p2) {
 651   /* Sort only using the 19 first chars (date+pid)
 652    * If the dates are the same, then, sort using pointer address (be stable wrt output of each process)
 653    */
 654   const char *s1 = *((const char**) p1);
 655   const char *s2 = *((const char**) p2);
 656
 657   XBT_DEBUG("Compare strings '%s' and '%s'", s1, s2);
 658
 659   int res = strncmp(s1, s2, sort_len);
 660   if (res == 0)
 661     return p1>p2;
 662   return res;
 663 }
 664
 665
 666 /* Waits for the child to end (or to timeout), and check its
 667    ending conditions. This is launched from rctx_start but either in main
 668    thread (for foreground jobs) or in a separate one for background jobs.
 669    That explains the prototype, forced by xbt_os_thread_create. */
 670
 671 void *rctx_wait(void *r)
 672 {
 673   rctx_t rctx = (rctx_t) r;
 674   int errcode = 0;
 675   int now = time(NULL);
 676
 677   rctx_dump(rctx, "wait");
 678
 679   if (!rctx->is_stoppable)
 680     THROWF(unknown_error, 0, "Cmd '%s' not started yet. Cannot wait it",
 681            rctx->cmd);
 682
 683   /* Wait for the child to die or the timeout to happen (or an armageddon to happen) */
 684   while (!rctx->reader_done
 685          && (rctx->end_time < 0 || rctx->end_time >= now)) {
 686     usleep(100);
 687     now = time(NULL);
 688   }
 689
 690   xbt_os_mutex_acquire(rctx->interruption);
 691   if (!rctx->interrupted && rctx->end_time > 0 && rctx->end_time < now) {
 692     XBT_INFO("<%s> timeouted. Kill the process.", rctx->filepos);
 693     rctx->timeout = 1;
 694     kill(rctx->pid, SIGTERM);
 695     usleep(100);
 696     kill(rctx->pid, SIGKILL);
 697   }
 698
 699   /* Make sure helper threads die.
 700      Cannot block since they wait for the child we just killed
 701      if not already dead. */
 702   xbt_os_thread_join(rctx->writer, NULL);
 703   xbt_os_thread_join(rctx->reader, NULL);
 704
 705   /*  xbt_os_mutex_release(rctx->interruption);
 706      if (rctx->interrupted)
 707      return NULL;
 708      xbt_os_mutex_acquire(rctx->interruption); */
 709
 710   xbt_strbuff_chomp(rctx->output_got);
 711   xbt_strbuff_chomp(rctx->output_wanted);
 712   xbt_strbuff_trim(rctx->output_got);
 713   xbt_strbuff_trim(rctx->output_wanted);
 714
 715   /* Check for broken pipe */
 716   if (rctx->brokenpipe)
 717     XBT_VERB
 718         ("Warning: Child did not consume all its input (I got broken pipe)");
 719
 720   /* Check for timeouts */
 721   if (rctx->timeout) {
 722     if (rctx->output_got->data[0])
 723       XBT_INFO("<%s> Output on timeout:\n%s",
 724             rctx->filepos, rctx->output_got->data);
 725     else
 726       XBT_INFO("<%s> No output before timeout", rctx->filepos);
 727     XBT_ERROR("Test suite `%s': NOK (<%s> timeout after %d sec)",
 728            testsuite_name, rctx->filepos, timeout_value);
 729     XBT_DEBUG("<%s> Interrupted = %d", rctx->filepos, rctx->interrupted);
 730     if (!rctx->interrupted) {
 731       xbt_os_mutex_release(rctx->interruption);
 732       rctx_armageddon(rctx, 3);
 733       return NULL;
 734     }
 735   }
 736
 737   XBT_DEBUG("RCTX=%p (pid=%d)", rctx, rctx->pid);
 738   XBT_DEBUG("Status(%s|%d)=%d", rctx->cmd, rctx->pid, rctx->status);
 739
 740   if (!rctx->interrupted) {
 741     if (WIFSIGNALED(rctx->status) && !rctx->expected_signal) {
 742       XBT_ERROR("Test suite `%s': NOK (<%s> got signal %s)",
 743              testsuite_name, rctx->filepos,
 744              signal_name(WTERMSIG(rctx->status), NULL));
 745       errcode = WTERMSIG(rctx->status) + 4;
 746     }
 747
 748     if (WIFSIGNALED(rctx->status) && rctx->expected_signal &&
 749         strcmp(signal_name(WTERMSIG(rctx->status), rctx->expected_signal),
 750                rctx->expected_signal)) {
 751       XBT_ERROR("Test suite `%s': NOK (%s got signal %s instead of %s)",
 752              testsuite_name, rctx->filepos,
 753              signal_name(WTERMSIG(rctx->status), rctx->expected_signal),
 754              rctx->expected_signal);
 755       errcode = WTERMSIG(rctx->status) + 4;
 756     }
 757
 758     if (!WIFSIGNALED(rctx->status) && rctx->expected_signal) {
 759       XBT_ERROR("Test suite `%s': NOK (child %s expected signal %s)",
 760              testsuite_name, rctx->filepos, rctx->expected_signal);
 761       errcode = 5;
 762     }
 763
 764     if (WIFEXITED(rctx->status)
 765         && WEXITSTATUS(rctx->status) != rctx->expected_return) {
 766       if (rctx->expected_return)
 767         XBT_ERROR
 768             ("Test suite `%s': NOK (<%s> returned code %d instead of %d)",
 769              testsuite_name, rctx->filepos, WEXITSTATUS(rctx->status),
 770              rctx->expected_return);
 771       else
 772         XBT_ERROR("Test suite `%s': NOK (<%s> returned code %d)",
 773                testsuite_name, rctx->filepos, WEXITSTATUS(rctx->status));
 774       errcode = 40 + WEXITSTATUS(rctx->status);
 775
 776     }
 777     rctx->expected_return = 0;
 778
 779     if (rctx->expected_signal) {
 780       free(rctx->expected_signal);
 781       rctx->expected_signal = NULL;
 782     }
 783   }
 784   while (rctx->output_got->used
 785          && !strncmp(rctx->output_got->data, "TESH_ERROR ",
 786                      strlen("TESH_ERROR "))) {
 787     int marklen = strlen("TESH_ERROR ");
 788     char *endline = strchr(rctx->output_got->data, '\n');
 789
 790     XBT_CRITICAL("%.*s", (int) (endline - rctx->output_got->data - marklen),
 791               rctx->output_got->data + marklen);
 792     memmove(rctx->output_got->data, rctx->output_got->data + marklen,
 793             rctx->output_got->used - marklen);
 794     rctx->output_got->used -= endline - rctx->output_got->data + 1;
 795     rctx->output_got->data[rctx->output_got->used] = '\0';
 796     errcode = 1;
 797   }
 798
 799   if (rctx->output_sort) {
 800     xbt_dynar_t a = xbt_str_split(rctx->output_got->data, "\n");
 801     xbt_dynar_sort(a,cmpstringp);
 802     char *sorted_output = xbt_str_join(a, "\n");
 803     strcpy(rctx->output_got->data, sorted_output);
 804     xbt_free(sorted_output);
 805     xbt_dynar_free(&a);
 806     /* If an empty line moved in first position, move it back to the end */
 807     if (rctx->output_got->data[0]=='\n') {
 808       memmove(rctx->output_got->data,rctx->output_got->data+1,rctx->output_got->used-1);
 809       rctx->output_got->data[rctx->output_got->used-1] = '\n';
 810     }
 811   }
 812   if ((errcode && errcode != 1) || rctx->interrupted) {
 813     /* checking output, and matching */
 814     xbt_dynar_t a = xbt_str_split(rctx->output_got->data, "\n");
 815     char *out = xbt_str_join(a, "\n||");
 816     xbt_dynar_free(&a);
 817     XBT_INFO("Output of <%s> so far: \n||%s", rctx->filepos, out);
 818     free(out);
 819   } else if (rctx->output == e_output_check
 820              && (rctx->output_got->used != rctx->output_wanted->used
 821                  || strcmp(rctx->output_got->data,
 822                            rctx->output_wanted->data))) {
 823     if (XBT_LOG_ISENABLED(tesh, xbt_log_priority_info)) {
 824       char *diff =
 825           xbt_str_diff(rctx->output_wanted->data, rctx->output_got->data);
 826       XBT_ERROR("Output of <%s> mismatch:\n%s", rctx->filepos, diff);
 827       free(diff);
 828     }
 829     XBT_ERROR("Test suite `%s': NOK (<%s> output mismatch)",
 830            testsuite_name, rctx->filepos);
 831
 832     errcode = 2;
 833   } else if (rctx->output == e_output_ignore) {
 834     XBT_INFO("(ignoring the output of <%s> as requested)", rctx->filepos);
 835   } else if (rctx->output == e_output_display) {
 836     xbt_dynar_t a = xbt_str_split(rctx->output_got->data, "\n");
 837     char *out = xbt_str_join(a, "\n||");
 838     xbt_dynar_free(&a);
 839     XBT_INFO("Here is the (ignored) command output: \n||%s", out);
 840     free(out);
 841   }
 842
 843   if (!rctx->is_background) {
 844     xbt_os_mutex_acquire(armageddon_mutex);
 845     /* Don't touch rctx if armageddon is in progress. */
 846     if (!armageddon_initiator)
 847       rctx_empty(rctx);
 848     xbt_os_mutex_release(armageddon_mutex);
 849   }
 850   if (errcode) {
 851     if (!rctx->interrupted) {
 852       xbt_os_mutex_release(rctx->interruption);
 853       rctx_armageddon(rctx, errcode);
 854       return NULL;
 855     }
 856   }
 857
 858   xbt_os_mutex_release(rctx->interruption);
 859   return NULL;
 860 }