SHUTDOWN
[oweals/gnunet.git] / src / include / gnunet_os_lib.h
index dfab4a74775fff33126aab2da610aa4d53086b82..7bd65adcbde19279c789c1611446ba59703acb45 100644 (file)
@@ -44,18 +44,86 @@ extern "C"
 #include "gnunet_configuration_lib.h"
 #include "gnunet_scheduler_lib.h"
 
+/**
+ * Process information (OS-dependent)
+ */
+struct GNUNET_OS_Process;
+
 
 /**
  * Possible installation paths to request
  */
 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
+};
+
+
+/**
+ * Process status types
+ */
+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
 };
 
 
@@ -90,60 +158,129 @@ 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.
+ * Get process structure for current process
  *
- * @param cfg to determine acceptable load level (LOAD::MAXCPULOAD)
- * @return -1 on error, otherwise load value (between 0 and 100,
- *        (100 is equivalent to full load for one CPU)
+ * The pointer it returns points to static memory location and must not be
+ * deallocated/closed
+ *
+ * @return pointer to the process sturcutre for this process
+ */
+struct GNUNET_OS_Process *GNUNET_OS_process_current (void);
+
+
+/**
+ * Sends sig to the process
+ *
+ * @param proc pointer to process structure
+ * @param sig signal
+ * @return 0 on success, -1 on error
  */
-int GNUNET_OS_load_cpu_get (struct GNUNET_CONFIGURATION_Handle *cfg);
+int GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
+
 
 /**
- * Get the current IO load.
+ * Cleans up process structure contents (OS-dependent) and deallocates it
  *
- * @param cfg to determine acceptable load level (LOAD::MAXIOLOAD)
- * @return -1 on error, otherwise load value (between 0 and 100,
- *       100 means that we spend all of our cycles waiting for
- *       the disk)
+ * @param proc pointer to process structure
  */
-int GNUNET_OS_load_disk_get (struct GNUNET_CONFIGURATION_Handle *cfg);
+void GNUNET_OS_process_close (struct GNUNET_OS_Process *proc);
 
+/**
+ * Get the pid of the process in question
+ *
+ * @param proc the process to get the pid of
+ *
+ * @return the current process id
+ */
+pid_t
+GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc);
 
 /**
  * Set process priority
  *
- * @param proc id of the process
+ * @param proc pointer to process structure
  * @param prio priority value
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
-int GNUNET_OS_set_process_priority (pid_t proc,
+int GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc,
                                     enum GNUNET_SCHEDULER_Priority prio);
 
 
 /**
  * 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
+ * @return pointer to process structure of the new process, NULL on error
  */
-pid_t GNUNET_OS_start_process (const char *filename, ...);
+struct GNUNET_OS_Process *
+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
+ * @return pointer to process structure of the new process, NULL on error
+ */
+struct GNUNET_OS_Process *
+GNUNET_OS_start_process_v (const int *lsocks, const char *filename,
+                          char *const argv[]);
+
+
+/**
+ * Retrieve the status of a process
+ * @param proc pointer to process structure
+ * @param type status type
+ * @param code return code/signal number
+ * @return GNUNET_OK on success, GNUNET_NO if the process is still running, GNUNET_SYSERR otherwise
+ */
+int GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
+                             enum GNUNET_OS_ProcessStatusType *type, unsigned long *code);
+
+
+/**
+ * Wait for a process
+ * @param proc pointer to process structure of the process to wait for
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
+ */
+int GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
+
+
+/**
+ * Connects this process to its parent via pipe
  */
-pid_t GNUNET_OS_start_process_v (const char *filename, char *const argv[]);
+void
+GNUNET_OS_install_parent_control_handler (void *cls,
+                                          const struct
+                                          GNUNET_SCHEDULER_TaskContext * tc);
 
 #if 0                           /* keep Emacsens' auto-indent happy */
 {