gnunet_os_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2011, 2020 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#if ! defined (__GNUNET_UTIL_LIB_H_INSIDE__)
#error "Only <gnunet_util_lib.h> can be included directly."
#endif
 
#ifndef GNUNET_OS_LIB_H
#define GNUNET_OS_LIB_H
 
#include "gnunet_disk_lib.h"
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
enum GNUNET_OS_InheritStdioFlags
{
  GNUNET_OS_INHERIT_STD_NONE = 0,
 
  GNUNET_OS_INHERIT_STD_IN = 1,
 
  GNUNET_OS_INHERIT_STD_OUT = 2,
 
  GNUNET_OS_INHERIT_STD_ERR = 4,
 
  GNUNET_OS_INHERIT_STD_OUT_AND_ERR = 6,
 
  GNUNET_OS_INHERIT_STD_ALL = 7,
 
  GNUNET_OS_USE_PIPE_CONTROL = 8
};
 
 
enum GNUNET_OS_InstallationPathKind
{
  GNUNET_OS_IPK_PREFIX,
 
  GNUNET_OS_IPK_BINDIR,
 
  GNUNET_OS_IPK_LIBDIR,
 
  GNUNET_OS_IPK_DATADIR,
 
  GNUNET_OS_IPK_LOCALEDIR,
 
  GNUNET_OS_IPK_SELF_PREFIX,
 
  GNUNET_OS_IPK_ICONDIR,
 
  GNUNET_OS_IPK_DOCDIR,
 
  GNUNET_OS_IPK_LIBEXECDIR
};
 
 
enum GNUNET_OS_ProcessStatusType
{
  GNUNET_OS_PROCESS_UNKNOWN,
 
  GNUNET_OS_PROCESS_RUNNING,
 
  GNUNET_OS_PROCESS_STOPPED,
 
  GNUNET_OS_PROCESS_EXITED,
 
  GNUNET_OS_PROCESS_SIGNALED
};
 
 
struct GNUNET_OS_ProjectData
{
  const char *libname;
 
  const char *project_dirname;
 
  const char *binary_name;
 
  const char *env_varname;
 
  const char *env_varname_alt;
 
  const char *base_config_varname;
 
  const char *bug_email;
 
  const char *homepage;
 
  const char *config_file;
 
  const char *user_config_file;
 
  const char *version;
 
  int is_gnu;
 
  const char *gettext_domain;
 
  const char *gettext_path;
 
  const char *agpl_url;
};
 
 
const struct GNUNET_OS_ProjectData *
GNUNET_OS_project_data_gnunet (void);
 
 
void
GNUNET_OS_init (const char *package_name,
                const struct GNUNET_OS_ProjectData *pd);
 
 
char *
GNUNET_OS_installation_get_path (const struct GNUNET_OS_ProjectData *pd,
                                 enum GNUNET_OS_InstallationPathKind dirkind);
 
 
char *
GNUNET_OS_get_libexec_binary_path (const struct GNUNET_OS_ProjectData *pd,
                                   const char *progname);
 
 
typedef enum GNUNET_GenericReturnValue
(*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);
 
 
void
GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc,
                                   void *proc_cls);
 
#ifndef HAVE_SYSCONF
#define HAVE_SYSCONF 0
#endif
 
#if HAVE_SYSCONF && defined(_SC_HOST_NAME_MAX)
#define GNUNET_OS_get_hostname_max_length() ({ int __sc_tmp = sysconf ( \
                                                 _SC_HOST_NAME_MAX); __sc_tmp <= \
                                               0 ? 255 : __sc_tmp; })
#elif defined(HOST_NAME_MAX)
#define GNUNET_OS_get_hostname_max_length() HOST_NAME_MAX
#else
#define GNUNET_OS_get_hostname_max_length() 255
#endif
 
 
struct GNUNET_OS_CommandHandle;
 
 
typedef void
(*GNUNET_OS_LineProcessor) (void *cls,
                            const char *line);
 
 
void
GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd);
 
 
struct GNUNET_OS_CommandHandle *
GNUNET_OS_command_run (
  GNUNET_OS_LineProcessor proc,
  void *proc_cls,
  struct GNUNET_TIME_Relative timeout,
  const char *binary,
  ...);
 
 
struct GNUNET_Process;
 
struct GNUNET_Process *
GNUNET_process_create (enum GNUNET_OS_InheritStdioFlags std_inheritance);
 
 
enum GNUNET_GenericReturnValue
GNUNET_process_run_command_ap (
  struct GNUNET_Process *p,
  const char *filename,
  va_list va);
 
 
enum GNUNET_GenericReturnValue
GNUNET_process_run_command_argv (
  struct GNUNET_Process *p,
  const char *filename,
  const char **argv);
 
 
enum GNUNET_GenericReturnValue
GNUNET_process_run_command_va (struct GNUNET_Process *p,
                               const char *filename,
                               ...);
 
enum GNUNET_GenericReturnValue
GNUNET_process_run_command (struct GNUNET_Process *p,
                            const char *command);
 
 
