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     ERROR2("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   VERB2("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     INFO2("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   DEBUG2("Armageddon request by <%s> (exit=%d)", filepos, exitcode);
 151   xbt_os_mutex_acquire(armageddon_mutex);
 152   if (armageddon_initiator != NULL) {
 153     VERB0("Armageddon already started. Let it go");
 154     xbt_os_mutex_release(armageddon_mutex);
 155     return;
 156   }
 157   DEBUG1("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   VERB0("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   DEBUG1("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   DEBUG9("%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   DEBUG5("%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         ERROR2
 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         ERROR1("Test suite `%s': NOK (syntax error)", testsuite_name);
 292         rctx_armageddon(rctx, 1);
 293         return;
 294       }
 295       rctx_start();
 296       VERB1("[%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     INFO3("[%s] %s%s", filepos, rctx->cmd,
 306           ((rctx->is_background) ? " (background command)" : ""));
 307
 308     break;
 309
 310   case '<':
 311     rctx->is_empty = 0;
 312     xbt_strbuff_append(rctx->input, line);
 313     xbt_strbuff_append(rctx->input, "\n");
 314     break;
 315
 316   case '>':
 317     rctx->is_empty = 0;
 318     xbt_strbuff_append(rctx->output_wanted, line);
 319     xbt_strbuff_append(rctx->output_wanted, "\n");
 320     break;
 321
 322   case '!':
 323     if (rctx->cmd)
 324       rctx_start();
 325
 326     if (!strncmp(line, "timeout no", strlen("timeout no"))) {
 327       VERB1("[%s] (disable timeout)", filepos);
 328       timeout_value = -1;
 329     } else if (!strncmp(line, "timeout ", strlen("timeout "))) {
 330       timeout_value = atoi(line + strlen("timeout"));
 331       VERB2("[%s] (new timeout value: %d)", filepos, timeout_value);
 332
 333     } else if (!strncmp(line, "expect signal ", strlen("expect signal "))) {
 334       rctx->expected_signal = strdup(line + strlen("expect signal "));
 335       xbt_str_trim(rctx->expected_signal, " \n");
 336       VERB2("[%s] (next command must raise signal %s)",
 337             filepos, rctx->expected_signal);
 338
 339     } else if (!strncmp(line, "expect return ", strlen("expect return "))) {
 340       rctx->expected_return = atoi(line + strlen("expect return "));
 341       VERB2("[%s] (next command must return code %d)",
 342             filepos, rctx->expected_return);
 343
 344     } else if (!strncmp(line, "output sort", strlen("output sort"))) {
 345       rctx->output_sort = 1;
 346       VERB1("[%s] (sort output of next command)", filepos);
 347
 348     } else if (!strncmp(line, "output ignore", strlen("output ignore"))) {
 349       rctx->output = e_output_ignore;
 350       VERB1("[%s] (ignore output of next command)", filepos);
 351
 352     } else if (!strncmp(line, "output display", strlen("output display"))) {
 353       rctx->output = e_output_display;
 354       VERB1("[%s] (ignore output of next command)", filepos);
 355
 356     } else if (!strncmp(line, "setenv ", strlen("setenv "))) {
 357       int len = strlen("setenv ");
 358       char *eq = strchr(line + len, '=');
 359       char *key = bprintf("%.*s", (int) (eq - line - len), line + len);
 360       xbt_dict_set(env, key, xbt_strdup(eq + 1), xbt_free_f);
 361       free(key);
 362
 363       rctx->env = realloc(rctx->env, ++(rctx->env_size) * sizeof(char *));
 364       rctx->env[rctx->env_size - 2] = xbt_strdup(line + len);
 365       rctx->env[rctx->env_size - 1] = NULL;
 366       VERB2("[%s] setenv %s", filepos, line + len);
 367
 368     } else {
 369       ERROR2("%s: Malformed metacommand: %s", filepos, line);
 370       ERROR1("Test suite `%s': NOK (syntax error)", testsuite_name);
 371       rctx_armageddon(rctx, 1);
 372       return;
 373     }
 374     break;
 375   }
 376 }
 377
 378 /*
 379  * Actually doing the job
 380  */
 381
 382 /* The IO of the childs are handled by the two following threads
 383    (one pair per child) */
 384
 385 static void *thread_writer(void *r)
 386 {
 387   int posw;
 388   rctx_t rctx = (rctx_t) r;
 389   for (posw = 0; posw < rctx->input->used && !rctx->brokenpipe;) {
 390     int got;
 391     DEBUG1("Still %d chars to write", rctx->input->used - posw);
 392     got =
 393         write(rctx->child_to, rctx->input->data + posw,
 394               rctx->input->used - posw);
 395     if (got > 0)
 396       posw += got;
 397     if (got < 0) {
 398       if (errno == EPIPE) {
 399         rctx->brokenpipe = 1;
 400       } else if (errno != EINTR && errno != EAGAIN && errno != EPIPE) {
 401         perror("Error while writing input to child");
 402         ERROR1("Test suite `%s': NOK (system error)", testsuite_name);
 403         rctx_armageddon(rctx, 4);
 404         return NULL;
 405       }
 406     }
 407     DEBUG1("written %d chars so far", posw);
 408
 409     if (got <= 0)
 410       usleep(100);
 411   }
 412   rctx->input->data[0] = '\0';
 413   rctx->input->used = 0;
 414   close(rctx->child_to);
 415
 416   return NULL;
 417 }
 418
 419 static void *thread_reader(void *r)
 420 {
 421   rctx_t rctx = (rctx_t) r;
 422   char *buffout = malloc(4096);
 423   int posr, got_pid;
 424
 425   do {
 426     posr = read(rctx->child_from, buffout, 4095);
 427     if (posr < 0 && errno != EINTR && errno != EAGAIN) {
 428       perror("Error while reading output of child");
 429       ERROR1("Test suite `%s': NOK (system error)", testsuite_name);
 430       rctx_armageddon(rctx, 4);
 431       return NULL;
 432     }
 433     if (posr > 0) {
 434       buffout[posr] = '\0';
 435       xbt_strbuff_append(rctx->output_got, buffout);
 436     } else {
 437       usleep(100);
 438     }
 439   } while (!rctx->timeout && posr != 0);
 440   free(buffout);
 441
 442   /* let this thread wait for the child so that the main thread can detect the timeout without blocking on the wait */
 443   got_pid = waitpid(rctx->pid, &rctx->status, 0);
 444   if (got_pid != rctx->pid) {
 445     perror(bprintf
 446            ("(%s) Cannot wait for the child %s (got pid %d where pid %d were expected;status=%d)",
 447             xbt_thread_self_name(), rctx->cmd, (int) got_pid,
 448             (int) rctx->pid, rctx->status));
 449     ERROR1("Test suite `%s': NOK (system error)", testsuite_name);
 450     rctx_armageddon(rctx, 4);
 451     return NULL;
 452   }
 453
 454   rctx->reader_done = 1;
 455   return NULL;
 456 }
 457
 458 /* Special command: mkfile is a built-in creating a file with the input data as content */
 459 static void rctx_mkfile(void)
 460 {
 461   char *filename = xbt_strdup(rctx->cmd + strlen("mkfile "));
 462   FILE *OUT;
 463   int err;
 464   xbt_str_trim(filename, NULL);
 465   OUT = fopen(filename, "w");
 466   if (!OUT) {
 467     THROW3(system_error, errno, "%s: Cannot create file %s: %s",
 468            rctx->filepos, filename, strerror(errno));
 469   }
 470   err = (fprintf(OUT, "%s", rctx->input->data) < 0);
 471   err = (fclose(OUT) == -1) || err;
 472   if (err) {
 473     THROW3(system_error, errno, "%s: Cannot write file %s: %s",
 474            rctx->filepos, filename, strerror(errno));
 475   }
 476   free(filename);
 477 }
 478
 479 /* function to be called from the child to start the actual process */
 480 static void start_command(rctx_t rctx)
 481 {
 482   xbt_dynar_t cmd;
 483   char *binary_name = NULL;
 484   unsigned int it;
 485   char *str;
 486   char **args;
 487   int errcode;
 488
 489   if (!strncmp(rctx->cmd, "mkfile ", strlen("mkfile "))) {
 490     rctx_mkfile();
 491     /* Valgrind detects memory leaks here.
 492      * To correct those leaks, we must free objects allocated in main() or in
 493      * handle_suite(), but we have no more reference to them at this point.
 494      * A quick and dirty hack to make valgrind happy it to uncomment the
 495      * following line.
 496      */
 497     /* execlp("true", "true", (const char *)0); */
 498     exit(0);                    /* end the working child */
 499   }
 500
 501   cmd = xbt_str_split_quoted(rctx->cmd);
 502   xbt_dynar_get_cpy(cmd, 0, &binary_name);
 503   args = xbt_new(char *, xbt_dynar_length(cmd) + 1);
 504   xbt_dynar_foreach(cmd, it, str) {
 505     args[it] = xbt_strdup(str);
 506   }
 507   args[it] = NULL;
 508   xbt_dynar_free_container(&cmd);
 509
 510   /* To search for the right executable path when not trivial */
 511   struct stat stat_buf;
 512
 513   /* build the command line */
 514   if (stat(binary_name, &stat_buf)) {
 515     /* Damn. binary not in current dir. We'll have to dig the PATH to find it */
 516     int i;
 517
 518     for (i = 0; environ[i]; i++) {
 519       if (!strncmp("PATH=", environ[i], 5)) {
 520         xbt_dynar_t path = xbt_str_split(environ[i] + 5, ":");
 521
 522         xbt_dynar_foreach(path, it, str) {
 523           if (binary_name)
 524             free(binary_name);
 525           binary_name = bprintf("%s/%s", str, args[0]);
 526           if (!stat(binary_name, &stat_buf)) {
 527             /* Found. */
 528             DEBUG1("Looked in the PATH for the binary. Found %s",
 529                    binary_name);
 530             xbt_dynar_free(&path);
 531             break;
 532           }
 533         }
 534         xbt_dynar_free(&path);
 535         if (stat(binary_name, &stat_buf)) {
 536           /* not found */
 537           printf("TESH_ERROR Command %s not found\n", args[0]);
 538           exit(127);
 539         }
 540         break;
 541       }
 542     }
 543   } else {
 544     binary_name = xbt_strdup(args[0]);
 545   }
 546
 547   errcode = execve(binary_name, args, rctx->env);
 548   printf("TESH_ERROR %s: Cannot start %s: %s\n", rctx->filepos, rctx->cmd,
 549          strerror(errcode));
 550   exit(127);
 551 }
 552
 553 /* Start a new child, plug the pipes as expected and fire up the
 554    helping threads. Is also waits for the child to end if this is a
 555    foreground job, or fire up a thread to wait otherwise. */
 556 void rctx_start(void)
 557 {
 558   int child_in[2];
 559   int child_out[2];
 560
 561   DEBUG1("Cmd before rewriting %s", rctx->cmd);
 562   rctx->cmd = xbt_str_varsubst(rctx->cmd, env);
 563   VERB2("Start %s %s", rctx->cmd,
 564         (rctx->is_background ? "(background job)" : ""));
 565   xbt_os_mutex_acquire(armageddon_mutex);
 566   if (armageddon_initiator) {
 567     VERB0("Armageddon in progress. Do not start job.");
 568     xbt_os_mutex_release(armageddon_mutex);
 569     return;
 570   }
 571   if (pipe(child_in) || pipe(child_out)) {
 572     perror("Cannot open the pipes");
 573     ERROR1("Test suite `%s': NOK (system error)", testsuite_name);
 574     xbt_os_mutex_release(armageddon_mutex);
 575     rctx_armageddon(rctx, 4);
 576   }
 577
 578   rctx->pid = fork();
 579   if (rctx->pid < 0) {
 580     perror("Cannot fork the command");
 581     ERROR1("Test suite `%s': NOK (system error)", testsuite_name);
 582     xbt_os_mutex_release(armageddon_mutex);
 583     rctx_armageddon(rctx, 4);
 584     return;
 585   }
 586
 587   if (rctx->pid) {              /* father */
 588     close(child_in[0]);
 589     rctx->child_to = child_in[1];
 590
 591     close(child_out[1]);
 592     rctx->child_from = child_out[0];
 593
 594     if (timeout_value > 0)
 595       rctx->end_time = time(NULL) + timeout_value;
 596     else
 597       rctx->end_time = -1;
 598
 599     rctx->reader_done = 0;
 600     rctx->reader =
 601         xbt_os_thread_create("reader", thread_reader, (void *) rctx, NULL);
 602     rctx->writer =
 603         xbt_os_thread_create("writer", thread_writer, (void *) rctx, NULL);
 604
 605   } else {                      /* child */
 606     close(child_in[1]);
 607     dup2(child_in[0], 0);
 608     close(child_in[0]);
 609
 610     close(child_out[0]);
 611     dup2(child_out[1], 1);
 612     dup2(child_out[1], 2);
 613     close(child_out[1]);
 614
 615     start_command(rctx);
 616   }
 617
 618   rctx->is_stoppable = 1;
 619
 620   if (!rctx->is_background) {
 621     fg_job = 1;
 622     xbt_os_mutex_release(armageddon_mutex);
 623     rctx_wait(rctx);
 624     fg_job = 0;
 625   } else {
 626     /* Damn. Copy the rctx and launch a thread to handle it */
 627     rctx_t old = rctx;
 628     xbt_os_thread_t runner;
 629
 630     rctx = rctx_new();
 631     DEBUG2("RCTX: new bg=%p, new fg=%p", old, rctx);
 632
 633     DEBUG2("Launch a thread to wait for %s %d", old->cmd, old->pid);
 634     runner = xbt_os_thread_create(old->cmd, rctx_wait, (void *) old, NULL);
 635     old->runner = runner;
 636     VERB3("Launched thread %p to wait for %s %d", runner, old->cmd,
 637           old->pid);
 638     xbt_dynar_push(bg_jobs, &old);
 639     xbt_os_mutex_release(armageddon_mutex);
 640   }
 641 }
 642
 643 /* Helper function to sort the output */
 644 static int cmpstringp(const void *p1, const void *p2) {
 645   /* Sort only using the 19 first chars (date+pid)
 646    * If the dates are the same, then, sort using pointer address (be stable wrt output of each process)
 647    */
 648   const char *s1 = *((const char**) p1);
 649   const char *s2 = *((const char**) p2);
 650
 651   DEBUG2("Compare strings '%s' and '%s'", s1, s2);
 652
 653   int res = strncmp(s1, s2, 19);
 654   if (res == 0)
 655     return p1>p2;
 656   return res;
 657 }
 658
 659
 660 /* Waits for the child to end (or to timeout), and check its
 661    ending conditions. This is launched from rctx_start but either in main
 662    thread (for foreground jobs) or in a separate one for background jobs.
 663    That explains the prototype, forced by xbt_os_thread_create. */
 664
 665 void *rctx_wait(void *r)
 666 {
 667   rctx_t rctx = (rctx_t) r;
 668   int errcode = 0;
 669   int now = time(NULL);
 670
 671   rctx_dump(rctx, "wait");
 672
 673   if (!rctx->is_stoppable)
 674     THROW1(unknown_error, 0, "Cmd '%s' not started yet. Cannot wait it",
 675            rctx->cmd);
 676
 677   /* Wait for the child to die or the timeout to happen (or an armageddon to happen) */
 678   while (!rctx->reader_done
 679          && (rctx->end_time < 0 || rctx->end_time >= now)) {
 680     usleep(100);
 681     now = time(NULL);
 682   }
 683
 684   xbt_os_mutex_acquire(rctx->interruption);
 685   if (!rctx->interrupted && rctx->end_time > 0 && rctx->end_time < now) {
 686     INFO1("<%s> timeouted. Kill the process.", rctx->filepos);
 687     rctx->timeout = 1;
 688     kill(rctx->pid, SIGTERM);
 689     usleep(100);
 690     kill(rctx->pid, SIGKILL);
 691   }
 692
 693   /* Make sure helper threads die.
 694      Cannot block since they wait for the child we just killed
 695      if not already dead. */
 696   xbt_os_thread_join(rctx->writer, NULL);
 697   xbt_os_thread_join(rctx->reader, NULL);
 698
 699   /*  xbt_os_mutex_release(rctx->interruption);
 700      if (rctx->interrupted)
 701      return NULL;
 702      xbt_os_mutex_acquire(rctx->interruption); */
 703
 704   xbt_strbuff_chomp(rctx->output_got);
 705   xbt_strbuff_chomp(rctx->output_wanted);
 706   xbt_strbuff_trim(rctx->output_got);
 707   xbt_strbuff_trim(rctx->output_wanted);
 708
 709   /* Check for broken pipe */
 710   if (rctx->brokenpipe)
 711     VERB0
 712         ("Warning: Child did not consume all its input (I got broken pipe)");
 713
 714   /* Check for timeouts */
 715   if (rctx->timeout) {
 716     if (rctx->output_got->data[0])
 717       INFO2("<%s> Output on timeout:\n%s",
 718             rctx->filepos, rctx->output_got->data);
 719     else
 720       INFO1("<%s> No output before timeout", rctx->filepos);
 721     ERROR3("Test suite `%s': NOK (<%s> timeout after %d sec)",
 722            testsuite_name, rctx->filepos, timeout_value);
 723     DEBUG2("<%s> Interrupted = %d", rctx->filepos, rctx->interrupted);
 724     if (!rctx->interrupted) {
 725       xbt_os_mutex_release(rctx->interruption);
 726       rctx_armageddon(rctx, 3);
 727       return NULL;
 728     }
 729   }
 730
 731   DEBUG2("RCTX=%p (pid=%d)", rctx, rctx->pid);
 732   DEBUG3("Status(%s|%d)=%d", rctx->cmd, rctx->pid, rctx->status);
 733
 734   if (!rctx->interrupted) {
 735     if (WIFSIGNALED(rctx->status) && !rctx->expected_signal) {
 736       ERROR3("Test suite `%s': NOK (<%s> got signal %s)",
 737              testsuite_name, rctx->filepos,
 738              signal_name(WTERMSIG(rctx->status), NULL));
 739       errcode = WTERMSIG(rctx->status) + 4;
 740     }
 741
 742     if (WIFSIGNALED(rctx->status) && rctx->expected_signal &&
 743         strcmp(signal_name(WTERMSIG(rctx->status), rctx->expected_signal),
 744                rctx->expected_signal)) {
 745       ERROR4("Test suite `%s': NOK (%s got signal %s instead of %s)",
 746              testsuite_name, rctx->filepos,
 747              signal_name(WTERMSIG(rctx->status), rctx->expected_signal),
 748              rctx->expected_signal);
 749       errcode = WTERMSIG(rctx->status) + 4;
 750     }
 751
 752     if (!WIFSIGNALED(rctx->status) && rctx->expected_signal) {
 753       ERROR3("Test suite `%s': NOK (child %s expected signal %s)",
 754              testsuite_name, rctx->filepos, rctx->expected_signal);
 755       errcode = 5;
 756     }
 757
 758     if (WIFEXITED(rctx->status)
 759         && WEXITSTATUS(rctx->status) != rctx->expected_return) {
 760       if (rctx->expected_return)
 761         ERROR4
 762             ("Test suite `%s': NOK (<%s> returned code %d instead of %d)",
 763              testsuite_name, rctx->filepos, WEXITSTATUS(rctx->status),
 764              rctx->expected_return);
 765       else
 766         ERROR3("Test suite `%s': NOK (<%s> returned code %d)",
 767                testsuite_name, rctx->filepos, WEXITSTATUS(rctx->status));
 768       errcode = 40 + WEXITSTATUS(rctx->status);
 769
 770     }
 771     rctx->expected_return = 0;
 772
 773     if (rctx->expected_signal) {
 774       free(rctx->expected_signal);
 775       rctx->expected_signal = NULL;
 776     }
 777   }
 778   while (rctx->output_got->used
 779          && !strncmp(rctx->output_got->data, "TESH_ERROR ",
 780                      strlen("TESH_ERROR "))) {
 781     int marklen = strlen("TESH_ERROR ");
 782     char *endline = strchr(rctx->output_got->data, '\n');
 783
 784     CRITICAL2("%.*s", (int) (endline - rctx->output_got->data - marklen),
 785               rctx->output_got->data + marklen);
 786     memmove(rctx->output_got->data, rctx->output_got->data + marklen,
 787             rctx->output_got->used - marklen);
 788     rctx->output_got->used -= endline - rctx->output_got->data + 1;
 789     rctx->output_got->data[rctx->output_got->used] = '\0';
 790     errcode = 1;
 791   }
 792
 793   if (rctx->output_sort) {
 794     xbt_dynar_t a = xbt_str_split(rctx->output_got->data, "\n");
 795     xbt_dynar_sort(a,cmpstringp);
 796     char *sorted_output = xbt_str_join(a, "\n");
 797     strcpy(rctx->output_got->data, sorted_output);
 798     xbt_free(sorted_output);
 799     xbt_dynar_free(&a);
 800     /* If an empty line moved in first position, move it back to the end */
 801     if (rctx->output_got->data[0]=='\n') {
 802       fprintf(stderr,"XXX");
 803       memmove(rctx->output_got->data,rctx->output_got->data+1,rctx->output_got->used-1);
 804       rctx->output_got->data[rctx->output_got->used-1] = '\n';
 805     }
 806   }
 807   if ((errcode && errcode != 1) || rctx->interrupted) {
 808     /* checking output, and matching */
 809     xbt_dynar_t a = xbt_str_split(rctx->output_got->data, "\n");
 810     char *out = xbt_str_join(a, "\n||");
 811     xbt_dynar_free(&a);
 812     INFO2("Output of <%s> so far: \n||%s", rctx->filepos, out);
 813     free(out);
 814   } else if (rctx->output == e_output_check
 815              && (rctx->output_got->used != rctx->output_wanted->used
 816                  || strcmp(rctx->output_got->data,
 817                            rctx->output_wanted->data))) {
 818     if (XBT_LOG_ISENABLED(tesh, xbt_log_priority_info)) {
 819       char *diff =
 820           xbt_str_diff(rctx->output_wanted->data, rctx->output_got->data);
 821       ERROR2("Output of <%s> mismatch:\n%s", rctx->filepos, diff);
 822       free(diff);
 823     }
 824     ERROR2("Test suite `%s': NOK (<%s> output mismatch)",
 825            testsuite_name, rctx->filepos);
 826
 827     errcode = 2;
 828   } else if (rctx->output == e_output_ignore) {
 829     INFO1("(ignoring the output of <%s> as requested)", rctx->filepos);
 830   } else if (rctx->output == e_output_display) {
 831     xbt_dynar_t a = xbt_str_split(rctx->output_got->data, "\n");
 832     char *out = xbt_str_join(a, "\n||");
 833     xbt_dynar_free(&a);
 834     INFO1("Here is the (ignored) command output: \n||%s", out);
 835     free(out);
 836   }
 837
 838   if (!rctx->is_background) {
 839     xbt_os_mutex_acquire(armageddon_mutex);
 840     /* Don't touch rctx if armageddon is in progress. */
 841     if (!armageddon_initiator)
 842       rctx_empty(rctx);
 843     xbt_os_mutex_release(armageddon_mutex);
 844   }
 845   if (errcode) {
 846     if (!rctx->interrupted) {
 847       xbt_os_mutex_release(rctx->interruption);
 848       rctx_armageddon(rctx, errcode);
 849       return NULL;
 850     }
 851   }
 852
 853   xbt_os_mutex_release(rctx->interruption);
 854   return NULL;
 855 }