27 #include "dbus-spawn.h"
28 #include "dbus-sysdeps-unix.h"
29 #include "dbus-internals.h"
30 #include "dbus-test.h"
31 #include "dbus-protocol.h"
42 extern char **environ;
74 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
83 to_read =
sizeof (int) * n_ints_in_buf - bytes;
94 if (chunk < 0 && errno == EINTR)
101 "Failed to read from child pipe (%s)",
102 _dbus_strerror (errno));
116 *n_ints_read = (int)(bytes /
sizeof(
int));
129 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
138 to_read =
sizeof (pid_t) - bytes;
146 ((
char*)buf) + bytes,
148 if (chunk < 0 && errno == EINTR)
155 "Failed to read from child pipe (%s)",
156 _dbus_strerror (errno));
208 DBusBabysitterFinishedFunc finished_cb;
213 unsigned int have_child_status : 1;
219 _dbus_babysitter_new (
void)
290 close_socket_to_babysitter (sitter);
292 close_error_pipe_from_child (sitter);
303 ret = waitpid (sitter->
sitter_pid, &status, WNOHANG);
313 ret = waitpid (sitter->
sitter_pid, &status, 0);
319 else if (errno == ECHILD)
320 _dbus_warn (
"Babysitter process not available to be reaped; should not happen\n");
322 _dbus_warn (
"Unexpected error %d in waitpid() for babysitter: %s\n",
323 errno, _dbus_strerror (errno));
327 _dbus_verbose (
"Reaped %ld, waiting for babysitter %ld\n",
330 if (WIFEXITED (sitter->
status))
331 _dbus_verbose (
"Babysitter exited with status %d\n",
332 WEXITSTATUS (sitter->
status));
333 else if (WIFSIGNALED (sitter->
status))
334 _dbus_verbose (
"Babysitter received signal %d\n",
335 WTERMSIG (sitter->
status));
337 _dbus_verbose (
"Babysitter exited abnormally\n");
361 r = read_ints (fd, &what, 1, &got, &error);
382 case CHILD_FORK_FAILED:
383 case CHILD_EXEC_FAILED:
387 r = read_ints (fd, &arg, 1, &got, &error);
403 if (what == CHILD_EXITED)
405 sitter->have_child_status =
TRUE;
408 _dbus_verbose (
"recorded child status exited = %d signaled = %d exitstatus = %d termsig = %d\n",
409 WIFEXITED (sitter->
status), WIFSIGNALED (sitter->
status),
410 WEXITSTATUS (sitter->
status), WTERMSIG (sitter->
status));
412 else if (what == CHILD_FORK_FAILED)
416 _dbus_verbose (
"recorded fork errnum %d\n", sitter->
errnum);
418 else if (what == CHILD_EXEC_FAILED)
422 _dbus_verbose (
"recorded exec errnum %d\n", sitter->
errnum);
431 r = read_pid (fd, &pid, &error);
447 _dbus_verbose (
"recorded grandchild pid %d\n", sitter->
grandchild_pid);
451 _dbus_warn (
"Unknown message received from babysitter process\n");
462 _dbus_verbose (
"Closing babysitter\n");
483 _dbus_verbose (
"Closing child error\n");
511 _dbus_verbose (
"Reading data from babysitter\n");
513 close_socket_to_babysitter (sitter);
517 close_socket_to_babysitter (sitter);
525 if (revents & _DBUS_POLLIN)
527 _dbus_verbose (
"Reading data from child error\n");
529 close_error_pipe_from_child (sitter);
533 close_error_pipe_from_child (sitter);
546 descriptors_ready =
FALSE;
574 while (ret < 0 && errno == EINTR);
576 if (ret == 0 && block)
582 while (ret < 0 && errno == EINTR);
587 descriptors_ready =
TRUE;
593 handle_error_pipe (sitter, fds[i].revents);
595 handle_babysitter_socket (sitter, fds[i].revents);
600 return descriptors_ready;
607 #define LIVE_CHILDREN(sitter) ((sitter)->socket_to_babysitter >= 0 || (sitter)->error_pipe_from_child >= 0)
621 babysitter_iteration (sitter,
TRUE);
623 _dbus_verbose (
"Got child PID %ld for killing\n",
643 babysitter_iteration (sitter,
FALSE))
669 if (!sitter->have_child_status ||
670 !(WIFEXITED (sitter->
status)))
673 *status = WEXITSTATUS (sitter->
status);
700 "Failed to execute program %s: %s",
706 "Failed to fork a new process %s: %s",
709 else if (sitter->have_child_status)
711 if (WIFEXITED (sitter->
status))
713 "Process %s exited with status %d",
715 else if (WIFSIGNALED (sitter->
status))
717 "Process %s received signal %d",
721 "Process %s exited abnormally",
727 "Process %s exited, reason unknown",
762 unsigned int condition,
780 handle_error_pipe (sitter, revents);
782 handle_babysitter_socket (sitter, revents);
785 babysitter_iteration (sitter,
FALSE))
794 sitter->finished_cb !=
NULL)
796 sitter->finished_cb (sitter, sitter->finished_data);
797 sitter->finished_cb =
NULL;
815 close_and_invalidate (
int *fd)
839 retval = pipe2 (p, O_CLOEXEC);
840 cloexec_done = retval >= 0;
844 if (retval < 0 && errno == ENOSYS)
850 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
856 "Failed to create pipe for communicating with child process (%s)",
857 _dbus_strerror (errno));
873 do_write (
int fd,
const void *buf,
size_t count)
875 size_t bytes_written;
882 ret = write (fd, ((
const char*)buf) + bytes_written, count - bytes_written);
890 _dbus_warn (
"Failed to write data to pipe!\n");
895 bytes_written += ret;
897 if (bytes_written < count)
902 write_err_and_exit (
int fd,
int msg)
906 do_write (fd, &msg,
sizeof (msg));
907 do_write (fd, &en,
sizeof (en));
913 write_pid (
int fd, pid_t pid)
917 do_write (fd, &msg,
sizeof (msg));
918 do_write (fd, &pid,
sizeof (pid));
922 write_status_and_exit (
int fd,
int status)
924 int msg = CHILD_EXITED;
926 do_write (fd, &msg,
sizeof (msg));
927 do_write (fd, &status,
sizeof (status));
933 do_exec (
int child_err_report_fd,
936 DBusSpawnChildSetupFunc child_setup,
939 #ifdef DBUS_BUILD_TESTS
943 _dbus_verbose_reset ();
948 (* child_setup) (user_data);
950 #ifdef DBUS_BUILD_TESTS
951 max_open = sysconf (_SC_OPEN_MAX);
953 for (i = 3; i < max_open; i++)
957 if (i == child_err_report_fd)
960 retval = fcntl (i, F_GETFD);
962 if (retval != -1 && !(retval & FD_CLOEXEC))
963 _dbus_warn (
"Fd %d did not have the close-on-exec flag set!\n", i);
974 execve (argv[0], argv, envp);
977 write_err_and_exit (child_err_report_fd,
982 check_babysit_events (pid_t grandchild_pid,
991 ret = waitpid (grandchild_pid, &status, WNOHANG);
996 while (ret < 0 && errno == EINTR);
1000 _dbus_verbose (
"no child exited\n");
1007 _dbus_warn (
"unexpected waitpid() failure in check_babysit_events(): %s\n",
1008 _dbus_strerror (errno));
1011 else if (ret == grandchild_pid)
1014 _dbus_verbose (
"reaped child pid %ld\n", (
long) ret);
1016 write_status_and_exit (parent_pipe, status);
1020 _dbus_warn (
"waitpid() reaped pid %d that we've never heard of\n",
1025 if (revents & _DBUS_POLLIN)
1027 _dbus_verbose (
"babysitter got POLLIN from parent pipe\n");
1033 _dbus_verbose (
"babysitter got POLLERR or POLLHUP from parent\n");
1038 static int babysit_sigchld_pipe = -1;
1041 babysit_signal_handler (
int signo)
1045 if (write (babysit_sigchld_pipe, &b, 1) <= 0)
1051 babysit (pid_t grandchild_pid,
1054 int sigchld_pipe[2];
1059 _dbus_verbose_reset ();
1066 if (pipe (sigchld_pipe) < 0)
1068 _dbus_warn (
"Not enough file descriptors to create pipe in babysitter process\n");
1072 babysit_sigchld_pipe = sigchld_pipe[
WRITE_END];
1076 write_pid (parent_pipe, grandchild_pid);
1078 check_babysit_events (grandchild_pid, parent_pipe, 0);
1084 pfds[0].
fd = parent_pipe;
1094 _dbus_warn (
"_dbus_poll() error: %s\n", strerror (errno));
1098 if (pfds[0].revents != 0)
1100 check_babysit_events (grandchild_pid, parent_pipe, pfds[0].revents);
1102 else if (pfds[1].revents & _DBUS_POLLIN)
1105 if (read (sigchld_pipe[
READ_END], &b, 1) == -1)
1110 check_babysit_events (grandchild_pid, parent_pipe, 0);
1140 DBusSpawnChildSetupFunc child_setup,
1145 int child_err_report_pipe[2] = { -1, -1 };
1146 int babysitter_pipe[2] = { -1, -1 };
1149 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1151 if (sitter_p !=
NULL)
1156 sitter = _dbus_babysitter_new ();
1167 goto cleanup_and_fail;
1170 if (!make_pipe (child_err_report_pipe, error))
1171 goto cleanup_and_fail;
1174 goto cleanup_and_fail;
1182 DBUS_WATCH_READABLE,
1187 goto cleanup_and_fail;
1199 goto cleanup_and_fail;
1203 DBUS_WATCH_READABLE,
1208 goto cleanup_and_fail;
1220 goto cleanup_and_fail;
1223 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1231 "Failed to fork (%s)",
1232 _dbus_strerror (errno));
1233 goto cleanup_and_fail;
1243 signal (SIGPIPE, SIG_DFL);
1246 close_and_invalidate (&child_err_report_pipe[READ_END]);
1247 close_and_invalidate (&babysitter_pipe[0]);
1250 grandchild_pid = fork ();
1252 if (grandchild_pid < 0)
1254 write_err_and_exit (babysitter_pipe[1],
1258 else if (grandchild_pid == 0)
1260 do_exec (child_err_report_pipe[
WRITE_END],
1263 child_setup, user_data);
1268 babysit (grandchild_pid, babysitter_pipe[1]);
1275 close_and_invalidate (&child_err_report_pipe[
WRITE_END]);
1276 close_and_invalidate (&babysitter_pipe[1]);
1279 babysitter_pipe[0] = -1;
1282 child_err_report_pipe[
READ_END] = -1;
1286 if (sitter_p !=
NULL)
1293 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1300 _DBUS_ASSERT_ERROR_IS_SET (error);
1302 close_and_invalidate (&child_err_report_pipe[READ_END]);
1303 close_and_invalidate (&child_err_report_pipe[
WRITE_END]);
1304 close_and_invalidate (&babysitter_pipe[0]);
1305 close_and_invalidate (&babysitter_pipe[1]);
1315 DBusBabysitterFinishedFunc finished,
1318 sitter->finished_cb = finished;
1319 sitter->finished_data = user_data;
1324 #ifdef DBUS_BUILD_TESTS
1327 get_test_exec (
const char *exe,
1330 const char *dbus_test_exec;
1334 if (dbus_test_exec ==
NULL)
1335 dbus_test_exec = DBUS_TEST_EXEC;
1341 dbus_test_exec, exe, DBUS_EXEEXT))
1347 return _dbus_string_get_data (scratch_space);
1354 babysitter_iteration (sitter,
TRUE);
1358 check_spawn_nonexistent (
void *data)
1366 argv[0] =
"/this/does/not/exist/32542sdgafgafdg";
1371 _dbus_babysitter_block_for_child_exit (sitter);
1380 _dbus_warn (
"Did not get an error launching nonexistent executable\n");
1387 _dbus_warn (
"Not expecting error when launching nonexistent executable: %s: %s\n",
1399 check_spawn_segfault (
void *data)
1408 argv[0] = get_test_exec (
"test-segfault", &argv0);
1410 if (argv[0] ==
NULL)
1420 _dbus_babysitter_block_for_child_exit (sitter);
1431 _dbus_warn (
"Did not get an error launching segfaulting binary\n");
1438 _dbus_warn (
"Not expecting error when launching segfaulting executable: %s: %s\n",
1450 check_spawn_exit (
void *data)
1459 argv[0] = get_test_exec (
"test-exit", &argv0);
1461 if (argv[0] ==
NULL)
1471 _dbus_babysitter_block_for_child_exit (sitter);
1482 _dbus_warn (
"Did not get an error launching binary that exited with failure code\n");
1489 _dbus_warn (
"Not expecting error when launching exiting executable: %s: %s\n",
1501 check_spawn_and_kill (
void *data)
1510 argv[0] = get_test_exec (
"test-sleep-forever", &argv0);
1512 if (argv[0] ==
NULL)
1524 _dbus_babysitter_block_for_child_exit (sitter);
1536 _dbus_warn (
"Did not get an error after killing spawned binary\n");
1543 _dbus_warn (
"Not expecting error when killing executable: %s: %s\n",
1555 _dbus_spawn_test (
const char *test_data_dir)
1557 if (!_dbus_test_oom_handling (
"spawn_nonexistent",
1558 check_spawn_nonexistent,
1562 if (!_dbus_test_oom_handling (
"spawn_segfault",
1563 check_spawn_segfault,
1567 if (!_dbus_test_oom_handling (
"spawn_exit",
1572 if (!_dbus_test_oom_handling (
"spawn_and_kill",
1573 check_spawn_and_kill,
dbus_bool_t dbus_error_has_name(const DBusError *error, const char *name)
Checks whether the error is set and has the given name.
const char * message
public error message field
#define DBUS_ERROR_SPAWN_FAILED
While starting a new process, something went wrong.
Implementation of DBusWatch.
#define NULL
A null pointer, defined appropriately for C or C++.
#define DBUS_ERROR_SPAWN_EXEC_FAILED
While starting a new process, the exec() call failed.
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
#define LIVE_CHILDREN(sitter)
Macro returns TRUE if the babysitter still has live sockets open to the babysitter child or the grand...
#define _DBUS_POLLHUP
Hung up.
void(* DBusRemoveWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus no longer needs a watch to be monitored by the main loop.
unsigned int have_exec_errnum
True if we have an error code from exec()
void dbus_free(void *memory)
Frees a block of memory previously allocated by dbus_malloc() or dbus_malloc0().
DBusWatch * error_watch
Error pipe watch.
DBusWatchList * _dbus_watch_list_new(void)
Creates a new watch list.
void _dbus_watch_invalidate(DBusWatch *watch)
Clears the file descriptor from a now-invalid watch object so that no one tries to use it...
#define DBUS_PID_FORMAT
an appropriate printf format for dbus_pid_t
#define DBUS_ERROR_SPAWN_CHILD_EXITED
While starting a new process, the child exited with a status code.
int status
Exit status code.
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
int socket_to_babysitter
Connection to the babysitter process.
dbus_bool_t _dbus_full_duplex_pipe(int *fd1, int *fd2, dbus_bool_t blocking, DBusError *error)
Creates a full-duplex pipe (as in socketpair()).
#define DBUS_ERROR_INIT
Expands to a suitable initializer for a DBusError on the stack.
dbus_bool_t _dbus_watch_list_add_watch(DBusWatchList *watch_list, DBusWatch *watch)
Adds a new watch to the watch list, invoking the application DBusAddWatchFunction if appropriate...
void dbus_error_free(DBusError *error)
Frees an error that's been set (or just initialized), then reinitializes the error as in dbus_error_i...
A portable struct pollfd wrapper.
#define _DBUS_POLLIN
There is data to read.
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
dbus_pid_t _dbus_getpid(void)
Gets our process ID.
char * executable
executable name to use in error messages
short events
Events to poll for.
dbus_bool_t _dbus_babysitter_get_child_exited(DBusBabysitter *sitter)
Checks whether the child has exited, without blocking.
const char * _dbus_getenv(const char *varname)
Wrapper for getenv().
dbus_bool_t _dbus_spawn_async_with_babysitter(DBusBabysitter **sitter_p, char **argv, char **env, DBusSpawnChildSetupFunc child_setup, void *user_data, DBusError *error)
Spawns a new process.
dbus_bool_t(* DBusAddWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus needs a new watch to be monitored by the main loop.
DBusWatchList * watches
Watches.
void _dbus_fd_set_close_on_exec(intptr_t fd)
Sets the file descriptor to be close on exec.
#define DBUS_ERROR_SPAWN_CHILD_SIGNALED
While starting a new process, the child exited on a signal.
#define dbus_new0(type, count)
Safe macro for using dbus_malloc0().
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
DBusWatch * sitter_watch
Sitter pipe watch.
DBUS_EXPORT int dbus_watch_get_socket(DBusWatch *watch)
Returns a socket to be watched, on UNIX this will return -1 if our transport is not socket-based so d...
dbus_bool_t _dbus_babysitter_get_child_exit_status(DBusBabysitter *sitter, int *status)
Gets the exit status of the child.
void _dbus_babysitter_kill_child(DBusBabysitter *sitter)
Blocks until the babysitter process gives us the PID of the spawned grandchild, then kills the spawne...
Babysitter implementation details.
ReadStatus
Enumeration for status of a read()
int _dbus_poll(DBusPollFD *fds, int n_fds, int timeout_milliseconds)
Wrapper for poll().
void _dbus_warn(const char *format,...)
Prints a warning message to stderr.
pid_t sitter_pid
PID Of the babysitter.
dbus_bool_t _dbus_string_append_printf(DBusString *str, const char *format,...)
Appends a printf-style formatted string to the DBusString.
dbus_bool_t _dbus_babysitter_set_watch_functions(DBusBabysitter *sitter, DBusAddWatchFunction add_function, DBusRemoveWatchFunction remove_function, DBusWatchToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
Sets watch functions to notify us when the babysitter object needs to read/write file descriptors...
Object representing an exception.
void dbus_set_error(DBusError *error, const char *name, const char *format,...)
Assigns an error name and message to a DBusError.
pid_t grandchild_pid
PID of the grandchild.
#define _DBUS_N_ELEMENTS(array)
Computes the number of elements in a fixed-size array using sizeof().
int refcount
Reference count.
As in POLLERR (can't watch for this, but can be present in current state passed to dbus_watch_handle(...
void _dbus_string_free(DBusString *str)
Frees a string created by _dbus_string_init().
#define TRUE
Expands to "1".
#define _dbus_assert_not_reached(explanation)
Aborts with an error message if called.
As in POLLHUP (can't watch for it, but can be present in current state passed to dbus_watch_handle())...
#define DBUS_ERROR_FAILED
A generic error; "something went wrong" - see the error message for more.
const char * name
public error name field
#define READ_END
Helps remember which end of the pipe is which.
DBusWatchList implementation details.
void _dbus_babysitter_unref(DBusBabysitter *sitter)
Decrement the reference count on the babysitter object.
dbus_bool_t _dbus_watch_list_set_functions(DBusWatchList *watch_list, DBusAddWatchFunction add_function, DBusRemoveWatchFunction remove_function, DBusWatchToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
Sets the watch functions.
#define DBUS_ERROR_SPAWN_FORK_FAILED
While starting a new process, the fork() call failed.
void _dbus_set_signal_handler(int sig, DBusSignalHandler handler)
Installs a UNIX signal handler.
DBusWatch * _dbus_watch_new(int fd, unsigned int flags, dbus_bool_t enabled, DBusWatchHandler handler, void *data, DBusFreeFunction free_data_function)
Creates a new DBusWatch.
void dbus_free_string_array(char **str_array)
Frees a NULL-terminated array of strings.
#define DBUS_ERROR_NO_MEMORY
There was not enough memory to complete an operation.
unsigned int have_fork_errnum
True if we have an error code from fork()
#define FALSE
Expands to "0".
int error_pipe_from_child
Connection to the process that does the exec()
void _dbus_watch_unref(DBusWatch *watch)
Decrements the reference count of a DBusWatch object and finalizes the object if the count reaches ze...
void(* DBusWatchToggledFunction)(DBusWatch *watch, void *data)
Called when dbus_watch_get_enabled() may return a different value than it did before.
#define WRITE_END
Helps remember which end of the pipe is which.
void _dbus_watch_list_free(DBusWatchList *watch_list)
Frees a DBusWatchList.
char * _dbus_strdup(const char *str)
Duplicates a string.
dbus_bool_t _dbus_close_socket(int fd, DBusError *error)
Closes a socket.
void _dbus_babysitter_set_child_exit_error(DBusBabysitter *sitter, DBusError *error)
Sets the DBusError with an explanation of why the spawned child process exited (on a signal...
short revents
Events that occurred.
dbus_bool_t dbus_error_is_set(const DBusError *error)
Checks whether an error occurred (the error is set).
void _dbus_watch_list_remove_watch(DBusWatchList *watch_list, DBusWatch *watch)
Removes a watch from the watch list, invoking the application's DBusRemoveWatchFunction if appropriat...
#define _DBUS_POLLERR
Error condition.
DBusBabysitter * _dbus_babysitter_ref(DBusBabysitter *sitter)
Increment the reference count on the babysitter object.