src/include/gnunet_os_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2011 GNUnet e.V.
   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 3, 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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Christian Grothoff
  23  * @author Krista Bennett
  24  * @author Gerd Knorr <kraxel@bytesex.org>
  25  * @author Ioana Patrascu
  26  * @author Tzvetan Horozov
  27  * @author Milan
  28  *
  29  * @file
  30  * Low level process routines
  31  *
  32  * @defgroup os  OS library
  33  * Low level process routines.
  34  *
  35  * This code manages child processes.  We can communicate with child
  36  * processes using signals.  Because signals are not supported on W32
  37  * and Java (at least not nicely), we can alternatively use a pipe
  38  * to send signals to the child processes (if the child process is
  39  * a full-blown GNUnet process that supports reading signals from
  40  * a pipe, of course).  Naturally, this also only works for 'normal'
  41  * termination via signals, and not as a replacement for SIGKILL.
  42  * Thus using pipes to communicate signals should only be enabled if
  43  * the child is a Java process OR if we are on Windoze.
  44  *
  45  * @{
  46  */
  47
  48 #ifndef GNUNET_OS_LIB_H
  49 #define GNUNET_OS_LIB_H
  50
  51 #ifdef __cplusplus
  52 extern "C"
  53 {
  54 #if 0                           /* keep Emacsens' auto-indent happy */
  55 }
  56 #endif
  57 #endif
  58
  59 #include "gnunet_common.h"
  60 #include "gnunet_configuration_lib.h"
  61 #include "gnunet_scheduler_lib.h"
  62
  63
  64 /**
  65  * Flags that determine which of the standard streams
  66  * should be inherited by the child process.
  67  */
  68 enum GNUNET_OS_InheritStdioFlags
  69 {
  70
  71   /**
  72    * No standard streams should be inherited.
  73    */
  74   GNUNET_OS_INHERIT_STD_NONE = 0,
  75
  76   /**
  77    * When this flag is set, the child process will
  78    * inherit stdin of the parent.
  79    */
  80   GNUNET_OS_INHERIT_STD_IN = 1,
  81
  82   /**
  83    * When this flag is set, the child process will
  84    * inherit stdout of the parent.
  85    */
  86   GNUNET_OS_INHERIT_STD_OUT = 2,
  87
  88   /**
  89    * When this flag is set, the child process will
  90    * inherit stderr of the parent.
  91    */
  92   GNUNET_OS_INHERIT_STD_ERR = 4,
  93
  94   /**
  95    * When these flags are set, the child process will
  96    * inherit stdout and stderr of the parent.
  97    */
  98   GNUNET_OS_INHERIT_STD_OUT_AND_ERR = 6,
  99
 100   /**
 101    * Use this option to have all of the standard streams
 102    * (stdin, stdout and stderror) be inherited.
 103    */
 104   GNUNET_OS_INHERIT_STD_ALL = 7
 105 };
 106
 107
 108 /**
 109  * Process information (OS-dependent)
 110  */
 111 struct GNUNET_OS_Process;
 112
 113
 114 /**
 115  * Possible installation paths to request
 116  */
 117 enum GNUNET_OS_InstallationPathKind
 118 {
 119   /**
 120    * Return the "PREFIX" directory given to configure.
 121    */
 122   GNUNET_OS_IPK_PREFIX,
 123
 124   /**
 125    * Return the directory where the program binaries are installed. (bin/)
 126    */
 127   GNUNET_OS_IPK_BINDIR,
 128
 129   /**
 130    * Return the directory where libraries are installed. (lib/gnunet/)
 131    */
 132   GNUNET_OS_IPK_LIBDIR,
 133
 134   /**
 135    * Return the directory where data is installed (share/gnunet/)
 136    */
 137   GNUNET_OS_IPK_DATADIR,
 138
 139   /**
 140    * Return the directory where translations are installed (share/locale/)
 141    */
 142   GNUNET_OS_IPK_LOCALEDIR,
 143
 144   /**
 145    * Return the installation directory of this application, not
 146    * the one of the overall GNUnet installation (in case they
 147    * are different).
 148    */
 149   GNUNET_OS_IPK_SELF_PREFIX,
 150
 151   /**
 152    * Return the prefix of the path with application icons (share/icons/).
 153    */
 154   GNUNET_OS_IPK_ICONDIR,
 155
 156   /**
 157    * Return the prefix of the path with documentation files, including the
 158    * license (share/doc/gnunet/).
 159    */
 160   GNUNET_OS_IPK_DOCDIR,
 161
 162   /**
 163    * Return the directory where helper binaries are installed (lib/gnunet/libexec/)
 164    */
 165   GNUNET_OS_IPK_LIBEXECDIR
 166 };
 167
 168
 169 /**
 170  * Process status types
 171  */
 172 enum GNUNET_OS_ProcessStatusType
 173 {
 174   /**
 175    * The process is not known to the OS (or at
 176    * least not one of our children).
 177    */
 178   GNUNET_OS_PROCESS_UNKNOWN,
 179
 180   /**
 181    * The process is still running.
 182    */
 183   GNUNET_OS_PROCESS_RUNNING,
 184
 185   /**
 186    * The process is paused (but could be resumed).
 187    */
 188   GNUNET_OS_PROCESS_STOPPED,
 189
 190   /**
 191    * The process exited with a return code.
 192    */
 193   GNUNET_OS_PROCESS_EXITED,
 194
 195   /**
 196    * The process was killed by a signal.
 197    */
 198   GNUNET_OS_PROCESS_SIGNALED
 199 };
 200
 201
 202 /**
 203  * Project-specific data used to help the OS subsystem
 204  * find installation paths.
 205  */
 206 struct GNUNET_OS_ProjectData
 207 {
 208   /**
 209    * Name of a library that is installed in the "lib/" directory of
 210    * the project, such as "libgnunetutil".  Used to locate the
 211    * installation by scanning dependencies of the current process.
 212    */
 213   const char *libname;
 214
 215   /**
 216    * Name of the project that is used in the "libexec" prefix, For
 217    * example, "gnunet".  Certain helper binaries are then expected to
 218    * be installed in "$PREFIX/libexec/gnunet/" and resources in
 219    * "$PREFIX/share/gnunet/".
 220    */
 221   const char *project_dirname;
 222
 223   /**
 224    * Name of a project-specific binary that should be in "$PREFIX/bin/".
 225    * Used to determine installation path from $PATH variable.
 226    * For example "gnunet-arm".  On W32, ".exe" should be omitted.
 227    */
 228   const char *binary_name;
 229
 230   /**
 231    * Name of an environment variable that can be used to override
 232    * installation path detection, for example "GNUNET_PREFIX".
 233    */
 234   const char *env_varname;
 235
 236   /**
 237    * Alternative name of an environment variable that can be used to
 238    * override installation path detection, if "env_varname" is not
 239    * set. Again, for example, "GNUNET_PREFIX".
 240    */
 241   const char *env_varname_alt;
 242
 243 };
 244
 245
 246 /**
 247  * Return default project data used by 'libgnunetutil' for GNUnet.
 248  */
 249 const struct GNUNET_OS_ProjectData *
 250 GNUNET_OS_project_data_default (void);
 251
 252
 253 /**
 254  * Setup OS subsystem with project data.
 255  *
 256  * @param pd project data used to determine paths.
 257  */
 258 void
 259 GNUNET_OS_init (const struct GNUNET_OS_ProjectData *pd);
 260
 261
 262 /**
 263  * Get the path to a specific GNUnet installation directory or, with
 264  * #GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
 265  * directory.
 266  *
 267  * @param dirkind what kind of directory is desired?
 268  * @return a pointer to the dir path (to be freed by the caller)
 269  */
 270 char *
 271 GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind);
 272
 273
 274 /**
 275  * Given the name of a gnunet-helper, gnunet-service or gnunet-daemon
 276  * binary, try to prefix it with the libexec/-directory to get the
 277  * full path.
 278  *
 279  * @param progname name of the binary
 280  * @return full path to the binary, if possible, otherwise copy of 'progname'
 281  */
 282 char *
 283 GNUNET_OS_get_libexec_binary_path (const char *progname);
 284
 285
 286 /**
 287  * Callback function invoked for each interface found.
 288  *
 289  * @param cls closure
 290  * @param name name of the interface (can be NULL for unknown)
 291  * @param isDefault is this presumably the default interface
 292  * @param addr address of this interface (can be NULL for unknown or unassigned)
 293  * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
 294  * @param netmask the network mask (can be NULL for unknown or unassigned)
 295  * @param addrlen length of the address
 296  * @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
 297  */
 298 typedef int
 299 (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls,
 300                                         const char *name,
 301                                         int isDefault,
 302                                         const struct sockaddr *addr,
 303                                         const struct sockaddr *broadcast_addr,
 304                                         const struct sockaddr *netmask,
 305                                         socklen_t addrlen);
 306
 307
 308 /**
 309  * @brief Enumerate all network interfaces
 310  *
 311  * @param proc the callback function
 312  * @param proc_cls closure for @a proc
 313  */
 314 void
 315 GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc,
 316                                    void *proc_cls);
 317
 318 /**
 319  * @brief Get maximum string length returned by gethostname()
 320  */
 321 #if HAVE_SYSCONF && defined(_SC_HOST_NAME_MAX)
 322 #define GNUNET_OS_get_hostname_max_length() ({ int __sc_tmp = sysconf(_SC_HOST_NAME_MAX); __sc_tmp <= 0 ? 255 : __sc_tmp; })
 323 #elif defined(HOST_NAME_MAX)
 324 #define GNUNET_OS_get_hostname_max_length() HOST_NAME_MAX
 325 #else
 326 #define GNUNET_OS_get_hostname_max_length() 255
 327 #endif
 328
 329
 330 /**
 331  * Get process structure for current process
 332  *
 333  * The pointer it returns points to static memory location and must not be
 334  * deallocated/closed
 335  *
 336  * @return pointer to the process sturcutre for this process
 337  */
 338 struct GNUNET_OS_Process *
 339 GNUNET_OS_process_current (void);
 340
 341
 342 /**
 343  * Sends a signal to the process
 344  *
 345  * @param proc pointer to process structure
 346  * @param sig signal
 347  * @return 0 on success, -1 on error
 348  */
 349 int
 350 GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
 351
 352
 353 /**
 354  * Cleans up process structure contents (OS-dependent) and deallocates it
 355  *
 356  * @param proc pointer to process structure
 357  */
 358 void
 359 GNUNET_OS_process_destroy (struct GNUNET_OS_Process *proc);
 360
 361
 362 /**
 363  * Get the pid of the process in question
 364  *
 365  * @param proc the process to get the pid of
 366  *
 367  * @return the current process id
 368  */
 369 pid_t
 370 GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc);
 371
 372
 373 /**
 374  * Start a process.
 375  *
 376  * @param pipe_control should a pipe be used to send signals to the child?
 377  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
 378  * @param pipe_stdin pipe to use to send input to child process (or NULL)
 379  * @param pipe_stdout pipe to use to get output from child process (or NULL)
 380  * @param pipe_stderr pipe to use to get error output from child process (or NULL)
 381  * @param filename name of the binary
 382  * @param argv NULL-terminated array of arguments to the process
 383  * @return pointer to process structure of the new process, NULL on error
 384  */
 385 struct GNUNET_OS_Process *
 386 GNUNET_OS_start_process_vap (int pipe_control,
 387                              enum GNUNET_OS_InheritStdioFlags std_inheritance,
 388                              struct GNUNET_DISK_PipeHandle *pipe_stdin,
 389                              struct GNUNET_DISK_PipeHandle *pipe_stdout,
 390                              struct GNUNET_DISK_PipeHandle *pipe_stderr,
 391                              const char *filename,
 392                              char *const argv[]);
 393
 394
 395 /**
 396  * Start a process.
 397  *
 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 pipe_stdin pipe to use to send input to child process (or NULL)
 401  * @param pipe_stdout pipe to use to get output from child process (or NULL)
 402  * @param pipe_stderr pipe to use to get error output from child process (or NULL)
 403  * @param filename name of the binary
 404  * @param ... NULL-terminated list of arguments to the process
 405  * @return pointer to process structure of the new process, NULL on error
 406  */
 407 struct GNUNET_OS_Process *
 408 GNUNET_OS_start_process (int pipe_control,
 409                          enum GNUNET_OS_InheritStdioFlags std_inheritance,
 410                          struct GNUNET_DISK_PipeHandle *pipe_stdin,
 411                          struct GNUNET_DISK_PipeHandle *pipe_stdout,
 412                          struct GNUNET_DISK_PipeHandle *pipe_stderr,
 413                          const char *filename, ...);
 414
 415
 416 /**
 417  * Start a process.
 418  *
 419  * @param pipe_control should a pipe be used to send signals to the child?
 420  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
 421  * @param pipe_stdin pipe to use to send input to child process (or NULL)
 422  * @param pipe_stdout pipe to use to get output from child process (or NULL)
 423  * @param pipe_stderr pipe to use to get error output from child process (or NULL)
 424  * @param filename name of the binary
 425  * @param va NULL-terminated list of arguments to the process
 426  * @return pointer to process structure of the new process, NULL on error
 427  */
 428 struct GNUNET_OS_Process *
 429 GNUNET_OS_start_process_va (int pipe_control,
 430                             enum GNUNET_OS_InheritStdioFlags std_inheritance,
 431                             struct GNUNET_DISK_PipeHandle *pipe_stdin,
 432                             struct GNUNET_DISK_PipeHandle *pipe_stdout,
 433                             struct GNUNET_DISK_PipeHandle *pipe_stderr,
 434                             const char *filename, va_list va);
 435
 436 /**
 437  * Start a process.
 438  *
 439  * @param pipe_control should a pipe be used to send signals to the child?
 440  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
 441  * @param lsocks array of listen sockets to dup systemd-style (or NULL);
 442  *         must be NULL on platforms where dup is not supported
 443  * @param filename name of the binary
 444  * @param argv NULL-terminated list of arguments to the process,
 445  *             including the process name as the first argument
 446  * @return pointer to process structure of the new process, NULL on error
 447  */
 448 struct GNUNET_OS_Process *
 449 GNUNET_OS_start_process_v (int pipe_control,
 450                            enum GNUNET_OS_InheritStdioFlags std_inheritance,
 451                            const SOCKTYPE *lsocks,
 452                            const char *filename,
 453                            char *const argv[]);
 454
 455
 456 /**
 457  * Start a process.  This function is similar to the GNUNET_OS_start_process_*
 458  * except that the filename and arguments can have whole strings which contain
 459  * the arguments.  These arguments are to be separated by spaces and are parsed
 460  * in the order they appear.  Arguments containing spaces can be used by
 461  * quoting them with @em ".
 462  *
 463  * @param pipe_control should a pipe be used to send signals to the child?
 464  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
 465  * @param lsocks array of listen sockets to dup systemd-style (or NULL);
 466  *         must be NULL on platforms where dup is not supported
 467  * @param filename name of the binary.  It is valid to have the arguments
 468  *         in this string when they are separated by spaces.
 469  * @param ... more arguments.  Should be of type `char *`.  It is valid
 470  *         to have the arguments in these strings when they are separated by
 471  *         spaces.  The last argument MUST be NULL.
 472  * @return pointer to process structure of the new process, NULL on error
 473  */
 474 struct GNUNET_OS_Process *
 475 GNUNET_OS_start_process_s (int pipe_control,
 476                            unsigned int std_inheritance,
 477                            const SOCKTYPE * lsocks,
 478                            const char *filename, ...);
 479
 480
 481 /**
 482  * Handle to a command action.
 483  */
 484 struct GNUNET_OS_CommandHandle;
 485
 486
 487 /**
 488  * Type of a function to process a line of output.
 489  *
 490  * @param cls closure
 491  * @param line line of output from a command, NULL for the end
 492  */
 493 typedef void (*GNUNET_OS_LineProcessor) (void *cls, const char *line);
 494
 495
 496 /**
 497  * Stop/kill a command.
 498  *
 499  * @param cmd handle to the process
 500  */
 501 void
 502 GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd);
 503
 504
 505 /**
 506  * Run the given command line and call the given function
 507  * for each line of the output.
 508  *
 509  * @param proc function to call for each line of the output
 510  * @param proc_cls closure for proc
 511  * @param timeout when to time out
 512  * @param binary command to run
 513  * @param ... arguments to command
 514  * @return NULL on error
 515  */
 516 struct GNUNET_OS_CommandHandle *
 517 GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc, void *proc_cls,
 518                        struct GNUNET_TIME_Relative timeout, const char *binary,
 519                        ...);
 520
 521
 522 /**
 523  * Retrieve the status of a process, waiting on him if dead.
 524  * Nonblocking version.
 525  *
 526  * @param proc pointer to process structure
 527  * @param type status type
 528  * @param code return code/signal number
 529  * @return #GNUNET_OK on success, #GNUNET_NO if the process is still running, #GNUNET_SYSERR otherwise
 530  */
 531 int
 532 GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
 533                           enum GNUNET_OS_ProcessStatusType *type,
 534                           unsigned long *code);
 535
 536
 537 /**
 538  * Wait for a process to terminate.  The return code is discarded.
 539  * You must not use #GNUNET_OS_process_status() on the same process
 540  * after calling this function!  This function is blocking and should
 541  * thus only be used if the child process is known to have terminated
 542  * or to terminate very soon.
 543  *
 544  * @param proc pointer to process structure of the process to wait for
 545  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
 546  */
 547 int
 548 GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
 549
 550
 551 /**
 552  * Connects this process to its parent via pipe;
 553  * essentially, the parent control handler will read signal numbers
 554  * from the #GNUNET_OS_CONTROL_PIPE (as given in an environment
 555  * variable) and raise those signals.
 556  *
 557  * @param cls closure (unused)
 558  * @param tc scheduler context (unused)
 559  */
 560 void
 561 GNUNET_OS_install_parent_control_handler (void *cls,
 562                                           const struct
 563                                           GNUNET_SCHEDULER_TaskContext *tc);
 564
 565
 566 /**
 567  * Check whether an executable exists and possibly
 568  * if the suid bit is set on the file.
 569  * Attempts to find the file using the current
 570  * PATH environment variable as a search path.
 571  *
 572  * @param binary the name of the file to check.
 573  *        W32: must not have an .exe suffix.
 574  * @param check_suid input true if the binary should be checked for SUID (*nix)
 575  *        W32: checks if the program has sufficient privileges by executing this
 576  *             binary with the -d flag. -d omits a programs main loop and only
 577  *             executes all privileged operations in an binary.
 578  * @param params parameters used for w32 privilege checking (can be NULL for != w32, or when not checking for suid/permissions )
 579  * @return #GNUNET_YES if the file is SUID (*nix) or can be executed with current privileges (W32),
 580  *         #GNUNET_NO if not SUID (but binary exists),
 581  *         #GNUNET_SYSERR on error (no such binary or not executable)
 582  */
 583 int
 584 GNUNET_OS_check_helper_binary (const char *binary,
 585                                int check_suid,
 586                                const char *params);
 587
 588
 589 #if 0                           /* keep Emacsens' auto-indent happy */
 590 {
 591 #endif
 592 #ifdef __cplusplus
 593 }
 594 #endif
 595
 596 /* ifndef GNUNET_OS_LIB_H */
 597 #endif
 598
 599 /** @} */  /* end of group */
 600
 601 /* end of gnunet_os_lib.h */