Smallers steps to keep plugin running

[oweals/gnunet.git] / src / include / gnunet_os_lib.h

diff --git a/src/include/gnunet_os_lib.h b/src/include/gnunet_os_lib.h
index 1d4d474417f4802883efe7b56154cf02d8ffb72f..bea96034616c0489476fa936ac0556260ebba52e 100644 (file)
--- a/src/include/gnunet_os_lib.h
+++ b/src/include/gnunet_os_lib.h
@@ -50,12 +50,42 @@ extern "C"
  */
 enum GNUNET_OS_InstallationPathKind
 {
+  /**
+   * Return the "PREFIX" directory given to configure.
+   */
   GNUNET_OS_IPK_PREFIX,
+
+  /**
+   * Return the directory where the program binaries are installed. (bin/)
+   */
   GNUNET_OS_IPK_BINDIR,
+
+  /**
+   * Return the directory where libraries are installed. (lib/)
+   */
   GNUNET_OS_IPK_LIBDIR,
+
+  /**
+   * Return the directory where data is installed (share/)
+   */
   GNUNET_OS_IPK_DATADIR,
+
+  /**
+   * Return the directory where translations are installed (share/locale/)
+   */
   GNUNET_OS_IPK_LOCALEDIR,
-  GNUNET_OS_IPK_SELF_PREFIX
+
+  /**
+   * Return the installation directory of this application, not
+   * the one of the overall GNUnet installation (in case they
+   * are different).
+   */
+  GNUNET_OS_IPK_SELF_PREFIX,
+
+  /**
+   * Return the prefix of the path with application icons.
+   */
+  GNUNET_OS_IPK_ICONDIR
 };
 
 
@@ -64,10 +94,30 @@ enum GNUNET_OS_InstallationPathKind
  */
 enum GNUNET_OS_ProcessStatusType
 {
+  /**
+   * The process is not known to the OS (or at
+   * least not one of our children).
+   */
   GNUNET_OS_PROCESS_UNKNOWN,
+
+  /**
+   * The process is still running.
+   */
   GNUNET_OS_PROCESS_RUNNING,
+
+  /**
+   * The process is paused (but could be resumed).
+   */
   GNUNET_OS_PROCESS_STOPPED,
+
+  /**
+   * The process exited with a return code.
+   */
   GNUNET_OS_PROCESS_EXITED,
+
+  /**
+   * The process was killed by a signal.
+   */
   GNUNET_OS_PROCESS_SIGNALED
 };
 
@@ -103,10 +153,23 @@ typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls,
 
 /**
  * @brief Enumerate all network interfaces
- * @param callback the callback function
+ * @param proc the callback function
+ * @param proc_cls closure for proc
  */
 void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor
-                                        proc, void *cls);
+                                        proc, void *proc_cls);
+
+/**
+ * @brief Get maximum string length returned by gethostname()
+ */
+#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
+
 
 /**
  * Get the current CPU load.
@@ -115,7 +178,8 @@ void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor
  * @return -1 on error, otherwise load value (between 0 and 100,
  *        (100 is equivalent to full load for one CPU)
  */
-int GNUNET_OS_load_cpu_get (struct GNUNET_CONFIGURATION_Handle *cfg);
+int GNUNET_OS_load_cpu_get (const struct GNUNET_CONFIGURATION_Handle *cfg);
+
 
 /**
  * Get the current IO load.
@@ -125,7 +189,7 @@ int GNUNET_OS_load_cpu_get (struct GNUNET_CONFIGURATION_Handle *cfg);
  *       100 means that we spend all of our cycles waiting for
  *       the disk)
  */
-int GNUNET_OS_load_disk_get (struct GNUNET_CONFIGURATION_Handle *cfg);
+int GNUNET_OS_load_disk_get (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
 /**
@@ -142,21 +206,31 @@ int GNUNET_OS_set_process_priority (pid_t proc,
 /**
  * Start a process.
  *
+ * @param pipe_stdin pipe to use to send input to child process (or NULL)
+ * @param pipe_stdout pipe to use to get output from child process (or NULL)
  * @param filename name of the binary
  * @param ... NULL-terminated list of arguments to the process
  * @return process ID of the new process, -1 on error
  */
-pid_t GNUNET_OS_start_process (const char *filename, ...);
+pid_t
+GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin, 
+                        struct GNUNET_DISK_PipeHandle *pipe_stdout, 
+                        const char *filename, ...);
+
 
 /**
  * Start a process.
  *
+ * @param lsocks array of listen sockets to dup systemd-style (or NULL);
+ *         must be NULL on platforms where dup is not supported
  * @param filename name of the binary
  * @param argv NULL-terminated list of arguments to the process,
  *             including the process name as the first argument
  * @return process ID of the new process, -1 on error
  */
-pid_t GNUNET_OS_start_process_v (const char *filename, char *const argv[]);
+pid_t GNUNET_OS_start_process_v (const int *lsocks,
+                                const char *filename, char *const argv[]);
+
 
 /**
  * Retrieve the status of a process
@@ -168,6 +242,7 @@ pid_t GNUNET_OS_start_process_v (const char *filename, char *const argv[]);
 int GNUNET_OS_process_status (pid_t proc, enum GNUNET_OS_ProcessStatusType *type,
     unsigned long *code);
 
+
 /**
  * Wait for a process
  * @param proc process ID to wait for
@@ -175,6 +250,7 @@ int GNUNET_OS_process_status (pid_t proc, enum GNUNET_OS_ProcessStatusType *type
  */
 int GNUNET_OS_process_wait (pid_t proc);
 
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif