2 This file is part of GNUnet.
3 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
23 * Low level process routines
25 * @author Christian Grothoff
26 * @author Krista Bennett
27 * @author Gerd Knorr <kraxel@bytesex.org>
28 * @author Ioana Patrascu
29 * @author Tzvetan Horozov
32 * This code manages child processes. We can communicate with child
33 * processes using signals. Because signals are not supported on W32
34 * and Java (at least not nicely), we can alternatively use a pipe
35 * to send signals to the child processes (if the child process is
36 * a full-blown GNUnet process that supports reading signals from
37 * a pipe, of course). Naturally, this also only works for 'normal'
38 * termination via signals, and not as a replacement for SIGKILL.
39 * Thus using pipes to communicate signals should only be enabled if
40 * the child is a Java process OR if we are on Windoze.
43 #ifndef GNUNET_OS_LIB_H
44 #define GNUNET_OS_LIB_H
49 #if 0 /* keep Emacsens' auto-indent happy */
54 #include "gnunet_common.h"
55 #include "gnunet_configuration_lib.h"
56 #include "gnunet_scheduler_lib.h"
60 * Flags that determine which of the standard streams
61 * should be inherited by the child process.
63 enum GNUNET_OS_InheritStdioFlags
67 * No standard streams should be inherited.
69 GNUNET_OS_INHERIT_STD_NONE = 0,
72 * When this flag is set, the child process will
73 * inherit stdin of the parent.
75 GNUNET_OS_INHERIT_STD_IN = 1,
78 * When this flag is set, the child process will
79 * inherit stdout of the parent.
81 GNUNET_OS_INHERIT_STD_OUT = 2,
84 * When this flag is set, the child process will
85 * inherit stderr of the parent.
87 GNUNET_OS_INHERIT_STD_ERR = 4,
90 * When these flags are set, the child process will
91 * inherit stdout and stderr of the parent.
93 GNUNET_OS_INHERIT_STD_OUT_AND_ERR = 6,
96 * Use this option to have all of the standard streams
97 * (stdin, stdout and stderror) be inherited.
99 GNUNET_OS_INHERIT_STD_ALL = 7
104 * Process information (OS-dependent)
106 struct GNUNET_OS_Process;
110 * Possible installation paths to request
112 enum GNUNET_OS_InstallationPathKind
115 * Return the "PREFIX" directory given to configure.
117 GNUNET_OS_IPK_PREFIX,
120 * Return the directory where the program binaries are installed. (bin/)
122 GNUNET_OS_IPK_BINDIR,
125 * Return the directory where libraries are installed. (lib/gnunet/)
127 GNUNET_OS_IPK_LIBDIR,
130 * Return the directory where data is installed (share/gnunet/)
132 GNUNET_OS_IPK_DATADIR,
135 * Return the directory where translations are installed (share/locale/)
137 GNUNET_OS_IPK_LOCALEDIR,
140 * Return the installation directory of this application, not
141 * the one of the overall GNUnet installation (in case they
144 GNUNET_OS_IPK_SELF_PREFIX,
147 * Return the prefix of the path with application icons (share/icons/).
149 GNUNET_OS_IPK_ICONDIR,
152 * Return the prefix of the path with documentation files, including the
153 * license (share/doc/gnunet/).
155 GNUNET_OS_IPK_DOCDIR,
158 * Return the directory where helper binaries are installed (lib/gnunet/libexec/)
160 GNUNET_OS_IPK_LIBEXECDIR
165 * Process status types
167 enum GNUNET_OS_ProcessStatusType
170 * The process is not known to the OS (or at
171 * least not one of our children).
173 GNUNET_OS_PROCESS_UNKNOWN,
176 * The process is still running.
178 GNUNET_OS_PROCESS_RUNNING,
181 * The process is paused (but could be resumed).
183 GNUNET_OS_PROCESS_STOPPED,
186 * The process exited with a return code.
188 GNUNET_OS_PROCESS_EXITED,
191 * The process was killed by a signal.
193 GNUNET_OS_PROCESS_SIGNALED
198 * Get the path to a specific GNUnet installation directory or, with
199 * #GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
202 * @param dirkind what kind of directory is desired?
203 * @return a pointer to the dir path (to be freed by the caller)
206 GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind);
210 * Given the name of a gnunet-helper, gnunet-service or gnunet-daemon
211 * binary, try to prefix it with the libexec/-directory to get the
214 * @param progname name of the binary
215 * @return full path to the binary, if possible, otherwise copy of 'progname'
218 GNUNET_OS_get_libexec_binary_path (const char *progname);
222 * Callback function invoked for each interface found.
225 * @param name name of the interface (can be NULL for unknown)
226 * @param isDefault is this presumably the default interface
227 * @param addr address of this interface (can be NULL for unknown or unassigned)
228 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
229 * @param netmask the network mask (can be NULL for unknown or unassigned)
230 * @param addrlen length of the address
231 * @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
234 (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls,
237 const struct sockaddr *addr,
238 const struct sockaddr *broadcast_addr,
239 const struct sockaddr *netmask,
244 * @brief Enumerate all network interfaces
246 * @param proc the callback function
247 * @param proc_cls closure for @a proc
250 GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc,
254 * @brief Get maximum string length returned by gethostname()
256 #if HAVE_SYSCONF && defined(_SC_HOST_NAME_MAX)
257 #define GNUNET_OS_get_hostname_max_length() ({ int __sc_tmp = sysconf(_SC_HOST_NAME_MAX); __sc_tmp <= 0 ? 255 : __sc_tmp; })
258 #elif defined(HOST_NAME_MAX)
259 #define GNUNET_OS_get_hostname_max_length() HOST_NAME_MAX
261 #define GNUNET_OS_get_hostname_max_length() 255
266 * Get process structure for current process
268 * The pointer it returns points to static memory location and must not be
271 * @return pointer to the process sturcutre for this process
273 struct GNUNET_OS_Process *
274 GNUNET_OS_process_current (void);
278 * Sends a signal to the process
280 * @param proc pointer to process structure
282 * @return 0 on success, -1 on error
285 GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
289 * Cleans up process structure contents (OS-dependent) and deallocates it
291 * @param proc pointer to process structure
294 GNUNET_OS_process_destroy (struct GNUNET_OS_Process *proc);
298 * Get the pid of the process in question
300 * @param proc the process to get the pid of
302 * @return the current process id
305 GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc);
311 * @param pipe_control should a pipe be used to send signals to the child?
312 * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
313 * @param pipe_stdin pipe to use to send input to child process (or NULL)
314 * @param pipe_stdout pipe to use to get output from child process (or NULL)
315 * @param pipe_stderr pipe to use to get error output from child process (or NULL)
316 * @param filename name of the binary
317 * @param argv NULL-terminated array of arguments to the process
318 * @return pointer to process structure of the new process, NULL on error
320 struct GNUNET_OS_Process *
321 GNUNET_OS_start_process_vap (int pipe_control,
322 enum GNUNET_OS_InheritStdioFlags std_inheritance,
323 struct GNUNET_DISK_PipeHandle *pipe_stdin,
324 struct GNUNET_DISK_PipeHandle *pipe_stdout,
325 struct GNUNET_DISK_PipeHandle *pipe_stderr,
326 const char *filename,
333 * @param pipe_control should a pipe be used to send signals to the child?
334 * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
335 * @param pipe_stdin pipe to use to send input to child process (or NULL)
336 * @param pipe_stdout pipe to use to get output from child process (or NULL)
337 * @param pipe_stderr pipe to use to get error output from child process (or NULL)
338 * @param filename name of the binary
339 * @param ... NULL-terminated list of arguments to the process
340 * @return pointer to process structure of the new process, NULL on error
342 struct GNUNET_OS_Process *
343 GNUNET_OS_start_process (int pipe_control,
344 enum GNUNET_OS_InheritStdioFlags std_inheritance,
345 struct GNUNET_DISK_PipeHandle *pipe_stdin,
346 struct GNUNET_DISK_PipeHandle *pipe_stdout,
347 struct GNUNET_DISK_PipeHandle *pipe_stderr,
348 const char *filename, ...);
354 * @param pipe_control should a pipe be used to send signals to the child?
355 * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
356 * @param pipe_stdin pipe to use to send input to child process (or NULL)
357 * @param pipe_stdout pipe to use to get output from child process (or NULL)
358 * @param pipe_stderr pipe to use to get error output from child process (or NULL)
359 * @param filename name of the binary
360 * @param va NULL-terminated list of arguments to the process
361 * @return pointer to process structure of the new process, NULL on error
363 struct GNUNET_OS_Process *
364 GNUNET_OS_start_process_va (int pipe_control,
365 enum GNUNET_OS_InheritStdioFlags std_inheritance,
366 struct GNUNET_DISK_PipeHandle *pipe_stdin,
367 struct GNUNET_DISK_PipeHandle *pipe_stdout,
368 struct GNUNET_DISK_PipeHandle *pipe_stderr,
369 const char *filename, va_list va);
374 * @param pipe_control should a pipe be used to send signals to the child?
375 * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
376 * @param lsocks array of listen sockets to dup systemd-style (or NULL);
377 * must be NULL on platforms where dup is not supported
378 * @param filename name of the binary
379 * @param argv NULL-terminated list of arguments to the process,
380 * including the process name as the first argument
381 * @return pointer to process structure of the new process, NULL on error
383 struct GNUNET_OS_Process *
384 GNUNET_OS_start_process_v (int pipe_control,
385 enum GNUNET_OS_InheritStdioFlags std_inheritance,
386 const SOCKTYPE *lsocks,
387 const char *filename,
392 * Start a process. This function is similar to the GNUNET_OS_start_process_*
393 * except that the filename and arguments can have whole strings which contain
394 * the arguments. These arguments are to be separated by spaces and are parsed
395 * in the order they appear. Arguments containing spaces can be used by
396 * quoting them with @em ".
398 * @param pipe_control should a pipe be used to send signals to the child?
399 * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
400 * @param lsocks array of listen sockets to dup systemd-style (or NULL);
401 * must be NULL on platforms where dup is not supported
402 * @param filename name of the binary. It is valid to have the arguments
403 * in this string when they are separated by spaces.
404 * @param ... more arguments. Should be of type `char *`. It is valid
405 * to have the arguments in these strings when they are separated by
406 * spaces. The last argument MUST be NULL.
407 * @return pointer to process structure of the new process, NULL on error
409 struct GNUNET_OS_Process *
410 GNUNET_OS_start_process_s (int pipe_control,
411 unsigned int std_inheritance,
412 const SOCKTYPE * lsocks,
413 const char *filename, ...);
417 * Handle to a command action.
419 struct GNUNET_OS_CommandHandle;
423 * Type of a function to process a line of output.
426 * @param line line of output from a command, NULL for the end
428 typedef void (*GNUNET_OS_LineProcessor) (void *cls, const char *line);
432 * Stop/kill a command.
434 * @param cmd handle to the process
437 GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd);
441 * Run the given command line and call the given function
442 * for each line of the output.
444 * @param proc function to call for each line of the output
445 * @param proc_cls closure for proc
446 * @param timeout when to time out
447 * @param binary command to run
448 * @param ... arguments to command
449 * @return NULL on error
451 struct GNUNET_OS_CommandHandle *
452 GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc, void *proc_cls,
453 struct GNUNET_TIME_Relative timeout, const char *binary,
458 * Retrieve the status of a process, waiting on him if dead.
459 * Nonblocking version.
461 * @param proc pointer to process structure
462 * @param type status type
463 * @param code return code/signal number
464 * @return #GNUNET_OK on success, #GNUNET_NO if the process is still running, #GNUNET_SYSERR otherwise
467 GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
468 enum GNUNET_OS_ProcessStatusType *type,
469 unsigned long *code);
473 * Wait for a process to terminate. The return code is discarded.
474 * You must not use #GNUNET_OS_process_status() on the same process
475 * after calling this function! This function is blocking and should
476 * thus only be used if the child process is known to have terminated
477 * or to terminate very soon.
479 * @param proc pointer to process structure of the process to wait for
480 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
483 GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
487 * Connects this process to its parent via pipe;
488 * essentially, the parent control handler will read signal numbers
489 * from the #GNUNET_OS_CONTROL_PIPE (as given in an environment
490 * variable) and raise those signals.
492 * @param cls closure (unused)
493 * @param tc scheduler context (unused)
496 GNUNET_OS_install_parent_control_handler (void *cls,
498 GNUNET_SCHEDULER_TaskContext *tc);
502 * Check whether an executable exists and possibly
503 * if the suid bit is set on the file.
504 * Attempts to find the file using the current
505 * PATH environment variable as a search path.
507 * @param binary the name of the file to check.
508 * W32: must not have an .exe suffix.
509 * @param check_suid input true if the binary should be checked for SUID (*nix)
510 * W32: checks if the program has sufficient privileges by executing this
511 * binary with the -d flag. -d omits a programs main loop and only
512 * executes all privileged operations in an binary.
513 * @param params parameters used for w32 privilege checking (can be NULL for != w32, or when not checking for suid/permissions )
514 * @return #GNUNET_YES if the file is SUID (*nix) or can be executed with current privileges (W32),
515 * #GNUNET_NO if not SUID (but binary exists),
516 * #GNUNET_SYSERR on error (no such binary or not executable)
519 GNUNET_OS_check_helper_binary (const char *binary,
524 #if 0 /* keep Emacsens' auto-indent happy */
532 /* ifndef GNUNET_OS_LIB_H */
534 /* end of gnunet_os_lib.h */