GNUnet  0.10.x
gnunet_os_lib.h
Go to the documentation of this file.
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 it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your 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  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19 */
20 
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"
61 #include "gnunet_scheduler_lib.h"
62 
63 
69 {
70 
75 
81 
87 
93 
99 
105 };
106 
107 
111 struct GNUNET_OS_Process;
112 
113 
118 {
123 
128 
133 
138 
143 
150 
155 
161 
166 };
167 
168 
173 {
179 
184 
189 
194 
199 };
200 
201 
207 {
213  const char *libname;
214 
221  const char *project_dirname;
222 
228  const char *binary_name;
229 
234  const char *env_varname;
235 
241  const char *env_varname_alt;
242 
248  const char *base_config_varname;
249 
253  const char *bug_email;
254 
258  const char *homepage;
259 
263  const char *config_file;
264 
268  const char *user_config_file;
269 
270 };
271 
272 
276 const struct GNUNET_OS_ProjectData *
278 
279 
283 const struct GNUNET_OS_ProjectData *
285 
286 
292 void
293 GNUNET_OS_init (const struct GNUNET_OS_ProjectData *pd);
294 
295 
304 char *
306 
307 
316 char *
317 GNUNET_OS_get_libexec_binary_path (const char *progname);
318 
319 
332 char *
334  const char *progname);
335 
336 
349 typedef int
351  const char *name,
352  int isDefault,
353  const struct sockaddr *addr,
354  const struct sockaddr *broadcast_addr,
355  const struct sockaddr *netmask,
356  socklen_t addrlen);
357 
358 
365 void
367  void *proc_cls);
368 
372 #if HAVE_SYSCONF && defined(_SC_HOST_NAME_MAX)
373 #define GNUNET_OS_get_hostname_max_length() ({ int __sc_tmp = sysconf(_SC_HOST_NAME_MAX); __sc_tmp <= 0 ? 255 : __sc_tmp; })
374 #elif defined(HOST_NAME_MAX)
375 #define GNUNET_OS_get_hostname_max_length() HOST_NAME_MAX
376 #else
377 #define GNUNET_OS_get_hostname_max_length() 255
378 #endif
379 
380 
389 struct GNUNET_OS_Process *
391 
392 
400 int
402  int sig);
403 
404 
410 void
412 
413 
421 pid_t
423 
424 
437 struct GNUNET_OS_Process *
438 GNUNET_OS_start_process_vap (int pipe_control,
439  enum GNUNET_OS_InheritStdioFlags std_inheritance,
440  struct GNUNET_DISK_PipeHandle *pipe_stdin,
441  struct GNUNET_DISK_PipeHandle *pipe_stdout,
442  struct GNUNET_DISK_PipeHandle *pipe_stderr,
443  const char *filename,
444  char *const argv[]);
445 
446 
459 struct GNUNET_OS_Process *
460 GNUNET_OS_start_process (int pipe_control,
461  enum GNUNET_OS_InheritStdioFlags std_inheritance,
462  struct GNUNET_DISK_PipeHandle *pipe_stdin,
463  struct GNUNET_DISK_PipeHandle *pipe_stdout,
464  struct GNUNET_DISK_PipeHandle *pipe_stderr,
465  const char *filename, ...);
466 
467 
480 struct GNUNET_OS_Process *
481 GNUNET_OS_start_process_va (int pipe_control,
482  enum GNUNET_OS_InheritStdioFlags std_inheritance,
483  struct GNUNET_DISK_PipeHandle *pipe_stdin,
484  struct GNUNET_DISK_PipeHandle *pipe_stdout,
485  struct GNUNET_DISK_PipeHandle *pipe_stderr,
486  const char *filename, va_list va);
487 
500 struct GNUNET_OS_Process *
501 GNUNET_OS_start_process_v (int pipe_control,
502  enum GNUNET_OS_InheritStdioFlags std_inheritance,
503  const SOCKTYPE *lsocks,
504  const char *filename,
505  char *const argv[]);
506 
507 
526 struct GNUNET_OS_Process *
527 GNUNET_OS_start_process_s (int pipe_control,
528  unsigned int std_inheritance,
529  const SOCKTYPE * lsocks,
530  const char *filename, ...);
531 
532 
537 
538 
545 typedef void
546 (*GNUNET_OS_LineProcessor) (void *cls, const char *line);
547 
548 
554 void
556 
557 
571  void *proc_cls,
573  const char *binary,
574  ...);
575 
576 
586 int
589  unsigned long *code);
590 
591 
602 int
604 
605 
606 
616 int
619  unsigned long *code);
620 
621 
630 void
632 
633 
651 int
652 GNUNET_OS_check_helper_binary (const char *binary,
653  int check_suid,
654  const char *params);
655 
656 
657 #if 0 /* keep Emacsens' auto-indent happy */
658 {
659 #endif
660 #ifdef __cplusplus
661 }
662 #endif
663 
664 /* ifndef GNUNET_OS_LIB_H */
665 #endif
666  /* end of group */
668 
669 /* end of gnunet_os_lib.h */
Return the directory where translations are installed (share/locale/)
GNUNET_OS_InheritStdioFlags
Flags that determine which of the standard streams should be inherited by the child process...
Definition: gnunet_os_lib.h:68
const char * config_file
Configuration file name (in $XDG_CONFIG_HOME) to use.
When this flag is set, the child process will inherit stderr of the parent.
Definition: gnunet_os_lib.h:92
pid_t GNUNET_OS_process_get_pid(struct GNUNET_OS_Process *proc)
Get the pid of the process in question.
Definition: os_priority.c:351
Project-specific data used to help the OS subsystem find installation paths.
#define SOCKTYPE
Definition: platform.h:276
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:364
int GNUNET_OS_process_status(struct GNUNET_OS_Process *proc, enum GNUNET_OS_ProcessStatusType *type, unsigned long *code)
Retrieve the status of a process, waiting on it if dead.
Definition: os_priority.c:1719
Return the directory where libraries are installed.
const char * project_dirname
Name of the project that is used in the "libexec" prefix, For example, "gnunet".
struct GNUNET_OS_Process * GNUNET_OS_start_process(int pipe_control, enum GNUNET_OS_InheritStdioFlags std_inheritance, struct GNUNET_DISK_PipeHandle *pipe_stdin, struct GNUNET_DISK_PipeHandle *pipe_stdout, struct GNUNET_DISK_PipeHandle *pipe_stderr, const char *filename,...)
Start a process.
Definition: os_priority.c:1400
When this flag is set, the child process will inherit stdin of the parent.
Definition: gnunet_os_lib.h:80
struct GNUNET_OS_Process * GNUNET_OS_start_process_s(int pipe_control, unsigned int std_inheritance, const SOCKTYPE *lsocks, const char *filename,...)
Start a process.
Definition: os_priority.c:1474
const char * env_varname_alt
Alternative name of an environment variable that can be used to override installation path detection...
const char * user_config_file
Configuration file name to use (if $XDG_CONFIG_HOME is not set).
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_default(void)
Return default project data used by &#39;libgnunetutil&#39; for GNUnet.
int GNUNET_OS_check_helper_binary(const char *binary, int check_suid, const char *params)
Check whether an executable exists and possibly if the suid bit is set on the file.
void GNUNET_OS_network_interfaces_list(GNUNET_OS_NetworkInterfaceProcessor proc, void *proc_cls)
Enumerate all network interfaces.
Definition: os_network.c:388
struct GNUNET_OS_Process * GNUNET_OS_start_process_va(int pipe_control, enum GNUNET_OS_InheritStdioFlags std_inheritance, struct GNUNET_DISK_PipeHandle *pipe_stdin, struct GNUNET_DISK_PipeHandle *pipe_stdout, struct GNUNET_DISK_PipeHandle *pipe_stderr, const char *filename, va_list va)
Start a process.
Definition: os_priority.c:1353
void * proc_cls
Closure for proc.
Definition: os_priority.c:1830
const char * bug_email
E-mail address for reporting bugs.
Return the "PREFIX" directory given to configure.
Use this option to have all of the standard streams (stdin, stdout and stderror) be inherited...
const char * env_varname
Name of an environment variable that can be used to override installation path detection, for example "GNUNET_PREFIX".
static struct GNUNET_TIME_Relative timeout
User defined timestamp for completing operations.
Definition: gnunet-arm.c:114
static char * line
Desired phone line (string to be converted to a hash).
Return the prefix of the path with documentation files, including the license (share/doc/gnunet/).
const char * libname
Name of a library that is installed in the "lib/" directory of the project, such as "libgnunetutil"...
No standard streams should be inherited.
Definition: gnunet_os_lib.h:74
When this flag is set, the child process will inherit stdout of the parent.
Definition: gnunet_os_lib.h:86
GNUNET_OS_ProcessStatusType
Process status types.
char * GNUNET_OS_installation_get_path(enum GNUNET_OS_InstallationPathKind dirkind)
Get the path to a specific GNUnet installation directory or, with GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation directory.
struct GNUNET_OS_Process * GNUNET_OS_process_current(void)
Get process structure for current process.
Definition: os_priority.c:231
struct GNUNET_OS_Process * GNUNET_OS_start_process_vap(int pipe_control, enum GNUNET_OS_InheritStdioFlags std_inheritance, struct GNUNET_DISK_PipeHandle *pipe_stdin, struct GNUNET_DISK_PipeHandle *pipe_stdout, struct GNUNET_DISK_PipeHandle *pipe_stderr, const char *filename, char *const argv[])
Start a process.
Definition: os_priority.c:1321
int GNUNET_OS_process_wait_status(struct GNUNET_OS_Process *proc, enum GNUNET_OS_ProcessStatusType *type, unsigned long *code)
Retrieve the status of a process, waiting on it if dead.
Definition: os_priority.c:1740
const char * binary_name
Name of a project-specific binary that should be in "$PREFIX/bin/".
static char * filename
char * GNUNET_OS_get_suid_binary_path(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *progname)
Given the name of a helper, service or daemon binary construct the full path to the binary using the ...
The process exited with a return code.
Return the directory where helper binaries are installed (lib/gnunet/libexec/)
void GNUNET_OS_install_parent_control_handler(void *cls)
Connects this process to its parent via pipe; essentially, the parent control handler will read signa...
Definition: os_priority.c:150
GNUNET_OS_InstallationPathKind
Possible installation paths to request.
When these flags are set, the child process will inherit stdout and stderr of the parent...
Definition: gnunet_os_lib.h:98
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:104
const char * name
int(* GNUNET_OS_NetworkInterfaceProcessor)(void *cls, const char *name, int isDefault, const struct sockaddr *addr, const struct sockaddr *broadcast_addr, const struct sockaddr *netmask, socklen_t addrlen)
Callback function invoked for each interface found.
struct GNUNET_OS_CommandHandle * GNUNET_OS_command_run(GNUNET_OS_LineProcessor proc, void *proc_cls, struct GNUNET_TIME_Relative timeout, const char *binary,...)
Run the given command line and call the given function for each line of the output.
Definition: os_priority.c:1948
The process was killed by a signal.
Return the installation directory of this application, not the one of the overall GNUnet installation...
Return the directory where the program binaries are installed.
const char * homepage
Project homepage.
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:1762
configuration data
Definition: configuration.c:85
Handle to a command.
Definition: os_priority.c:1804
const char * base_config_varname
Name of an environment variable that can be used to override the location from which default configur...
const struct GNUNET_OS_ProjectData * GNUNET_OS_project_data_get(void)
The process is still running.
GNUNET_OS_LineProcessor proc
Function to call on each line of output.
Definition: os_priority.c:1825
char * GNUNET_OS_get_libexec_binary_path(const char *progname)
Given the name of a gnunet-helper, gnunet-service or gnunet-daemon binary, try to prefix it with the ...
void GNUNET_OS_init(const struct GNUNET_OS_ProjectData *pd)
Setup OS subsystem with project data.
The process is not known to the OS (or at least not one of our children).
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
void GNUNET_OS_command_stop(struct GNUNET_OS_CommandHandle *cmd)
Stop/kill a command.
Definition: os_priority.c:1862
Return the prefix of the path with application icons (share/icons/).
commonly used definitions; globals in this file are exempt from the rule that the module name ("commo...
void(* GNUNET_OS_LineProcessor)(void *cls, const char *line)
Type of a function to process a line of output.
struct GNUNET_OS_Process * GNUNET_OS_start_process_v(int pipe_control, enum GNUNET_OS_InheritStdioFlags std_inheritance, const SOCKTYPE *lsocks, const char *filename, char *const argv[])
Start a process.
Definition: os_priority.c:1438
Handle used to manage a pipe.
Definition: disk.c:66
The process is paused (but could be resumed).
Return the directory where data is installed (share/gnunet/)
Time for relative time used by GNUnet, in microseconds.
int GNUNET_OS_process_kill(struct GNUNET_OS_Process *proc, int sig)
Sends a signal to the process.
Definition: os_priority.c:251