enum GNUNET_ProcessOption
{
  GNUNET_PROCESS_OPTION_END = 0,
 
  GNUNET_PROCESS_OPTION_SET_ENVIRONMENT = 1,
 
  GNUNET_PROCESS_OPTION_INHERIT_FD = 2,
 
  GNUNET_PROCESS_OPTION_INHERIT_LSOCK = 3
};
 
 
#define GNUNET_PROCESS_OPTIONS_ARRAY_MAX_SIZE 32
 
 
struct GNUNET_ProcessOptionValue
{
 
  enum GNUNET_ProcessOption option;
 
  union
  {
 
    struct
    {
      const char *key;
 
      const char *value;
 
    } set_environment;
 
    struct
    {
 
      int target_fd;
 
      int parent_fd;
 
    } inherit_fd;
 
    int inherit_lsock;
 
  } details;
 
};
 
 
#define GNUNET_process_option_end_()             \
        (const struct GNUNET_ProcessOptionValue) \
        {                                        \
          .option = GNUNET_PROCESS_OPTION_END    \
        }
 
#define GNUNET_process_option_set_environment(k,v)         \
        (const struct GNUNET_ProcessOptionValue)           \
        {                                                  \
          .option = GNUNET_PROCESS_OPTION_SET_ENVIRONMENT, \
          .details.set_environment.key = k,                \
          .details.set_environment.value = v               \
        }
 
#define GNUNET_process_option_inherit_fd(p, c)  \
        (const struct GNUNET_ProcessOptionValue)               \
        {                                                      \
          .option = GNUNET_PROCESS_OPTION_INHERIT_FD,          \
          .details.inherit_fd.target_fd = c,                   \
          .details.inherit_fd.parent_fd = p                    \
        }
 
#define GNUNET_process_option_inherit_rpipe(rpipe, child_fd)   \
        (const struct GNUNET_ProcessOptionValue)               \
        {                                                      \
          .option = GNUNET_PROCESS_OPTION_INHERIT_FD,          \
          .details.inherit_fd.target_fd = child_fd,            \
          .details.inherit_fd.parent_fd                        \
            = GNUNET_DISK_internal_file_handle (               \
                GNUNET_DISK_pipe_detach_end (rpipe,            \
                                             GNUNET_DISK_PIPE_END_READ)) \
        }
 
#define GNUNET_process_option_inherit_wpipe(wpipe, child_fd)  \
        (const struct GNUNET_ProcessOptionValue)               \
        {                                                      \
          .option = GNUNET_PROCESS_OPTION_INHERIT_FD,          \
          .details.inherit_fd.target_fd = child_fd,            \
          .details.inherit_fd.parent_fd \
            = GNUNET_DISK_internal_file_handle ( \
                GNUNET_DISK_pipe_detach_end (wpipe, \
                                             GNUNET_DISK_PIPE_END_WRITE)) \
        }
 
#define GNUNET_process_option_inherit_lsock(lsock)        \
        (const struct GNUNET_ProcessOptionValue)          \
        {                                                 \
          .option = GNUNET_PROCESS_OPTION_INHERIT_LSOCK,  \
          .details.inherit_lsock = lsock                  \
        }
 
 
enum GNUNET_GenericReturnValue
GNUNET_process_set_options_ (
  struct GNUNET_Process *proc,
  unsigned int num_options,
  const struct GNUNET_ProcessOptionValue options[]);
 
 
#define GNUNET_process_set_options(proc,...)              \
        GNUNET_process_set_options_ (                     \
          proc,                                           \
          GNUNET_PROCESS_OPTIONS_ARRAY_MAX_SIZE,          \
          ((const struct GNUNET_ProcessOptionValue[])     \
           {__VA_ARGS__, GNUNET_process_option_end_ () }  \
          ))
 
 
enum GNUNET_GenericReturnValue
GNUNET_process_wait (struct GNUNET_Process *proc,
                     bool blocking,
                     enum GNUNET_OS_ProcessStatusType *type,
                     unsigned long *code);
 
 
void
GNUNET_process_destroy (struct GNUNET_Process *proc);
 
 
pid_t
GNUNET_process_get_pid (const struct GNUNET_Process *proc);
 
 
enum GNUNET_GenericReturnValue
GNUNET_process_kill (struct GNUNET_Process *proc,
                     int sig);
 
 
struct GNUNET_Process *
GNUNET_process_current (void);
 
 
void
GNUNET_process_install_parent_control_handler (void);
 
 
void
GNUNET_OS_install_parent_control_handler (void *cls);
 
 
enum GNUNET_GenericReturnValue
GNUNET_OS_check_helper_binary (const char *binary,
                               bool check_suid,
                               const char *params);
 
 
void
GNUNET_OS_purge_cfg_dir (const struct GNUNET_OS_ProjectData *pd,
                           const char *cfg_filename,
                           const char *option);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_OS_LIB_H */
#endif
 
 
 
/* end of gnunet_os_lib.h */