Nuked almost all trailing white space.
[gnupg.git] / common / exechelp.h
1 /* exechelp.h - Definitions for the fork and exec helpers
2  * Copyright (C) 2004, 2009, 2010 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef GNUPG_COMMON_EXECHELP_H
21 #define GNUPG_COMMON_EXECHELP_H
22
23 #include "../common/estream.h"
24
25
26 /* Return the maximum number of currently allowed file descriptors.
27    Only useful on POSIX systems.  */
28 int get_max_fds (void);
29
30
31 /* Close all file descriptors starting with descriptor FIRST.  If
32    EXCEPT is not NULL, it is expected to be a list of file descriptors
33    which are not to close.  This list shall be sorted in ascending
34    order with its end marked by -1.  */
35 void close_all_fds (int first, int *except);
36
37
38 /* Returns an array with all currently open file descriptors.  The end
39    of the array is marked by -1.  The caller needs to release this
40    array using the *standard free* and not with xfree.  This allow the
41    use of this fucntion right at startup even before libgcrypt has
42    been initialized.  Returns NULL on error and sets ERRNO accordingly.  */
43 int *get_all_open_fds (void);
44
45
46 /* Portable function to create a pipe.  Under Windows the write end is
47    inheritable.  */
48 gpg_error_t gnupg_create_inbound_pipe (int filedes[2]);
49
50 /* Portable function to create a pipe.  Under Windows the read end is
51    inheritable.  */
52 gpg_error_t gnupg_create_outbound_pipe (int filedes[2]);
53
54
55 /* Fork and exec the PGMNAME.  If INFP is NULL connect /dev/null to
56    stdin of the new process; if it is not NULL connect the file
57    descriptor retrieved from INFP to stdin.  If R_OUTFP is NULL
58    connect stdout of the new process to /dev/null; if it is not NULL
59    store the address of a pointer to a new estream there.  If R_ERRFP
60    is NULL connect stderr of the new process to /dev/null; if it is
61    not NULL store the address of a pointer to a new estream there.  On
62    success the pid of the new process is stored at PID.  On error -1
63    is stored at PID and if R_OUTFP or R_ERRFP are not NULL, NULL is
64    stored there.
65
66    The arguments for the process are expected in the NULL terminated
67    array ARGV.  The program name itself should not be included there.
68    If PREEXEC is not NULL, the given function will be called right
69    before the exec.
70
71    Returns 0 on success or an error code.  Calling gnupg_wait_process
72    and gnupg_release_process is required if the function succeeded.
73
74    FLAGS is a bit vector:
75
76    Bit 7: If set the process will be started as a background process.
77           This flag is only useful under W32 (but not W32CE) systems,
78           so that no new console is created and pops up a console
79           window when starting the server.  Does not work on W32CE.
80
81    Bit 6: On W32 (but not on W32CE) run AllowSetForegroundWindow for
82           the child.  Note that due to unknown problems this actually
83           allows SetForegroundWindow for all childs of this process.
84
85  */
86 gpg_error_t
87 gnupg_spawn_process (const char *pgmname, const char *argv[],
88                      gpg_err_source_t errsource,
89                      void (*preexec)(void), unsigned int flags,
90                      estream_t infp,
91                      estream_t *r_outfp,
92                      estream_t *r_errfp,
93                      pid_t *pid);
94
95
96 /* Simplified version of gnupg_spawn_process.  This function forks and
97    then execs PGMNAME, while connecting INFD to stdin, OUTFD to stdout
98    and ERRFD to stderr (any of them may be -1 to connect them to
99    /dev/null).  The arguments for the process are expected in the NULL
100    terminated array ARGV.  The program name itself should not be
101    included there.  Calling gnupg_wait_process and
102    gnupg_release_process is required.  Returns 0 on success or an
103    error code. */
104 gpg_error_t gnupg_spawn_process_fd (const char *pgmname,
105                                     const char *argv[],
106                                     int infd, int outfd, int errfd,
107                                     pid_t *pid);
108
109
110 /* If HANG is true, waits for the process identified by PID to exit;
111    if HANG is false, checks whether the process has terminated.
112    PGMNAME should be the same as supplied to the spawn function and is
113    only used for diagnostics.  Return values:
114
115    0
116        The process exited successful.  0 is stored at R_EXITCODE.
117
118    GPG_ERR_GENERAL
119        The process exited without success.  The exit code of process
120        is then stored at R_EXITCODE.  An exit code of -1 indicates
121        that the process terminated abnormally (e.g. due to a signal).
122
123    GPG_ERR_TIMEOUT
124        The process is still running (returned only if HANG is false).
125
126    GPG_ERR_INV_VALUE
127        An invalid PID has been specified.
128
129    Other error codes may be returned as well.  Unless otherwise noted,
130    -1 will be stored at R_EXITCODE.  R_EXITCODE may be passed as NULL
131    if the exit code is not required (in that case an error messge will
132    be printed).  Note that under Windows PID is not the process id but
133    the handle of the process.  */
134 gpg_error_t gnupg_wait_process (const char *pgmname, pid_t pid, int hang,
135                                 int *r_exitcode);
136
137
138 /* Kill a process; that is send an appropriate signal to the process.
139    gnupg_wait_process must be called to actually remove the process
140    from the system.  An invalid PID is ignored.  */
141 void gnupg_kill_process (pid_t pid);
142
143 /* Release the process identified by PID.  This function is actually
144    only required for Windows but it does not harm to always call it.
145    It is a nop if PID is invalid.  */
146 void gnupg_release_process (pid_t pid);
147
148
149 /* Spawn a new process and immediatley detach from it.  The name of
150    the program to exec is PGMNAME and its arguments are in ARGV (the
151    programname is automatically passed as first argument).
152    Environment strings in ENVP are set.  An error is returned if
153    pgmname is not executable; to make this work it is necessary to
154    provide an absolute file name.  */
155 gpg_error_t gnupg_spawn_process_detached (const char *pgmname,
156                                           const char *argv[],
157                                           const char *envp[] );
158
159
160
161 #endif /*GNUPG_COMMON_EXECHELP_H*/