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    * Name of an environment variable that can be used to override
 245    * the location from which default configuration files are loaded
 246    * from, for example "GNUNET_BASE_CONFIG".
 247    */
 248   const char *base_config_varname;
 249
 250   /**
 251    * E-mail address for reporting bugs.
 252    */
 253   const char *bug_email;
 254
 255   /**
 256    * Project homepage.
 257    */
 258   const char *homepage;
 259
 260   /**
 261    * Configuration file name (in $XDG_CONFIG_HOME) to use.
 262    */
 263   const char *config_file;
 264
 265   /**
 266    * Configuration file name to use (if $XDG_CONFIG_HOME is not set).
 267    */
 268   const char *user_config_file;
 269
 270 };
 271
 272
 273 /**
 274  * Return default project data used by 'libgnunetutil' for GNUnet.
 275  */
 276 const struct GNUNET_OS_ProjectData *
 277 GNUNET_OS_project_data_default (void);
 278
 279
 280 /**
 281  * @return current (actual) project data.
 282  */
 283 const struct GNUNET_OS_ProjectData *
 284 GNUNET_OS_project_data_get (void);
 285
 286
 287 /**
 288  * Setup OS subsystem with project data.
 289  *
 290  * @param pd project data used to determine paths.
 291  */
 292 void
 293 GNUNET_OS_init (const struct GNUNET_OS_ProjectData *pd);
 294
 295
 296 /**
 297  * Get the path to a specific GNUnet installation directory or, with
 298  * #GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
 299  * directory.
 300  *
 301  * @param dirkind what kind of directory is desired?
 302  * @return a pointer to the dir path (to be freed by the caller)
 303  */
 304 char *
 305 GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind);
 306
 307
 308 /**
 309  * Given the name of a gnunet-helper, gnunet-service or gnunet-daemon
 310  * binary, try to prefix it with the libexec/-directory to get the
 311  * full path.
 312  *
 313  * @param progname name of the binary
 314  * @return full path to the binary, if possible, otherwise copy of 'progname'
 315  */
 316 char *
 317 GNUNET_OS_get_libexec_binary_path (const char *progname);
 318
 319
 320 /**
 321  * Callback function invoked for each interface found.
 322  *
 323  * @param cls closure
 324  * @param name name of the interface (can be NULL for unknown)
 325  * @param isDefault is this presumably the default interface
 326  * @param addr address of this interface (can be NULL for unknown or unassigned)
 327  * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
 328  * @param netmask the network mask (can be NULL for unknown or unassigned)
 329  * @param addrlen length of the address
 330  * @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
 331  */
 332 typedef int
 333 (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls,
 334                                         const char *name,
 335                                         int isDefault,
 336                                         const struct sockaddr *addr,
 337                                         const struct sockaddr *broadcast_addr,
 338                                         const struct sockaddr *netmask,
 339                                         socklen_t addrlen);
 340
 341
 342 /**
 343  * @brief Enumerate all network interfaces
 344  *
 345  * @param proc the callback function
 346  * @param proc_cls closure for @a proc
 347  */
 348 void
 349 GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc,
 350                                    void *proc_cls);
 351
 352 /**
 353  * @brief Get maximum string length returned by gethostname()
 354  */
 355 #if HAVE_SYSCONF && defined(_SC_HOST_NAME_MAX)
 356 #define GNUNET_OS_get_hostname_max_length() ({ int __sc_tmp = sysconf(_SC_HOST_NAME_MAX); __sc_tmp <= 0 ? 255 : __sc_tmp; })
 357 #elif defined(HOST_NAME_MAX)
 358 #define GNUNET_OS_get_hostname_max_length() HOST_NAME_MAX
 359 #else
 360 #define GNUNET_OS_get_hostname_max_length() 255
 361 #endif
 362
 363
 364 /**
 365  * Get process structure for current process
 366  *
 367  * The pointer it returns points to static memory location and must not be
 368  * deallocated/closed
 369  *
 370  * @return pointer to the process sturcutre for this process
 371  */
 372 struct GNUNET_OS_Process *
 373 GNUNET_OS_process_current (void);
 374
 375
 376 /**
 377  * Sends a signal to the process
 378  *
 379  * @param proc pointer to process structure
 380  * @param sig signal
 381  * @return 0 on success, -1 on error
 382  */
 383 int
 384 GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
 385
 386
 387 /**
 388  * Cleans up process structure contents (OS-dependent) and deallocates it
 389  *
 390  * @param proc pointer to process structure
 391  */
 392 void
 393 GNUNET_OS_process_destroy (struct GNUNET_OS_Process *proc);
 394
 395
 396 /**
 397  * Get the pid of the process in question
 398  *
 399  * @param proc the process to get the pid of
 400  *
 401  * @return the current process id
 402  */
 403 pid_t
 404 GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc);
 405
 406
 407 /**
 408  * Start a process.
 409  *
 410  * @param pipe_control should a pipe be used to send signals to the child?
 411  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
 412  * @param pipe_stdin pipe to use to send input to child process (or NULL)
 413  * @param pipe_stdout pipe to use to get output from child process (or NULL)
 414  * @param pipe_stderr pipe to use to get error output from child process (or NULL)
 415  * @param filename name of the binary
 416  * @param argv NULL-terminated array of arguments to the process
 417  * @return pointer to process structure of the new process, NULL on error
 418  */
 419 struct GNUNET_OS_Process *
 420 GNUNET_OS_start_process_vap (int pipe_control,
 421                              enum GNUNET_OS_InheritStdioFlags std_inheritance,
 422                              struct GNUNET_DISK_PipeHandle *pipe_stdin,
 423                              struct GNUNET_DISK_PipeHandle *pipe_stdout,
 424                              struct GNUNET_DISK_PipeHandle *pipe_stderr,
 425                              const char *filename,
 426                              char *const argv[]);
 427
 428
 429 /**
 430  * Start a process.
 431  *
 432  * @param pipe_control should a pipe be used to send signals to the child?
 433  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
 434  * @param pipe_stdin pipe to use to send input to child process (or NULL)
 435  * @param pipe_stdout pipe to use to get output from child process (or NULL)
 436  * @param pipe_stderr pipe to use to get error output from child process (or NULL)
 437  * @param filename name of the binary
 438  * @param ... NULL-terminated list of arguments to the process
 439  * @return pointer to process structure of the new process, NULL on error
 440  */
 441 struct GNUNET_OS_Process *
 442 GNUNET_OS_start_process (int pipe_control,
 443                          enum GNUNET_OS_InheritStdioFlags std_inheritance,
 444                          struct GNUNET_DISK_PipeHandle *pipe_stdin,
 445                          struct GNUNET_DISK_PipeHandle *pipe_stdout,
 446                          struct GNUNET_DISK_PipeHandle *pipe_stderr,
 447                          const char *filename, ...);
 448
 449
 450 /**
 451  * Start a process.
 452  *
 453  * @param pipe_control should a pipe be used to send signals to the child?
 454  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
 455  * @param pipe_stdin pipe to use to send input to child process (or NULL)
 456  * @param pipe_stdout pipe to use to get output from child process (or NULL)
 457  * @param pipe_stderr pipe to use to get error output from child process (or NULL)
 458  * @param filename name of the binary
 459  * @param va NULL-terminated list of arguments to the process
 460  * @return pointer to process structure of the new process, NULL on error
 461  */
 462 struct GNUNET_OS_Process *
 463 GNUNET_OS_start_process_va (int pipe_control,
 464                             enum GNUNET_OS_InheritStdioFlags std_inheritance,
 465                             struct GNUNET_DISK_PipeHandle *pipe_stdin,
 466                             struct GNUNET_DISK_PipeHandle *pipe_stdout,
 467                             struct GNUNET_DISK_PipeHandle *pipe_stderr,
 468                             const char *filename, va_list va);
 469
 470 /**
 471  * Start a process.
 472  *
 473  * @param pipe_control should a pipe be used to send signals to the child?
 474  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
 475  * @param lsocks array of listen sockets to dup systemd-style (or NULL);
 476  *         must be NULL on platforms where dup is not supported
 477  * @param filename name of the binary
 478  * @param argv NULL-terminated list of arguments to the process,
 479  *             including the process name as the first argument
 480  * @return pointer to process structure of the new process, NULL on error
 481  */
 482 struct GNUNET_OS_Process *
 483 GNUNET_OS_start_process_v (int pipe_control,
 484                            enum GNUNET_OS_InheritStdioFlags std_inheritance,
 485                            const SOCKTYPE *lsocks,
 486                            const char *filename,
 487                            char *const argv[]);
 488
 489
 490 /**
 491  * Start a process.  This function is similar to the GNUNET_OS_start_process_*
 492  * except that the filename and arguments can have whole strings which contain
 493  * the arguments.  These arguments are to be separated by spaces and are parsed
 494  * in the order they appear.  Arguments containing spaces can be used by
 495  * quoting them with @em ".
 496  *
 497  * @param pipe_control should a pipe be used to send signals to the child?
 498  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
 499  * @param lsocks array of listen sockets to dup systemd-style (or NULL);
 500  *         must be NULL on platforms where dup is not supported
 501  * @param filename name of the binary.  It is valid to have the arguments
 502  *         in this string when they are separated by spaces.
 503  * @param ... more arguments.  Should be of type `char *`.  It is valid
 504  *         to have the arguments in these strings when they are separated by
 505  *         spaces.  The last argument MUST be NULL.
 506  * @return pointer to process structure of the new process, NULL on error
 507  */
 508 struct GNUNET_OS_Process *
 509 GNUNET_OS_start_process_s (int pipe_control,
 510                            unsigned int std_inheritance,
 511                            const SOCKTYPE * lsocks,
 512                            const char *filename, ...);
 513
 514
 515 /**
 516  * Handle to a command action.
 517  */
 518 struct GNUNET_OS_CommandHandle;
 519
 520
 521 /**
 522  * Type of a function to process a line of output.
 523  *
 524  * @param cls closure
 525  * @param line line of output from a command, NULL for the end
 526  */
 527 typedef void
 528 (*GNUNET_OS_LineProcessor) (void *cls, const char *line);
 529
 530
 531 /**
 532  * Stop/kill a command.
 533  *
 534  * @param cmd handle to the process
 535  */
 536 void
 537 GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd);
 538
 539
 540 /**
 541  * Run the given command line and call the given function
 542  * for each line of the output.
 543  *
 544  * @param proc function to call for each line of the output
 545  * @param proc_cls closure for proc
 546  * @param timeout when to time out
 547  * @param binary command to run
 548  * @param ... arguments to command
 549  * @return NULL on error
 550  */
 551 struct GNUNET_OS_CommandHandle *
 552 GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc,
 553                        void *proc_cls,
 554                        struct GNUNET_TIME_Relative timeout,
 555                        const char *binary,
 556                        ...);
 557
 558
 559 /**
 560  * Retrieve the status of a process, waiting on him if dead.
 561  * Nonblocking version.
 562  *
 563  * @param proc pointer to process structure
 564  * @param type status type
 565  * @param code return code/signal number
 566  * @return #GNUNET_OK on success, #GNUNET_NO if the process is still running, #GNUNET_SYSERR otherwise
 567  */
 568 int
 569 GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
 570                           enum GNUNET_OS_ProcessStatusType *type,
 571                           unsigned long *code);
 572
 573
 574 /**
 575  * Wait for a process to terminate.  The return code is discarded.
 576  * You must not use #GNUNET_OS_process_status() on the same process
 577  * after calling this function!  This function is blocking and should
 578  * thus only be used if the child process is known to have terminated
 579  * or to terminate very soon.
 580  *
 581  * @param proc pointer to process structure of the process to wait for
 582  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
 583  */
 584 int
 585 GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
 586
 587
 588
 589 /**
 590  * Retrieve the status of a process, waiting on him if dead.
 591  * Blocking version.
 592  *
 593  * @param proc pointer to process structure
 594  * @param type status type
 595  * @param code return code/signal number
 596  * @return #GNUNET_OK on success, #GNUNET_NO if the process is still running, #GNUNET_SYSERR otherwise
 597  */
 598 int
 599 GNUNET_OS_process_wait_status (struct GNUNET_OS_Process *proc,
 600                                enum GNUNET_OS_ProcessStatusType *type,
 601                                unsigned long *code);
 602
 603
 604 /**
 605  * Connects this process to its parent via pipe;
 606  * essentially, the parent control handler will read signal numbers
 607  * from the #GNUNET_OS_CONTROL_PIPE (as given in an environment
 608  * variable) and raise those signals.
 609  *
 610  * @param cls closure (unused)
 611  */
 612 void
 613 GNUNET_OS_install_parent_control_handler (void *cls);
 614
 615
 616 /**
 617  * Check whether an executable exists and possibly
 618  * if the suid bit is set on the file.
 619  * Attempts to find the file using the current
 620  * PATH environment variable as a search path.
 621  *
 622  * @param binary the name of the file to check.
 623  *        W32: must not have an .exe suffix.
 624  * @param check_suid input true if the binary should be checked for SUID (*nix)
 625  *        W32: checks if the program has sufficient privileges by executing this
 626  *             binary with the -d flag. -d omits a programs main loop and only
 627  *             executes all privileged operations in an binary.
 628  * @param params parameters used for w32 privilege checking (can be NULL for != w32, or when not checking for suid/permissions )
 629  * @return #GNUNET_YES if the file is SUID (*nix) or can be executed with current privileges (W32),
 630  *         #GNUNET_NO if not SUID (but binary exists),
 631  *         #GNUNET_SYSERR on error (no such binary or not executable)
 632  */
 633 int
 634 GNUNET_OS_check_helper_binary (const char *binary,
 635                                int check_suid,
 636                                const char *params);
 637
 638
 639 #if 0                           /* keep Emacsens' auto-indent happy */
 640 {
 641 #endif
 642 #ifdef __cplusplus
 643 }
 644 #endif
 645
 646 /* ifndef GNUNET_OS_LIB_H */
 647 #endif
 648
 649 /** @} */  /* end of group */
 650
 651 /* end of gnunet_os_lib.h */