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