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