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