src/include/gnunet_os_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006 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 /**
  49  * Possible installation paths to request
  50  */
  51 enum GNUNET_OS_InstallationPathKind
  52 {
  53   GNUNET_OS_IPK_PREFIX,
  54   GNUNET_OS_IPK_BINDIR,
  55   GNUNET_OS_IPK_LIBDIR,
  56   GNUNET_OS_IPK_DATADIR,
  57   GNUNET_OS_IPK_LOCALEDIR,
  58   GNUNET_OS_IPK_SELF_PREFIX
  59 };
  60
  61
  62 /**
  63  * Get the path to a specific GNUnet installation directory or, with
  64  * GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
  65  * directory.
  66  *
  67  * @param dirkind what kind of directory is desired?
  68  * @return a pointer to the dir path (to be freed by the caller)
  69  */
  70 char *GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind
  71                                        dirkind);
  72
  73
  74 /**
  75  * Callback function invoked for each interface found.
  76  *
  77  * @param cls closure
  78  * @param name name of the interface (can be NULL for unknown)
  79  * @param isDefault is this presumably the default interface
  80  * @param addr address of this interface (can be NULL for unknown or unassigned)
  81  * @param addrlen length of the address
  82  * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
  83  */
  84 typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls,
  85                                                     const char *name,
  86                                                     int isDefault,
  87                                                     const struct sockaddr *
  88                                                     addr, socklen_t addrlen);
  89
  90
  91 /**
  92  * @brief Enumerate all network interfaces
  93  * @param callback the callback function
  94  */
  95 void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor
  96                                         proc, void *cls);
  97
  98 /**
  99  * Get the current CPU load.
 100  *
 101  * @param cfg to determine acceptable load level (LOAD::MAXCPULOAD)
 102  * @return -1 on error, otherwise load value (between 0 and 100,
 103  *        (100 is equivalent to full load for one CPU)
 104  */
 105 int GNUNET_OS_load_cpu_get (struct GNUNET_CONFIGURATION_Handle *cfg);
 106
 107 /**
 108  * Get the current IO load.
 109  *
 110  * @param cfg to determine acceptable load level (LOAD::MAXIOLOAD)
 111  * @return -1 on error, otherwise load value (between 0 and 100,
 112  *       100 means that we spend all of our cycles waiting for
 113  *       the disk)
 114  */
 115 int GNUNET_OS_load_disk_get (struct GNUNET_CONFIGURATION_Handle *cfg);
 116
 117
 118 /**
 119  * Set process priority
 120  *
 121  * @param proc id of the process
 122  * @param prio priority value
 123  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 124  */
 125 int GNUNET_OS_set_process_priority (pid_t proc,
 126                                     enum GNUNET_SCHEDULER_Priority prio);
 127
 128
 129 /**
 130  * Start a process.
 131  *
 132  * @param filename name of the binary
 133  * @param ... NULL-terminated list of arguments to the process
 134  * @return process ID of the new process, -1 on error
 135  */
 136 pid_t GNUNET_OS_start_process (const char *filename, ...);
 137
 138 /**
 139  * Start a process.
 140  *
 141  * @param filename name of the binary
 142  * @param argv NULL-terminated list of arguments to the process,
 143  *             including the process name as the first argument
 144  * @return process ID of the new process, -1 on error
 145  */
 146 pid_t GNUNET_OS_start_process_v (const char *filename, char *const argv[]);
 147
 148 #if 0                           /* keep Emacsens' auto-indent happy */
 149 {
 150 #endif
 151 #ifdef __cplusplus
 152 }
 153 #endif
 154
 155
 156 /* ifndef GNUNET_OS_LIB_H */
 157 #endif
 158 /* end of gnunet_os_lib.h */