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/)
74 * Return the directory where data is installed (share/)
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.
98 * Process status types
100 enum GNUNET_OS_ProcessStatusType
103 * The process is not known to the OS (or at
104 * least not one of our children).
106 GNUNET_OS_PROCESS_UNKNOWN,
109 * The process is still running.
111 GNUNET_OS_PROCESS_RUNNING,
114 * The process is paused (but could be resumed).
116 GNUNET_OS_PROCESS_STOPPED,
119 * The process exited with a return code.
121 GNUNET_OS_PROCESS_EXITED,
124 * The process was killed by a signal.
126 GNUNET_OS_PROCESS_SIGNALED
131 * Get the path to a specific GNUnet installation directory or, with
132 * GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
135 * @param dirkind what kind of directory is desired?
136 * @return a pointer to the dir path (to be freed by the caller)
139 GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind);
143 * Callback function invoked for each interface found.
146 * @param name name of the interface (can be NULL for unknown)
147 * @param isDefault is this presumably the default interface
148 * @param addr address of this interface (can be NULL for unknown or unassigned)
149 * @param addrlen length of the address
150 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
152 typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls, const char *name,
154 const struct sockaddr *
155 addr, socklen_t addrlen);
159 * @brief Enumerate all network interfaces
160 * @param proc the callback function
161 * @param proc_cls closure for proc
164 GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc,
168 * @brief Get maximum string length returned by gethostname()
170 #if HAVE_SYSCONF && defined(_SC_HOST_NAME_MAX)
171 #define GNUNET_OS_get_hostname_max_length() ({ int __sc_tmp = sysconf(_SC_HOST_NAME_MAX); __sc_tmp <= 0 ? 255 : __sc_tmp; })
172 #elif defined(HOST_NAME_MAX)
173 #define GNUNET_OS_get_hostname_max_length() HOST_NAME_MAX
175 #define GNUNET_OS_get_hostname_max_length() 255
180 * Get process structure for current process
182 * The pointer it returns points to static memory location and must not be
185 * @return pointer to the process sturcutre for this process
187 struct GNUNET_OS_Process *
188 GNUNET_OS_process_current (void);
192 * Sends sig to the process
194 * @param proc pointer to process structure
196 * @return 0 on success, -1 on error
199 GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
203 * Cleans up process structure contents (OS-dependent) and deallocates it
205 * @param proc pointer to process structure
208 GNUNET_OS_process_close (struct GNUNET_OS_Process *proc);
211 * Get the pid of the process in question
213 * @param proc the process to get the pid of
215 * @return the current process id
218 GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc);
221 * Set process priority
223 * @param proc pointer to process structure
224 * @param prio priority value
225 * @return GNUNET_OK on success, GNUNET_SYSERR on error
228 GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc,
229 enum GNUNET_SCHEDULER_Priority prio);
235 * @param pipe_stdin pipe to use to send input to child process (or NULL)
236 * @param pipe_stdout pipe to use to get output from child process (or NULL)
237 * @param filename name of the binary
238 * @param ... NULL-terminated list of arguments to the process
239 * @return pointer to process structure of the new process, NULL on error
241 struct GNUNET_OS_Process *
242 GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin,
243 struct GNUNET_DISK_PipeHandle *pipe_stdout,
244 const char *filename, ...);
250 * @param pipe_stdin pipe to use to send input to child process (or NULL)
251 * @param pipe_stdout pipe to use to get output from child process (or NULL)
252 * @param filename name of the binary
253 * @param va NULL-terminated list of arguments to the process
254 * @return pointer to process structure of the new process, NULL on error
256 struct GNUNET_OS_Process *
257 GNUNET_OS_start_process_va (struct GNUNET_DISK_PipeHandle *pipe_stdin,
258 struct GNUNET_DISK_PipeHandle *pipe_stdout,
259 const char *filename, va_list va);
264 * @param lsocks array of listen sockets to dup systemd-style (or NULL);
265 * must be NULL on platforms where dup is not supported
266 * @param filename name of the binary
267 * @param argv NULL-terminated list of arguments to the process,
268 * including the process name as the first argument
269 * @return pointer to process structure of the new process, NULL on error
271 struct GNUNET_OS_Process *
272 GNUNET_OS_start_process_v (const int *lsocks, const char *filename,
277 * Handle to a command action.
279 struct GNUNET_OS_CommandHandle;
282 * Type of a function to process a line of output.
285 * @param line line of output from a command, NULL for the end
287 typedef void (*GNUNET_OS_LineProcessor) (void *cls, const char *line);
290 * Stop/kill a command.
292 * @param cmd handle to the process
295 GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd);
299 * Run the given command line and call the given function
300 * for each line of the output.
302 * @param proc function to call for each line of the output
303 * @param proc_cls closure for proc
304 * @param timeout when to time out
305 * @param binary command to run
306 * @param ... arguments to command
307 * @return NULL on error
309 struct GNUNET_OS_CommandHandle *
310 GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc, void *proc_cls,
311 struct GNUNET_TIME_Relative timeout, const char *binary,
316 * Retrieve the status of a process. Nonblocking version.
318 * @param proc pointer to process structure
319 * @param type status type
320 * @param code return code/signal number
321 * @return GNUNET_OK on success, GNUNET_NO if the process is still running, GNUNET_SYSERR otherwise
324 GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
325 enum GNUNET_OS_ProcessStatusType *type,
326 unsigned long *code);
330 * Wait for a process to terminate. The return code is discarded.
331 * You must not use 'GNUNET_OS_process_status' on the same process
332 * after calling this function! This function is blocking and should
333 * thus only be used if the child process is known to have terminated
334 * or to terminate very soon.
336 * @param proc pointer to process structure of the process to wait for
337 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
340 GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
344 * Connects this process to its parent via pipe
347 GNUNET_OS_install_parent_control_handler (void *cls,
349 GNUNET_SCHEDULER_TaskContext *tc);
353 * Check whether an executable exists and possibly
354 * if the suid bit is set on the file.
355 * Attempts to find the file using the current
356 * PATH environment variable as a search path.
358 * @param binary the name of the file to check
359 * @return GNUNET_YES if the file is SUID,
360 * GNUNET_NO if not SUID (but binary exists)
361 * GNUNET_SYSERR on error (no such binary or not executable)
364 GNUNET_OS_check_helper_binary (const char *binary);
367 #if 0 /* keep Emacsens' auto-indent happy */
375 /* ifndef GNUNET_OS_LIB_H */
377 /* end of gnunet_os_lib.h */