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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef __WINE_SERVER_THREAD_H
  22 #define __WINE_SERVER_THREAD_H
  23
  24 #include "object.h"
  25
  26 /* thread structure */
  27
  28 struct process;
  29 struct thread_wait;
  30 struct thread_apc;
  31 struct debug_ctx;
  32 struct debug_event;
  33 struct msg_queue;
  34
  35 enum run_state
  36 {
  37     RUNNING,    /* running normally */
  38     TERMINATED  /* terminated */
  39 };
  40
  41 /* descriptor for fds currently in flight from client to server */
  42 struct inflight_fd
  43 {
  44     int client;  /* fd on the client side (or -1 if entry is free) */
  45     int server;  /* fd on the server side */
  46 };
  47 #define MAX_INFLIGHT_FDS 16  /* max number of fds in flight per thread */
  48
  49 struct thread
  50 {
  51     struct object          obj;           /* object header */
  52     struct list            entry;         /* entry in system-wide thread list */
  53     struct list            proc_entry;    /* entry in per-process thread list */
  54     struct process        *process;
  55     thread_id_t            id;            /* thread id */
  56     struct list            mutex_list;    /* list of currently owned mutexes */
  57     struct debug_ctx      *debug_ctx;     /* debugger context if this thread is a debugger */
  58     unsigned int           system_regs;   /* which system regs have been set */
  59     struct msg_queue      *queue;         /* message queue */
  60     struct thread_wait    *wait;          /* current wait condition if sleeping */
  61     struct list            system_apc;    /* queue of system async procedure calls */
  62     struct list            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     union generic_request  req;           /* current request */
  66     void                  *req_data;      /* variable-size data for request */
  67     unsigned int           req_toread;    /* amount of data still to read in request */
  68     void                  *reply_data;    /* variable-size data for reply */
  69     unsigned int           reply_size;    /* size of reply data */
  70     unsigned int           reply_towrite; /* amount of data still to write in reply */
  71     struct fd             *request_fd;    /* fd for receiving client requests */
  72     struct fd             *reply_fd;      /* fd to send a reply to a client */
  73     struct fd             *wait_fd;       /* fd to use to wake a sleeping client */
  74     enum run_state         state;         /* running state */
  75     int                    exit_code;     /* thread exit code */
  76     int                    unix_pid;      /* Unix pid of client */
  77     int                    unix_tid;      /* Unix tid of client */
  78     context_t             *context;       /* current context if in an exception handler */
  79     context_t             *suspend_context; /* current context if suspended */
  80     client_ptr_t           teb;           /* TEB address (in client address space) */
  81     client_ptr_t           entry_point;   /* entry point (in client address space) */
  82     affinity_t             affinity;      /* affinity mask */
  83     int                    priority;      /* priority level */
  84     int                    suspend;       /* suspend count */
  85     obj_handle_t           desktop;       /* desktop handle */
  86     int                    desktop_users; /* number of objects using the thread desktop */
  87     timeout_t              creation_time; /* Thread creation time */
  88     timeout_t              exit_time;     /* Thread exit time */
  89     struct token          *token;         /* security token associated with this thread */
  90     struct list            kernel_object; /* list of kernel object pointers */
  91     data_size_t            desc_len;      /* thread description length in bytes */
  92     WCHAR                 *desc;          /* thread description string */
  93 };
  94
  95 struct thread_snapshot
  96 {
  97     struct thread  *thread;    /* thread ptr */
  98     int             count;     /* thread refcount */
  99     int             priority;  /* priority class */
 100 };
 101
 102 extern struct thread *current;
 103
 104 /* thread functions */
 105
 106 extern struct thread *create_thread( int fd, struct process *process,
 107                                      const struct security_descriptor *sd );
 108 extern struct thread *get_thread_from_id( thread_id_t id );
 109 extern struct thread *get_thread_from_handle( obj_handle_t handle, unsigned int access );
 110 extern struct thread *get_thread_from_tid( int tid );
 111 extern struct thread *get_thread_from_pid( int pid );
 112 extern struct thread *get_wait_queue_thread( struct wait_queue_entry *entry );
 113 extern enum select_op get_wait_queue_select_op( struct wait_queue_entry *entry );
 114 extern client_ptr_t get_wait_queue_key( struct wait_queue_entry *entry );
 115 extern void make_wait_abandoned( struct wait_queue_entry *entry );
 116 extern void stop_thread( struct thread *thread );
 117 extern void stop_thread_if_suspended( struct thread *thread );
 118 extern int wake_thread( struct thread *thread );
 119 extern int wake_thread_queue_entry( struct wait_queue_entry *entry );
 120 extern int add_queue( struct object *obj, struct wait_queue_entry *entry );
 121 extern void remove_queue( struct object *obj, struct wait_queue_entry *entry );
 122 extern void kill_thread( struct thread *thread, int violent_death );
 123 extern void wake_up( struct object *obj, int max );
 124 extern int thread_queue_apc( struct process *process, struct thread *thread, struct object *owner, const apc_call_t *call_data );
 125 extern void thread_cancel_apc( struct thread *thread, struct object *owner, enum apc_type type );
 126 extern int thread_add_inflight_fd( struct thread *thread, int client, int server );
 127 extern int thread_get_inflight_fd( struct thread *thread, int client );
 128 extern struct thread_snapshot *thread_snap( int *count );
 129 extern struct token *thread_get_impersonation_token( struct thread *thread );
 130 extern int set_thread_affinity( struct thread *thread, affinity_t affinity );
 131 extern int is_cpu_supported( enum cpu_type cpu );
 132 extern unsigned int get_supported_cpu_mask(void);
 133 extern int suspend_thread( struct thread *thread );
 134 extern int resume_thread( struct thread *thread );
 135
 136 /* ptrace functions */
 137
 138 extern void sigchld_callback(void);
 139 extern void init_thread_context( struct thread *thread );
 140 extern void get_thread_context( struct thread *thread, context_t *context, unsigned int flags );
 141 extern void set_thread_context( struct thread *thread, const context_t *context, unsigned int flags );
 142 extern int send_thread_signal( struct thread *thread, int sig );
 143 extern void get_selector_entry( struct thread *thread, int entry, unsigned int *base,
 144                                 unsigned int *limit, unsigned char *flags );
 145
 146 extern unsigned int global_error;  /* global error code for when no thread is current */
 147
 148 static inline unsigned int get_error(void)       { return current ? current->error : global_error; }
 149 static inline void set_error( unsigned int err ) { global_error = err; if (current) current->error = err; }
 150 static inline void clear_error(void)             { set_error(0); }
 151 static inline void set_win32_error( unsigned int err ) { set_error( 0xc0010000 | err ); }
 152
 153 static inline thread_id_t get_thread_id( struct thread *thread ) { return thread->id; }
 154
 155 #endif  /* __WINE_SERVER_THREAD_H */