/* exechelp.h - Definitions for the fork and exec helpers * Copyright (C) 2004, 2009, 2010 Free Software Foundation, Inc. * * This file is part of GnuPG. * * GnuPG is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * GnuPG is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see . */ #ifndef GNUPG_COMMON_EXECHELP_H #define GNUPG_COMMON_EXECHELP_H #include "../common/estream.h" /* Return the maximum number of currently allowed file descriptors. Only useful on POSIX systems. */ int get_max_fds (void); /* Close all file descriptors starting with descriptor FIRST. If EXCEPT is not NULL, it is expected to be a list of file descriptors which are not to close. This list shall be sorted in ascending order with its end marked by -1. */ void close_all_fds (int first, int *except); /* Returns an array with all currently open file descriptors. The end of the array is marked by -1. The caller needs to release this array using the *standard free* and not with xfree. This allow the use of this fucntion right at startup even before libgcrypt has been initialized. Returns NULL on error and sets ERRNO accordingly. */ int *get_all_open_fds (void); /* Portable function to create a pipe. Under Windows the write end is inheritable. */ gpg_error_t gnupg_create_inbound_pipe (int filedes[2]); /* Portable function to create a pipe. Under Windows the read end is inheritable. */ gpg_error_t gnupg_create_outbound_pipe (int filedes[2]); /* Fork and exec the PGMNAME, connect the file descriptor of INFILE to stdin, write the output to OUTFILE. INFILE or PUTFILE may be NULL to connect thenm to /dev/null. Returns a new stream in STATUSFILE for stderr and the pid of the process in PID. The arguments for the process are expected in the NULL terminated array ARGV. The program name itself should not be included there. If PREEXEC is not NULL, that function will be called right before the exec. Calling gnupg_wait_process and gnupg_release_process is required. Returns 0 on success or an error code. FLAGS is a bit vector: Bit 7: If set the process will be started as a background process. This flag is only useful under W32 (but not W32CE) systems, so that no new console is created and pops up a console window when starting the server. Does not work on W32CE. Bit 6: On W32 (but not on W32CE) run AllowSetForegroundWindow for the child. Note that due to unknown problems this actually allows SetForegroundWindow for all childs of this process. */ gpg_error_t gnupg_spawn_process (const char *pgmname, const char *argv[], estream_t infile, estream_t outfile, void (*preexec)(void), unsigned int flags, estream_t *statusfile, pid_t *pid); /* Simplified version of gnupg_spawn_process. This function forks and then execs PGMNAME, while connecting INFD to stdin, OUTFD to stdout and ERRFD to stderr (any of them may be -1 to connect them to /dev/null). The arguments for the process are expected in the NULL terminated array ARGV. The program name itself should not be included there. Calling gnupg_wait_process and gnupg_release_process is required. Returns 0 on success or an error code. */ gpg_error_t gnupg_spawn_process_fd (const char *pgmname, const char *argv[], int infd, int outfd, int errfd, pid_t *pid); /* If HANG is true, waits for the process identified by PID to exit; if HANG is false, checks whether the process has terminated. PGMNAME should be the same as supplied to the spawn function and is only used for diagnostics. Return values: 0 The process exited successful. 0 is stored at R_EXITCODE. GPG_ERR_GENERAL The process exited without success. The exit code of process is then stored at R_EXITCODE. An exit code of -1 indicates that the process terminated abnormally (e.g. due to a signal). GPG_ERR_TIMEOUT The process is still running (returned only if HANG is false). GPG_ERR_INV_VALUE An invalid PID has been specified. Other error codes may be returned as well. Unless otherwise noted, -1 will be stored at R_EXITCODE. R_EXITCODE may be passed as NULL if the exit code is not required (in that case an error messge will be printed). Note that under Windows PID is not the process id but the handle of the process. */ gpg_error_t gnupg_wait_process (const char *pgmname, pid_t pid, int hang, int *r_exitcode); /* Kill a process; that is send an appropriate signal to the process. gnupg_wait_process must be called to actually remove the process from the system. An invalid PID is ignored. */ void gnupg_kill_process (pid_t pid); /* Release the process identified by PID. This function is actually only required for Windows but it does not harm to always call it. It is a nop if PID is invalid. */ void gnupg_release_process (pid_t pid); /* Spawn a new process and immediatley detach from it. The name of the program to exec is PGMNAME and its arguments are in ARGV (the programname is automatically passed as first argument). Environment strings in ENVP are set. An error is returned if pgmname is not executable; to make this work it is necessary to provide an absolute file name. */ gpg_error_t gnupg_spawn_process_detached (const char *pgmname, const char *argv[], const char *envp[] ); #endif /*GNUPG_COMMON_EXECHELP_H*/