server/process.h

   1 /*
   2  * Wine server processes
   3  *
   4  * Copyright (C) 1999 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef __WINE_SERVER_PROCESS_H
  22 #define __WINE_SERVER_PROCESS_H
  23
  24 #include "object.h"
  25
  26 struct atom_table;
  27 struct handle_table;
  28 struct startup_info;
  29 struct job;
  30
  31 /* process startup state */
  32 enum startup_state { STARTUP_IN_PROGRESS, STARTUP_DONE, STARTUP_ABORTED };
  33
  34 /* process structures */
  35
  36 struct process_dll
  37 {
  38     struct list          entry;           /* entry in per-process dll list */
  39     mod_handle_t         base;            /* dll base address (in process addr space) */
  40     client_ptr_t         name;            /* ptr to ptr to name (in process addr space) */
  41     int                  dbg_offset;      /* debug info offset */
  42     int                  dbg_size;        /* debug info size */
  43     data_size_t          namelen;         /* length of dll file name */
  44     WCHAR               *filename;        /* dll file name */
  45 };
  46
  47 struct rawinput_device_entry
  48 {
  49     struct list            entry;
  50     struct rawinput_device device;
  51 };
  52
  53 struct process
  54 {
  55     struct object        obj;             /* object header */
  56     struct list          entry;           /* entry in system-wide process list */
  57     process_id_t         parent_id;       /* parent process id (at the time of creation) */
  58     struct list          thread_list;     /* thread list */
  59     struct thread       *debugger;        /* thread debugging this process */
  60     struct debug_event  *debug_event;     /* debug event being sent to debugger */
  61     struct handle_table *handles;         /* handle entries */
  62     struct fd           *msg_fd;          /* fd for sendmsg/recvmsg */
  63     process_id_t         id;              /* id of the process */
  64     process_id_t         group_id;        /* group id of the process */
  65     struct timeout_user *sigkill_timeout; /* timeout for final SIGKILL */
  66     enum cpu_type        cpu;             /* client CPU type */
  67     int                  unix_pid;        /* Unix pid for final SIGKILL */
  68     int                  exit_code;       /* process exit code */
  69     int                  running_threads; /* number of threads running in this process */
  70     timeout_t            start_time;      /* absolute time at process start */
  71     timeout_t            end_time;        /* absolute time at process end */
  72     affinity_t           affinity;        /* process affinity mask */
  73     int                  priority;        /* priority class */
  74     int                  suspend;         /* global process suspend count */
  75     unsigned int         is_system:1;     /* is it a system process? */
  76     unsigned int         debug_children:1;/* also debug all child processes */
  77     unsigned int         is_terminating:1;/* is process terminating? */
  78     struct job          *job;             /* job object ascoicated with this process */
  79     struct list          job_entry;       /* list entry for job object */
  80     struct list          asyncs;          /* list of async object owned by the process */
  81     struct list          locks;           /* list of file locks owned by the process */
  82     struct list          classes;         /* window classes owned by the process */
  83     struct console_input*console;         /* console input */
  84     enum startup_state   startup_state;   /* startup state */
  85     struct startup_info *startup_info;    /* startup info while init is in progress */
  86     struct event        *idle_event;      /* event for input idle */
  87     struct file         *exe_file;        /* file handle for main exe (during startup only) */
  88     obj_handle_t         winstation;      /* main handle to process window station */
  89     obj_handle_t         desktop;         /* handle to desktop to use for new threads */
  90     struct token        *token;           /* security token associated with this process */
  91     struct list          views;           /* list of memory views */
  92     struct list          dlls;            /* list of loaded dlls */
  93     client_ptr_t         peb;             /* PEB address in client address space */
  94     client_ptr_t         ldt_copy;        /* pointer to LDT copy in client addr space */
  95     struct dir_cache    *dir_cache;       /* map of client-side directory cache */
  96     unsigned int         trace_data;      /* opaque data used by the process tracing mechanism */
  97     struct list          rawinput_devices;/* list of registered rawinput devices */
  98     const struct rawinput_device *rawinput_mouse; /* rawinput mouse device, if any */
  99     const struct rawinput_device *rawinput_kbd;   /* rawinput keyboard device, if any */
 100     struct list          kernel_object;   /* list of kernel object pointers */
 101 };
 102
 103 #define CPU_FLAG(cpu) (1 << (cpu))
 104 #define CPU_64BIT_MASK (CPU_FLAG(CPU_x86_64) | CPU_FLAG(CPU_ARM64))
 105
 106 /* process functions */
 107
 108 extern unsigned int alloc_ptid( void *ptr );
 109 extern void free_ptid( unsigned int id );
 110 extern void *get_ptid_entry( unsigned int id );
 111 extern struct process *create_process( int fd, struct process *parent, int inherit_all, const startup_info_t *info,
 112                                        const struct security_descriptor *sd, const obj_handle_t *handles,
 113                                        unsigned int handle_count, struct token *token );
 114 extern data_size_t init_process( struct thread *thread );
 115 extern struct thread *get_process_first_thread( struct process *process );
 116 extern struct process *get_process_from_id( process_id_t id );
 117 extern struct process *get_process_from_handle( obj_handle_t handle, unsigned int access );
 118 extern int process_set_debugger( struct process *process, struct thread *thread );
 119 extern int debugger_detach( struct process* process, struct thread* debugger );
 120 extern int set_process_debug_flag( struct process *process, int flag );
 121
 122 extern void add_process_thread( struct process *process,
 123                                 struct thread *thread );
 124 extern void remove_process_thread( struct process *process,
 125                                    struct thread *thread );
 126 extern void suspend_process( struct process *process );
 127 extern void resume_process( struct process *process );
 128 extern void kill_process( struct process *process, int violent_death );
 129 extern void kill_console_processes( struct thread *renderer, int exit_code );
 130 extern void kill_debugged_processes( struct thread *debugger, int exit_code );
 131 extern void detach_debugged_processes( struct thread *debugger );
 132 extern void enum_processes( int (*cb)(struct process*, void*), void *user);
 133
 134 /* console functions */
 135 extern int free_console( struct process *process );
 136 extern struct thread *console_get_renderer( struct console_input *console );
 137
 138 /* process tracing mechanism to use */
 139 #ifdef __APPLE__
 140 #define USE_MACH
 141 #elif defined(__sun)
 142 #define USE_PROCFS
 143 #else
 144 #define USE_PTRACE
 145 #endif
 146
 147 extern void init_tracing_mechanism(void);
 148 extern void init_process_tracing( struct process *process );
 149 extern void finish_process_tracing( struct process *process );
 150 extern int read_process_memory( struct process *process, client_ptr_t ptr, data_size_t size, char *dest );
 151 extern int write_process_memory( struct process *process, client_ptr_t ptr, data_size_t size, const char *src );
 152
 153 static inline process_id_t get_process_id( struct process *process ) { return process->id; }
 154
 155 static inline int is_process_init_done( struct process *process )
 156 {
 157     return process->startup_state == STARTUP_DONE;
 158 }
 159
 160 static inline struct process_dll *get_process_exe_module( struct process *process )
 161 {
 162     struct list *ptr = list_head( &process->dlls );
 163     return ptr ? LIST_ENTRY( ptr, struct process_dll, entry ) : NULL;
 164 }
 165
 166 #endif  /* __WINE_SERVER_PROCESS_H */