dbus/dbus-spawn.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-spawn.c Wrapper around fork/exec
   3  *
   4  * Copyright (C) 2002, 2003  Red Hat, Inc.
   5  * Copyright (C) 2003 CodeFactory AB
   6  *
   7  * Licensed under the Academic Free License version 1.2
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  */
  24 #include "dbus-spawn.h"
  25 #include "dbus-sysdeps.h"
  26 #include "dbus-internals.h"
  27 #include "dbus-test.h"
  28
  29 #include <unistd.h>
  30 #include <fcntl.h>
  31 #include <signal.h>
  32 #include <sys/wait.h>
  33 #include <errno.h>
  34
  35 /**
  36  * @addtogroup DBusInternalsUtils
  37  * @{
  38  */
  39
  40 /*
  41  * I'm pretty sure this whole spawn file could be made simpler,
  42  * if you thought about it a bit.
  43  */
  44
  45 /**
  46  * Enumeration for status of a read()
  47  */
  48 typedef enum
  49 {
  50   READ_STATUS_OK,    /**< Read succeeded */
  51   READ_STATUS_ERROR, /**< Some kind of error */
  52   READ_STATUS_EOF    /**< EOF returned */
  53 } ReadStatus;
  54
  55 static ReadStatus
  56 read_ints (int        fd,
  57            int       *buf,
  58            int        n_ints_in_buf,
  59            int       *n_ints_read,
  60            DBusError *error)
  61 {
  62   size_t bytes = 0;
  63   ReadStatus retval;
  64
  65   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
  66
  67   retval = READ_STATUS_OK;
  68
  69   while (TRUE)
  70     {
  71       size_t chunk;
  72       size_t to_read;
  73
  74     again:
  75
  76       to_read = sizeof (int) * n_ints_in_buf - bytes;
  77
  78       if (to_read == 0)
  79         break;
  80
  81       chunk = read (fd,
  82                     ((char*)buf) + bytes,
  83                     to_read);
  84
  85       if (chunk < 0 && errno == EINTR)
  86         goto again;
  87
  88       if (chunk < 0)
  89         {
  90           dbus_set_error (error,
  91                           DBUS_ERROR_SPAWN_FAILED,
  92                           "Failed to read from child pipe (%s)",
  93                           _dbus_strerror (errno));
  94
  95           retval = READ_STATUS_ERROR;
  96           break;
  97         }
  98       else if (chunk == 0)
  99         {
 100           retval = READ_STATUS_EOF;
 101           break; /* EOF */
 102         }
 103       else /* chunk > 0 */
 104         bytes += chunk;
 105     }
 106
 107   *n_ints_read = (int)(bytes / sizeof(int));
 108
 109   return retval;
 110 }
 111
 112 static ReadStatus
 113 read_pid (int        fd,
 114           pid_t     *buf,
 115           DBusError *error)
 116 {
 117   size_t bytes = 0;
 118   ReadStatus retval;
 119
 120   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 121
 122   retval = READ_STATUS_OK;
 123
 124   while (TRUE)
 125     {
 126       size_t chunk;
 127       size_t to_read;
 128
 129     again:
 130       to_read = sizeof (pid_t) - bytes;
 131
 132       if (to_read == 0)
 133         break;
 134
 135       chunk = read (fd,
 136                     ((char*)buf) + bytes,
 137                     to_read);
 138       if (chunk < 0 && errno == EINTR)
 139         goto again;
 140
 141       if (chunk < 0)
 142         {
 143           dbus_set_error (error,
 144                           DBUS_ERROR_SPAWN_FAILED,
 145                           "Failed to read from child pipe (%s)",
 146                           _dbus_strerror (errno));
 147
 148           retval = READ_STATUS_ERROR;
 149           break;
 150         }
 151       else if (chunk == 0)
 152         {
 153           retval = READ_STATUS_EOF;
 154           break; /* EOF */
 155         }
 156       else /* chunk > 0 */
 157         bytes += chunk;
 158     }
 159
 160   return retval;
 161 }
 162
 163 /* The implementation uses an intermediate child between the main process
 164  * and the grandchild. The grandchild is our spawned process. The intermediate
 165  * child is a babysitter process; it keeps track of when the grandchild
 166  * exits/crashes, and reaps the grandchild.
 167  */
 168
 169 /* Messages from children to parents */
 170 enum
 171 {
 172   CHILD_EXITED,            /* This message is followed by the exit status int */
 173   CHILD_FORK_FAILED,       /* Followed by errno */
 174   CHILD_EXEC_FAILED,       /* Followed by errno */
 175   CHILD_PID                /* Followed by pid_t */
 176 };
 177
 178 struct DBusBabysitter
 179 {
 180   int refcount;
 181
 182   char *executable; /**< executable name to use in error messages */
 183
 184   int socket_to_babysitter;
 185   int error_pipe_from_child;
 186
 187   pid_t sitter_pid;
 188   pid_t grandchild_pid;
 189
 190   DBusWatchList *watches;
 191
 192   DBusWatch *error_watch;
 193   DBusWatch *sitter_watch;
 194
 195   int errnum;
 196   int status;
 197   unsigned int have_child_status : 1;
 198   unsigned int have_fork_errnum : 1;
 199   unsigned int have_exec_errnum : 1;
 200 };
 201
 202 static DBusBabysitter*
 203 _dbus_babysitter_new (void)
 204 {
 205   DBusBabysitter *sitter;
 206
 207   sitter = dbus_new0 (DBusBabysitter, 1);
 208   if (sitter == NULL)
 209     return NULL;
 210
 211   sitter->refcount = 1;
 212
 213   sitter->socket_to_babysitter = -1;
 214   sitter->error_pipe_from_child = -1;
 215
 216   sitter->sitter_pid = -1;
 217   sitter->grandchild_pid = -1;
 218
 219   sitter->watches = _dbus_watch_list_new ();
 220   if (sitter->watches == NULL)
 221     goto failed;
 222
 223   return sitter;
 224
 225  failed:
 226   _dbus_babysitter_unref (sitter);
 227   return NULL;
 228 }
 229
 230 /**
 231  * Increment the reference count on the babysitter object.
 232  *
 233  * @param sitter the babysitter
 234  */
 235 void
 236 _dbus_babysitter_ref (DBusBabysitter *sitter)
 237 {
 238   _dbus_assert (sitter != NULL);
 239   _dbus_assert (sitter->refcount > 0);
 240
 241   sitter->refcount += 1;
 242 }
 243
 244 /**
 245  * Decrement the reference count on the babysitter object.
 246  *
 247  * @param sitter the babysitter
 248  */
 249 void
 250 _dbus_babysitter_unref (DBusBabysitter *sitter)
 251 {
 252   _dbus_assert (sitter != NULL);
 253   _dbus_assert (sitter->refcount > 0);
 254
 255   sitter->refcount -= 1;
 256   if (sitter->refcount == 0)
 257     {
 258       if (sitter->socket_to_babysitter >= 0)
 259         {
 260           close (sitter->socket_to_babysitter);
 261           sitter->socket_to_babysitter = -1;
 262         }
 263
 264       if (sitter->error_pipe_from_child >= 0)
 265         {
 266           close (sitter->error_pipe_from_child);
 267           sitter->error_pipe_from_child = -1;
 268         }
 269
 270       if (sitter->sitter_pid != -1)
 271         {
 272           int status;
 273           int ret;
 274
 275           /* Reap the babysitter */
 276         again:
 277           ret = waitpid (sitter->sitter_pid, &status, 0);
 278           if (ret < 0)
 279             {
 280               if (errno == EINTR)
 281                 goto again;
 282               else if (errno == ECHILD)
 283                 _dbus_warn ("Babysitter process not available to be reaped; should not happen\n");
 284               else
 285                 _dbus_warn ("Unexpected error %d in waitpid() for babysitter: %s\n",
 286                             errno, _dbus_strerror (errno));
 287             }
 288           else
 289             {
 290               _dbus_verbose ("Reaped %ld, waiting for babysitter %ld\n",
 291                              (long) ret, (long) sitter->sitter_pid);
 292
 293               if (WIFEXITED (sitter->status))
 294                 _dbus_verbose ("Babysitter exited with status %d\n",
 295                                WEXITSTATUS (sitter->status));
 296               else if (WIFSIGNALED (sitter->status))
 297                 _dbus_verbose ("Babysitter received signal %d\n",
 298                                WTERMSIG (sitter->status));
 299               else
 300                 _dbus_verbose ("Babysitter exited abnormally\n");
 301             }
 302
 303           sitter->sitter_pid = -1;
 304         }
 305
 306       if (sitter->error_watch)
 307         {
 308           _dbus_watch_invalidate (sitter->error_watch);
 309           _dbus_watch_unref (sitter->error_watch);
 310           sitter->error_watch = NULL;
 311         }
 312
 313       if (sitter->sitter_watch)
 314         {
 315           _dbus_watch_invalidate (sitter->sitter_watch);
 316           _dbus_watch_unref (sitter->sitter_watch);
 317           sitter->sitter_watch = NULL;
 318         }
 319
 320       if (sitter->watches)
 321         _dbus_watch_list_free (sitter->watches);
 322
 323       dbus_free (sitter->executable);
 324
 325       dbus_free (sitter);
 326     }
 327 }
 328
 329 static ReadStatus
 330 read_data (DBusBabysitter *sitter,
 331            int             fd)
 332 {
 333   int what;
 334   int got;
 335   DBusError error;
 336   ReadStatus r;
 337
 338   dbus_error_init (&error);
 339
 340   r = read_ints (fd, &what, 1, &got, &error);
 341
 342   switch (r)
 343     {
 344     case READ_STATUS_ERROR:
 345       _dbus_warn ("Failed to read data from fd %d: %s\n", fd, error.message);
 346       dbus_error_free (&error);
 347       return r;
 348
 349     case READ_STATUS_EOF:
 350       return r;
 351
 352     case READ_STATUS_OK:
 353       break;
 354     }
 355
 356   if (got == 1)
 357     {
 358       switch (what)
 359         {
 360         case CHILD_EXITED:
 361         case CHILD_FORK_FAILED:
 362         case CHILD_EXEC_FAILED:
 363           {
 364             int arg;
 365
 366             r = read_ints (fd, &arg, 1, &got, &error);
 367
 368             switch (r)
 369               {
 370               case READ_STATUS_ERROR:
 371                 _dbus_warn ("Failed to read arg from fd %d: %s\n", fd, error.message);
 372                 dbus_error_free (&error);
 373                 return r;
 374               case READ_STATUS_EOF:
 375                 return r;
 376               case READ_STATUS_OK:
 377                 break;
 378               }
 379
 380             if (got == 1)
 381               {
 382                 if (what == CHILD_EXITED)
 383                   {
 384                     sitter->have_child_status = TRUE;
 385                     sitter->status = arg;
 386                     _dbus_verbose ("recorded child status exited = %d signaled = %d exitstatus = %d termsig = %d\n",
 387                                    WIFEXITED (sitter->status), WIFSIGNALED (sitter->status),
 388                                    WEXITSTATUS (sitter->status), WTERMSIG (sitter->status));
 389                   }
 390                 else if (what == CHILD_FORK_FAILED)
 391                   {
 392                     sitter->have_fork_errnum = TRUE;
 393                     sitter->errnum = arg;
 394                     _dbus_verbose ("recorded fork errnum %d\n", sitter->errnum);
 395                   }
 396                 else if (what == CHILD_EXEC_FAILED)
 397                   {
 398                     sitter->have_exec_errnum = TRUE;
 399                     sitter->errnum = arg;
 400                     _dbus_verbose ("recorded exec errnum %d\n", sitter->errnum);
 401                   }
 402               }
 403           }
 404           break;
 405         case CHILD_PID:
 406           {
 407             pid_t pid = -1;
 408
 409             r = read_pid (fd, &pid, &error);
 410
 411             switch (r)
 412               {
 413               case READ_STATUS_ERROR:
 414                 _dbus_warn ("Failed to read PID from fd %d: %s\n", fd, error.message);
 415                 dbus_error_free (&error);
 416                 return r;
 417               case READ_STATUS_EOF:
 418                 return r;
 419               case READ_STATUS_OK:
 420                 break;
 421               }
 422
 423             sitter->grandchild_pid = pid;
 424
 425             _dbus_verbose ("recorded grandchild pid %d\n", sitter->grandchild_pid);
 426           }
 427           break;
 428         default:
 429           _dbus_warn ("Unknown message received from babysitter process\n");
 430           break;
 431         }
 432     }
 433
 434   return r;
 435 }
 436
 437 static void
 438 close_socket_to_babysitter (DBusBabysitter *sitter)
 439 {
 440   _dbus_verbose ("Closing babysitter\n");
 441   close (sitter->socket_to_babysitter);
 442   sitter->socket_to_babysitter = -1;
 443 }
 444
 445 static void
 446 close_error_pipe_from_child (DBusBabysitter *sitter)
 447 {
 448   _dbus_verbose ("Closing child error\n");
 449   close (sitter->error_pipe_from_child);
 450   sitter->error_pipe_from_child = -1;
 451 }
 452
 453 static void
 454 handle_babysitter_socket (DBusBabysitter *sitter,
 455                           int             revents)
 456 {
 457   /* Even if we have POLLHUP, we want to keep reading
 458    * data until POLLIN goes away; so this function only
 459    * looks at HUP/ERR if no IN is set.
 460    */
 461   if (revents & _DBUS_POLLIN)
 462     {
 463       _dbus_verbose ("Reading data from babysitter\n");
 464       if (read_data (sitter, sitter->socket_to_babysitter) != READ_STATUS_OK)
 465         close_socket_to_babysitter (sitter);
 466     }
 467   else if (revents & (_DBUS_POLLERR | _DBUS_POLLHUP))
 468     {
 469       close_socket_to_babysitter (sitter);
 470     }
 471 }
 472
 473 static void
 474 handle_error_pipe (DBusBabysitter *sitter,
 475                    int             revents)
 476 {
 477   if (revents & _DBUS_POLLIN)
 478     {
 479       _dbus_verbose ("Reading data from child error\n");
 480       if (read_data (sitter, sitter->error_pipe_from_child) != READ_STATUS_OK)
 481         close_error_pipe_from_child (sitter);
 482     }
 483   else if (revents & (_DBUS_POLLERR | _DBUS_POLLHUP))
 484     {
 485       close_error_pipe_from_child (sitter);
 486     }
 487 }
 488
 489 /* returns whether there were any poll events handled */
 490 static dbus_bool_t
 491 babysitter_iteration (DBusBabysitter *sitter,
 492                       dbus_bool_t     block)
 493 {
 494   DBusPollFD fds[2];
 495   int i;
 496   dbus_bool_t descriptors_ready;
 497
 498   descriptors_ready = FALSE;
 499
 500   i = 0;
 501
 502   if (sitter->error_pipe_from_child >= 0)
 503     {
 504       fds[i].fd = sitter->error_pipe_from_child;
 505       fds[i].events = _DBUS_POLLIN;
 506       fds[i].revents = 0;
 507       ++i;
 508     }
 509
 510   if (sitter->socket_to_babysitter >= 0)
 511     {
 512       fds[i].fd = sitter->socket_to_babysitter;
 513       fds[i].events = _DBUS_POLLIN;
 514       fds[i].revents = 0;
 515       ++i;
 516     }
 517
 518   if (i > 0)
 519     {
 520       int ret;
 521
 522       ret = _dbus_poll (fds, i, 0);
 523       if (ret == 0 && block)
 524         ret = _dbus_poll (fds, i, -1);
 525
 526       if (ret > 0)
 527         {
 528           descriptors_ready = TRUE;
 529
 530           while (i > 0)
 531             {
 532               --i;
 533               if (fds[i].fd == sitter->error_pipe_from_child)
 534                 handle_error_pipe (sitter, fds[i].revents);
 535               else if (fds[i].fd == sitter->socket_to_babysitter)
 536                 handle_babysitter_socket (sitter, fds[i].revents);
 537             }
 538         }
 539     }
 540
 541   return descriptors_ready;
 542 }
 543
 544 /**
 545  * Macro returns #TRUE if the babysitter still has live sockets open to the
 546  * babysitter child or the grandchild.
 547  */
 548 #define LIVE_CHILDREN(sitter) ((sitter)->socket_to_babysitter >= 0 || (sitter)->error_pipe_from_child >= 0)
 549
 550 /**
 551  * Blocks until the babysitter process gives us the PID of the spawned grandchild,
 552  * then kills the spawned grandchild.
 553  *
 554  * @param sitter the babysitter object
 555  */
 556 void
 557 _dbus_babysitter_kill_child (DBusBabysitter *sitter)
 558 {
 559   /* be sure we have the PID of the child */
 560   while (LIVE_CHILDREN (sitter) &&
 561          sitter->grandchild_pid == -1)
 562     babysitter_iteration (sitter, TRUE);
 563
 564   _dbus_verbose ("Got child PID %ld for killing\n",
 565                  (long) sitter->grandchild_pid);
 566
 567   if (sitter->grandchild_pid == -1)
 568     return; /* child is already dead, or we're so hosed we'll never recover */
 569
 570   kill (sitter->grandchild_pid, SIGKILL);
 571 }
 572
 573 /**
 574  * Checks whether the child has exited, without blocking.
 575  *
 576  * @param sitter the babysitter
 577  */
 578 dbus_bool_t
 579 _dbus_babysitter_get_child_exited (DBusBabysitter *sitter)
 580 {
 581
 582   /* Be sure we're up-to-date */
 583   while (LIVE_CHILDREN (sitter) &&
 584          babysitter_iteration (sitter, FALSE))
 585     ;
 586
 587   /* We will have exited the babysitter when the child has exited */
 588   return sitter->socket_to_babysitter < 0;
 589 }
 590
 591 static void
 592 _dbus_babysitter_block_for_child_exit (DBusBabysitter *sitter)
 593 {
 594   while (LIVE_CHILDREN (sitter))
 595     babysitter_iteration (sitter, TRUE);
 596 }
 597
 598 /**
 599  * Sets the #DBusError with an explanation of why the spawned
 600  * child process exited (on a signal, or whatever). If
 601  * the child process has not exited, does nothing (error
 602  * will remain unset).
 603  *
 604  * @param sitter the babysitter
 605  * @param error an error to fill in
 606  */
 607 void
 608 _dbus_babysitter_set_child_exit_error (DBusBabysitter *sitter,
 609                                        DBusError      *error)
 610 {
 611   if (!_dbus_babysitter_get_child_exited (sitter))
 612     return;
 613
 614   /* Note that if exec fails, we will also get a child status
 615    * from the babysitter saying the child exited,
 616    * so we need to give priority to the exec error
 617    */
 618   if (sitter->have_exec_errnum)
 619     {
 620       dbus_set_error (error, DBUS_ERROR_SPAWN_EXEC_FAILED,
 621                       "Failed to execute program %s: %s",
 622                       sitter->executable, _dbus_strerror (sitter->errnum));
 623     }
 624   else if (sitter->have_fork_errnum)
 625     {
 626       dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
 627                       "Failed to fork a new process %s: %s",
 628                       sitter->executable, _dbus_strerror (sitter->errnum));
 629     }
 630   else if (sitter->have_child_status)
 631     {
 632       if (WIFEXITED (sitter->status))
 633         dbus_set_error (error, DBUS_ERROR_SPAWN_CHILD_EXITED,
 634                         "Process %s exited with status %d",
 635                         sitter->executable, WEXITSTATUS (sitter->status));
 636       else if (WIFSIGNALED (sitter->status))
 637         dbus_set_error (error, DBUS_ERROR_SPAWN_CHILD_SIGNALED,
 638                         "Process %s received signal %d",
 639                         sitter->executable, WTERMSIG (sitter->status));
 640       else
 641         dbus_set_error (error, DBUS_ERROR_FAILED,
 642                         "Process %s exited abnormally",
 643                         sitter->executable);
 644     }
 645   else
 646     {
 647       dbus_set_error (error, DBUS_ERROR_FAILED,
 648                       "Process %s exited, reason unknown",
 649                       sitter->executable);
 650     }
 651 }
 652
 653 /**
 654  * Sets watch functions to notify us when the
 655  * babysitter object needs to read/write file descriptors.
 656  *
 657  * @param sitter the babysitter
 658  * @param add_function function to begin monitoring a new descriptor.
 659  * @param remove_function function to stop monitoring a descriptor.
 660  * @param toggled_function function to notify when the watch is enabled/disabled
 661  * @param data data to pass to add_function and remove_function.
 662  * @param free_data_function function to be called to free the data.
 663  * @returns #FALSE on failure (no memory)
 664  */
 665 dbus_bool_t
 666 _dbus_babysitter_set_watch_functions (DBusBabysitter            *sitter,
 667                                       DBusAddWatchFunction       add_function,
 668                                       DBusRemoveWatchFunction    remove_function,
 669                                       DBusWatchToggledFunction   toggled_function,
 670                                       void                      *data,
 671                                       DBusFreeFunction           free_data_function)
 672 {
 673   return _dbus_watch_list_set_functions (sitter->watches,
 674                                          add_function,
 675                                          remove_function,
 676                                          toggled_function,
 677                                          data,
 678                                          free_data_function);
 679 }
 680
 681 /**
 682  * Handles watch when descriptors are ready.
 683  *
 684  * @param sitter the babysitter.
 685  * @param watch the watch object
 686  * @param condition the descriptor conditions
 687  * @returns #FALSE if there wasn't enough memory.
 688  *
 689  */
 690 dbus_bool_t
 691 _dbus_babysitter_handle_watch (DBusBabysitter  *sitter,
 692                                DBusWatch       *watch,
 693                                unsigned int     condition)
 694 {
 695   int revents;
 696   int fd;
 697
 698   revents = 0;
 699   if (condition & DBUS_WATCH_READABLE)
 700     revents |= _DBUS_POLLIN;
 701   if (condition & DBUS_WATCH_ERROR)
 702     revents |= _DBUS_POLLERR;
 703   if (condition & DBUS_WATCH_HANGUP)
 704     revents |= _DBUS_POLLHUP;
 705
 706   fd = dbus_watch_get_fd (watch);
 707
 708   if (fd == sitter->error_pipe_from_child)
 709     handle_error_pipe (sitter, revents);
 710   else if (fd == sitter->socket_to_babysitter)
 711     handle_babysitter_socket (sitter, revents);
 712
 713   while (LIVE_CHILDREN (sitter) &&
 714          babysitter_iteration (sitter, FALSE))
 715     ;
 716
 717   return TRUE;
 718 }
 719
 720 /** Helps remember which end of the pipe is which */
 721 #define READ_END 0
 722 /** Helps remember which end of the pipe is which */
 723 #define WRITE_END 1
 724
 725
 726 /* Avoids a danger in threaded situations (calling close()
 727  * on a file descriptor twice, and another thread has
 728  * re-opened it since the first close)
 729  */
 730 static int
 731 close_and_invalidate (int *fd)
 732 {
 733   int ret;
 734
 735   if (*fd < 0)
 736     return -1;
 737   else
 738     {
 739       ret = close (*fd);
 740       *fd = -1;
 741     }
 742
 743   return ret;
 744 }
 745
 746 static dbus_bool_t
 747 make_pipe (int         p[2],
 748            DBusError  *error)
 749 {
 750   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 751
 752   if (pipe (p) < 0)
 753     {
 754       dbus_set_error (error,
 755                       DBUS_ERROR_SPAWN_FAILED,
 756                       "Failed to create pipe for communicating with child process (%s)",
 757                       _dbus_strerror (errno));
 758       return FALSE;
 759     }
 760
 761   return TRUE;
 762 }
 763
 764 static void
 765 do_write (int fd, const void *buf, size_t count)
 766 {
 767   size_t bytes_written;
 768   int ret;
 769
 770   bytes_written = 0;
 771
 772  again:
 773
 774   ret = write (fd, ((const char*)buf) + bytes_written, count - bytes_written);
 775
 776   if (ret < 0)
 777     {
 778       if (errno == EINTR)
 779         goto again;
 780       else
 781         {
 782           _dbus_warn ("Failed to write data to pipe!\n");
 783           _exit (1); /* give up, we suck */
 784         }
 785     }
 786   else
 787     bytes_written += ret;
 788
 789   if (bytes_written < count)
 790     goto again;
 791 }
 792
 793 static void
 794 write_err_and_exit (int fd, int msg)
 795 {
 796   int en = errno;
 797
 798   do_write (fd, &msg, sizeof (msg));
 799   do_write (fd, &en, sizeof (en));
 800
 801   _exit (1);
 802 }
 803
 804 static void
 805 write_pid (int fd, pid_t pid)
 806 {
 807   int msg = CHILD_PID;
 808
 809   do_write (fd, &msg, sizeof (msg));
 810   do_write (fd, &pid, sizeof (pid));
 811 }
 812
 813 static void
 814 write_status_and_exit (int fd, int status)
 815 {
 816   int msg = CHILD_EXITED;
 817
 818   do_write (fd, &msg, sizeof (msg));
 819   do_write (fd, &status, sizeof (status));
 820
 821   _exit (0);
 822 }
 823
 824 static void
 825 do_exec (int                       child_err_report_fd,
 826          char                    **argv,
 827          DBusSpawnChildSetupFunc   child_setup,
 828          void                     *user_data)
 829 {
 830 #ifdef DBUS_BUILD_TESTS
 831   int i, max_open;
 832 #endif
 833
 834   _dbus_verbose_reset ();
 835   _dbus_verbose ("Child process has PID %lu\n",
 836                  _dbus_getpid ());
 837
 838   if (child_setup)
 839     (* child_setup) (user_data);
 840
 841 #ifdef DBUS_BUILD_TESTS
 842   max_open = sysconf (_SC_OPEN_MAX);
 843
 844   for (i = 3; i < max_open; i++)
 845     {
 846       int retval;
 847
 848       if (i == child_err_report_fd)
 849         continue;
 850
 851       retval = fcntl (i, F_GETFD);
 852
 853       if (retval != -1 && !(retval & FD_CLOEXEC))
 854         _dbus_warn ("Fd %d did not have the close-on-exec flag set!\n", i);
 855     }
 856 #endif
 857
 858   execv (argv[0], argv);
 859
 860   /* Exec failed */
 861   write_err_and_exit (child_err_report_fd,
 862                       CHILD_EXEC_FAILED);
 863 }
 864
 865 static void
 866 check_babysit_events (pid_t grandchild_pid,
 867                       int   parent_pipe,
 868                       int   revents)
 869 {
 870   pid_t ret;
 871   int status;
 872
 873   ret = waitpid (grandchild_pid, &status, WNOHANG);
 874
 875   if (ret == 0)
 876     {
 877       _dbus_verbose ("no child exited\n");
 878
 879       ; /* no child exited */
 880     }
 881   else if (ret < 0)
 882     {
 883       /* This isn't supposed to happen. */
 884       _dbus_warn ("unexpected waitpid() failure in check_babysit_events(): %s\n",
 885                   _dbus_strerror (errno));
 886       _exit (1);
 887     }
 888   else if (ret == grandchild_pid)
 889     {
 890       /* Child exited */
 891       _dbus_verbose ("reaped child pid %ld\n", (long) ret);
 892
 893       write_status_and_exit (parent_pipe, status);
 894     }
 895   else
 896     {
 897       _dbus_warn ("waitpid() reaped pid %d that we've never heard of\n",
 898                   (int) ret);
 899       _exit (1);
 900     }
 901
 902   if (revents & _DBUS_POLLIN)
 903     {
 904       _dbus_verbose ("babysitter got POLLIN from parent pipe\n");
 905     }
 906
 907   if (revents & (_DBUS_POLLERR | _DBUS_POLLHUP))
 908     {
 909       /* Parent is gone, so we just exit */
 910       _dbus_verbose ("babysitter got POLLERR or POLLHUP from parent\n");
 911       _exit (0);
 912     }
 913 }
 914
 915 static int babysit_sigchld_pipe = -1;
 916
 917 static void
 918 babysit_signal_handler (int signo)
 919 {
 920   char b = '\0';
 921  again:
 922   write (babysit_sigchld_pipe, &b, 1);
 923   if (errno == EINTR)
 924     goto again;
 925 }
 926
 927 static void
 928 babysit (pid_t grandchild_pid,
 929          int   parent_pipe)
 930 {
 931   int sigchld_pipe[2];
 932
 933   /* We don't exec, so we keep parent state, such as the pid that
 934    * _dbus_verbose() uses. Reset the pid here.
 935    */
 936   _dbus_verbose_reset ();
 937
 938   /* I thought SIGCHLD would just wake up the poll, but
 939    * that didn't seem to work, so added this pipe.
 940    * Probably the pipe is more likely to work on busted
 941    * operating systems anyhow.
 942    */
 943   if (pipe (sigchld_pipe) < 0)
 944     {
 945       _dbus_warn ("Not enough file descriptors to create pipe in babysitter process\n");
 946       _exit (1);
 947     }
 948
 949   babysit_sigchld_pipe = sigchld_pipe[WRITE_END];
 950
 951   _dbus_set_signal_handler (SIGCHLD, babysit_signal_handler);
 952
 953   write_pid (parent_pipe, grandchild_pid);
 954
 955   check_babysit_events (grandchild_pid, parent_pipe, 0);
 956
 957   while (TRUE)
 958     {
 959       DBusPollFD pfds[2];
 960
 961       pfds[0].fd = parent_pipe;
 962       pfds[0].events = _DBUS_POLLIN;
 963       pfds[0].revents = 0;
 964
 965       pfds[1].fd = sigchld_pipe[READ_END];
 966       pfds[1].events = _DBUS_POLLIN;
 967       pfds[1].revents = 0;
 968
 969       _dbus_poll (pfds, _DBUS_N_ELEMENTS (pfds), -1);
 970
 971       if (pfds[0].revents != 0)
 972         {
 973           check_babysit_events (grandchild_pid, parent_pipe, pfds[0].revents);
 974         }
 975       else if (pfds[1].revents & _DBUS_POLLIN)
 976         {
 977           char b;
 978           read (sigchld_pipe[READ_END], &b, 1);
 979           /* do waitpid check */
 980           check_babysit_events (grandchild_pid, parent_pipe, 0);
 981         }
 982     }
 983
 984   _exit (1);
 985 }
 986
 987 /**
 988  * Spawns a new process. The executable name and argv[0]
 989  * are the same, both are provided in argv[0]. The child_setup
 990  * function is passed the given user_data and is run in the child
 991  * just before calling exec().
 992  *
 993  * Also creates a "babysitter" which tracks the status of the
 994  * child process, advising the parent if the child exits.
 995  * If the spawn fails, no babysitter is created.
 996  * If sitter_p is #NULL, no babysitter is kept.
 997  *
 998  * @param sitter_p return location for babysitter or #NULL
 999  * @param argv the executable and arguments
1000  * @param child_setup function to call in child pre-exec()
1001  * @param user_data user data for setup function
1002  * @param error error object to be filled in if function fails
1003  * @returns #TRUE on success, #FALSE if error is filled in
1004  */
1005 dbus_bool_t
1006 _dbus_spawn_async_with_babysitter (DBusBabysitter          **sitter_p,
1007                                    char                    **argv,
1008                                    DBusSpawnChildSetupFunc   child_setup,
1009                                    void                     *user_data,
1010                                    DBusError                *error)
1011 {
1012   DBusBabysitter *sitter;
1013   int child_err_report_pipe[2] = { -1, -1 };
1014   int babysitter_pipe[2] = { -1, -1 };
1015   pid_t pid;
1016
1017   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1018
1019   *sitter_p = NULL;
1020   sitter = NULL;
1021
1022   sitter = _dbus_babysitter_new ();
1023   if (sitter == NULL)
1024     {
1025       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1026       return FALSE;
1027     }
1028
1029   sitter->executable = _dbus_strdup (argv[0]);
1030   if (sitter->executable == NULL)
1031     {
1032       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1033       goto cleanup_and_fail;
1034     }
1035
1036   if (!make_pipe (child_err_report_pipe, error))
1037     goto cleanup_and_fail;
1038
1039   _dbus_fd_set_close_on_exec (child_err_report_pipe[READ_END]);
1040
1041   if (!_dbus_full_duplex_pipe (&babysitter_pipe[0], &babysitter_pipe[1], TRUE, error))
1042     goto cleanup_and_fail;
1043
1044   _dbus_fd_set_close_on_exec (babysitter_pipe[0]);
1045   _dbus_fd_set_close_on_exec (babysitter_pipe[1]);
1046
1047   /* Setting up the babysitter is only useful in the parent,
1048    * but we don't want to run out of memory and fail
1049    * after we've already forked, since then we'd leak
1050    * child processes everywhere.
1051    */
1052   sitter->error_watch = _dbus_watch_new (child_err_report_pipe[READ_END],
1053                                          DBUS_WATCH_READABLE,
1054                                          TRUE);
1055   if (sitter->error_watch == NULL)
1056     {
1057       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1058       goto cleanup_and_fail;
1059     }
1060
1061   if (!_dbus_watch_list_add_watch (sitter->watches,  sitter->error_watch))
1062     {
1063       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1064       goto cleanup_and_fail;
1065     }
1066
1067   sitter->sitter_watch = _dbus_watch_new (babysitter_pipe[0],
1068                                           DBUS_WATCH_READABLE,
1069                                           TRUE);
1070   if (sitter->sitter_watch == NULL)
1071     {
1072       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1073       goto cleanup_and_fail;
1074     }
1075
1076   if (!_dbus_watch_list_add_watch (sitter->watches,  sitter->sitter_watch))
1077     {
1078       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1079       goto cleanup_and_fail;
1080     }
1081
1082   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1083
1084   pid = fork ();
1085
1086   if (pid < 0)
1087     {
1088       dbus_set_error (error,
1089                       DBUS_ERROR_SPAWN_FORK_FAILED,
1090                       "Failed to fork (%s)",
1091                       _dbus_strerror (errno));
1092       goto cleanup_and_fail;
1093     }
1094   else if (pid == 0)
1095     {
1096       /* Immediate child, this is the babysitter process. */
1097       int grandchild_pid;
1098
1099       /* Be sure we crash if the parent exits
1100        * and we write to the err_report_pipe
1101        */
1102       signal (SIGPIPE, SIG_DFL);
1103
1104       /* Close the parent's end of the pipes. */
1105       close_and_invalidate (&child_err_report_pipe[READ_END]);
1106       close_and_invalidate (&babysitter_pipe[0]);
1107
1108       /* Create the child that will exec () */
1109       grandchild_pid = fork ();
1110
1111       if (grandchild_pid < 0)
1112         {
1113           write_err_and_exit (babysitter_pipe[1],
1114                               CHILD_FORK_FAILED);
1115           _dbus_assert_not_reached ("Got to code after write_err_and_exit()");
1116         }
1117       else if (grandchild_pid == 0)
1118         {
1119           do_exec (child_err_report_pipe[WRITE_END],
1120                    argv,
1121                    child_setup, user_data);
1122           _dbus_assert_not_reached ("Got to code after exec() - should have exited on error");
1123         }
1124       else
1125         {
1126           babysit (grandchild_pid, babysitter_pipe[1]);
1127           _dbus_assert_not_reached ("Got to code after babysit()");
1128         }
1129     }
1130   else
1131     {
1132       /* Close the uncared-about ends of the pipes */
1133       close_and_invalidate (&child_err_report_pipe[WRITE_END]);
1134       close_and_invalidate (&babysitter_pipe[1]);
1135
1136       sitter->socket_to_babysitter = babysitter_pipe[0];
1137       babysitter_pipe[0] = -1;
1138
1139       sitter->error_pipe_from_child = child_err_report_pipe[READ_END];
1140       child_err_report_pipe[READ_END] = -1;
1141
1142       sitter->sitter_pid = pid;
1143
1144       if (sitter_p != NULL)
1145         *sitter_p = sitter;
1146       else
1147         _dbus_babysitter_unref (sitter);
1148
1149       _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1150
1151       return TRUE;
1152     }
1153
1154  cleanup_and_fail:
1155
1156   _DBUS_ASSERT_ERROR_IS_SET (error);
1157
1158   close_and_invalidate (&child_err_report_pipe[READ_END]);
1159   close_and_invalidate (&child_err_report_pipe[WRITE_END]);
1160   close_and_invalidate (&babysitter_pipe[0]);
1161   close_and_invalidate (&babysitter_pipe[1]);
1162
1163   if (sitter != NULL)
1164     _dbus_babysitter_unref (sitter);
1165
1166   return FALSE;
1167 }
1168
1169 /** @} */
1170
1171 #ifdef DBUS_BUILD_TESTS
1172
1173 static dbus_bool_t
1174 check_spawn_nonexistent (void *data)
1175 {
1176   char *argv[4] = { NULL, NULL, NULL, NULL };
1177   DBusBabysitter *sitter;
1178   DBusError error;
1179
1180   sitter = NULL;
1181
1182   dbus_error_init (&error);
1183
1184   /*** Test launching nonexistent binary */
1185
1186   argv[0] = "/this/does/not/exist/32542sdgafgafdg";
1187   if (_dbus_spawn_async_with_babysitter (&sitter, argv,
1188                                          NULL, NULL,
1189                                          &error))
1190     {
1191       _dbus_babysitter_block_for_child_exit (sitter);
1192       _dbus_babysitter_set_child_exit_error (sitter, &error);
1193     }
1194
1195   if (sitter)
1196     _dbus_babysitter_unref (sitter);
1197
1198   if (!dbus_error_is_set (&error))
1199     {
1200       _dbus_warn ("Did not get an error launching nonexistent executable\n");
1201       return FALSE;
1202     }
1203
1204   if (!(dbus_error_has_name (&error, DBUS_ERROR_NO_MEMORY) ||
1205         dbus_error_has_name (&error, DBUS_ERROR_SPAWN_EXEC_FAILED)))
1206     {
1207       _dbus_warn ("Not expecting error when launching nonexistent executable: %s: %s\n",
1208                   error.name, error.message);
1209       dbus_error_free (&error);
1210       return FALSE;
1211     }
1212
1213   dbus_error_free (&error);
1214
1215   return TRUE;
1216 }
1217
1218 static dbus_bool_t
1219 check_spawn_segfault (void *data)
1220 {
1221   char *argv[4] = { NULL, NULL, NULL, NULL };
1222   DBusBabysitter *sitter;
1223   DBusError error;
1224
1225   sitter = NULL;
1226
1227   dbus_error_init (&error);
1228
1229   /*** Test launching segfault binary */
1230
1231   argv[0] = TEST_SEGFAULT_BINARY;
1232   if (_dbus_spawn_async_with_babysitter (&sitter, argv,
1233                                          NULL, NULL,
1234                                          &error))
1235     {
1236       _dbus_babysitter_block_for_child_exit (sitter);
1237       _dbus_babysitter_set_child_exit_error (sitter, &error);
1238     }
1239
1240   if (sitter)
1241     _dbus_babysitter_unref (sitter);
1242
1243   if (!dbus_error_is_set (&error))
1244     {
1245       _dbus_warn ("Did not get an error launching segfaulting binary\n");
1246       return FALSE;
1247     }
1248
1249   if (!(dbus_error_has_name (&error, DBUS_ERROR_NO_MEMORY) ||
1250         dbus_error_has_name (&error, DBUS_ERROR_SPAWN_CHILD_SIGNALED)))
1251     {
1252       _dbus_warn ("Not expecting error when launching segfaulting executable: %s: %s\n",
1253                   error.name, error.message);
1254       dbus_error_free (&error);
1255       return FALSE;
1256     }
1257
1258   dbus_error_free (&error);
1259
1260   return TRUE;
1261 }
1262
1263 static dbus_bool_t
1264 check_spawn_exit (void *data)
1265 {
1266   char *argv[4] = { NULL, NULL, NULL, NULL };
1267   DBusBabysitter *sitter;
1268   DBusError error;
1269
1270   sitter = NULL;
1271
1272   dbus_error_init (&error);
1273
1274   /*** Test launching exit failure binary */
1275
1276   argv[0] = TEST_EXIT_BINARY;
1277   if (_dbus_spawn_async_with_babysitter (&sitter, argv,
1278                                          NULL, NULL,
1279                                          &error))
1280     {
1281       _dbus_babysitter_block_for_child_exit (sitter);
1282       _dbus_babysitter_set_child_exit_error (sitter, &error);
1283     }
1284
1285   if (sitter)
1286     _dbus_babysitter_unref (sitter);
1287
1288   if (!dbus_error_is_set (&error))
1289     {
1290       _dbus_warn ("Did not get an error launching binary that exited with failure code\n");
1291       return FALSE;
1292     }
1293
1294   if (!(dbus_error_has_name (&error, DBUS_ERROR_NO_MEMORY) ||
1295         dbus_error_has_name (&error, DBUS_ERROR_SPAWN_CHILD_EXITED)))
1296     {
1297       _dbus_warn ("Not expecting error when launching exiting executable: %s: %s\n",
1298                   error.name, error.message);
1299       dbus_error_free (&error);
1300       return FALSE;
1301     }
1302
1303   dbus_error_free (&error);
1304
1305   return TRUE;
1306 }
1307
1308 static dbus_bool_t
1309 check_spawn_and_kill (void *data)
1310 {
1311   char *argv[4] = { NULL, NULL, NULL, NULL };
1312   DBusBabysitter *sitter;
1313   DBusError error;
1314
1315   sitter = NULL;
1316
1317   dbus_error_init (&error);
1318
1319   /*** Test launching sleeping binary then killing it */
1320
1321   argv[0] = TEST_SLEEP_FOREVER_BINARY;
1322   if (_dbus_spawn_async_with_babysitter (&sitter, argv,
1323                                          NULL, NULL,
1324                                          &error))
1325     {
1326       _dbus_babysitter_kill_child (sitter);
1327
1328       _dbus_babysitter_block_for_child_exit (sitter);
1329
1330       _dbus_babysitter_set_child_exit_error (sitter, &error);
1331     }
1332
1333   if (sitter)
1334     _dbus_babysitter_unref (sitter);
1335
1336   if (!dbus_error_is_set (&error))
1337     {
1338       _dbus_warn ("Did not get an error after killing spawned binary\n");
1339       return FALSE;
1340     }
1341
1342   if (!(dbus_error_has_name (&error, DBUS_ERROR_NO_MEMORY) ||
1343         dbus_error_has_name (&error, DBUS_ERROR_SPAWN_CHILD_SIGNALED)))
1344     {
1345       _dbus_warn ("Not expecting error when killing executable: %s: %s\n",
1346                   error.name, error.message);
1347       dbus_error_free (&error);
1348       return FALSE;
1349     }
1350
1351   dbus_error_free (&error);
1352
1353   return TRUE;
1354 }
1355
1356 dbus_bool_t
1357 _dbus_spawn_test (const char *test_data_dir)
1358 {
1359   if (!_dbus_test_oom_handling ("spawn_nonexistent",
1360                                 check_spawn_nonexistent,
1361                                 NULL))
1362     return FALSE;
1363
1364   if (!_dbus_test_oom_handling ("spawn_segfault",
1365                                 check_spawn_segfault,
1366                                 NULL))
1367     return FALSE;
1368
1369   if (!_dbus_test_oom_handling ("spawn_exit",
1370                                 check_spawn_exit,
1371                                 NULL))
1372     return FALSE;
1373
1374   if (!_dbus_test_oom_handling ("spawn_and_kill",
1375                                 check_spawn_and_kill,
1376                                 NULL))
1377     return FALSE;
1378
1379   return TRUE;
1380 }
1381 #endif