1 /* gspawn.h - Process launching
3 * Copyright 2000 Red Hat, Inc.
5 * GLib is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
10 * GLib is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with GLib; see the file COPYING.LIB. If not, write
17 * to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
24 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
25 #error "Only <glib.h> can be included directly."
28 #include <glib/gerror.h>
33 /* I'm not sure I remember our proposed naming convention here. */
37 * Error domain for spawning processes. Errors in this domain will
38 * be from the #GSpawnError enumeration. See #GError for information on
41 #define G_SPAWN_ERROR g_spawn_error_quark ()
45 * @G_SPAWN_ERROR_FORK: Fork failed due to lack of memory.
46 * @G_SPAWN_ERROR_READ: Read or select on pipes failed.
47 * @G_SPAWN_ERROR_CHDIR: Changing to working directory failed.
48 * @G_SPAWN_ERROR_ACCES: execv() returned <literal>EACCES</literal>
49 * @G_SPAWN_ERROR_PERM: execv() returned <literal>EPERM</literal>
50 * @G_SPAWN_ERROR_TOO_BIG: execv() returned <literal>E2BIG</literal>
51 * @G_SPAWN_ERROR_2BIG: deprecated alias for %G_SPAWN_ERROR_TOO_BIG
52 * @G_SPAWN_ERROR_NOEXEC: execv() returned <literal>ENOEXEC</literal>
53 * @G_SPAWN_ERROR_NAMETOOLONG: execv() returned <literal>ENAMETOOLONG</literal>
54 * @G_SPAWN_ERROR_NOENT: execv() returned <literal>ENOENT</literal>
55 * @G_SPAWN_ERROR_NOMEM: execv() returned <literal>ENOMEM</literal>
56 * @G_SPAWN_ERROR_NOTDIR: execv() returned <literal>ENOTDIR</literal>
57 * @G_SPAWN_ERROR_LOOP: execv() returned <literal>ELOOP</literal>
58 * @G_SPAWN_ERROR_TXTBUSY: execv() returned <literal>ETXTBUSY</literal>
59 * @G_SPAWN_ERROR_IO: execv() returned <literal>EIO</literal>
60 * @G_SPAWN_ERROR_NFILE: execv() returned <literal>ENFILE</literal>
61 * @G_SPAWN_ERROR_MFILE: execv() returned <literal>EMFILE</literal>
62 * @G_SPAWN_ERROR_INVAL: execv() returned <literal>EINVAL</literal>
63 * @G_SPAWN_ERROR_ISDIR: execv() returned <literal>EISDIR</literal>
64 * @G_SPAWN_ERROR_LIBBAD: execv() returned <literal>ELIBBAD</literal>
65 * @G_SPAWN_ERROR_FAILED: Some other fatal failure,
66 * <literal>error->message</literal> should explain.
68 * Error codes returned by spawning processes.
72 G_SPAWN_ERROR_FORK
, /* fork failed due to lack of memory */
73 G_SPAWN_ERROR_READ
, /* read or select on pipes failed */
74 G_SPAWN_ERROR_CHDIR
, /* changing to working dir failed */
75 G_SPAWN_ERROR_ACCES
, /* execv() returned EACCES */
76 G_SPAWN_ERROR_PERM
, /* execv() returned EPERM */
77 G_SPAWN_ERROR_TOO_BIG
,/* execv() returned E2BIG */
78 #ifndef G_DISABLE_DEPRECATED
79 G_SPAWN_ERROR_2BIG
= G_SPAWN_ERROR_TOO_BIG
,
81 G_SPAWN_ERROR_NOEXEC
, /* execv() returned ENOEXEC */
82 G_SPAWN_ERROR_NAMETOOLONG
, /* "" "" ENAMETOOLONG */
83 G_SPAWN_ERROR_NOENT
, /* "" "" ENOENT */
84 G_SPAWN_ERROR_NOMEM
, /* "" "" ENOMEM */
85 G_SPAWN_ERROR_NOTDIR
, /* "" "" ENOTDIR */
86 G_SPAWN_ERROR_LOOP
, /* "" "" ELOOP */
87 G_SPAWN_ERROR_TXTBUSY
, /* "" "" ETXTBUSY */
88 G_SPAWN_ERROR_IO
, /* "" "" EIO */
89 G_SPAWN_ERROR_NFILE
, /* "" "" ENFILE */
90 G_SPAWN_ERROR_MFILE
, /* "" "" EMFLE */
91 G_SPAWN_ERROR_INVAL
, /* "" "" EINVAL */
92 G_SPAWN_ERROR_ISDIR
, /* "" "" EISDIR */
93 G_SPAWN_ERROR_LIBBAD
, /* "" "" ELIBBAD */
94 G_SPAWN_ERROR_FAILED
/* other fatal failure, error->message
100 * G_SPAWN_EXIT_ERROR:
102 * Error domain used by g_spawn_check_exit_status(). The code
103 * will be the program exit code.
105 #define G_SPAWN_EXIT_ERROR g_spawn_exit_error_quark ()
108 * GSpawnChildSetupFunc:
109 * @user_data: user data to pass to the function.
111 * Specifies the type of the setup function passed to g_spawn_async(),
112 * g_spawn_sync() and g_spawn_async_with_pipes(), which can, in very
113 * limited ways, be used to affect the child's execution.
115 * On POSIX platforms, the function is called in the child after GLib
116 * has performed all the setup it plans to perform, but before calling
117 * exec(). Actions taken in this function will only affect the child,
120 * On Windows, the function is called in the parent. Its usefulness on
121 * Windows is thus questionable. In many cases executing the child setup
122 * function in the parent can have ill effects, and you should be very
123 * careful when porting software to Windows that uses child setup
126 * However, even on POSIX, you are extremely limited in what you can
127 * safely do from a #GSpawnChildSetupFunc, because any mutexes that
128 * were held by other threads in the parent process at the time of the
129 * fork() will still be locked in the child process, and they will
130 * never be unlocked (since the threads that held them don't exist in
131 * the child). POSIX allows only async-signal-safe functions (see
132 * <citerefentry><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>)
133 * to be called in the child between fork() and exec(), which
134 * drastically limits the usefulness of child setup functions.
136 * In particular, it is not safe to call any function which may
137 * call malloc(), which includes POSIX functions such as setenv().
138 * If you need to set up the child environment differently from
139 * the parent, you should use g_get_environ(), g_environ_setenv(),
140 * and g_environ_unsetenv(), and then pass the complete environment
141 * list to the <literal>g_spawn...</literal> function.
143 typedef void (* GSpawnChildSetupFunc
) (gpointer user_data
);
147 * @G_SPAWN_DEFAULT: no flags, default behaviour
148 * @G_SPAWN_LEAVE_DESCRIPTORS_OPEN: the parent's open file descriptors will be
149 * inherited by the child; otherwise all descriptors except stdin/stdout/stderr
150 * will be closed before calling exec() in the child.
151 * @G_SPAWN_DO_NOT_REAP_CHILD: the child will not be automatically reaped; you
152 * must use g_child_watch_add() yourself (or call waitpid()
153 * or handle <literal>SIGCHLD</literal> yourself), or the child will become a zombie.
154 * @G_SPAWN_SEARCH_PATH: <literal>argv[0]</literal> need not be an absolute path,
155 * it will be looked for in the user's <envar>PATH</envar>.
156 * @G_SPAWN_STDOUT_TO_DEV_NULL: the child's standard output will be discarded,
157 * instead of going to the same location as the parent's standard output.
158 * @G_SPAWN_STDERR_TO_DEV_NULL: the child's standard error will be discarded.
159 * @G_SPAWN_CHILD_INHERITS_STDIN: the child will inherit the parent's standard
160 * input (by default, the child's standard input is attached to
161 * <filename>/dev/null</filename>).
162 * @G_SPAWN_FILE_AND_ARGV_ZERO: the first element of <literal>argv</literal> is
163 * the file to execute, while the remaining elements are the actual argument
164 * vector to pass to the file. Normally g_spawn_async_with_pipes() uses
165 * <literal>argv[0]</literal> as the file to execute, and passes all of
166 * <literal>argv</literal> to the child.
167 * @G_SPAWN_SEARCH_PATH_FROM_ENVP: if <literal>argv[0]</literal> is not an abolute path,
168 * it will be looked for in the <envar>PATH</envar> from the passed child
169 * environment. Since: 2.34
170 * @G_SPAWN_CLOEXEC_PIPES: create all pipes with the O_CLOEXEC flag set.
173 * Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes().
178 G_SPAWN_LEAVE_DESCRIPTORS_OPEN
= 1 << 0,
179 G_SPAWN_DO_NOT_REAP_CHILD
= 1 << 1,
180 /* look for argv[0] in the path i.e. use execvp() */
181 G_SPAWN_SEARCH_PATH
= 1 << 2,
182 /* Dump output to /dev/null */
183 G_SPAWN_STDOUT_TO_DEV_NULL
= 1 << 3,
184 G_SPAWN_STDERR_TO_DEV_NULL
= 1 << 4,
185 G_SPAWN_CHILD_INHERITS_STDIN
= 1 << 5,
186 G_SPAWN_FILE_AND_ARGV_ZERO
= 1 << 6,
187 G_SPAWN_SEARCH_PATH_FROM_ENVP
= 1 << 7,
188 G_SPAWN_CLOEXEC_PIPES
= 1 << 8
191 GLIB_AVAILABLE_IN_ALL
192 GQuark
g_spawn_error_quark (void);
193 GLIB_AVAILABLE_IN_ALL
194 GQuark
g_spawn_exit_error_quark (void);
196 GLIB_AVAILABLE_IN_ALL
197 gboolean
g_spawn_async (const gchar
*working_directory
,
201 GSpawnChildSetupFunc child_setup
,
207 /* Opens pipes for non-NULL standard_output, standard_input, standard_error,
208 * and returns the parent's end of the pipes.
210 GLIB_AVAILABLE_IN_ALL
211 gboolean
g_spawn_async_with_pipes (const gchar
*working_directory
,
215 GSpawnChildSetupFunc child_setup
,
218 gint
*standard_input
,
219 gint
*standard_output
,
220 gint
*standard_error
,
224 /* If standard_output or standard_error are non-NULL, the full
225 * standard output or error of the command will be placed there.
228 GLIB_AVAILABLE_IN_ALL
229 gboolean
g_spawn_sync (const gchar
*working_directory
,
233 GSpawnChildSetupFunc child_setup
,
235 gchar
**standard_output
,
236 gchar
**standard_error
,
240 GLIB_AVAILABLE_IN_ALL
241 gboolean
g_spawn_command_line_sync (const gchar
*command_line
,
242 gchar
**standard_output
,
243 gchar
**standard_error
,
246 GLIB_AVAILABLE_IN_ALL
247 gboolean
g_spawn_command_line_async (const gchar
*command_line
,
250 GLIB_AVAILABLE_IN_2_34
251 gboolean
g_spawn_check_exit_status (gint exit_status
,
254 GLIB_AVAILABLE_IN_ALL
255 void g_spawn_close_pid (GPid pid
);
258 #define g_spawn_async g_spawn_async_utf8
259 #define g_spawn_async_with_pipes g_spawn_async_with_pipes_utf8
260 #define g_spawn_sync g_spawn_sync_utf8
261 #define g_spawn_command_line_sync g_spawn_command_line_sync_utf8
262 #define g_spawn_command_line_async g_spawn_command_line_async_utf8
264 GLIB_AVAILABLE_IN_ALL
265 gboolean
g_spawn_async_utf8 (const gchar
*working_directory
,
269 GSpawnChildSetupFunc child_setup
,
273 GLIB_AVAILABLE_IN_ALL
274 gboolean
g_spawn_async_with_pipes_utf8 (const gchar
*working_directory
,
278 GSpawnChildSetupFunc child_setup
,
281 gint
*standard_input
,
282 gint
*standard_output
,
283 gint
*standard_error
,
285 GLIB_AVAILABLE_IN_ALL
286 gboolean
g_spawn_sync_utf8 (const gchar
*working_directory
,
290 GSpawnChildSetupFunc child_setup
,
292 gchar
**standard_output
,
293 gchar
**standard_error
,
297 GLIB_AVAILABLE_IN_ALL
298 gboolean
g_spawn_command_line_sync_utf8 (const gchar
*command_line
,
299 gchar
**standard_output
,
300 gchar
**standard_error
,
303 GLIB_AVAILABLE_IN_ALL
304 gboolean
g_spawn_command_line_async_utf8 (const gchar
*command_line
,
310 #endif /* __G_SPAWN_H__ */