server/thread.h

   1 /*
   2  * Wine server threads
   3  *
   4  * Copyright (C) 1998 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef __WINE_SERVER_THREAD_H
  22 #define __WINE_SERVER_THREAD_H
  23
  24 #include "object.h"
  25 #include "ntstatus.h"
  26
  27 /* thread structure */
  28
  29 struct process;
  30 struct thread_wait;
  31 struct thread_apc;
  32 struct mutex;
  33 struct debug_ctx;
  34 struct debug_event;
  35 struct msg_queue;
  36
  37 enum run_state
  38 {
  39     RUNNING,    /* running normally */
  40     TERMINATED  /* terminated */
  41 };
  42
  43 struct apc_queue
  44 {
  45     struct thread_apc *head;
  46     struct thread_apc *tail;
  47 };
  48
  49 /* descriptor for fds currently in flight from client to server */
  50 struct inflight_fd
  51 {
  52     int client;  /* fd on the client side (or -1 if entry is free) */
  53     int server;  /* fd on the server side */
  54 };
  55 #define MAX_INFLIGHT_FDS 16  /* max number of fds in flight per thread */
  56
  57 struct thread
  58 {
  59     struct object          obj;           /* object header */
  60     struct thread         *next;          /* system-wide thread list */
  61     struct thread         *prev;
  62     struct thread         *proc_next;     /* per-process thread list */
  63     struct thread         *proc_prev;
  64     struct process        *process;
  65     thread_id_t            id;            /* thread id */
  66     struct mutex          *mutex;         /* list of currently owned mutexes */
  67     struct debug_ctx      *debug_ctx;     /* debugger context if this thread is a debugger */
  68     struct debug_event    *debug_event;   /* debug event being sent to debugger */
  69     struct msg_queue      *queue;         /* message queue */
  70     struct thread_wait    *wait;          /* current wait condition if sleeping */
  71     struct apc_queue       system_apc;    /* queue of system async procedure calls */
  72     struct apc_queue       user_apc;      /* queue of user async procedure calls */
  73     struct inflight_fd     inflight[MAX_INFLIGHT_FDS];  /* fds currently in flight */
  74     unsigned int           error;         /* current error code */
  75     union generic_request  req;           /* current request */
  76     void                  *req_data;      /* variable-size data for request */
  77     unsigned int           req_toread;    /* amount of data still to read in request */
  78     void                  *reply_data;    /* variable-size data for reply */
  79     unsigned int           reply_size;    /* size of reply data */
  80     unsigned int           reply_towrite; /* amount of data still to write in reply */
  81     struct fd             *request_fd;    /* fd for receiving client requests */
  82     struct fd             *reply_fd;      /* fd to send a reply to a client */
  83     struct fd             *wait_fd;       /* fd to use to wake a sleeping client */
  84     enum run_state         state;         /* running state */
  85     int                    attached;      /* is thread attached with ptrace? */
  86     int                    exit_code;     /* thread exit code */
  87     int                    unix_pid;      /* Unix pid of client */
  88     int                    unix_tid;      /* Unix tid of client */
  89     CONTEXT               *context;       /* current context if in an exception handler */
  90     void                  *teb;           /* TEB address (in client address space) */
  91     int                    priority;      /* priority level */
  92     int                    affinity;      /* affinity mask */
  93     int                    suspend;       /* suspend count */
  94     time_t                 creation_time; /* Thread creation time */
  95     time_t                 exit_time;     /* Thread exit time */
  96     struct token          *token;         /* security token associated with this thread */
  97 };
  98
  99 struct thread_snapshot
 100 {
 101     struct thread  *thread;    /* thread ptr */
 102     int             count;     /* thread refcount */
 103     int             priority;  /* priority class */
 104 };
 105
 106 extern struct thread *current;
 107
 108 /* thread functions */
 109
 110 extern struct thread *create_thread( int fd, struct process *process );
 111 extern struct thread *get_thread_from_id( thread_id_t id );
 112 extern struct thread *get_thread_from_handle( obj_handle_t handle, unsigned int access );
 113 extern struct thread *get_thread_from_pid( int pid );
 114 extern void stop_thread( struct thread *thread );
 115 extern int wake_thread( struct thread *thread );
 116 extern int add_queue( struct object *obj, struct wait_queue_entry *entry );
 117 extern void remove_queue( struct object *obj, struct wait_queue_entry *entry );
 118 extern void kill_thread( struct thread *thread, int violent_death );
 119 extern void wake_up( struct object *obj, int max );
 120 extern int thread_queue_apc( struct thread *thread, struct object *owner, void *func,
 121                              enum apc_type type, int system, void *arg1, void *arg2, void *arg3 );
 122 extern void thread_cancel_apc( struct thread *thread, struct object *owner, int system );
 123 extern int thread_add_inflight_fd( struct thread *thread, int client, int server );
 124 extern int thread_get_inflight_fd( struct thread *thread, int client );
 125 extern struct thread_snapshot *thread_snap( int *count );
 126
 127 /* ptrace functions */
 128
 129 extern void sigchld_callback(void);
 130 extern int get_ptrace_pid( struct thread *thread );
 131 extern void detach_thread( struct thread *thread, int sig );
 132 extern int attach_process( struct process *process );
 133 extern void detach_process( struct process *process );
 134 extern int suspend_for_ptrace( struct thread *thread );
 135 extern void resume_after_ptrace( struct thread *thread );
 136 extern int read_thread_int( struct thread *thread, const int *addr, int *data );
 137 extern int write_thread_int( struct thread *thread, int *addr, int data, unsigned int mask );
 138 extern void *get_thread_ip( struct thread *thread );
 139 extern int get_thread_single_step( struct thread *thread );
 140 extern int tkill( int pid, int sig );
 141 extern int send_thread_signal( struct thread *thread, int sig );
 142
 143 extern unsigned int global_error;  /* global error code for when no thread is current */
 144
 145 static inline unsigned int get_error(void)       { return current ? current->error : global_error; }
 146 static inline void set_error( unsigned int err ) { global_error = err; if (current) current->error = err; }
 147 static inline void clear_error(void)    { set_error(0); }
 148
 149 static inline thread_id_t get_thread_id( struct thread *thread ) { return thread->id; }
 150
 151 #endif  /* __WINE_SERVER_THREAD_H */