server/thread.h

   1 /*
   2  * Wine server threads
   3  *
   4  * Copyright (C) 1998 Alexandre Julliard
   5  */
   6
   7 #ifndef __WINE_SERVER_THREAD_H
   8 #define __WINE_SERVER_THREAD_H
   9
  10 #ifndef __WINE_SERVER__
  11 #error This file can only be used in the Wine server
  12 #endif
  13
  14 #include "object.h"
  15
  16 /* thread structure */
  17
  18 struct process;
  19 struct thread_wait;
  20 struct thread_apc;
  21 struct mutex;
  22 struct debug_ctx;
  23 struct debug_event;
  24 struct startup_info;
  25 struct msg_queue;
  26
  27 enum run_state
  28 {
  29     RUNNING,    /* running normally */
  30     TERMINATED  /* terminated */
  31 };
  32
  33
  34 struct thread
  35 {
  36     struct object       obj;       /* object header */
  37     struct thread      *next;      /* system-wide thread list */
  38     struct thread      *prev;
  39     struct thread      *proc_next; /* per-process thread list */
  40     struct thread      *proc_prev;
  41     struct process     *process;
  42     struct mutex       *mutex;       /* list of currently owned mutexes */
  43     struct debug_ctx   *debug_ctx;   /* debugger context if this thread is a debugger */
  44     struct debug_event *debug_event; /* debug event being sent to debugger */
  45     struct msg_queue   *queue;       /* message queue */
  46     struct startup_info*info;        /* startup info for child process */
  47     struct thread_wait *wait;        /* current wait condition if sleeping */
  48     struct thread_apc  *apc_head;    /* queue of async procedure calls */
  49     struct thread_apc  *apc_tail;    /* queue of async procedure calls */
  50     unsigned int        error;       /* current error code */
  51     struct object      *request_fd;  /* fd for receiving client requests */
  52     int                 pass_fd;     /* fd to pass to the client */
  53     int                 reply_fd;    /* fd to use to wake a client waiting on a reply */
  54     enum run_state      state;     /* running state */
  55     int                 attached;  /* is thread attached with ptrace? */
  56     int                 exit_code; /* thread exit code */
  57     int                 unix_pid;  /* Unix pid of client */
  58     CONTEXT            *context;   /* current context if in an exception handler */
  59     void               *teb;       /* TEB address (in client address space) */
  60     int                 priority;  /* priority level */
  61     int                 affinity;  /* affinity mask */
  62     int                 suspend;   /* suspend count */
  63     void               *buffer;    /* buffer for communication with the client */
  64     struct server_buffer_info *buffer_info;   /* buffer information structure */
  65     enum request        last_req;  /* last request received (for debugging) */
  66 };
  67
  68 struct thread_snapshot
  69 {
  70     struct thread  *thread;    /* thread ptr */
  71     int             count;     /* thread refcount */
  72     int             priority;  /* priority class */
  73 };
  74
  75 /* callback function for building the thread reply when sleep_on is finished */
  76 typedef void (*sleep_reply)( struct thread *thread, struct object *obj, int signaled );
  77
  78 extern struct thread *current;
  79
  80 /* thread functions */
  81
  82 extern struct thread *create_thread( int fd, struct process *process );
  83 extern struct thread *get_thread_from_id( void *id );
  84 extern struct thread *get_thread_from_handle( int handle, unsigned int access );
  85 extern struct thread *get_thread_from_pid( int pid );
  86 extern int suspend_thread( struct thread *thread, int check_limit );
  87 extern int resume_thread( struct thread *thread );
  88 extern void suspend_all_threads( void );
  89 extern void resume_all_threads( void );
  90 extern int add_queue( struct object *obj, struct wait_queue_entry *entry );
  91 extern void remove_queue( struct object *obj, struct wait_queue_entry *entry );
  92 extern void kill_thread( struct thread *thread, int violent_death );
  93 extern void wake_up( struct object *obj, int max );
  94 extern int sleep_on( int count, struct object *objects[], int flags,
  95                      int timeout, sleep_reply func );
  96 extern int thread_queue_apc( struct thread *thread, struct object *owner, void *func,
  97                              enum apc_type type, int nb_args, ... );
  98 extern void thread_cancel_apc( struct thread *thread, struct object *owner );
  99 extern struct thread_snapshot *thread_snap( int *count );
 100
 101 /* ptrace functions */
 102
 103 extern void sigchld_handler();
 104 extern void wait4_thread( struct thread *thread, int signal );
 105 extern void stop_thread( struct thread *thread );
 106 extern void continue_thread( struct thread *thread );
 107 extern void detach_thread( struct thread *thread, int sig );
 108 extern int suspend_for_ptrace( struct thread *thread );
 109 extern int read_thread_int( struct thread *thread, const int *addr, int *data );
 110 extern int write_thread_int( struct thread *thread, int *addr, int data, unsigned int mask );
 111 extern void *get_thread_ip( struct thread *thread );
 112
 113 extern unsigned int global_error;  /* global error code for when no thread is current */
 114
 115 static inline unsigned int get_error(void)       { return current ? current->error : global_error; }
 116 static inline void set_error( unsigned int err ) { global_error = err; if (current) current->error = err; }
 117 static inline void clear_error(void)    { set_error(0); }
 118
 119 static inline void *get_thread_id( struct thread *thread ) { return thread; }
 120
 121 #endif  /* __WINE_SERVER_THREAD_H */