src/lib/process/process_win32.h

   1 /* Copyright (c) 2003-2004, Roger Dingledine
   2  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   3  * Copyright (c) 2007-2018, The Tor Project, Inc. */
   4 /* See LICENSE for licensing information */
   5
   6 /**
   7  * \file process_win32.h
   8  * \brief Header for process_win32.c
   9  **/
  10
  11 #ifndef TOR_PROCESS_WIN32_H
  12 #define TOR_PROCESS_WIN32_H
  13
  14 #ifdef _WIN32
  15
  16 #include "orconfig.h"
  17 #include "lib/malloc/malloc.h"
  18 #include "lib/evloop/compat_libevent.h"
  19
  20 #include <windows.h>
  21
  22 struct process_t;
  23
  24 struct process_win32_t;
  25 typedef struct process_win32_t process_win32_t;
  26
  27 process_win32_t *process_win32_new(void);
  28 void process_win32_free_(process_win32_t *win32_process);
  29 #define process_win32_free(s) \
  30   FREE_AND_NULL(process_win32_t, process_win32_free_, (s))
  31
  32 void process_win32_init(void);
  33 void process_win32_deinit(void);
  34
  35 process_status_t process_win32_exec(struct process_t *process);
  36 bool process_win32_terminate(struct process_t *process);
  37
  38 process_pid_t process_win32_get_pid(struct process_t *process);
  39
  40 int process_win32_write(struct process_t *process, buf_t *buffer);
  41 int process_win32_read_stdout(struct process_t *process, buf_t *buffer);
  42 int process_win32_read_stderr(struct process_t *process, buf_t *buffer);
  43
  44 void process_win32_trigger_completion_callbacks(void);
  45
  46 #ifdef PROCESS_WIN32_PRIVATE
  47 /* Timer handling. */
  48 STATIC void process_win32_timer_start(void);
  49 STATIC void process_win32_timer_stop(void);
  50 STATIC bool process_win32_timer_running(void);
  51 STATIC void process_win32_timer_callback(periodic_timer_t *, void *);
  52 STATIC void process_win32_timer_test_process(process_t *);
  53
  54 /* I/O pipe handling. */
  55 struct process_win32_handle_t;
  56 typedef struct process_win32_handle_t process_win32_handle_t;
  57
  58 typedef enum process_win32_pipe_type_t {
  59   /** This pipe is used for reading. */
  60   PROCESS_WIN32_PIPE_TYPE_READER,
  61
  62   /** This pipe is used for writing. */
  63   PROCESS_WIN32_PIPE_TYPE_WRITER
  64 } process_win32_pipe_type_t;
  65
  66 STATIC bool process_win32_create_pipe(HANDLE *,
  67                                       HANDLE *,
  68                                       SECURITY_ATTRIBUTES *,
  69                                       process_win32_pipe_type_t);
  70
  71 STATIC void process_win32_cleanup_handle(process_win32_handle_t *handle);
  72
  73 STATIC VOID WINAPI process_win32_stdout_read_done(DWORD,
  74                                                   DWORD,
  75                                                   LPOVERLAPPED);
  76 STATIC VOID WINAPI process_win32_stderr_read_done(DWORD,
  77                                                   DWORD,
  78                                                   LPOVERLAPPED);
  79 STATIC VOID WINAPI process_win32_stdin_write_done(DWORD,
  80                                                   DWORD,
  81                                                   LPOVERLAPPED);
  82
  83 STATIC int process_win32_read_from_handle(process_win32_handle_t *,
  84                                           buf_t *,
  85                                           LPOVERLAPPED_COMPLETION_ROUTINE);
  86 STATIC bool process_win32_handle_read_completion(process_win32_handle_t *,
  87                                                  DWORD,
  88                                                  DWORD);
  89
  90 STATIC char *format_win_cmdline_argument(const char *arg);
  91 STATIC char *tor_join_win_cmdline(const char *argv[]);
  92 #endif /* defined(PROCESS_WIN32_PRIVATE). */
  93
  94 #endif /* ! defined(_WIN32). */
  95
  96 #endif /* defined(TOR_PROCESS_WIN32_H). */