X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_os_lib.h;h=e4bbab8a97ac77a6b0d27cd985b08638e4abc453;hb=9e249590e5d750c70ec61d1100c70d325374dbd8;hp=87d9a8fb1700a438f704b4360a50bee306c3b2bb;hpb=13a7da212738f9c76c0772ca7726f91885e588d2;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_os_lib.h b/src/include/gnunet_os_lib.h index 87d9a8fb1..e4bbab8a9 100644 --- a/src/include/gnunet_os_lib.h +++ b/src/include/gnunet_os_lib.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet. - (C) 2001, 2002, 2003, 2004, 2005, 2006 Christian Grothoff (and other contributing authors) + (C) 2001, 2002, 2003, 2004, 2005, 2006, 2011 Christian Grothoff (and other contributing authors) GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -27,6 +27,16 @@ * @author Ioana Patrascu * @author Tzvetan Horozov * @author Milan + * + * This code manages child processes. We can communicate with child + * processes using signals. Because signals are not supported on W32 + * and Java (at least not nicely), we can alternatively use a pipe + * to send signals to the child processes (if the child process is + * a full-blown GNUnet process that supports reading signals from + * a pipe, of course). Naturally, this also only works for 'normal' + * termination via signals, and not as a replacement for SIGKILL. + * Thus using pipes to communicate signals should only be enabled if + * the child is a Java process OR if we are on Windoze. */ #ifndef GNUNET_OS_LIB_H @@ -45,6 +55,56 @@ extern "C" #include "gnunet_scheduler_lib.h" +/** + * Flags that determine which of the standard streams + * should be inherited by the child process. + */ +enum GNUNET_OS_InheritStdioFlags +{ + + /** + * No standard streams should be inherited. + */ + GNUNET_OS_INHERIT_STD_NONE = 0, + + /** + * When this flag is set, the child process will + * inherit stdin of the parent. + */ + GNUNET_OS_INHERIT_STD_IN = 1, + + /** + * When this flag is set, the child process will + * inherit stdout of the parent. + */ + GNUNET_OS_INHERIT_STD_OUT = 2, + + /** + * When this flag is set, the child process will + * inherit stderr of the parent. + */ + GNUNET_OS_INHERIT_STD_ERR = 4, + + /** + * When these flags are set, the child process will + * inherit stdout and stderr of the parent. + */ + GNUNET_OS_INHERIT_STD_OUT_AND_ERR = 6, + + /** + * Use this option to have all of the standard streams + * (stdin, stdout and stderror) be inherited. + */ + GNUNET_OS_INHERIT_STD_ALL = 7 +}; + + +/** + * Process information (OS-dependent) + */ +struct GNUNET_OS_Process; + + /** * Possible installation paths to request */ @@ -61,12 +121,12 @@ enum GNUNET_OS_InstallationPathKind GNUNET_OS_IPK_BINDIR, /** - * Return the directory where libraries are installed. (lib/) + * Return the directory where libraries are installed. (lib/gnunet/) */ GNUNET_OS_IPK_LIBDIR, /** - * Return the directory where data is installed (share/) + * Return the directory where data is installed (share/gnunet/) */ GNUNET_OS_IPK_DATADIR, @@ -80,7 +140,23 @@ enum GNUNET_OS_InstallationPathKind * the one of the overall GNUnet installation (in case they * are different). */ - GNUNET_OS_IPK_SELF_PREFIX + GNUNET_OS_IPK_SELF_PREFIX, + + /** + * Return the prefix of the path with application icons (share/icons/). + */ + GNUNET_OS_IPK_ICONDIR, + + /** + * Return the prefix of the path with documentation files, including the + * license (share/doc/gnunet/). + */ + GNUNET_OS_IPK_DOCDIR, + + /** + * Return the directory where helper binaries are installed (lib/gnunet/libexec/) + */ + GNUNET_OS_IPK_LIBEXECDIR }; @@ -125,8 +201,20 @@ enum GNUNET_OS_ProcessStatusType * @param dirkind what kind of directory is desired? * @return a pointer to the dir path (to be freed by the caller) */ -char *GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind - dirkind); +char * +GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind); + + +/** + * Given the name of a gnunet-helper, gnunet-service or gnunet-daemon + * binary, try to prefix it with the libexec/-directory to get the + * full path. + * + * @param progname name of the binary + * @return full path to the binary, if possible, otherwise copy of 'progname' + */ +char * +GNUNET_OS_get_libexec_binary_path (const char *progname); /** @@ -136,14 +224,19 @@ char *GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind * @param name name of the interface (can be NULL for unknown) * @param isDefault is this presumably the default interface * @param addr address of this interface (can be NULL for unknown or unassigned) + * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned) + * @param netmask the network mask (can be NULL for unknown or unassigned)) * @param addrlen length of the address * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort */ -typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls, - const char *name, +typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls, const char *name, int isDefault, const struct sockaddr * - addr, socklen_t addrlen); + addr, + const struct sockaddr * + broadcast_addr, + const struct sockaddr * + netmask, socklen_t addrlen); /** @@ -151,8 +244,9 @@ typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls, * @param proc the callback function * @param proc_cls closure for proc */ -void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor - proc, void *proc_cls); +void +GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc, + void *proc_cls); /** * @brief Get maximum string length returned by gethostname() @@ -167,83 +261,235 @@ void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor /** - * Get the current CPU load. + * Get process structure for current process + * + * The pointer it returns points to static memory location and must not be + * deallocated/closed + * + * @return pointer to the process sturcutre for this process + */ +struct GNUNET_OS_Process * +GNUNET_OS_process_current (void); + + +/** + * Sends a signal to the process + * + * @param proc pointer to process structure + * @param sig signal + * @return 0 on success, -1 on error + */ +int +GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig); + + +/** + * Cleans up process structure contents (OS-dependent) and deallocates it * - * @param cfg to determine acceptable load level (LOAD::MAXCPULOAD) - * @return -1 on error, otherwise load value (between 0 and 100, - * (100 is equivalent to full load for one CPU) + * @param proc pointer to process structure */ -int GNUNET_OS_load_cpu_get (const struct GNUNET_CONFIGURATION_Handle *cfg); +void +GNUNET_OS_process_destroy (struct GNUNET_OS_Process *proc); /** - * Get the current IO load. + * Get the pid of the process in question + * + * @param proc the process to get the pid of * - * @param cfg to determine acceptable load level (LOAD::MAXIOLOAD) - * @return -1 on error, otherwise load value (between 0 and 100, - * 100 means that we spend all of our cycles waiting for - * the disk) + * @return the current process id */ -int GNUNET_OS_load_disk_get (const struct GNUNET_CONFIGURATION_Handle *cfg); +pid_t +GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc); /** * Set process priority * - * @param proc id of the process + * @param proc pointer to process structure * @param prio priority value * @return GNUNET_OK on success, GNUNET_SYSERR on error */ -int GNUNET_OS_set_process_priority (pid_t proc, - enum GNUNET_SCHEDULER_Priority prio); +int +GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc, + enum GNUNET_SCHEDULER_Priority prio); + + +/** + * Start a process. + * + * @param pipe_control should a pipe be used to send signals to the child? + * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags + * @param pipe_stdin pipe to use to send input to child process (or NULL) + * @param pipe_stdout pipe to use to get output from child process (or NULL) + * @param filename name of the binary + * @param argv NULL-terminated array of arguments to the process + * @return pointer to process structure of the new process, NULL on error + */ +struct GNUNET_OS_Process * +GNUNET_OS_start_process_vap (int pipe_control, + enum GNUNET_OS_InheritStdioFlags std_inheritance, + struct GNUNET_DISK_PipeHandle *pipe_stdin, + struct GNUNET_DISK_PipeHandle *pipe_stdout, + const char *filename, + char *const argv[]); /** * Start a process. * + * @param pipe_control should a pipe be used to send signals to the child? + * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags * @param pipe_stdin pipe to use to send input to child process (or NULL) * @param pipe_stdout pipe to use to get output from child process (or NULL) * @param filename name of the binary * @param ... NULL-terminated list of arguments to the process - * @return process ID of the new process, -1 on error + * @return pointer to process structure of the new process, NULL on error */ -pid_t -GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin, - struct GNUNET_DISK_PipeHandle *pipe_stdout, - const char *filename, ...); +struct GNUNET_OS_Process * +GNUNET_OS_start_process (int pipe_control, + enum GNUNET_OS_InheritStdioFlags std_inheritance, + struct GNUNET_DISK_PipeHandle *pipe_stdin, + struct GNUNET_DISK_PipeHandle *pipe_stdout, + const char *filename, ...); /** * Start a process. * + * @param pipe_control should a pipe be used to send signals to the child? + * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags + * @param pipe_stdin pipe to use to send input to child process (or NULL) + * @param pipe_stdout pipe to use to get output from child process (or NULL) + * @param filename name of the binary + * @param va NULL-terminated list of arguments to the process + * @return pointer to process structure of the new process, NULL on error + */ +struct GNUNET_OS_Process * +GNUNET_OS_start_process_va (int pipe_control, + enum GNUNET_OS_InheritStdioFlags std_inheritance, + struct GNUNET_DISK_PipeHandle *pipe_stdin, + struct GNUNET_DISK_PipeHandle *pipe_stdout, + const char *filename, va_list va); + +/** + * Start a process. + * + * @param pipe_control should a pipe be used to send signals to the child? + * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags * @param lsocks array of listen sockets to dup systemd-style (or NULL); * must be NULL on platforms where dup is not supported * @param filename name of the binary * @param argv NULL-terminated list of arguments to the process, * including the process name as the first argument - * @return process ID of the new process, -1 on error + * @return pointer to process structure of the new process, NULL on error + */ +struct GNUNET_OS_Process * +GNUNET_OS_start_process_v (int pipe_control, + enum GNUNET_OS_InheritStdioFlags std_inheritance, + const SOCKTYPE *lsocks, + const char *filename, + char *const argv[]); + + +/** + * Handle to a command action. + */ +struct GNUNET_OS_CommandHandle; + + +/** + * Type of a function to process a line of output. + * + * @param cls closure + * @param line line of output from a command, NULL for the end + */ +typedef void (*GNUNET_OS_LineProcessor) (void *cls, const char *line); + + +/** + * Stop/kill a command. + * + * @param cmd handle to the process */ -pid_t GNUNET_OS_start_process_v (const int *lsocks, - const char *filename, char *const argv[]); +void +GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd); /** - * Retrieve the status of a process - * @param proc process ID + * Run the given command line and call the given function + * for each line of the output. + * + * @param proc function to call for each line of the output + * @param proc_cls closure for proc + * @param timeout when to time out + * @param binary command to run + * @param ... arguments to command + * @return NULL on error + */ +struct GNUNET_OS_CommandHandle * +GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc, void *proc_cls, + struct GNUNET_TIME_Relative timeout, const char *binary, + ...); + + +/** + * Retrieve the status of a process, waiting on him if dead. + * Nonblocking version. + * + * @param proc pointer to process structure * @param type status type * @param code return code/signal number * @return GNUNET_OK on success, GNUNET_NO if the process is still running, GNUNET_SYSERR otherwise */ -int GNUNET_OS_process_status (pid_t proc, enum GNUNET_OS_ProcessStatusType *type, - unsigned long *code); +int +GNUNET_OS_process_status (struct GNUNET_OS_Process *proc, + enum GNUNET_OS_ProcessStatusType *type, + unsigned long *code); /** - * Wait for a process - * @param proc process ID to wait for + * Wait for a process to terminate. The return code is discarded. + * You must not use 'GNUNET_OS_process_status' on the same process + * after calling this function! This function is blocking and should + * thus only be used if the child process is known to have terminated + * or to terminate very soon. + * + * @param proc pointer to process structure of the process to wait for * @return GNUNET_OK on success, GNUNET_SYSERR otherwise */ -int GNUNET_OS_process_wait (pid_t proc); +int +GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc); + + +/** + * Connects this process to its parent via pipe; + * essentially, the parent control handler will read signal numbers + * from the 'GNUNET_OS_CONTROL_PIPE' (as given in an environment + * variable) and raise those signals. + * + * @param cls closure (unused) + * @param tc scheduler context (unused) + */ +void +GNUNET_OS_install_parent_control_handler (void *cls, + const struct + GNUNET_SCHEDULER_TaskContext *tc); + + +/** + * Check whether an executable exists and possibly + * if the suid bit is set on the file. + * Attempts to find the file using the current + * PATH environment variable as a search path. + * + * @param binary the name of the file to check + * @return GNUNET_YES if the file is SUID, + * GNUNET_NO if not SUID (but binary exists) + * GNUNET_SYSERR on error (no such binary or not executable) + */ +int +GNUNET_OS_check_helper_binary (const char *binary); #if 0 /* keep Emacsens' auto-indent happy */