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