GNUnet  0.11.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, 2020 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 {
74 
80 
86 
92 
98 
104 
109 };
110 
111 
115 struct GNUNET_OS_Process;
116 
117 
122 {
127 
132 
137 
142 
147 
154 
159 
165 
170 };
171 
172 
177 {
183 
188 
193 
198 
203 };
204 
205 
211 {
217  const char *libname;
218 
225  const char *project_dirname;
226 
232  const char *binary_name;
233 
238  const char *env_varname;
239 
245  const char *env_varname_alt;
246 
252  const char *base_config_varname;
253 
257  const char *bug_email;
258 
262  const char *homepage;
263 
267  const char *config_file;
268 
272  const char *user_config_file;
273 
277  const char *version;
278 
282  int is_gnu;
283 
289 
295 
302  char *agpl_url;
303 };
304 
305 
309 const struct GNUNET_OS_ProjectData *
311 
312 
316 const struct GNUNET_OS_ProjectData *
318 
319 
325 void
326 GNUNET_OS_init (const struct GNUNET_OS_ProjectData *pd);
327 
328 
337 char *
339 
340 
349 char *
350 GNUNET_OS_get_libexec_binary_path (const char *progname);
351 
352 
365 char *
367  const char *progname);
368 
369 
382 typedef int
384  const char *name,
385  int isDefault,
386  const struct sockaddr *addr,
387  const struct sockaddr *broadcast_addr,
388  const struct sockaddr *netmask,
389  socklen_t addrlen);
390 
391 
398 void
400  void *proc_cls);
401 
405 #if HAVE_SYSCONF && defined(_SC_HOST_NAME_MAX)
406 #define GNUNET_OS_get_hostname_max_length() ({ int __sc_tmp = sysconf ( \
407  _SC_HOST_NAME_MAX); __sc_tmp <= \
408  0 ? 255 : __sc_tmp; })
409 #elif defined(HOST_NAME_MAX)
410 #define GNUNET_OS_get_hostname_max_length() HOST_NAME_MAX
411 #else
412 #define GNUNET_OS_get_hostname_max_length() 255
413 #endif
414 
415 
424 struct GNUNET_OS_Process *
426 
427 
435 int
437  int sig);
438 
439 
445 void
447 
448 
456 pid_t
458 
459 
471 struct GNUNET_OS_Process *
473  struct GNUNET_DISK_PipeHandle *pipe_stdin,
474  struct GNUNET_DISK_PipeHandle *pipe_stdout,
475  struct GNUNET_DISK_PipeHandle *pipe_stderr,
476  const char *filename,
477  char *const argv[]);
478 
479 
491 struct GNUNET_OS_Process *
493  struct GNUNET_DISK_PipeHandle *pipe_stdin,
494  struct GNUNET_DISK_PipeHandle *pipe_stdout,
495  struct GNUNET_DISK_PipeHandle *pipe_stderr,
496  const char *filename, ...);
497 
498 
510 struct GNUNET_OS_Process *
512  struct GNUNET_DISK_PipeHandle *pipe_stdin,
513  struct GNUNET_DISK_PipeHandle *pipe_stdout,
514  struct GNUNET_DISK_PipeHandle *pipe_stderr,
515  const char *filename, va_list va);
516 
528 struct GNUNET_OS_Process *
530  const int *lsocks,
531  const char *filename,
532  char *const argv[]);
533 
534 
552 struct GNUNET_OS_Process *
554  const int *lsocks,
555  const char *filename, ...);
556 
557 
562 
563 
570 typedef void
571 (*GNUNET_OS_LineProcessor) (void *cls, const char *line);
572 
573 
579 void
581 
582 
596  void *proc_cls,
598  const char *binary,
599  ...);
600 
601 
611 int
614  unsigned long *code);
615 
616 
627 int
629 
630 
640 int
643  unsigned long *code);
644 
645 
654 void
656 
657 
675 int
676 GNUNET_OS_check_helper_binary (const char *binary,
677  int check_suid,
678  const char *params);
679 
680 
681 #if 0 /* keep Emacsens' auto-indent happy */
682 {
683 #endif
684 #ifdef __cplusplus
685 }
686 #endif
687 
688 /* ifndef GNUNET_OS_LIB_H */
689 #endif
690  /* end of group */
692 
693 /* 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
struct GNUNET_OS_Process * GNUNET_OS_start_process_s(enum GNUNET_OS_InheritStdioFlags std_inheritance, const int *lsocks, const char *filename,...)
Start a process.
Definition: os_priority.c:747
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:91
pid_t GNUNET_OS_process_get_pid(struct GNUNET_OS_Process *proc)
Get the pid of the process in question.
Definition: os_priority.c:274
char * gettext_domain
Gettext domain for localisation, e.g.
Project-specific data used to help the OS subsystem find installation paths.
struct GNUNET_OS_Process * GNUNET_OS_start_process_vap(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:604
struct GNUNET_OS_Process * GNUNET_OS_start_process(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:678
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
char * gettext_path
Gettext directory, e.g.
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:287
int GNUNET_OS_process_status(struct GNUNET_OS_Process *proc, enum GNUNET_OS_ProcessStatusType *type, unsigned long *code)
Retrieve the status of a process.
Definition: os_priority.c:946
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".
When this flag is set, the child process will inherit stdin of the parent.
Definition: gnunet_os_lib.h:79
struct GNUNET_OS_Process * GNUNET_OS_start_process_v(enum GNUNET_OS_InheritStdioFlags std_inheritance, const int *lsocks, const char *filename, char *const argv[])
Start a process.
Definition: os_priority.c:714
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:396
void * proc_cls
Closure for proc.
Definition: os_priority.c:1027
int is_gnu
Non-zero means this project is part of GNU.
const char * version
String identifying the current project version.
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...
char * agpl_url
URL pointing to the source code of the application.
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
Desired timeout for the lookup (default is no timeout).
Definition: gnunet-abd.c:61
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:73
When this flag is set, the child process will inherit stdout of the parent.
Definition: gnunet_os_lib.h:85
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:210
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:964
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:141
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:97
struct GNUNET_OS_Process * GNUNET_OS_start_process_va(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:633
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:1144
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:983
configuration data
const char * name
Handle to a command.
Definition: os_priority.c:1002
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:1022
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:1059
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.
Should a pipe be used to send signals to the child?
Handle used to manage a pipe.
Definition: disk.c:68
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:225