Added support for cleaning up the TEB from inside the exiting thread.
[wine] / 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 "ntdef.h" /* UNICODE_STRING */
11 #include "wine/windef16.h"
12
13 struct _PDB;
14 struct __EXCEPTION_FRAME;
15 struct _SECURITY_ATTRIBUTES;
16 struct tagSYSLEVEL;
17 struct server_buffer_info;
18
19 /* Thread exception block
20
21   flags in the comment:
22   1-- win95 field
23   d-- win95 debug version
24   -2- nt field
25   --3 wine special
26   --n wine unused
27   !-- or -!- likely or observed  collision
28   more problems (collected from mailing list):
29   psapi.dll 0x10/0x30 (expects nt fields)
30   ie4       0x40
31   PESHiELD  0x23/0x30 (win95)
32 */
33 typedef struct _TEB
34 {
35 /* start of NT_TIB */
36     struct __EXCEPTION_FRAME *except; /* 12- 00 Head of exception handling chain */
37     void        *stack_top;      /* 12-  04 Top of thread stack */
38     void        *stack_low;      /* 12-  08 Stack low-water mark */
39     HTASK16      htask16;        /* 1--  0c Win16 task handle */
40     WORD         stack_sel;      /* 1--  0e 16-bit stack selector */
41     DWORD        selman_list;    /* 1-n  10 Selector manager list */
42     DWORD        user_ptr;       /* 12n  14 User pointer */
43 /* end of NT_TIB */  
44     struct _TEB *self;           /* 12-  18 Pointer to this structure */
45     WORD         tibflags;       /* 1!n  1c Flags (NT: EnvironmentPointer) */
46     WORD         mutex_count;    /* 1-n  1e Win16 mutex count */
47     void        *pid;            /* !2-  20 Process id (win95: debug context) */
48     void        *tid;            /* -2-  24 Thread id */
49     HQUEUE16     queue;          /* 1!-  28 Message queue (NT: DWORD ActiveRpcHandle)*/
50     WORD         pad1;           /* --n  2a */
51     LPVOID      *tls_ptr;        /* 1--  2c Pointer to TLS array */
52     struct _PDB *process;        /* 12-  30 owning process (win95: PDB; nt: NTPEB !!) */
53     DWORD        flags;          /* 1-n  34 */
54     DWORD        exit_code;      /* 1--  38 Termination status */
55     WORD         teb_sel;        /* 1--  3c Selector to TEB */
56     WORD         emu_sel;        /* 1-n  3e 80387 emulator selector */
57     DWORD        unknown1;       /* --n  40 */
58     DWORD        unknown2;       /* --n  44 */
59     void       (*startup)(void); /* --3  48 Thread startup routine */
60     int          thread_errno;   /* --3  4c Per-thread errno (was: ring0_thread) */
61     int          thread_h_errno; /* --3  50 Per-thread h_errno (was: ptr to tdbx structure) */
62     void        *stack_base;     /* 1--  54 Base of the stack */
63     void        *signal_stack;   /* --3  58 Signal stack (was: exit_stack) */
64     void        *emu_data;       /* --n  5c Related to 80387 emulation */
65     DWORD        last_error;     /* 1--  60 Last error code */
66     HANDLE       debug_cb;       /* 1-n  64 Debugger context block */
67     DWORD        debug_thread;   /* 1-n  68 Thread debugging this one (?) */
68     void        *pcontext;       /* 1-n  6c Thread register context */
69     DWORD        cur_stack;      /* --3  70 Current stack (was: unknown) */
70     DWORD        ThunkConnect;   /* 1-n  74 */
71     DWORD        NegStackBase;   /* 1-n  78 */
72     WORD         current_ss;     /* 1-n  7c Another 16-bit stack selector */
73     WORD         pad2;           /* --n  7e */
74     void        *ss_table;       /* --n  80 Pointer to info about 16-bit stack */
75     WORD         thunk_ss;       /* --n  84 Yet another 16-bit stack selector */
76     WORD         pad3;           /* --n  86 */
77     DWORD        pad4[15];       /* --n  88 */
78     ULONG        CurrentLocale;  /* -2-  C4 */
79     DWORD        pad5[48];       /* --n  C8 */
80     DWORD        delta_priority; /* 1-n 188 Priority delta */
81     DWORD        unknown4[7];    /* d-n 18c Unknown */
82     void        *create_data;    /* d-n 1a8 Pointer to creation structure */
83     DWORD        suspend_count;  /* d-n 1ac SuspendThread() counter */
84     void        *entry_point;    /* --3 1b0 Thread entry point (was: unknown) */
85     void        *entry_arg;      /* --3 1b4 Entry point arg (was: unknown) */
86     DWORD        unknown5[4];    /* --n 1b8 Unknown */
87     DWORD        sys_count[4];   /* --3 1c8 Syslevel mutex entry counters */
88     struct tagSYSLEVEL *sys_mutex[4];   /* --3 1d8 Syslevel mutex pointers */
89     DWORD        unknown6[5];    /* --n 1e8 Unknown */
90
91     /* The following are Wine-specific fields (NT: GDI stuff) */
92     DWORD        unused[4];      /* --3 1fc Was server buffer */
93     int          request_fd;     /* --3 20c fd for sending server requests */
94     int          reply_fd;       /* --3 210 fd for receiving server replies */
95     int          wait_fd[2];     /* --3 214 fd for sleeping server requests */
96     void        *debug_info;     /* --3 21c Info for debugstr functions */
97     void        *pthread_data;   /* --3 220 Data for pthread emulation */
98     struct async_private *pending_list;   /* --3 224 list of pending async operations */
99     void        *driver_data;    /* --3 228 Graphics driver private data */
100     DWORD        alarms;         /* --3 22c Data for vm86 mode */
101     DWORD        vm86_pending;   /* --3 230 Data for vm86 mode */
102     void        *vm86_ptr;       /* --3 234 Data for vm86 mode */
103     /* here is plenty space for wine specific fields (don't forget to change pad6!!) */
104
105     /* the following are nt specific fields */
106     DWORD        pad6[624];                  /* --n 238 */
107     UNICODE_STRING StaticUnicodeString;      /* -2- bf8 used by advapi32 */
108     USHORT       StaticUnicodeBuffer[261];   /* -2- c00 used by advapi32 */
109     DWORD        pad7;                       /* --n e0c */
110     LPVOID       tls_array[64];              /* -2- e10 Thread local storage */
111     DWORD        pad8[3];                    /* --n f10 */
112     PVOID        ReservedForNtRpc;           /* -2- f1c used by rpcrt4 */
113     DWORD        pad9[24];                   /* --n f20 */
114     PVOID        ErrorInfo;                  /* -2- f80 used by ole32 (IErrorInfo*) */
115 } TEB;
116
117 /* Thread exception flags */
118 #define TEBF_WIN32  0x0001
119 #define TEBF_TRAP   0x0002
120
121 /* The per-thread signal stack size */
122 #define SIGNAL_STACK_SIZE  16384
123
124
125 /* scheduler/thread.c */
126 extern void THREAD_Init(void);
127 extern TEB *THREAD_InitStack( TEB *teb, DWORD stack_size );
128 extern TEB *THREAD_IdToTEB( DWORD id );
129
130 /* scheduler/sysdeps.c */
131 extern int SYSDEPS_SpawnThread( TEB *teb );
132 extern void SYSDEPS_SetCurThread( TEB *teb );
133 extern void SYSDEPS_ExitThread( int status ) WINE_NORETURN;
134 extern void SYSDEPS_AbortThread( int status ) WINE_NORETURN;
135 extern void SYSDEPS_SwitchToThreadStack( void (*func)(void) ) WINE_NORETURN;
136
137 /* signal handling */
138 extern BOOL SIGNAL_Init(void);
139 extern void SIGNAL_Reset(void);
140
141 #endif  /* __WINE_THREAD_H */