2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006 Christian Grothoff (and other contributing authors)
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.
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.
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.
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
32 #ifndef GNUNET_OS_LIB_H
33 #define GNUNET_OS_LIB_H
38 #if 0 /* keep Emacsens' auto-indent happy */
43 #include "gnunet_common.h"
44 #include "gnunet_configuration_lib.h"
45 #include "gnunet_scheduler_lib.h"
49 * Possible installation paths to request
51 enum GNUNET_OS_InstallationPathKind
56 GNUNET_OS_IPK_DATADIR,
57 GNUNET_OS_IPK_LOCALEDIR,
58 GNUNET_OS_IPK_SELF_PREFIX
63 * Process status types
65 enum GNUNET_OS_ProcessStatusType
67 GNUNET_OS_PROCESS_UNKNOWN,
68 GNUNET_OS_PROCESS_RUNNING,
69 GNUNET_OS_PROCESS_STOPPED,
70 GNUNET_OS_PROCESS_EXITED,
71 GNUNET_OS_PROCESS_SIGNALED
76 * Get the path to a specific GNUnet installation directory or, with
77 * GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
80 * @param dirkind what kind of directory is desired?
81 * @return a pointer to the dir path (to be freed by the caller)
83 char *GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind
88 * Callback function invoked for each interface found.
91 * @param name name of the interface (can be NULL for unknown)
92 * @param isDefault is this presumably the default interface
93 * @param addr address of this interface (can be NULL for unknown or unassigned)
94 * @param addrlen length of the address
95 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
97 typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls,
100 const struct sockaddr *
101 addr, socklen_t addrlen);
105 * @brief Enumerate all network interfaces
106 * @param callback the callback function
108 void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor
112 * Get the current CPU load.
114 * @param cfg to determine acceptable load level (LOAD::MAXCPULOAD)
115 * @return -1 on error, otherwise load value (between 0 and 100,
116 * (100 is equivalent to full load for one CPU)
118 int GNUNET_OS_load_cpu_get (struct GNUNET_CONFIGURATION_Handle *cfg);
121 * Get the current IO load.
123 * @param cfg to determine acceptable load level (LOAD::MAXIOLOAD)
124 * @return -1 on error, otherwise load value (between 0 and 100,
125 * 100 means that we spend all of our cycles waiting for
128 int GNUNET_OS_load_disk_get (struct GNUNET_CONFIGURATION_Handle *cfg);
132 * Set process priority
134 * @param proc id of the process
135 * @param prio priority value
136 * @return GNUNET_OK on success, GNUNET_SYSERR on error
138 int GNUNET_OS_set_process_priority (pid_t proc,
139 enum GNUNET_SCHEDULER_Priority prio);
145 * @param filename name of the binary
146 * @param ... NULL-terminated list of arguments to the process
147 * @return process ID of the new process, -1 on error
149 pid_t GNUNET_OS_start_process (const char *filename, ...);
154 * @param filename name of the binary
155 * @param argv NULL-terminated list of arguments to the process,
156 * including the process name as the first argument
157 * @return process ID of the new process, -1 on error
159 pid_t GNUNET_OS_start_process_v (const char *filename, char *const argv[]);
162 * Retrieve the status of a process
163 * @param proc process ID
164 * @param type status type
165 * @param code return code/signal number
166 * @return GNUNET_OK on success, GNUNET_NO if the process is still running, GNUNET_SYSERR otherwise
168 int GNUNET_OS_process_status (pid_t proc, enum GNUNET_OS_ProcessStatusType *type,
169 unsigned long *code);
173 * @param proc process ID to wait for
174 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
176 int GNUNET_OS_process_wait (pid_t proc);
178 #if 0 /* keep Emacsens' auto-indent happy */
186 /* ifndef GNUNET_OS_LIB_H */
188 /* end of gnunet_os_lib.h */