include/thread.h

   1 /*
   2  * Thread definitions
   3  *
   4  * Copyright 1996 Alexandre Julliard
   5  */
   6
   7 #ifndef __WINE_THREAD_H
   8 #define __WINE_THREAD_H
   9
  10 #include "k32obj.h"
  11 #include "windows.h"
  12 #include "winbase.h"
  13 #include "winnt.h"
  14 #include "selectors.h"  /* for SET_FS */
  15
  16 struct _PDB32;
  17
  18 /* Thread exception block */
  19 typedef struct _TEB
  20 {
  21     void        *except;         /* 00 Head of exception handling chain */
  22     void        *stack_top;      /* 04 Top of thread stack */
  23     void        *stack_low;      /* 08 Stack low-water mark */
  24     HTASK16      htask16;        /* 0c Win16 task handle */
  25     WORD         stack_sel;      /* 0e 16-bit stack selector */
  26     DWORD        selman_list;    /* 10 Selector manager list */
  27     DWORD        user_ptr;       /* 14 User pointer */
  28     struct _TEB *self;           /* 18 Pointer to this structure */
  29     WORD         flags;          /* 1c Flags */
  30     WORD         mutex_count;    /* 1e Win16 mutex count */
  31     DWORD        debug_context;  /* 20 Debug context */
  32     DWORD       *ppriority;      /* 24 Pointer to current priority */
  33     HQUEUE16     queue;          /* 28 Message queue */
  34     WORD         pad1;           /* 2a */
  35     LPVOID      *tls_ptr;        /* 2c Pointer to TLS array */
  36     struct _PDB32 *process;      /* 30 owning process (used by NT3.51 applets)*/
  37 } TEB;
  38
  39 /* Event waiting structure */
  40 typedef struct
  41 {
  42     DWORD         count;     /* Count of valid objects */
  43     DWORD         signaled;  /* Index of signaled object (or WAIT_FAILED)*/
  44     BOOL32        wait_all;  /* Wait for all objects flag */
  45     BOOL32        wait_msg;  /* Wait for message flag */
  46     K32OBJ       *objs[MAXIMUM_WAIT_OBJECTS];  /* Object pointers */
  47     int           server[MAXIMUM_WAIT_OBJECTS];  /* Server handles */
  48 } WAIT_STRUCT;
  49
  50 /* Thread database */
  51 typedef struct _THDB
  52 {
  53     K32OBJ         header;         /*  00 Kernel object header */
  54     struct _PDB32 *process;        /*  08 Process owning this thread */
  55     K32OBJ        *event;          /*  0c Thread event */
  56     TEB            teb;            /*  10 Thread exception block */
  57     DWORD          flags;          /*  44 Flags */
  58     DWORD          exit_code;      /*  48 Termination status */
  59     WORD           teb_sel;        /*  4c Selector to TEB */
  60     WORD           emu_sel;        /*  4e 80387 emulator selector */
  61     int            thread_errno;   /*  50 Per-thread errno (was: unknown) */
  62     WAIT_STRUCT   *wait_list;      /*  54 Event waiting list */
  63     int            thread_h_errno; /*  50 Per-thread h_errno (was: unknown) */
  64     void          *ring0_thread;   /*  5c Pointer to ring 0 thread */
  65     void          *ptdbx;          /*  60 Pointer to TDBX structure */
  66     void          *stack_base;     /*  64 Base of the stack */
  67     void          *exit_stack;     /*  68 Stack pointer on thread exit */
  68     void          *emu_data;       /*  6c Related to 80387 emulation */
  69     DWORD          last_error;     /*  70 Last error code */
  70     void          *debugger_CB;    /*  74 Debugger context block */
  71     DWORD          debug_thread;   /*  78 Thread debugging this one (?) */
  72     void          *pcontext;       /*  7c Thread register context */
  73     DWORD          cur_stack;      /*  80 Current stack (was: unknown) */
  74     DWORD          unknown3[2];    /*  84 Unknown */
  75     WORD           current_ss;     /*  8c Another 16-bit stack selector */
  76     WORD           pad2;           /*  8e */
  77     void          *ss_table;       /*  90 Pointer to info about 16-bit stack */
  78     WORD           thunk_ss;       /*  94 Yet another 16-bit stack selector */
  79     WORD           pad3;           /*  96 */
  80     LPVOID         tls_array[64];  /*  98 Thread local storage */
  81     DWORD          delta_priority; /* 198 Priority delta */
  82     DWORD          unknown4[7];    /* 19c Unknown */
  83     void          *create_data;    /* 1b8 Pointer to creation structure */
  84     DWORD          suspend_count;  /* 1bc SuspendThread() counter */
  85     void          *entry_point;    /* 1c0 Thread entry point (was: unknown) */
  86     void          *entry_arg;      /* 1c4 Entry point arg (was: unknown) */
  87     int            unix_pid;       /* 1c8 Unix thread pid (was: unknown) */
  88     K32OBJ        *mutex_list;     /* 1cc List of owned mutex (was: unknown)*/
  89     DWORD          unknown5[2];    /* 1d0 Unknown */
  90     DWORD          sys_count[4];   /* 1d8 Syslevel mutex entry counters */
  91     CRITICAL_SECTION *sys_mutex[4];/* 1e8 Syslevel mutex pointers */
  92     DWORD          unknown6[2];    /* 1f8 Unknown */
  93     /* The following are Wine-specific fields */
  94     CONTEXT        context;        /* 200 Thread context */
  95     WAIT_STRUCT    wait_struct;    /*     Event wait structure */
  96     int            socket;         /*     Socket for server communication */
  97     unsigned int   seq;            /*     Server sequence number */
  98     void          *server_tid;     /*     Server id for this thread */
  99 } THDB;
 100
 101 /* Thread queue entry */
 102 typedef struct _THREAD_ENTRY
 103 {
 104     THDB                 *thread;
 105     struct _THREAD_ENTRY *next;
 106 } THREAD_ENTRY;
 107
 108 /* A thread queue is a circular list; a THREAD_QUEUE is a pointer */
 109 /* to the end of the queue (i.e. where we add elements) */
 110 typedef THREAD_ENTRY *THREAD_QUEUE;
 111
 112 /* THDB <-> Thread id conversion macros */
 113 #define THREAD_OBFUSCATOR       ((DWORD)0xdeadbeef)
 114 #define THREAD_ID_TO_THDB(id)   ((THDB *)((id) ^ THREAD_OBFUSCATOR))
 115 #define THDB_TO_THREAD_ID(thdb) ((DWORD)(thdb) ^ THREAD_OBFUSCATOR)
 116
 117 #ifdef __i386__
 118 /* On the i386, the current thread is in the %fs register */
 119 # define SET_CUR_THREAD(thdb) SET_FS((thdb)->teb_sel)
 120 #else
 121 extern THDB *pCurrentThread;
 122 # define SET_CUR_THREAD(thdb) (pCurrentThread = (thdb))
 123 #endif  /* __i386__ */
 124
 125
 126 /* scheduler/thread.c */
 127 extern THDB *THREAD_Create( struct _PDB32 *pdb, DWORD stack_size,
 128                             BOOL32 alloc_stack16,
 129                             int *server_thandle, int *server_phandle,
 130                             LPTHREAD_START_ROUTINE start_addr, LPVOID param );
 131 extern THDB *THREAD_Current(void);
 132 extern BOOL32 THREAD_IsWin16( THDB *thdb );
 133 extern void THREAD_Start( THDB *thdb );
 134 extern THDB *THREAD_GetPtr( HANDLE32 handle, DWORD access, int *server_handle );
 135 extern void THREAD_AddQueue( THREAD_QUEUE *queue, THDB *thread );
 136 extern void THREAD_RemoveQueue( THREAD_QUEUE *queue, THDB *thread );
 137 extern DWORD THREAD_TlsAlloc( THDB *thread );
 138
 139 /* scheduler/event.c */
 140 extern void EVENT_Set( K32OBJ *obj );
 141 extern K32OBJ *EVENT_Create( BOOL32 manual_reset, BOOL32 initial_state );
 142
 143 /* scheduler/mutex.c */
 144 extern void MUTEX_Abandon( K32OBJ *obj );
 145
 146 /* scheduler/synchro.c */
 147 extern void SYNC_WaitForCondition( WAIT_STRUCT *wait, DWORD timeout );
 148 extern void SYNC_WakeUp( THREAD_QUEUE *queue, DWORD max );
 149 extern void SYNC_MsgWakeUp( THDB *thdb );
 150 extern void SYNC_SetupSignals(void);
 151 extern DWORD SYNC_DoWait( DWORD count, const HANDLE32 *handles,
 152                           BOOL32 wait_all, DWORD timeout,
 153                           BOOL32 alertable, BOOL32 wait_msg );
 154
 155
 156 /* scheduler/sysdeps.c */
 157 extern int SYSDEPS_SpawnThread( THDB *thread );
 158 extern void SYSDEPS_ExitThread(void);
 159 extern TEB * WINAPI NtCurrentTeb(void);
 160
 161 #endif  /* __WINE_THREAD_H */