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