Fixed Get/SetThreadContext to work properly on suspended threads.
[wine] / include / wine / library.h
1 /*
2  * Definitions for the Wine library
3  *
4  * Copyright 2000 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #ifndef __WINE_WINE_LIBRARY_H
22 #define __WINE_WINE_LIBRARY_H
23
24 #include <stdarg.h>
25 #include <sys/types.h>
26
27 #include <windef.h>
28 #include <winbase.h>
29
30 /* configuration */
31
32 extern const char *wine_get_config_dir(void);
33 extern const char *wine_get_server_dir(void);
34 extern const char *wine_get_user_name(void);
35 extern void wine_init_argv0_path( const char *argv0 );
36 extern void wine_exec_wine_binary( const char *name, char **argv, char **envp, int use_preloader );
37
38 /* dll loading */
39
40 typedef void (*load_dll_callback_t)( void *, const char * );
41
42 extern void *wine_dlopen( const char *filename, int flag, char *error, size_t errorsize );
43 extern void *wine_dlsym( void *handle, const char *symbol, char *error, size_t errorsize );
44 extern int wine_dlclose( void *handle, char *error, size_t errorsize );
45 extern void wine_dll_set_callback( load_dll_callback_t load );
46 extern void *wine_dll_load( const char *filename, char *error, int errorsize, int *file_exists );
47 extern void *wine_dll_load_main_exe( const char *name, char *error, int errorsize,
48                                      int test_only, int *file_exists );
49 extern void wine_dll_unload( void *handle );
50 extern int wine_dll_get_owner( const char *name, char *buffer, int size, int *file_exists );
51
52 extern int __wine_main_argc;
53 extern char **__wine_main_argv;
54 extern WCHAR **__wine_main_wargv;
55 extern char **__wine_main_environ;
56 extern void __wine_dll_register( const IMAGE_NT_HEADERS *header, const char *filename );
57 extern void wine_init( int argc, char *argv[], char *error, int error_size );
58
59 /* portability */
60
61 extern void DECLSPEC_NORETURN wine_switch_to_stack( void (*func)(void *), void *arg, void *stack );
62 extern void wine_set_pe_load_area( void *base, size_t size );
63 extern void wine_free_pe_load_area(void);
64
65 /* memory mappings */
66
67 extern void *wine_anon_mmap( void *start, size_t size, int prot, int flags );
68 extern void wine_mmap_add_reserved_area( void *addr, size_t size );
69 extern void wine_mmap_remove_reserved_area( void *addr, size_t size, int unmap );
70 extern int wine_mmap_is_in_reserved_area( void *addr, size_t size );
71
72 /* LDT management */
73
74 extern void wine_ldt_init_locking( void (*lock_func)(void), void (*unlock_func)(void) );
75 extern void wine_ldt_get_entry( unsigned short sel, LDT_ENTRY *entry );
76 extern int wine_ldt_set_entry( unsigned short sel, const LDT_ENTRY *entry );
77 extern int wine_ldt_is_system( unsigned short sel );
78 extern void *wine_ldt_get_ptr( unsigned short sel, unsigned long offset );
79 extern unsigned short wine_ldt_alloc_entries( int count );
80 extern unsigned short wine_ldt_realloc_entries( unsigned short sel, int oldcount, int newcount );
81 extern void wine_ldt_free_entries( unsigned short sel, int count );
82 #ifdef __i386__
83 extern unsigned short wine_ldt_alloc_fs(void);
84 extern void wine_ldt_init_fs( unsigned short sel, const LDT_ENTRY *entry );
85 extern void wine_ldt_free_fs( unsigned short sel );
86 #else  /* __i386__ */
87 static inline unsigned short wine_ldt_alloc_fs(void) { return 0x0b; /* pseudo GDT selector */ }
88 static inline void wine_ldt_init_fs( unsigned short sel, const LDT_ENTRY *entry ) { }
89 static inline void wine_ldt_free_fs( unsigned short sel ) { }
90 #endif  /* __i386__ */
91
92
93 /* the local copy of the LDT */
94 #ifdef __CYGWIN__
95 # ifdef WINE_EXPORT_LDT_COPY
96 #  define WINE_LDT_EXTERN __declspec(dllexport)
97 # else
98 #  define WINE_LDT_EXTERN __declspec(dllimport)
99 # endif
100 #else
101 # define WINE_LDT_EXTERN extern
102 #endif
103
104 WINE_LDT_EXTERN struct __wine_ldt_copy
105 {
106     void         *base[8192];  /* base address or 0 if entry is free   */
107     unsigned long limit[8192]; /* limit in bytes or 0 if entry is free */
108     unsigned char flags[8192]; /* flags (defined below) */
109 } wine_ldt_copy;
110
111 #define WINE_LDT_FLAGS_DATA      0x13  /* Data segment */
112 #define WINE_LDT_FLAGS_STACK     0x17  /* Stack segment */
113 #define WINE_LDT_FLAGS_CODE      0x1b  /* Code segment */
114 #define WINE_LDT_FLAGS_TYPE_MASK 0x1f  /* Mask for segment type */
115 #define WINE_LDT_FLAGS_32BIT     0x40  /* Segment is 32-bit (code or stack) */
116 #define WINE_LDT_FLAGS_ALLOCATED 0x80  /* Segment is allocated (no longer free) */
117
118 /* helper functions to manipulate the LDT_ENTRY structure */
119 inline static void wine_ldt_set_base( LDT_ENTRY *ent, const void *base )
120 {
121     ent->BaseLow               = (WORD)(unsigned long)base;
122     ent->HighWord.Bits.BaseMid = (BYTE)((unsigned long)base >> 16);
123     ent->HighWord.Bits.BaseHi  = (BYTE)((unsigned long)base >> 24);
124 }
125 inline static void wine_ldt_set_limit( LDT_ENTRY *ent, unsigned int limit )
126 {
127     if ((ent->HighWord.Bits.Granularity = (limit >= 0x100000))) limit >>= 12;
128     ent->LimitLow = (WORD)limit;
129     ent->HighWord.Bits.LimitHi = (limit >> 16);
130 }
131 inline static void *wine_ldt_get_base( const LDT_ENTRY *ent )
132 {
133     return (void *)(ent->BaseLow |
134                     (unsigned long)ent->HighWord.Bits.BaseMid << 16 |
135                     (unsigned long)ent->HighWord.Bits.BaseHi << 24);
136 }
137 inline static unsigned int wine_ldt_get_limit( const LDT_ENTRY *ent )
138 {
139     unsigned int limit = ent->LimitLow | (ent->HighWord.Bits.LimitHi << 16);
140     if (ent->HighWord.Bits.Granularity) limit = (limit << 12) | 0xfff;
141     return limit;
142 }
143 inline static void wine_ldt_set_flags( LDT_ENTRY *ent, unsigned char flags )
144 {
145     ent->HighWord.Bits.Dpl         = 3;
146     ent->HighWord.Bits.Pres        = 1;
147     ent->HighWord.Bits.Type        = flags;
148     ent->HighWord.Bits.Sys         = 0;
149     ent->HighWord.Bits.Reserved_0  = 0;
150     ent->HighWord.Bits.Default_Big = (flags & WINE_LDT_FLAGS_32BIT) != 0;
151 }
152 inline static unsigned char wine_ldt_get_flags( const LDT_ENTRY *ent )
153 {
154     unsigned char ret = ent->HighWord.Bits.Type;
155     if (ent->HighWord.Bits.Default_Big) ret |= WINE_LDT_FLAGS_32BIT;
156     return ret;
157 }
158 inline static int wine_ldt_is_empty( const LDT_ENTRY *ent )
159 {
160     const DWORD *dw = (const DWORD *)ent;
161     return (dw[0] | dw[1]) == 0;
162 }
163
164 /* segment register access */
165
166 #ifdef __i386__
167 # ifdef __GNUC__
168 #  define __DEFINE_GET_SEG(seg) \
169     extern inline unsigned short wine_get_##seg(void); \
170     extern inline unsigned short wine_get_##seg(void) \
171     { unsigned short res; __asm__("movw %%" #seg ",%w0" : "=r"(res)); return res; }
172 #  define __DEFINE_SET_SEG(seg) \
173     extern inline void wine_set_##seg(int val); \
174     extern inline void wine_set_##seg(int val) { __asm__("movw %w0,%%" #seg : : "r" (val)); }
175 # elif defined(_MSC_VER)
176 #  define __DEFINE_GET_SEG(seg) \
177     extern inline unsigned short wine_get_##seg(void); \
178     extern inline unsigned short wine_get_##seg(void) \
179     { unsigned short res; __asm { mov res, seg } return res; }
180 #  define __DEFINE_SET_SEG(seg) \
181     extern inline void wine_set_##seg(unsigned short val); \
182     extern inline void wine_set_##seg(unsigned short val) { __asm { mov seg, val } }
183 # else  /* __GNUC__ || _MSC_VER */
184 #  define __DEFINE_GET_SEG(seg) extern unsigned short wine_get_##seg(void);
185 #  define __DEFINE_SET_SEG(seg) extern void wine_set_##seg(unsigned int);
186 # endif /* __GNUC__ || _MSC_VER */
187 #else  /* __i386__ */
188 # define __DEFINE_GET_SEG(seg) inline static unsigned short wine_get_##seg(void) { return 0; }
189 # define __DEFINE_SET_SEG(seg) inline static void wine_set_##seg(int val) { /* nothing */ }
190 #endif  /* __i386__ */
191
192 __DEFINE_GET_SEG(cs)
193 __DEFINE_GET_SEG(ds)
194 __DEFINE_GET_SEG(es)
195 __DEFINE_GET_SEG(fs)
196 __DEFINE_GET_SEG(gs)
197 __DEFINE_GET_SEG(ss)
198 __DEFINE_SET_SEG(fs)
199 __DEFINE_SET_SEG(gs)
200 #undef __DEFINE_GET_SEG
201 #undef __DEFINE_SET_SEG
202
203 #endif  /* __WINE_WINE_LIBRARY_H */