usp10: Check that there are sufficient script_items before setting the last pointer.
[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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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 #ifdef __WINE_WINE_TEST_H
31 #error This file should not be used in Wine tests
32 #endif
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 /* configuration */
39
40 extern const char *wine_get_build_dir(void);
41 extern const char *wine_get_config_dir(void);
42 extern const char *wine_get_data_dir(void);
43 extern const char *wine_get_server_dir(void);
44 extern const char *wine_get_user_name(void);
45 extern const char *wine_get_version(void);
46 extern const char *wine_get_build_id(void);
47 extern void wine_init_argv0_path( const char *argv0 );
48 extern void wine_exec_wine_binary( const char *name, char **argv, const char *env_var );
49
50 /* dll loading */
51
52 typedef void (*load_dll_callback_t)( void *, const char * );
53
54 extern void *wine_dlopen( const char *filename, int flag, char *error, size_t errorsize );
55 extern void *wine_dlsym( void *handle, const char *symbol, char *error, size_t errorsize );
56 extern int wine_dlclose( void *handle, char *error, size_t errorsize );
57 extern void wine_dll_set_callback( load_dll_callback_t load );
58 extern void *wine_dll_load( const char *filename, char *error, int errorsize, int *file_exists );
59 extern void *wine_dll_load_main_exe( const char *name, char *error, int errorsize,
60                                      int test_only, int *file_exists );
61 extern void wine_dll_unload( void *handle );
62 extern const char *wine_dll_enum_load_path( unsigned int index );
63 extern int wine_dll_get_owner( const char *name, char *buffer, int size, int *file_exists );
64
65 extern int __wine_main_argc;
66 extern char **__wine_main_argv;
67 extern WCHAR **__wine_main_wargv;
68 extern void __wine_dll_register( const IMAGE_NT_HEADERS *header, const char *filename );
69 extern void wine_init( int argc, char *argv[], char *error, int error_size );
70
71 /* portability */
72
73 extern void DECLSPEC_NORETURN wine_switch_to_stack( void (*func)(void *), void *arg, void *stack );
74 extern int wine_call_on_stack( int (*func)(void *), void *arg, void *stack );
75
76 /* memory mappings */
77
78 extern void *wine_anon_mmap( void *start, size_t size, int prot, int flags );
79 extern void wine_mmap_add_reserved_area( void *addr, size_t size );
80 extern void wine_mmap_remove_reserved_area( void *addr, size_t size, int unmap );
81 extern int wine_mmap_is_in_reserved_area( void *addr, size_t size );
82 extern int wine_mmap_enum_reserved_areas( int (*enum_func)(void *base, size_t size, void *arg),
83                                           void *arg, int top_down );
84
85 #ifdef __i386__
86
87 /* LDT management */
88
89 extern void wine_ldt_init_locking( void (*lock_func)(void), void (*unlock_func)(void) );
90 extern void wine_ldt_get_entry( unsigned short sel, LDT_ENTRY *entry );
91 extern int wine_ldt_set_entry( unsigned short sel, const LDT_ENTRY *entry );
92 extern int wine_ldt_is_system( unsigned short sel );
93 extern void *wine_ldt_get_ptr( unsigned short sel, unsigned long offset );
94 extern unsigned short wine_ldt_alloc_entries( int count );
95 extern unsigned short wine_ldt_realloc_entries( unsigned short sel, int oldcount, int newcount );
96 extern void wine_ldt_free_entries( unsigned short sel, int count );
97 extern unsigned short wine_ldt_alloc_fs(void);
98 extern void wine_ldt_init_fs( unsigned short sel, const LDT_ENTRY *entry );
99 extern void wine_ldt_free_fs( unsigned short sel );
100
101 /* the local copy of the LDT */
102 extern struct __wine_ldt_copy
103 {
104     void         *base[8192];  /* base address or 0 if entry is free   */
105     unsigned long limit[8192]; /* limit in bytes or 0 if entry is free */
106     unsigned char flags[8192]; /* flags (defined below) */
107 } wine_ldt_copy;
108
109 #define WINE_LDT_FLAGS_DATA      0x13  /* Data segment */
110 #define WINE_LDT_FLAGS_STACK     0x17  /* Stack segment */
111 #define WINE_LDT_FLAGS_CODE      0x1b  /* Code segment */
112 #define WINE_LDT_FLAGS_TYPE_MASK 0x1f  /* Mask for segment type */
113 #define WINE_LDT_FLAGS_32BIT     0x40  /* Segment is 32-bit (code or stack) */
114 #define WINE_LDT_FLAGS_ALLOCATED 0x80  /* Segment is allocated (no longer free) */
115
116 /* helper functions to manipulate the LDT_ENTRY structure */
117 static inline void wine_ldt_set_base( LDT_ENTRY *ent, const void *base )
118 {
119     ent->BaseLow               = (WORD)(ULONG_PTR)base;
120     ent->HighWord.Bits.BaseMid = (BYTE)((ULONG_PTR)base >> 16);
121     ent->HighWord.Bits.BaseHi  = (BYTE)((ULONG_PTR)base >> 24);
122 }
123 static inline void wine_ldt_set_limit( LDT_ENTRY *ent, unsigned int limit )
124 {
125     if ((ent->HighWord.Bits.Granularity = (limit >= 0x100000))) limit >>= 12;
126     ent->LimitLow = (WORD)limit;
127     ent->HighWord.Bits.LimitHi = (limit >> 16);
128 }
129 static inline void *wine_ldt_get_base( const LDT_ENTRY *ent )
130 {
131     return (void *)(ent->BaseLow |
132                     (ULONG_PTR)ent->HighWord.Bits.BaseMid << 16 |
133                     (ULONG_PTR)ent->HighWord.Bits.BaseHi << 24);
134 }
135 static inline unsigned int wine_ldt_get_limit( const LDT_ENTRY *ent )
136 {
137     unsigned int limit = ent->LimitLow | (ent->HighWord.Bits.LimitHi << 16);
138     if (ent->HighWord.Bits.Granularity) limit = (limit << 12) | 0xfff;
139     return limit;
140 }
141 static inline void wine_ldt_set_flags( LDT_ENTRY *ent, unsigned char flags )
142 {
143     ent->HighWord.Bits.Dpl         = 3;
144     ent->HighWord.Bits.Pres        = 1;
145     ent->HighWord.Bits.Type        = flags;
146     ent->HighWord.Bits.Sys         = 0;
147     ent->HighWord.Bits.Reserved_0  = 0;
148     ent->HighWord.Bits.Default_Big = (flags & WINE_LDT_FLAGS_32BIT) != 0;
149 }
150 static inline unsigned char wine_ldt_get_flags( const LDT_ENTRY *ent )
151 {
152     unsigned char ret = ent->HighWord.Bits.Type;
153     if (ent->HighWord.Bits.Default_Big) ret |= WINE_LDT_FLAGS_32BIT;
154     return ret;
155 }
156 static inline int wine_ldt_is_empty( const LDT_ENTRY *ent )
157 {
158     const DWORD *dw = (const DWORD *)ent;
159     return (dw[0] | dw[1]) == 0;
160 }
161
162 /* segment register access */
163
164 # ifdef __MINGW32__
165 #  define __DEFINE_GET_SEG(seg) \
166     static inline unsigned short wine_get_##seg(void); \
167     static inline unsigned short wine_get_##seg(void) \
168     { unsigned short res; __asm__ __volatile__("movw %%" #seg ",%w0" : "=r"(res)); return res; }
169 #  define __DEFINE_SET_SEG(seg) \
170     static inline void wine_set_##seg(int val); \
171     static inline void wine_set_##seg(int val) { __asm__("movw %w0,%%" #seg : : "r" (val)); }
172 # elif defined(__GNUC__)
173 #  define __DEFINE_GET_SEG(seg) \
174     extern inline unsigned short wine_get_##seg(void); \
175     extern inline unsigned short wine_get_##seg(void) \
176     { unsigned short res; __asm__ __volatile__("movw %%" #seg ",%w0" : "=r"(res)); return res; }
177 #  define __DEFINE_SET_SEG(seg) \
178     extern inline void wine_set_##seg(int val); \
179     extern inline void wine_set_##seg(int val) { __asm__("movw %w0,%%" #seg : : "r" (val)); }
180 # elif defined(_MSC_VER)
181 #  define __DEFINE_GET_SEG(seg) \
182     extern inline unsigned short wine_get_##seg(void); \
183     extern inline unsigned short wine_get_##seg(void) \
184     { unsigned short res; __asm { mov res, seg } return res; }
185 #  define __DEFINE_SET_SEG(seg) \
186     extern inline void wine_set_##seg(unsigned short val); \
187     extern inline void wine_set_##seg(unsigned short val) { __asm { mov seg, val } }
188 # else  /* __GNUC__ || _MSC_VER */
189 #  define __DEFINE_GET_SEG(seg) extern unsigned short wine_get_##seg(void);
190 #  define __DEFINE_SET_SEG(seg) extern void wine_set_##seg(unsigned int);
191 # endif /* __GNUC__ || _MSC_VER */
192
193 __DEFINE_GET_SEG(cs)
194 __DEFINE_GET_SEG(ds)
195 __DEFINE_GET_SEG(es)
196 __DEFINE_GET_SEG(fs)
197 __DEFINE_GET_SEG(gs)
198 __DEFINE_GET_SEG(ss)
199 __DEFINE_SET_SEG(fs)
200 __DEFINE_SET_SEG(gs)
201 #undef __DEFINE_GET_SEG
202 #undef __DEFINE_SET_SEG
203
204 #endif  /* __i386__ */
205
206 #ifdef __cplusplus
207 }
208 #endif
209
210 #endif  /* __WINE_WINE_LIBRARY_H */