src/util/os_priority.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2002, 2003, 2004, 2005, 2006 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file util/os_priority.c
  23  * @brief Methods to set process priority
  24  * @author Nils Durner
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_common.h"
  29 #include "gnunet_os_lib.h"
  30 #include "disk.h"
  31
  32 #if WINDOWS
  33 #include "gnunet_signal_lib.h"
  34
  35 extern GNUNET_SIGNAL_Handler w32_sigchld_handler;
  36
  37 /**
  38  * @brief Waits for a process to terminate and invokes the SIGCHLD handler
  39  * @param h handle to the process
  40  */
  41 static DWORD WINAPI
  42 ChildWaitThread (HANDLE h)
  43 {
  44   WaitForSingleObject (h, INFINITE);
  45
  46   if (w32_sigchld_handler)
  47     w32_sigchld_handler ();
  48
  49   CloseHandle (h);
  50 }
  51 #endif
  52
  53 /**
  54  * Set process priority
  55  *
  56  * @param proc id of the process
  57  * @param prio priority value
  58  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  59  */
  60 int
  61 GNUNET_OS_set_process_priority (pid_t proc,
  62                                 enum GNUNET_SCHEDULER_Priority prio)
  63 {
  64   int rprio = 0;
  65
  66   GNUNET_assert (prio < GNUNET_SCHEDULER_PRIORITY_COUNT);
  67   if (prio == GNUNET_SCHEDULER_PRIORITY_KEEP)
  68     return GNUNET_OK;
  69   /* convert to MINGW/Unix values */
  70   switch (prio)
  71     {
  72     case GNUNET_SCHEDULER_PRIORITY_DEFAULT:
  73 #ifdef MINGW
  74       rprio = NORMAL_PRIORITY_CLASS;
  75 #else
  76       rprio = 0;
  77 #endif
  78       break;
  79     case GNUNET_SCHEDULER_PRIORITY_HIGH:
  80 #ifdef MINGW
  81       rprio = ABOVE_NORMAL_PRIORITY_CLASS;
  82 #else
  83       rprio = -5;
  84 #endif
  85       break;
  86     case GNUNET_SCHEDULER_PRIORITY_BACKGROUND:
  87 #ifdef MINGW
  88       rprio = BELOW_NORMAL_PRIORITY_CLASS;
  89 #else
  90       rprio = 10;
  91 #endif
  92       break;
  93     case GNUNET_SCHEDULER_PRIORITY_UI:
  94     case GNUNET_SCHEDULER_PRIORITY_URGENT:
  95 #ifdef MINGW
  96       rprio = HIGH_PRIORITY_CLASS;
  97 #else
  98       rprio = -10;
  99 #endif
 100       break;
 101     case GNUNET_SCHEDULER_PRIORITY_IDLE:
 102 #ifdef MINGW
 103       rprio = IDLE_PRIORITY_CLASS;
 104 #else
 105       rprio = 19;
 106 #endif
 107       break;
 108     default:
 109       GNUNET_assert (0);
 110       return GNUNET_SYSERR;
 111     }
 112   /* Set process priority */
 113 #ifdef MINGW
 114   SetPriorityClass (GetCurrentProcess (), rprio);
 115 #else
 116   if (proc == getpid ())
 117     {
 118       errno = 0;
 119       if ((-1 == nice (rprio)) && (errno != 0))
 120         {
 121           GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING |
 122                                GNUNET_ERROR_TYPE_BULK, "nice");
 123           return GNUNET_SYSERR;
 124         }
 125     }
 126   else
 127     {
 128       if (0 != setpriority (PRIO_PROCESS, proc, rprio))
 129
 130         {
 131           GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING |
 132                                GNUNET_ERROR_TYPE_BULK, "setpriority");
 133           return GNUNET_SYSERR;
 134         }
 135     }
 136 #endif
 137   return GNUNET_OK;
 138 }
 139
 140 /**
 141  * Start a process.
 142  *
 143  * @param pipe_stdin pipe to use to send input to child process (or NULL)
 144  * @param pipe_stdout pipe to use to get output from child process (or NULL)
 145  * @param filename name of the binary
 146  * @param ... NULL-terminated list of arguments to the process
 147  * @return process ID of the new process, -1 on error
 148  */
 149 pid_t
 150 GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin,
 151                          struct GNUNET_DISK_PipeHandle *pipe_stdout,
 152                          const char *filename, ...)
 153 {
 154   /* FIXME:  Make this work on windows!!! */
 155   va_list ap;
 156
 157 #ifndef MINGW
 158   pid_t ret;
 159   char **argv;
 160   int argc;
 161   int fd_stdout_write;
 162   int fd_stdout_read;
 163   int fd_stdin_read;
 164   int fd_stdin_write;
 165
 166   argc = 0;
 167   va_start (ap, filename);
 168   while (NULL != va_arg (ap, char *))
 169       argc++;
 170   va_end (ap);
 171   argv = GNUNET_malloc (sizeof (char *) * (argc + 1));
 172   argc = 0;
 173   va_start (ap, filename);
 174   while (NULL != (argv[argc] = va_arg (ap, char *)))
 175     argc++;
 176   va_end (ap);
 177   if (pipe_stdout != NULL)
 178     {
 179       GNUNET_DISK_internal_file_handle_ (GNUNET_DISK_pipe_handle(pipe_stdout, GNUNET_DISK_PIPE_END_WRITE), &fd_stdout_write, sizeof (int));
 180       GNUNET_DISK_internal_file_handle_ (GNUNET_DISK_pipe_handle(pipe_stdout, GNUNET_DISK_PIPE_END_READ), &fd_stdout_read, sizeof (int));
 181     }
 182   if (pipe_stdin != NULL)
 183     {
 184       GNUNET_DISK_internal_file_handle_ (GNUNET_DISK_pipe_handle(pipe_stdin, GNUNET_DISK_PIPE_END_READ), &fd_stdin_read, sizeof (int));
 185       GNUNET_DISK_internal_file_handle_ (GNUNET_DISK_pipe_handle(pipe_stdin, GNUNET_DISK_PIPE_END_WRITE), &fd_stdin_write, sizeof (int));
 186     }
 187
 188 #if HAVE_WORKING_VFORK
 189   ret = vfork ();
 190 #else
 191   ret = fork ();
 192 #endif
 193   if (ret != 0)
 194     {
 195       if (ret == -1)
 196         {
 197           GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
 198         }
 199       else
 200         {
 201
 202 #if HAVE_WORKING_VFORK
 203           /* let's hope vfork actually works; for some extreme cases (including
 204              a testcase) we need 'execvp' to have run before we return, since
 205              we may send a signal to the process next and we don't want it
 206              to be caught by OUR signal handler (but either by the default
 207              handler or the actual handler as installed by the process itself). */
 208 #else
 209           /* let's give the child process a chance to run execvp, 1s should
 210              be plenty in practice */
 211           if (pipe_stdout != NULL)
 212             GNUNET_DISK_pipe_close_end(pipe_stdout, GNUNET_DISK_PIPE_END_WRITE);
 213           if (pipe_stdin != NULL)
 214             GNUNET_DISK_pipe_close_end(pipe_stdin, GNUNET_DISK_PIPE_END_READ);
 215           sleep (1);
 216 #endif
 217         }
 218       GNUNET_free (argv);
 219       return ret;
 220     }
 221
 222   if (pipe_stdout != NULL)
 223     {
 224       dup2(fd_stdout_write, 1);
 225       close (fd_stdout_write);
 226       close (fd_stdout_read);
 227     }
 228
 229   if (pipe_stdin != NULL)
 230     {
 231
 232       dup2(fd_stdin_read, 0);
 233       close (fd_stdin_read);
 234       close (fd_stdin_write);
 235     }
 236
 237   execvp (filename, argv);
 238   GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "execvp", filename);
 239   _exit (1);
 240 #else
 241   char *arg;
 242   unsigned int cmdlen;
 243   char *cmd, *idx;
 244   STARTUPINFO start;
 245   PROCESS_INFORMATION proc;
 246 #if NILS
 247   HANDLE stdin_handle;
 248   HANDLE stdout_handle;
 249 #endif
 250   char *fn;
 251   int len;
 252
 253   cmdlen = 0;
 254   va_start (ap, filename);
 255   while (NULL != (arg = va_arg (ap, char *)))
 256       cmdlen = cmdlen + strlen (arg) + 3;
 257   va_end (ap);
 258
 259   cmd = idx = GNUNET_malloc (sizeof (char) * cmdlen);
 260   va_start (ap, filename);
 261   while (NULL != (arg = va_arg (ap, char *)))
 262       idx += sprintf (idx, "\"%s\" ", arg);
 263   va_end (ap);
 264
 265   memset (&start, 0, sizeof (start));
 266   start.cb = sizeof (start);
 267
 268 #if NILS
 269   if ((pipe_stdin != NULL) || (pipe_stdout != NULL))
 270     start.dwFlags |= STARTF_USESTDHANDLES;
 271
 272   if (pipe_stdin != NULL)
 273     {
 274       GNUNET_DISK_internal_file_handle_ (GNUNET_DISK_pipe_handle(pipe_stdin, GNUNET_DISK_PIPE_END_READ), &stdin_handle, sizeof (HANDLE));
 275       start.hStdInput = stdin_handle;
 276     }
 277
 278   if (pipe_stdout != NULL)
 279     {
 280       GNUNET_DISK_internal_file_handle_ (GNUNET_DISK_pipe_handle(pipe_stdout, GNUNET_DISK_PIPE_END_WRITE), &stdout_handle, sizeof (HANDLE));
 281       start.hStdOutput = stdout_handle;
 282     }
 283 #endif
 284   len = strlen (filename);
 285   if (strnicmp (filename + len - 4, ".exe", 4) == 0)
 286     fn = filename;
 287   else
 288     GNUNET_asprintf (&fn, "%s.exe", filename);
 289
 290   if (!CreateProcess
 291       (fn, cmd, NULL, NULL, FALSE, DETACHED_PROCESS, NULL, NULL, &start,
 292        &proc))
 293     {
 294       SetErrnoFromWinError (GetLastError ());
 295       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "CreateProcess", fn);
 296       return -1;
 297     }
 298
 299   CreateThread (NULL, 64000, ChildWaitThread, proc.hProcess, 0, NULL);
 300
 301   if (fn != filename)
 302     GNUNET_free (fn);
 303   CloseHandle (proc.hThread);
 304
 305   GNUNET_free (cmd);
 306
 307   return proc.dwProcessId;
 308 #endif
 309
 310 }
 311
 312
 313
 314 /**
 315  * Start a process.
 316  *
 317  * @param filename name of the binary
 318  * @param argv NULL-terminated list of arguments to the process
 319  * @return process ID of the new process, -1 on error
 320  */
 321 pid_t
 322 GNUNET_OS_start_process_v (const char *filename, char *const argv[])
 323 {
 324 #ifndef MINGW
 325   pid_t ret;
 326
 327 #if HAVE_WORKING_VFORK
 328   ret = vfork ();
 329 #else
 330   ret = fork ();
 331 #endif
 332   if (ret != 0)
 333     {
 334       if (ret == -1)
 335         {
 336           GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
 337         }
 338       else
 339         {
 340 #if HAVE_WORKING_VFORK
 341           /* let's hope vfork actually works; for some extreme cases (including
 342              a testcase) we need 'execvp' to have run before we return, since
 343              we may send a signal to the process next and we don't want it
 344              to be caught by OUR signal handler (but either by the default
 345              handler or the actual handler as installed by the process itself). */
 346 #else
 347           /* let's give the child process a chance to run execvp, 1s should
 348              be plenty in practice */
 349           sleep (1);
 350 #endif
 351         }
 352       return ret;
 353     }
 354   execvp (filename, argv);
 355   GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "execvp", filename);
 356   _exit (1);
 357 #else
 358   char **arg;
 359   unsigned int cmdlen;
 360   char *cmd, *idx;
 361   STARTUPINFO start;
 362   PROCESS_INFORMATION proc;
 363
 364   cmdlen = 0;
 365   arg = argv;
 366   while (*arg)
 367     {
 368       cmdlen = cmdlen + strlen (*arg) + 3;
 369       arg++;
 370     }
 371
 372   cmd = idx = GNUNET_malloc (sizeof (char) * cmdlen);
 373   arg = argv;
 374   while (*arg)
 375     {
 376       idx += sprintf (idx, "\"%s\" ", *arg);
 377       arg++;
 378     }
 379
 380   memset (&start, 0, sizeof (start));
 381   start.cb = sizeof (start);
 382
 383   if (!CreateProcess
 384       (filename, cmd, NULL, NULL, FALSE, DETACHED_PROCESS, NULL, NULL, &start,
 385        &proc))
 386     {
 387       SetErrnoFromWinError (GetLastError ());
 388       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "fork");
 389       return -1;
 390     }
 391
 392   CreateThread (NULL, 64000, ChildWaitThread, proc.hProcess, 0, NULL);
 393
 394   CloseHandle (proc.hThread);
 395   GNUNET_free (cmd);
 396
 397   return proc.dwProcessId;
 398 #endif
 399 }
 400
 401 /**
 402  * Retrieve the status of a process
 403  * @param proc process ID
 404  * @param type status type
 405  * @param code return code/signal number
 406  * @return GNUNET_OK on success, GNUNET_NO if the process is still running, GNUNET_SYSERR otherwise
 407  */
 408 int
 409 GNUNET_OS_process_status (pid_t proc, enum GNUNET_OS_ProcessStatusType *type,
 410                           unsigned long *code)
 411 {
 412 #ifndef MINGW
 413   int status;
 414   int ret;
 415
 416   GNUNET_assert (0 != proc);
 417   ret = waitpid (proc, &status, WNOHANG);
 418   if (0 == ret)
 419     {
 420       *type = GNUNET_OS_PROCESS_RUNNING;
 421       *code = 0;
 422       return GNUNET_NO;
 423     }
 424   if (proc != ret)
 425     {
 426       GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 427       return GNUNET_SYSERR;
 428     }
 429   if (WIFEXITED (status))
 430     {
 431       *type = GNUNET_OS_PROCESS_EXITED;
 432       *code = WEXITSTATUS (status);
 433     }
 434   else if (WIFSIGNALED (status))
 435     {
 436       *type = GNUNET_OS_PROCESS_SIGNALED;
 437       *code = WTERMSIG (status);
 438     }
 439   else if (WIFSTOPPED (status))
 440     {
 441       *type = GNUNET_OS_PROCESS_SIGNALED;
 442       *code = WSTOPSIG (status);
 443     }
 444 #ifdef WIFCONTINUED
 445   else if (WIFCONTINUED (status))
 446     {
 447       *type = GNUNET_OS_PROCESS_RUNNING;
 448       *code = 0;
 449     }
 450 #endif
 451   else
 452     {
 453       *type = GNUNET_OS_PROCESS_UNKNOWN;
 454       *code = 0;
 455     }
 456 #else
 457   HANDLE h;
 458   DWORD c;
 459
 460   h = OpenProcess (PROCESS_QUERY_INFORMATION, FALSE, proc);
 461   if (INVALID_HANDLE_VALUE == h)
 462     {
 463       SetErrnoFromWinError (GetLastError ());
 464       GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "OpenProcess");
 465       return GNUNET_SYSERR;
 466     }
 467
 468   c = GetExitCodeProcess (proc, &c);
 469   if (STILL_ACTIVE == c)
 470     {
 471       *type = GNUNET_OS_PROCESS_RUNNING;
 472       *code = 0;
 473       CloseHandle (h);
 474       return GNUNET_NO;
 475     }
 476   *type = GNUNET_OS_PROCESS_EXITED;
 477   *code = c;
 478   CloseHandle (h);
 479 #endif
 480
 481   return GNUNET_OK;
 482 }
 483
 484 /**
 485  * Wait for a process
 486  * @param proc process ID to wait for
 487  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 488  */
 489 int
 490 GNUNET_OS_process_wait (pid_t proc)
 491 {
 492 #ifndef MINGW
 493   if (proc != waitpid (proc, NULL, 0))
 494     return GNUNET_SYSERR;
 495
 496   return GNUNET_OK;
 497 #else
 498   HANDLE h;
 499   DWORD c;
 500   int ret;
 501
 502   h = OpenProcess (PROCESS_QUERY_INFORMATION, FALSE, proc);
 503   if (INVALID_HANDLE_VALUE == h)
 504     {
 505       SetErrnoFromWinError (GetLastError ());
 506       return GNUNET_SYSERR;
 507     }
 508
 509   if (WAIT_OBJECT_0 != WaitForSingleObject (h, INFINITE))
 510     {
 511       SetErrnoFromWinError (GetLastError ());
 512       ret = GNUNET_SYSERR;
 513     }
 514   else
 515     ret = GNUNET_OK;
 516
 517   CloseHandle (h);
 518
 519   return ret;
 520 #endif
 521 }
 522
 523
 524 /* end of os_priority.c */