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