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 struct apc_queue
  34 {
  35     struct thread_apc *head;
  36     struct thread_apc *tail;
  37 };
  38
  39 /* descriptor for fds currently in flight from client to server */
  40 struct inflight_fd
  41 {
  42     int client;  /* fd on the client side (or -1 if entry is free) */
  43     int server;  /* fd on the server side */
  44 };
  45 #define MAX_INFLIGHT_FDS 16  /* max number of fds in flight per thread */
  46
  47 struct thread
  48 {
  49     struct object       obj;       /* object header */
  50     struct thread      *next;      /* system-wide thread list */
  51     struct thread      *prev;
  52     struct thread      *proc_next; /* per-process thread list */
  53     struct thread      *proc_prev;
  54     struct process     *process;
  55     struct mutex       *mutex;       /* list of currently owned mutexes */
  56     struct debug_ctx   *debug_ctx;   /* debugger context if this thread is a debugger */
  57     struct debug_event *debug_event; /* debug event being sent to debugger */
  58     struct msg_queue   *queue;       /* message queue */
  59     struct startup_info*info;        /* startup info for child process */
  60     struct thread_wait *wait;        /* current wait condition if sleeping */
  61     struct apc_queue    system_apc;  /* queue of system async procedure calls */
  62     struct apc_queue    user_apc;    /* queue of user async procedure calls */
  63     struct inflight_fd  inflight[MAX_INFLIGHT_FDS];  /* fds currently in flight */
  64     unsigned int        error;       /* current error code */
  65     struct object      *request_fd;  /* fd for receiving client requests */
  66     int                 reply_fd;    /* fd to send a reply to a client */
  67     int                 wait_fd;     /* fd to use to wake a sleeping client */
  68     enum run_state      state;     /* running state */
  69     int                 attached;  /* is thread attached with ptrace? */
  70     int                 exit_code; /* thread exit code */
  71     int                 unix_pid;  /* Unix pid of client */
  72     CONTEXT            *context;   /* current context if in an exception handler */
  73     void               *teb;       /* TEB address (in client address space) */
  74     int                 priority;  /* priority level */
  75     int                 affinity;  /* affinity mask */
  76     int                 suspend;   /* suspend count */
  77     void               *buffer;    /* buffer for communication with the client */
  78 };
  79
  80 struct thread_snapshot
  81 {
  82     struct thread  *thread;    /* thread ptr */
  83     int             count;     /* thread refcount */
  84     int             priority;  /* priority class */
  85 };
  86
  87 extern struct thread *current;
  88
  89 /* thread functions */
  90
  91 extern struct thread *create_thread( int fd, struct process *process );
  92 extern struct thread *get_thread_from_id( void *id );
  93 extern struct thread *get_thread_from_handle( handle_t handle, unsigned int access );
  94 extern struct thread *get_thread_from_pid( int pid );
  95 extern int suspend_thread( struct thread *thread, int check_limit );
  96 extern int resume_thread( struct thread *thread );
  97 extern void suspend_all_threads( void );
  98 extern void resume_all_threads( void );
  99 extern int add_queue( struct object *obj, struct wait_queue_entry *entry );
 100 extern void remove_queue( struct object *obj, struct wait_queue_entry *entry );
 101 extern void kill_thread( struct thread *thread, int violent_death );
 102 extern void wake_up( struct object *obj, int max );
 103 extern int thread_queue_apc( struct thread *thread, struct object *owner, void *func,
 104                              enum apc_type type, int system, int nb_args, ... );
 105 extern void thread_cancel_apc( struct thread *thread, struct object *owner, int system );
 106 extern int thread_add_inflight_fd( struct thread *thread, int client, int server );
 107 extern int thread_get_inflight_fd( struct thread *thread, int client );
 108 extern struct thread_snapshot *thread_snap( int *count );
 109
 110 /* ptrace functions */
 111
 112 extern void sigchld_handler();
 113 extern void wait4_thread( struct thread *thread, int signal );
 114 extern void stop_thread( struct thread *thread );
 115 extern void continue_thread( struct thread *thread );
 116 extern void detach_thread( struct thread *thread, int sig );
 117 extern int suspend_for_ptrace( struct thread *thread );
 118 extern int read_thread_int( struct thread *thread, const int *addr, int *data );
 119 extern int write_thread_int( struct thread *thread, int *addr, int data, unsigned int mask );
 120 extern void *get_thread_ip( struct thread *thread );
 121
 122 extern unsigned int global_error;  /* global error code for when no thread is current */
 123
 124 static inline unsigned int get_error(void)       { return current ? current->error : global_error; }
 125 static inline void set_error( unsigned int err ) { global_error = err; if (current) current->error = err; }
 126 static inline void clear_error(void)    { set_error(0); }
 127
 128 static inline void *get_thread_id( struct thread *thread ) { return thread; }
 129
 130 #endif  /* __WINE_SERVER_THREAD_H */