X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_os_lib.h;h=c56947431e49889afa1e2c71bd3f4c105f531879;hb=b0c7119fa2f43fe1b5978651152974359de5a5d2;hp=7bd65adcbde19279c789c1611446ba59703acb45;hpb=22e893cbfab6d19abb860a13778850e9df4e82d7;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_os_lib.h b/src/include/gnunet_os_lib.h index 7bd65adcb..c56947431 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 @@ -66,12 +66,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, @@ -88,9 +88,15 @@ enum GNUNET_OS_InstallationPathKind GNUNET_OS_IPK_SELF_PREFIX, /** - * Return the prefix of the path with application icons. + * Return the prefix of the path with application icons (share/icons/). */ - GNUNET_OS_IPK_ICONDIR + GNUNET_OS_IPK_ICONDIR, + + /** + * Return the prefix of the path with documentation files, including the + * license (share/doc/gnunet/). + */ + GNUNET_OS_IPK_DOCDIR }; @@ -135,8 +141,8 @@ 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); /** @@ -146,14 +152,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); /** @@ -161,8 +172,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() @@ -184,7 +196,8 @@ void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor * * @return pointer to the process sturcutre for this process */ -struct GNUNET_OS_Process *GNUNET_OS_process_current (void); +struct GNUNET_OS_Process * +GNUNET_OS_process_current (void); /** @@ -194,7 +207,8 @@ struct GNUNET_OS_Process *GNUNET_OS_process_current (void); * @param sig signal * @return 0 on success, -1 on error */ -int GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig); +int +GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig); /** @@ -202,7 +216,8 @@ int GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig); * * @param proc pointer to process structure */ -void GNUNET_OS_process_close (struct GNUNET_OS_Process *proc); +void +GNUNET_OS_process_close (struct GNUNET_OS_Process *proc); /** * Get the pid of the process in question @@ -221,8 +236,26 @@ GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc); * @param prio priority value * @return GNUNET_OK on success, GNUNET_SYSERR on error */ -int GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *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_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 (struct GNUNET_DISK_PipeHandle *pipe_stdin, + struct GNUNET_DISK_PipeHandle *pipe_stdout, + const char *filename, + char *const argv[]); /** @@ -235,10 +268,24 @@ int GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc, * @return pointer to process structure of the new process, NULL on error */ struct GNUNET_OS_Process * -GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin, - struct GNUNET_DISK_PipeHandle *pipe_stdout, - const char *filename, ...); +GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin, + struct GNUNET_DISK_PipeHandle *pipe_stdout, + const char *filename, ...); + +/** + * Start a process. + * + * @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 (struct GNUNET_DISK_PipeHandle *pipe_stdin, + struct GNUNET_DISK_PipeHandle *pipe_stdout, + const char *filename, va_list va); /** * Start a process. @@ -251,27 +298,75 @@ GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin, * @return pointer to process structure of the new process, NULL on error */ struct GNUNET_OS_Process * -GNUNET_OS_start_process_v (const int *lsocks, const char *filename, - char *const argv[]); +GNUNET_OS_start_process_v (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 + */ +void +GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd); /** - * Retrieve the status of a process + * 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. 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 (struct GNUNET_OS_Process *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 + * 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 (struct GNUNET_OS_Process *proc); +int +GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc); /** @@ -280,7 +375,23 @@ int GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc); void GNUNET_OS_install_parent_control_handler (void *cls, const struct - GNUNET_SCHEDULER_TaskContext * tc); + 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 */ {