Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Search the binary to run in the path, if not in this dir
[simgrid.git] / tools / tesh / run_context.c
index 7acab0f..56c283f 100644 (file)
 
 #include <sys/types.h>
 #include <sys/wait.h>
+#include <sys/stat.h>
+#include <unistd.h>
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(tesh);
 
 xbt_dynar_t bg_jobs = NULL;
 rctx_t armageddon_initiator = NULL;
-xbt_mutex_t armageddon_mutex = NULL;
+xbt_os_mutex_t armageddon_mutex = NULL;
 
-/* 
+/*
  * Module management
  */
 
-static void kill_it(void*r) {  
+static void kill_it(void*r) {
   rctx_t rctx = *(rctx_t*)r;
 
-  VERB1("Join thread %p which were running a background cmd",rctx->runner);
-  xbt_thread_join(rctx->runner,NULL);
+  VERB2("Join thread %p which were running background cmd <%s>",rctx->runner,rctx->filepos);
+  xbt_os_thread_join(rctx->runner,NULL);
   rctx_free(rctx);
 }
 
 void rctx_init(void) {
-  bg_jobs = xbt_dynar_new(sizeof(rctx_t),kill_it);
-  armageddon_mutex = xbt_mutex_init();
+  bg_jobs = xbt_dynar_new_sync(sizeof(rctx_t),kill_it);
+  armageddon_mutex = xbt_os_mutex_init();
   armageddon_initiator = NULL;
 }
 
 void rctx_exit(void) {
-  if (bg_jobs)
+  if (bg_jobs) {
+    /* Do not use xbt_dynar_free or it will lock the dynar, preventing armageddon from working */
+    while (xbt_dynar_length(bg_jobs)) {
+       rctx_t rctx;
+       xbt_dynar_pop(bg_jobs,&rctx);
+       kill_it(&rctx);
+    }
     xbt_dynar_free(&bg_jobs);
-  xbt_mutex_destroy(armageddon_mutex);
+  }
+  xbt_os_mutex_destroy(armageddon_mutex);
 }
 
 void rctx_wait_bg(void) {
-  xbt_dynar_free(&bg_jobs);
-  bg_jobs = xbt_dynar_new(sizeof(rctx_t),kill_it);
+  if (bg_jobs) {
+    /* Do not use xbt_dynar_free or it will lock the dynar, preventing armageddon from working */
+    while (xbt_dynar_length(bg_jobs)) {
+       rctx_t rctx;
+       xbt_dynar_pop(bg_jobs,&rctx);
+       kill_it(&rctx);
+    }
+    xbt_dynar_free(&bg_jobs);
+  }
+  bg_jobs = xbt_dynar_new_sync(sizeof(rctx_t),kill_it);
 }
 
 void rctx_armageddon(rctx_t initiator, int exitcode) {
   rctx_t rctx;
-  int cpt;
 
-  xbt_mutex_lock(armageddon_mutex);
+  DEBUG2("Armageddon request by <%s> (exit=%d)",initiator->filepos,exitcode);
+  xbt_os_mutex_acquire(armageddon_mutex);
   if (armageddon_initiator != NULL) {
     VERB0("Armageddon already started. Let it go");
+    xbt_os_mutex_release(initiator->interruption);
+    xbt_os_mutex_release(armageddon_mutex);
     return;
   }
+  DEBUG1("Armageddon request by <%s> got the lock. Let's go amok",initiator->filepos);
   armageddon_initiator = initiator;
-  xbt_mutex_unlock(armageddon_mutex);
-
+  xbt_os_mutex_release(armageddon_mutex);
 
   /* Kill any background commands */
-  xbt_dynar_foreach(bg_jobs,cpt,rctx) {
+  while (xbt_dynar_length(bg_jobs)) {
+    xbt_dynar_pop(bg_jobs,&rctx);
     if (rctx != initiator) {
-      xbt_mutex_lock(rctx->interruption);
-      rctx->interrupted = 1;
       INFO2("Kill <%s> because <%s> failed",rctx->filepos,initiator->filepos);
+      xbt_os_mutex_acquire(rctx->interruption);
+      rctx->interrupted = 1;
+      xbt_os_mutex_release(rctx->interruption);
       if (!rctx->reader_done) {
        kill(rctx->pid,SIGTERM);
        usleep(100);
-       kill(rctx->pid,SIGKILL);          
+       kill(rctx->pid,SIGKILL);
       }
-      xbt_mutex_unlock(rctx->interruption);
     }
   }
 
-  /* Remove myself from the tasks */
-  if (xbt_dynar_member(bg_jobs, &initiator)) {
-    int mypos = xbt_dynar_search(bg_jobs, &initiator);
-    rctx_t myself;
-    xbt_dynar_remove_at(bg_jobs,mypos,&myself);
-    //    rctx_free(myself);
-  } 
-
-  /* Cleanup the place */
-  //  xbt_dynar_free(&bg_jobs);
-
+  VERB0("Shut everything down!");
   exit(exitcode);
 }
 
@@ -94,12 +104,33 @@ void rctx_armageddon(rctx_t initiator, int exitcode) {
  * Memory management
  */
 
+# ifdef __APPLE__
+/* under darwin, the environment gets added to the process at startup time. So, it's not defined at library link time, forcing us to extra tricks */
+# include <crt_externs.h>
+# define environ (*_NSGetEnviron())
+# else
+ /* the environment, as specified by the opengroup, used to initialize the process properties */
+ extern char **environ;
+# endif
+
 void rctx_empty(rctx_t rc) {
+  int i;
+  char **env_it=environ;
+
   if (rc->cmd)
     free(rc->cmd);
   rc->cmd = NULL;
   if (rc->filepos)
     free(rc->filepos);
+  if (rc->env)
+     free(rc->env);
+
+  for (i=0;*env_it;i++,env_it++);
+  i++;
+  rc->env_size = i;
+  rc->env = malloc(i*sizeof(char*));
+  memcpy(rc->env,environ,i*sizeof(char*));
+
   rc->filepos = NULL;
   rc->is_empty = 1;
   rc->is_background = 0;
@@ -108,18 +139,19 @@ void rctx_empty(rctx_t rc) {
   rc->brokenpipe = 0;
   rc->timeout = 0;
   rc->interrupted = 0;
-  buff_empty(rc->input);
-  buff_empty(rc->output_wanted);
-  buff_empty(rc->output_got);
+  xbt_strbuff_empty(rc->input);
+  xbt_strbuff_empty(rc->output_wanted);
+  xbt_strbuff_empty(rc->output_got);
 }
 
+
 rctx_t rctx_new() {
   rctx_t res = xbt_new0(s_rctx_t,1);
 
-  res->input=buff_new();
-  res->output_wanted=buff_new();
-  res->output_got=buff_new();
-  res->interruption = xbt_mutex_init();
+  res->input=xbt_strbuff_new();
+  res->output_wanted=xbt_strbuff_new();
+  res->output_got=xbt_strbuff_new();
+  res->interruption = xbt_os_mutex_init();
   rctx_empty(res);
   return res;
 }
@@ -134,10 +166,12 @@ void rctx_free(rctx_t rctx) {
     free(rctx->cmd);
   if (rctx->filepos)
     free(rctx->filepos);
-  xbt_mutex_destroy(rctx->interruption);
-  buff_free(rctx->input);
-  buff_free(rctx->output_got);
-  buff_free(rctx->output_wanted);
+  if (rctx->env)
+    free(rctx->env);
+  xbt_os_mutex_destroy(rctx->interruption);
+  xbt_strbuff_free(rctx->input);
+  xbt_strbuff_free(rctx->output_got);
+  xbt_strbuff_free(rctx->output_wanted);
   free(rctx);
 }
 
@@ -157,7 +191,7 @@ void rctx_dump(rctx_t rctx, const char *str) {
  */
 
 void rctx_pushline(const char* filepos, char kind, char *line) {
-  
+
   switch (kind) {
   case '$':
   case '&':
@@ -168,6 +202,7 @@ void rctx_pushline(const char* filepos, char kind, char *line) {
               filepos,rctx->cmd);
        ERROR1("Test suite `%s': NOK (syntax error)",testsuite_name);
        rctx_armageddon(rctx,1);
+       return;
       }
       rctx_start();
       VERB1("[%s] More than one command in this chunk of lines",filepos);
@@ -176,39 +211,42 @@ void rctx_pushline(const char* filepos, char kind, char *line) {
       rctx->is_background = 1;
     else
       rctx->is_background = 0;
-      
+
     rctx->cmd = xbt_strdup(line);
     rctx->filepos = xbt_strdup(filepos);
     INFO3("[%s] %s%s",filepos,rctx->cmd,
          ((rctx->is_background)?" (background command)":""));
 
     break;
-    
+
   case '<':
     rctx->is_empty = 0;
-    buff_append(rctx->input,line);
-    buff_append(rctx->input,"\n");
+    xbt_strbuff_append(rctx->input,line);
+    xbt_strbuff_append(rctx->input,"\n");
     break;
 
   case '>':
     rctx->is_empty = 0;
-    buff_append(rctx->output_wanted,line);
-    buff_append(rctx->output_wanted,"\n");
+    xbt_strbuff_append(rctx->output_wanted,line);
+    xbt_strbuff_append(rctx->output_wanted,"\n");
     break;
 
   case '!':
     if (rctx->cmd)
       rctx_start();
 
-    if (!strncmp(line,"set timeout ",strlen("set timeout "))) {
-      timeout_value=atoi(line+strlen("set timeout"));
+    if (!strncmp(line,"timeout no",strlen("timeout no"))) {
+      VERB1("[%s] (disable timeout)", filepos);
+      timeout_value = -1;
+    } else if (!strncmp(line,"timeout ",strlen("timeout "))) {
+      timeout_value=atoi(line+strlen("timeout"));
       VERB2("[%s] (new timeout value: %d)",
             filepos,timeout_value);
 
     } else if (!strncmp(line,"expect signal ",strlen("expect signal "))) {
       rctx->expected_signal = strdup(line + strlen("expect signal "));
       xbt_str_trim(rctx->expected_signal," \n");
-          VERB2("[%s] (next command must raise signal %s)", 
+          VERB2("[%s] (next command must raise signal %s)",
                 filepos, rctx->expected_signal);
 
     } else if (!strncmp(line,"expect return ",strlen("expect return "))) {
@@ -219,21 +257,28 @@ void rctx_pushline(const char* filepos, char kind, char *line) {
     } else if (!strncmp(line,"output ignore",strlen("output ignore"))) {
       rctx->output = e_output_ignore;
       VERB1("[%s] (ignore output of next command)", filepos);
-       
+
     } else if (!strncmp(line,"output display",strlen("output display"))) {
       rctx->output = e_output_display;
       VERB1("[%s] (ignore output of next command)", filepos);
-       
+
+    } else if (!strncmp(line,"setenv ",strlen("setenv "))) {
+      rctx->env = realloc(rctx->env,++(rctx->env_size)*sizeof(char*));
+      rctx->env[rctx->env_size-2] = xbt_strdup(line+strlen("setenv "));
+      rctx->env[rctx->env_size-1] = NULL;
+      VERB1("[%s] (ignore output of next command)", filepos);
+
     } else {
       ERROR2("%s: Malformed metacommand: %s",filepos,line);
       ERROR1("Test suite `%s': NOK (syntax error)",testsuite_name);
       rctx_armageddon(rctx,1);
+      return;
     }
     break;
   }
 }
 
-/* 
+/*
  * Actually doing the job
  */
 
@@ -256,6 +301,7 @@ static void* thread_writer(void *r) {
        perror("Error while writing input to child");
        ERROR1("Test suite `%s': NOK (system error)",testsuite_name);
        rctx_armageddon(rctx,4);
+       return NULL;
       }
     }
     DEBUG1("written %d chars so far",posw);
@@ -280,10 +326,11 @@ static void *thread_reader(void *r) {
       perror("Error while reading output of child");
       ERROR1("Test suite `%s': NOK (system error)", testsuite_name);
       rctx_armageddon(rctx,4);
+      return NULL;
     }
     if (posr>0) {
       buffout[posr]='\0';
-      buff_append(rctx->output_got,buffout);
+      xbt_strbuff_append(rctx->output_got,buffout);
     } else {
       usleep(100);
     }
@@ -296,14 +343,15 @@ static void *thread_reader(void *r) {
     perror(bprintf("Cannot wait for the child %s",rctx->cmd));
     ERROR1("Test suite `%s': NOK (system error)", testsuite_name);
     rctx_armageddon(rctx,4);
+    return NULL;
   }
-   
+
   rctx->reader_done = 1;
   return NULL;
-} 
+}
 
-/* Start a new child, plug the pipes as expected and fire up the 
-   helping threads. Is also waits for the child to end if this is a 
+/* Start a new child, plug the pipes as expected and fire up the
+   helping threads. Is also waits for the child to end if this is a
    foreground job, or fire up a thread to wait otherwise. */
 
 void rctx_start(void) {
@@ -322,6 +370,7 @@ void rctx_start(void) {
     perror("Cannot fork the command");
     ERROR1("Test suite `%s': NOK (system error)", testsuite_name);
     rctx_armageddon(rctx,4);
+    return;
   }
 
   if (rctx->pid) { /* father */
@@ -331,11 +380,14 @@ void rctx_start(void) {
     close(child_out[1]);
     rctx->child_from = child_out[0];
 
-    rctx->end_time = time(NULL) + timeout_value;
+    if (timeout_value > 0)
+       rctx->end_time = time(NULL) + timeout_value;
+    else
+       rctx->end_time = -1;
 
     rctx->reader_done = 0;
-    rctx->reader = xbt_thread_create(thread_reader,(void*)rctx);
-    rctx->writer = xbt_thread_create(thread_writer,(void*)rctx);
+    rctx->reader = xbt_os_thread_create("reader",thread_reader,(void*)rctx);
+    rctx->writer = xbt_os_thread_create("writer",thread_writer,(void*)rctx);
 
   } else { /* child */
 
@@ -348,7 +400,60 @@ void rctx_start(void) {
     dup2(child_out[1],2);
     close(child_out[1]);
 
-    execlp ("/bin/sh", "sh", "-c", rctx->cmd, NULL);
+       xbt_dynar_t cmd = xbt_str_split_quoted(rctx->cmd);
+       char *file;
+       unsigned int it;
+       char *str;
+       char *long_cmd=xbt_strdup("");
+       xbt_dynar_get_cpy(cmd,0,&file);
+       char **args = xbt_new(char*,xbt_dynar_length(cmd)+1);
+       xbt_dynar_foreach(cmd,it,str) {
+               args[it] = xbt_strdup(str);
+               long_cmd = bprintf("%s %s",long_cmd,str);
+       }
+       args[it] = NULL;
+
+         /* To search for the right executable path when not trivial */
+         struct stat stat_buf;
+         char *binary_name = NULL;
+
+         /* build the command line */
+         if (stat(file, &stat_buf)) {
+           /* Damn. binary not in current dir. We'll have to dig the PATH to find it */
+           int i;
+
+           for (i = 0; environ[i]; i++) {
+             if (!strncmp("PATH=", environ[i], 5)) {
+               xbt_dynar_t path = xbt_str_split(environ[i] + 5, ":");
+
+               xbt_dynar_foreach(path, it, str) {
+                 if (binary_name)
+                   free(binary_name);
+                 binary_name = bprintf("%s/%s", str, file);
+                 if (!stat(binary_name, &stat_buf)) {
+                   /* Found. */
+                   DEBUG1("Looked in the PATH for the binary. Found %s",
+                          binary_name);
+                   xbt_dynar_free(&path);
+                   break;
+                 }
+               }
+               xbt_dynar_free(&path);
+               if (stat(binary_name, &stat_buf)) {
+                 /* not found */
+                 ERROR1("Command %s not found",file);
+                 return;
+               }
+               break;
+             }
+           }
+         } else {
+           binary_name = xbt_strdup(file);
+         }
+
+
+       DEBUG2("execve %s %s env",binary_name,long_cmd);
+       execve(binary_name, args, rctx->env);
   }
 
   rctx->is_stoppable = 1;
@@ -358,13 +463,13 @@ void rctx_start(void) {
   } else {
     /* Damn. Copy the rctx and launch a thread to handle it */
     rctx_t old = rctx;
-    xbt_thread_t runner;
+    xbt_os_thread_t runner;
 
     rctx = rctx_new();
     DEBUG2("RCTX: new bg=%p, new fg=%p",old,rctx);
 
     DEBUG2("Launch a thread to wait for %s %d",old->cmd,old->pid);
-    runner = xbt_thread_create(rctx_wait,(void*)old);
+    runner = xbt_os_thread_create(old->cmd,rctx_wait,(void*)old);
     old->runner = runner;
     VERB3("Launched thread %p to wait for %s %d",
          runner,old->cmd, old->pid);
@@ -372,54 +477,53 @@ void rctx_start(void) {
   }
 }
 
-/* Waits for the child to end (or to timeout), and check its 
+/* Waits for the child to end (or to timeout), and check its
    ending conditions. This is launched from rctx_start but either in main
-   thread (for foreground jobs) or in a separate one for background jobs. 
-   That explains the prototype, forced by xbt_thread_create. */
+   thread (for foreground jobs) or in a separate one for background jobs.
+   That explains the prototype, forced by xbt_os_thread_create. */
 
 void *rctx_wait(void* r) {
   rctx_t rctx = (rctx_t)r;
   int errcode = 0;
   int now = time(NULL);
-    
+
   rctx_dump(rctx,"wait");
 
-  if (!rctx->is_stoppable) 
+  if (!rctx->is_stoppable)
     THROW1(unknown_error,0,"Cmd '%s' not started yet. Cannot wait it",
           rctx->cmd);
 
   /* Wait for the child to die or the timeout to happen (or an armageddon to happen) */
-  while (!rctx->interrupted && !rctx->reader_done && rctx->end_time >= now) {
+  while (!rctx->interrupted && !rctx->reader_done && (rctx->end_time <0 ||rctx->end_time >= now)) {
     usleep(100);
     now = time(NULL);
   }
-   
-  xbt_mutex_lock(rctx->interruption);
 
-  if (!rctx->interrupted && rctx->end_time < now) {    
+  xbt_os_mutex_acquire(rctx->interruption);
+  if (!rctx->interrupted && rctx->end_time > 0 && rctx->end_time < now) {
     INFO1("<%s> timeouted. Kill the process.",rctx->filepos);
     rctx->timeout = 1;
     kill(rctx->pid,SIGTERM);
     usleep(100);
-    kill(rctx->pid,SIGKILL);    
+    kill(rctx->pid,SIGKILL);
     rctx->reader_done = 1;
   }
-   
+
   /* Make sure helper threads die.
      Cannot block since they wait for the child we just killed
      if not already dead. */
-  xbt_thread_join(rctx->writer,NULL);
-  xbt_thread_join(rctx->reader,NULL);
+  xbt_os_thread_join(rctx->writer,NULL);
+  xbt_os_thread_join(rctx->reader,NULL);
 
-  /*  xbt_mutex_unlock(rctx->interruption);
+  /*  xbt_os_mutex_release(rctx->interruption);
   if (rctx->interrupted)
     return NULL;
-    xbt_mutex_lock(rctx->interruption);*/
-  buff_chomp(rctx->output_got);
-  buff_chomp(rctx->output_wanted);
-  buff_trim(rctx->output_got);
-  buff_trim(rctx->output_wanted);
+    xbt_os_mutex_acquire(rctx->interruption);*/
+
+  xbt_strbuff_chomp(rctx->output_got);
+  xbt_strbuff_chomp(rctx->output_wanted);
+  xbt_strbuff_trim(rctx->output_got);
+  xbt_strbuff_trim(rctx->output_wanted);
 
   /* Check for broken pipe */
   if (rctx->brokenpipe)
@@ -433,42 +537,45 @@ void *rctx_wait(void* r) {
     else
       INFO1("<%s> No output before timeout",
            rctx->filepos);
-    ERROR3("Test suite `%s': NOK (<%s> timeout after %d sec)", 
+    ERROR3("Test suite `%s': NOK (<%s> timeout after %d sec)",
           testsuite_name,rctx->filepos,timeout_value);
-    if (!rctx->interrupted)
+    DEBUG2("<%s> Interrupted = %d", rctx->filepos, rctx->interrupted);
+    if (!rctx->interrupted) {
       rctx_armageddon(rctx, 3);
+      return NULL;
+    }
   }
-      
+
   DEBUG2("RCTX=%p (pid=%d)",rctx,rctx->pid);
   DEBUG3("Status(%s|%d)=%d",rctx->cmd,rctx->pid,rctx->status);
 
   if (!rctx->interrupted) {
     if (WIFSIGNALED(rctx->status) && !rctx->expected_signal) {
-      ERROR3("Test suite `%s': NOK (<%s> got signal %s)", 
+      ERROR3("Test suite `%s': NOK (<%s> got signal %s)",
             testsuite_name, rctx->filepos,
             signal_name(WTERMSIG(rctx->status),NULL));
-      errcode = WTERMSIG(rctx->status)+4;      
+      errcode = WTERMSIG(rctx->status)+4;
     }
-    
+
     if (WIFSIGNALED(rctx->status) && rctx->expected_signal &&
        strcmp(signal_name(WTERMSIG(rctx->status),rctx->expected_signal),
               rctx->expected_signal)) {
-      ERROR4("Test suite `%s': NOK (%s got signal %s instead of %s)", 
+      ERROR4("Test suite `%s': NOK (%s got signal %s instead of %s)",
             testsuite_name, rctx->filepos,
             signal_name(WTERMSIG(rctx->status),rctx->expected_signal),
             rctx->expected_signal);
-      errcode = WTERMSIG(rctx->status)+4;      
+      errcode = WTERMSIG(rctx->status)+4;
     }
-    
+
     if (!WIFSIGNALED(rctx->status) && rctx->expected_signal) {
-      ERROR3("Test suite `%s': NOK (child %s expected signal %s)", 
+      ERROR3("Test suite `%s': NOK (child %s expected signal %s)",
             testsuite_name, rctx->filepos,
             rctx->expected_signal);
       errcode = 5;
     }
-    
+
     if (WIFEXITED(rctx->status) && WEXITSTATUS(rctx->status) != rctx->expected_return ) {
-      if (rctx->expected_return) 
+      if (rctx->expected_return)
        ERROR4("Test suite `%s': NOK (<%s> returned code %d instead of %d)",
               testsuite_name, rctx->filepos,
               WEXITSTATUS(rctx->status), rctx->expected_return);
@@ -476,10 +583,10 @@ void *rctx_wait(void* r) {
        ERROR3("Test suite `%s': NOK (<%s> returned code %d)",
               testsuite_name, rctx->filepos, WEXITSTATUS(rctx->status));
       errcode = 40+WEXITSTATUS(rctx->status);
-      
+
     }
     rctx->expected_return = 0;
-  
+
     if(rctx->expected_signal){
       free(rctx->expected_signal);
       rctx->expected_signal = NULL;
@@ -490,13 +597,13 @@ void *rctx_wait(void* r) {
       && (    rctx->output_got->used != rctx->output_wanted->used
           || strcmp(rctx->output_got->data, rctx->output_wanted->data))) {
     if (XBT_LOG_ISENABLED(tesh,xbt_log_priority_info)) {
-       char *diff= xbt_str_diff(rctx->output_wanted->data,rctx->output_got->data);       
+       char *diff= xbt_str_diff(rctx->output_wanted->data,rctx->output_got->data);
        ERROR2("Output of <%s> mismatch:\n%s",rctx->filepos,diff);
        free(diff);
-    }     
-    ERROR2("Test suite `%s': NOK (<%s> output mismatch)", 
+    }
+    ERROR2("Test suite `%s': NOK (<%s> output mismatch)",
           testsuite_name,rctx->filepos);
-     
+
     errcode=2;
   } else if (rctx->output == e_output_ignore) {
     INFO1("(ignoring the output of <%s> as requested)",rctx->filepos);
@@ -512,18 +619,20 @@ void *rctx_wait(void* r) {
     char *out = xbt_str_join(a,"\n||");
     xbt_dynar_free(&a);
     INFO2("Output of <%s> so far: \n||%s",rctx->filepos,out);
-    free(out);    
+    free(out);
   }
 
   if (!rctx->is_background) {
     rctx_empty(rctx);
   }
   if (errcode) {
-    if (!rctx->interrupted)
+    if (!rctx->interrupted) {
       rctx_armageddon(rctx, errcode);
+      return NULL;
+    }
   }
-  xbt_mutex_unlock(rctx->interruption);
 
+  xbt_os_mutex_release(rctx->interruption);
   return NULL;
 }