2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2011 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"
48 * Process information (OS-dependent)
50 struct GNUNET_OS_Process;
54 * Possible installation paths to request
56 enum GNUNET_OS_InstallationPathKind
59 * Return the "PREFIX" directory given to configure.
64 * Return the directory where the program binaries are installed. (bin/)
69 * Return the directory where libraries are installed. (lib/gnunet/)
74 * Return the directory where data is installed (share/gnunet/)
76 GNUNET_OS_IPK_DATADIR,
79 * Return the directory where translations are installed (share/locale/)
81 GNUNET_OS_IPK_LOCALEDIR,
84 * Return the installation directory of this application, not
85 * the one of the overall GNUnet installation (in case they
88 GNUNET_OS_IPK_SELF_PREFIX,
91 * Return the prefix of the path with application icons (share/icons/).
93 GNUNET_OS_IPK_ICONDIR,
96 * Return the prefix of the path with documentation files, including the
97 * license (share/doc/gnunet/).
104 * Process status types
106 enum GNUNET_OS_ProcessStatusType
109 * The process is not known to the OS (or at
110 * least not one of our children).
112 GNUNET_OS_PROCESS_UNKNOWN,
115 * The process is still running.
117 GNUNET_OS_PROCESS_RUNNING,
120 * The process is paused (but could be resumed).
122 GNUNET_OS_PROCESS_STOPPED,
125 * The process exited with a return code.
127 GNUNET_OS_PROCESS_EXITED,
130 * The process was killed by a signal.
132 GNUNET_OS_PROCESS_SIGNALED
137 * Get the path to a specific GNUnet installation directory or, with
138 * GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
141 * @param dirkind what kind of directory is desired?
142 * @return a pointer to the dir path (to be freed by the caller)
145 GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind);
149 * Callback function invoked for each interface found.
152 * @param name name of the interface (can be NULL for unknown)
153 * @param isDefault is this presumably the default interface
154 * @param addr address of this interface (can be NULL for unknown or unassigned)
155 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
156 * @param netmask the network mask (can be NULL for unknown or unassigned))
157 * @param addrlen length of the address
158 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
160 typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls, const char *name,
162 const struct sockaddr *
164 const struct sockaddr *
166 const struct sockaddr *
167 netmask, socklen_t addrlen);
171 * @brief Enumerate all network interfaces
172 * @param proc the callback function
173 * @param proc_cls closure for proc
176 GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc,
180 * @brief Get maximum string length returned by gethostname()
182 #if HAVE_SYSCONF && defined(_SC_HOST_NAME_MAX)
183 #define GNUNET_OS_get_hostname_max_length() ({ int __sc_tmp = sysconf(_SC_HOST_NAME_MAX); __sc_tmp <= 0 ? 255 : __sc_tmp; })
184 #elif defined(HOST_NAME_MAX)
185 #define GNUNET_OS_get_hostname_max_length() HOST_NAME_MAX
187 #define GNUNET_OS_get_hostname_max_length() 255
192 * Get process structure for current process
194 * The pointer it returns points to static memory location and must not be
197 * @return pointer to the process sturcutre for this process
199 struct GNUNET_OS_Process *
200 GNUNET_OS_process_current (void);
204 * Sends sig to the process
206 * @param proc pointer to process structure
208 * @return 0 on success, -1 on error
211 GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
215 * Cleans up process structure contents (OS-dependent) and deallocates it
217 * @param proc pointer to process structure
220 GNUNET_OS_process_close (struct GNUNET_OS_Process *proc);
223 * Get the pid of the process in question
225 * @param proc the process to get the pid of
227 * @return the current process id
230 GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc);
233 * Set process priority
235 * @param proc pointer to process structure
236 * @param prio priority value
237 * @return GNUNET_OK on success, GNUNET_SYSERR on error
240 GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc,
241 enum GNUNET_SCHEDULER_Priority prio);
248 * @param pipe_stdin pipe to use to send input to child process (or NULL)
249 * @param pipe_stdout pipe to use to get output from child process (or NULL)
250 * @param filename name of the binary
251 * @param argv NULL-terminated array of arguments to the process
252 * @return pointer to process structure of the new process, NULL on error
254 struct GNUNET_OS_Process *
255 GNUNET_OS_start_process_vap (struct GNUNET_DISK_PipeHandle *pipe_stdin,
256 struct GNUNET_DISK_PipeHandle *pipe_stdout,
257 const char *filename,
264 * @param pipe_stdin pipe to use to send input to child process (or NULL)
265 * @param pipe_stdout pipe to use to get output from child process (or NULL)
266 * @param filename name of the binary
267 * @param ... NULL-terminated list of arguments to the process
268 * @return pointer to process structure of the new process, NULL on error
270 struct GNUNET_OS_Process *
271 GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin,
272 struct GNUNET_DISK_PipeHandle *pipe_stdout,
273 const char *filename, ...);
279 * @param pipe_stdin pipe to use to send input to child process (or NULL)
280 * @param pipe_stdout pipe to use to get output from child process (or NULL)
281 * @param filename name of the binary
282 * @param va NULL-terminated list of arguments to the process
283 * @return pointer to process structure of the new process, NULL on error
285 struct GNUNET_OS_Process *
286 GNUNET_OS_start_process_va (struct GNUNET_DISK_PipeHandle *pipe_stdin,
287 struct GNUNET_DISK_PipeHandle *pipe_stdout,
288 const char *filename, va_list va);
293 * @param lsocks array of listen sockets to dup systemd-style (or NULL);
294 * must be NULL on platforms where dup is not supported
295 * @param filename name of the binary
296 * @param argv NULL-terminated list of arguments to the process,
297 * including the process name as the first argument
298 * @return pointer to process structure of the new process, NULL on error
300 struct GNUNET_OS_Process *
301 GNUNET_OS_start_process_v (const SOCKTYPE *lsocks, const char *filename,
306 * Handle to a command action.
308 struct GNUNET_OS_CommandHandle;
311 * Type of a function to process a line of output.
314 * @param line line of output from a command, NULL for the end
316 typedef void (*GNUNET_OS_LineProcessor) (void *cls, const char *line);
319 * Stop/kill a command.
321 * @param cmd handle to the process
324 GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd);
328 * Run the given command line and call the given function
329 * for each line of the output.
331 * @param proc function to call for each line of the output
332 * @param proc_cls closure for proc
333 * @param timeout when to time out
334 * @param binary command to run
335 * @param ... arguments to command
336 * @return NULL on error
338 struct GNUNET_OS_CommandHandle *
339 GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc, void *proc_cls,
340 struct GNUNET_TIME_Relative timeout, const char *binary,
345 * Retrieve the status of a process. Nonblocking version.
347 * @param proc pointer to process structure
348 * @param type status type
349 * @param code return code/signal number
350 * @return GNUNET_OK on success, GNUNET_NO if the process is still running, GNUNET_SYSERR otherwise
353 GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
354 enum GNUNET_OS_ProcessStatusType *type,
355 unsigned long *code);
359 * Wait for a process to terminate. The return code is discarded.
360 * You must not use 'GNUNET_OS_process_status' on the same process
361 * after calling this function! This function is blocking and should
362 * thus only be used if the child process is known to have terminated
363 * or to terminate very soon.
365 * @param proc pointer to process structure of the process to wait for
366 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
369 GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
373 * Connects this process to its parent via pipe
376 GNUNET_OS_install_parent_control_handler (void *cls,
378 GNUNET_SCHEDULER_TaskContext *tc);
382 * Check whether an executable exists and possibly
383 * if the suid bit is set on the file.
384 * Attempts to find the file using the current
385 * PATH environment variable as a search path.
387 * @param binary the name of the file to check
388 * @return GNUNET_YES if the file is SUID,
389 * GNUNET_NO if not SUID (but binary exists)
390 * GNUNET_SYSERR on error (no such binary or not executable)
393 GNUNET_OS_check_helper_binary (const char *binary);
396 #if 0 /* keep Emacsens' auto-indent happy */
404 /* ifndef GNUNET_OS_LIB_H */
406 /* end of gnunet_os_lib.h */