src/include/gnunet_os_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2011 Christian Grothoff (and other contributing authors)
   4
   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 2, or (at your
   8      option) any later version.
   9
  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.
  14
  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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_os_lib.h
  23  * @brief low level process routines
  24  * @author Christian Grothoff
  25  * @author Krista Bennett
  26  * @author Gerd Knorr <kraxel@bytesex.org>
  27  * @author Ioana Patrascu
  28  * @author Tzvetan Horozov
  29  * @author Milan
  30  */
  31
  32 #ifndef GNUNET_OS_LIB_H
  33 #define GNUNET_OS_LIB_H
  34
  35 #ifdef __cplusplus
  36 extern "C"
  37 {
  38 #if 0                           /* keep Emacsens' auto-indent happy */
  39 }
  40 #endif
  41 #endif
  42
  43 #include "gnunet_common.h"
  44 #include "gnunet_configuration_lib.h"
  45 #include "gnunet_scheduler_lib.h"
  46
  47 /**
  48  * Process information (OS-dependent)
  49  */
  50 struct GNUNET_OS_Process;
  51
  52
  53 /**
  54  * Possible installation paths to request
  55  */
  56 enum GNUNET_OS_InstallationPathKind
  57 {
  58   /**
  59    * Return the "PREFIX" directory given to configure.
  60    */
  61   GNUNET_OS_IPK_PREFIX,
  62
  63   /**
  64    * Return the directory where the program binaries are installed. (bin/)
  65    */
  66   GNUNET_OS_IPK_BINDIR,
  67
  68   /**
  69    * Return the directory where libraries are installed. (lib/)
  70    */
  71   GNUNET_OS_IPK_LIBDIR,
  72
  73   /**
  74    * Return the directory where data is installed (share/)
  75    */
  76   GNUNET_OS_IPK_DATADIR,
  77
  78   /**
  79    * Return the directory where translations are installed (share/locale/)
  80    */
  81   GNUNET_OS_IPK_LOCALEDIR,
  82
  83   /**
  84    * Return the installation directory of this application, not
  85    * the one of the overall GNUnet installation (in case they
  86    * are different).
  87    */
  88   GNUNET_OS_IPK_SELF_PREFIX,
  89
  90   /**
  91    * Return the prefix of the path with application icons.
  92    */
  93   GNUNET_OS_IPK_ICONDIR
  94 };
  95
  96
  97 /**
  98  * Process status types
  99  */
 100 enum GNUNET_OS_ProcessStatusType
 101 {
 102   /**
 103    * The process is not known to the OS (or at
 104    * least not one of our children).
 105    */
 106   GNUNET_OS_PROCESS_UNKNOWN,
 107
 108   /**
 109    * The process is still running.
 110    */
 111   GNUNET_OS_PROCESS_RUNNING,
 112
 113   /**
 114    * The process is paused (but could be resumed).
 115    */
 116   GNUNET_OS_PROCESS_STOPPED,
 117
 118   /**
 119    * The process exited with a return code.
 120    */
 121   GNUNET_OS_PROCESS_EXITED,
 122
 123   /**
 124    * The process was killed by a signal.
 125    */
 126   GNUNET_OS_PROCESS_SIGNALED
 127 };
 128
 129
 130 /**
 131  * Get the path to a specific GNUnet installation directory or, with
 132  * GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
 133  * directory.
 134  *
 135  * @param dirkind what kind of directory is desired?
 136  * @return a pointer to the dir path (to be freed by the caller)
 137  */
 138 char *GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind
 139                                        dirkind);
 140
 141
 142 /**
 143  * Callback function invoked for each interface found.
 144  *
 145  * @param cls closure
 146  * @param name name of the interface (can be NULL for unknown)
 147  * @param isDefault is this presumably the default interface
 148  * @param addr address of this interface (can be NULL for unknown or unassigned)
 149  * @param addrlen length of the address
 150  * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
 151  */
 152 typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls, const char *name,
 153                                                     int isDefault,
 154                                                     const struct sockaddr *
 155                                                     addr, socklen_t addrlen);
 156
 157
 158 /**
 159  * @brief Enumerate all network interfaces
 160  * @param proc the callback function
 161  * @param proc_cls closure for proc
 162  */
 163 void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor
 164                                         proc, void *proc_cls);
 165
 166 /**
 167  * @brief Get maximum string length returned by gethostname()
 168  */
 169 #if HAVE_SYSCONF && defined(_SC_HOST_NAME_MAX)
 170 #define GNUNET_OS_get_hostname_max_length() ({ int __sc_tmp = sysconf(_SC_HOST_NAME_MAX); __sc_tmp <= 0 ? 255 : __sc_tmp; })
 171 #elif defined(HOST_NAME_MAX)
 172 #define GNUNET_OS_get_hostname_max_length() HOST_NAME_MAX
 173 #else
 174 #define GNUNET_OS_get_hostname_max_length() 255
 175 #endif
 176
 177
 178 /**
 179  * Get process structure for current process
 180  *
 181  * The pointer it returns points to static memory location and must not be
 182  * deallocated/closed
 183  *
 184  * @return pointer to the process sturcutre for this process
 185  */
 186 struct GNUNET_OS_Process *GNUNET_OS_process_current (void);
 187
 188
 189 /**
 190  * Sends sig to the process
 191  *
 192  * @param proc pointer to process structure
 193  * @param sig signal
 194  * @return 0 on success, -1 on error
 195  */
 196 int GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
 197
 198
 199 /**
 200  * Cleans up process structure contents (OS-dependent) and deallocates it
 201  *
 202  * @param proc pointer to process structure
 203  */
 204 void GNUNET_OS_process_close (struct GNUNET_OS_Process *proc);
 205
 206 /**
 207  * Get the pid of the process in question
 208  *
 209  * @param proc the process to get the pid of
 210  *
 211  * @return the current process id
 212  */
 213 pid_t GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc);
 214
 215 /**
 216  * Set process priority
 217  *
 218  * @param proc pointer to process structure
 219  * @param prio priority value
 220  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 221  */
 222 int GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc,
 223                                     enum GNUNET_SCHEDULER_Priority prio);
 224
 225
 226 /**
 227  * Start a process.
 228  *
 229  * @param pipe_stdin pipe to use to send input to child process (or NULL)
 230  * @param pipe_stdout pipe to use to get output from child process (or NULL)
 231  * @param filename name of the binary
 232  * @param ... NULL-terminated list of arguments to the process
 233  * @return pointer to process structure of the new process, NULL on error
 234  */
 235 struct GNUNET_OS_Process *GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle
 236                                                    *pipe_stdin,
 237                                                    struct GNUNET_DISK_PipeHandle
 238                                                    *pipe_stdout,
 239                                                    const char *filename, ...);
 240
 241
 242 /**
 243  * Start a process.
 244  *
 245  * @param pipe_stdin pipe to use to send input to child process (or NULL)
 246  * @param pipe_stdout pipe to use to get output from child process (or NULL)
 247  * @param filename name of the binary
 248  * @param va NULL-terminated list of arguments to the process
 249  * @return pointer to process structure of the new process, NULL on error
 250  */
 251 struct GNUNET_OS_Process *GNUNET_OS_start_process_va (struct
 252                                                       GNUNET_DISK_PipeHandle
 253                                                       *pipe_stdin,
 254                                                       struct
 255                                                       GNUNET_DISK_PipeHandle
 256                                                       *pipe_stdout,
 257                                                       const char *filename,
 258                                                       va_list va);
 259
 260 /**
 261  * Start a process.
 262  *
 263  * @param lsocks array of listen sockets to dup systemd-style (or NULL);
 264  *         must be NULL on platforms where dup is not supported
 265  * @param filename name of the binary
 266  * @param argv NULL-terminated list of arguments to the process,
 267  *             including the process name as the first argument
 268  * @return pointer to process structure of the new process, NULL on error
 269  */
 270 struct GNUNET_OS_Process *GNUNET_OS_start_process_v (const int *lsocks,
 271                                                      const char *filename,
 272                                                      char *const argv[]);
 273
 274
 275 /**
 276  * Handle to a command action.
 277  */
 278 struct GNUNET_OS_CommandHandle;
 279
 280 /**
 281  * Type of a function to process a line of output.
 282  *
 283  * @param cls closure
 284  * @param line line of output from a command, NULL for the end
 285  */
 286 typedef void (*GNUNET_OS_LineProcessor) (void *cls, const char *line);
 287
 288 /**
 289  * Stop/kill a command.
 290  *
 291  * @param cmd handle to the process
 292  */
 293 void GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd);
 294
 295
 296 /**
 297  * Run the given command line and call the given function
 298  * for each line of the output.
 299  *
 300  * @param proc function to call for each line of the output
 301  * @param proc_cls closure for proc
 302  * @param timeout when to time out
 303  * @param binary command to run
 304  * @param ... arguments to command
 305  * @return NULL on error
 306  */
 307 struct GNUNET_OS_CommandHandle *GNUNET_OS_command_run (GNUNET_OS_LineProcessor
 308                                                        proc, void *proc_cls,
 309                                                        struct
 310                                                        GNUNET_TIME_Relative
 311                                                        timeout,
 312                                                        const char *binary, ...);
 313
 314
 315 /**
 316  * Retrieve the status of a process.  Nonblocking version.
 317  *
 318  * @param proc pointer to process structure
 319  * @param type status type
 320  * @param code return code/signal number
 321  * @return GNUNET_OK on success, GNUNET_NO if the process is still running, GNUNET_SYSERR otherwise
 322  */
 323 int GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
 324                               enum GNUNET_OS_ProcessStatusType *type,
 325                               unsigned long *code);
 326
 327
 328 /**
 329  * Wait for a process to terminate.  The return code is discarded.
 330  * You must not use 'GNUNET_OS_process_status' on the same process
 331  * after calling this function!  This function is blocking and should
 332  * thus only be used if the child process is known to have terminated
 333  * or to terminate very soon.
 334  *
 335  * @param proc pointer to process structure of the process to wait for
 336  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 337  */
 338 int GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
 339
 340
 341 /**
 342  * Connects this process to its parent via pipe
 343  */
 344 void GNUNET_OS_install_parent_control_handler (void *cls,
 345                                                const struct
 346                                                GNUNET_SCHEDULER_TaskContext
 347                                                *tc);
 348
 349
 350 /**
 351  * Check whether an executable exists and possibly
 352  * if the suid bit is set on the file.
 353  * Attempts to find the file using the current
 354  * PATH environment variable as a search path.
 355  *
 356  * @param binary the name of the file to check
 357  * @return GNUNET_YES if the file is SUID,
 358  *         GNUNET_NO if not SUID (but binary exists)
 359  *         GNUNET_SYSERR on error (no such binary or not executable)
 360  */
 361 int GNUNET_OS_check_helper_binary (const char *binary);
 362
 363
 364 #if 0                           /* keep Emacsens' auto-indent happy */
 365 {
 366 #endif
 367 #ifdef __cplusplus
 368 }
 369 #endif
 370
 371
 372 /* ifndef GNUNET_OS_LIB_H */
 373 #endif
 374 /* end of gnunet_os_lib.h */