dbus/dbus-spawn.c

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