dlls/ntdll/ntdll_misc.h

   1 /*
   2  * Copyright 2000 Juergen Schmied
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifndef __WINE_NTDLL_MISC_H
  20 #define __WINE_NTDLL_MISC_H
  21
  22 #include <stdarg.h>
  23 #include <signal.h>
  24 #include <sys/types.h>
  25 #ifdef HAVE_PTHREAD_H
  26 # include <pthread.h>
  27 #endif
  28
  29 #include "windef.h"
  30 #include "winnt.h"
  31 #include "winternl.h"
  32 #include "wine/server.h"
  33
  34 #define MAX_NT_PATH_LENGTH 277
  35
  36 #define MAX_DOS_DRIVES 26
  37
  38 struct drive_info
  39 {
  40     dev_t dev;
  41     ino_t ino;
  42 };
  43
  44 /* exceptions */
  45 extern void wait_suspend( CONTEXT *context );
  46 extern void WINAPI __regs_RtlRaiseException( PEXCEPTION_RECORD, PCONTEXT );
  47 extern void set_cpu_context( const CONTEXT *context );
  48 extern void copy_context( CONTEXT *to, const CONTEXT *from, DWORD flags );
  49
  50 /* debug helpers */
  51 extern LPCSTR debugstr_us( const UNICODE_STRING *str );
  52 extern LPCSTR debugstr_ObjectAttributes(const OBJECT_ATTRIBUTES *oa);
  53
  54 extern NTSTATUS NTDLL_queue_process_apc( HANDLE process, const apc_call_t *call, apc_result_t *result );
  55 extern NTSTATUS NTDLL_wait_for_multiple_objects( UINT count, const HANDLE *handles, UINT flags,
  56                                                  const LARGE_INTEGER *timeout, HANDLE signal_object );
  57
  58 /* init routines */
  59 extern void signal_init_thread( TEB *teb );
  60 extern void signal_init_process(void);
  61 extern size_t get_signal_stack_total_size(void);
  62 extern void version_init( const WCHAR *appname );
  63 extern void debug_init(void);
  64 extern HANDLE thread_init(void);
  65 extern void actctx_init(void);
  66 extern void virtual_init(void);
  67 extern void virtual_init_threading(void);
  68
  69 /* server support */
  70 extern timeout_t server_start_time;
  71 extern void server_init_process(void);
  72 extern NTSTATUS server_init_process_done(void);
  73 extern size_t server_init_thread( void *entry_point );
  74 extern void DECLSPEC_NORETURN server_protocol_error( const char *err, ... );
  75 extern void DECLSPEC_NORETURN server_protocol_perror( const char *err );
  76 extern void DECLSPEC_NORETURN abort_thread( int status );
  77 extern sigset_t server_block_set;
  78 extern void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
  79 extern void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
  80 extern int server_remove_fd_from_cache( HANDLE handle );
  81 extern int server_get_unix_fd( HANDLE handle, unsigned int access, int *unix_fd,
  82                                int *needs_close, enum server_fd_type *type, unsigned int *options );
  83
  84 /* security descriptors */
  85 NTSTATUS NTDLL_create_struct_sd(PSECURITY_DESCRIPTOR nt_sd, struct security_descriptor **server_sd,
  86                                 data_size_t *server_sd_len);
  87 void NTDLL_free_struct_sd(struct security_descriptor *server_sd);
  88
  89 /* module handling */
  90 extern NTSTATUS MODULE_DllThreadAttach( LPVOID lpReserved );
  91 extern FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
  92                                      DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user );
  93 extern FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
  94                                      FARPROC origfun, DWORD ordinal, const WCHAR *user );
  95 extern void RELAY_SetupDLL( HMODULE hmod );
  96 extern void SNOOP_SetupDLL( HMODULE hmod );
  97 extern UNICODE_STRING windows_dir;
  98 extern UNICODE_STRING system_dir;
  99
 100 typedef LONG (WINAPI *PUNHANDLED_EXCEPTION_FILTER)(PEXCEPTION_POINTERS);
 101 extern PUNHANDLED_EXCEPTION_FILTER unhandled_exception_filter;
 102
 103 /* redefine these to make sure we don't reference kernel symbols */
 104 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
 105 #define GetCurrentProcessId()  (HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess))
 106 #define GetCurrentThreadId()   (HandleToULong(NtCurrentTeb()->ClientId.UniqueThread))
 107
 108 /* Device IO */
 109 extern NTSTATUS CDROM_DeviceIoControl(HANDLE hDevice,
 110                                       HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 111                                       PVOID UserApcContext,
 112                                       PIO_STATUS_BLOCK piosb,
 113                                       ULONG IoControlCode,
 114                                       LPVOID lpInBuffer, DWORD nInBufferSize,
 115                                       LPVOID lpOutBuffer, DWORD nOutBufferSize);
 116 extern NTSTATUS COMM_DeviceIoControl(HANDLE hDevice,
 117                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 118                                      PVOID UserApcContext,
 119                                      PIO_STATUS_BLOCK piosb,
 120                                      ULONG IoControlCode,
 121                                      LPVOID lpInBuffer, DWORD nInBufferSize,
 122                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
 123 extern NTSTATUS TAPE_DeviceIoControl(HANDLE hDevice,
 124                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 125                                      PVOID UserApcContext,
 126                                      PIO_STATUS_BLOCK piosb,
 127                                      ULONG IoControlCode,
 128                                      LPVOID lpInBuffer, DWORD nInBufferSize,
 129                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
 130
 131 /* file I/O */
 132 extern NTSTATUS FILE_GetNtStatus(void);
 133 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name );
 134 extern NTSTATUS DIR_unmount_device( HANDLE handle );
 135 extern NTSTATUS DIR_get_unix_cwd( char **cwd );
 136 extern unsigned int DIR_get_drives_info( struct drive_info info[MAX_DOS_DRIVES] );
 137
 138 /* virtual memory */
 139 extern void virtual_get_system_info( SYSTEM_BASIC_INFORMATION *info );
 140 extern NTSTATUS virtual_create_system_view( void *base, SIZE_T size, DWORD vprot );
 141 extern SIZE_T virtual_free_system_view( PVOID *addr_ptr );
 142 extern NTSTATUS virtual_alloc_thread_stack( TEB *teb, SIZE_T reserve_size, SIZE_T commit_size );
 143 extern void virtual_clear_thread_stack(void);
 144 extern BOOL virtual_handle_stack_fault( void *addr );
 145 extern NTSTATUS virtual_handle_fault( LPCVOID addr, DWORD err );
 146 extern BOOL virtual_check_buffer_for_read( const void *ptr, SIZE_T size );
 147 extern BOOL virtual_check_buffer_for_write( void *ptr, SIZE_T size );
 148 extern void VIRTUAL_SetForceExec( BOOL enable );
 149 extern void VIRTUAL_UseLargeAddressSpace(void);
 150 extern struct _KUSER_SHARED_DATA *user_shared_data;
 151
 152 /* completion */
 153 extern NTSTATUS NTDLL_AddCompletion( HANDLE hFile, ULONG_PTR CompletionValue,
 154                                      NTSTATUS CompletionStatus, ULONG Information );
 155
 156 /* code pages */
 157 extern int ntdll_umbstowcs(DWORD flags, const char* src, int srclen, WCHAR* dst, int dstlen);
 158 extern int ntdll_wcstoumbs(DWORD flags, const WCHAR* src, int srclen, char* dst, int dstlen,
 159                            const char* defchar, int *used );
 160
 161 extern int CDECL NTDLL__vsnprintf( char *str, SIZE_T len, const char *format, __ms_va_list args );
 162 extern int CDECL NTDLL__vsnwprintf( WCHAR *str, SIZE_T len, const WCHAR *format, __ms_va_list args );
 163
 164 /* load order */
 165
 166 enum loadorder
 167 {
 168     LO_INVALID,
 169     LO_DISABLED,
 170     LO_NATIVE,
 171     LO_BUILTIN,
 172     LO_NATIVE_BUILTIN,  /* native then builtin */
 173     LO_BUILTIN_NATIVE,  /* builtin then native */
 174     LO_DEFAULT          /* nothing specified, use default strategy */
 175 };
 176
 177 extern enum loadorder get_load_order( const WCHAR *app_name, const WCHAR *path );
 178
 179 struct debug_info
 180 {
 181     char *str_pos;       /* current position in strings buffer */
 182     char *out_pos;       /* current position in output buffer */
 183     char  strings[1024]; /* buffer for temporary strings */
 184     char  output[1024];  /* current output line */
 185 };
 186
 187 /* thread private data, stored in NtCurrentTeb()->SystemReserved2 */
 188 struct ntdll_thread_data
 189 {
 190     DWORD              fs;            /* 1d4 TEB selector */
 191     DWORD              gs;            /* 1d8 libc selector; update winebuild if you move this! */
 192     struct debug_info *debug_info;    /* 1dc info for debugstr functions */
 193     int                request_fd;    /* 1e0 fd for sending server requests */
 194     int                reply_fd;      /* 1e4 fd for receiving server replies */
 195     int                wait_fd[2];    /* 1e8 fd for sleeping server requests */
 196     void              *vm86_ptr;      /* 1f0 data for vm86 mode */
 197     void              *pthread_data;  /* 1f4 private data for pthread emulation */
 198     pthread_t          pthread_id;    /* 1f8 pthread thread id */
 199 };
 200
 201 static inline struct ntdll_thread_data *ntdll_get_thread_data(void)
 202 {
 203     return (struct ntdll_thread_data *)NtCurrentTeb()->SystemReserved2;
 204 }
 205
 206 /* thread debug_registers, stored in NtCurrentTeb()->SpareBytes1 */
 207 struct ntdll_thread_regs
 208 {
 209     DWORD dr0;
 210     DWORD dr1;
 211     DWORD dr2;
 212     DWORD dr3;
 213     DWORD dr6;
 214     DWORD dr7;
 215 };
 216
 217 static inline struct ntdll_thread_regs *ntdll_get_thread_regs(void)
 218 {
 219     return (struct ntdll_thread_regs *)NtCurrentTeb()->SpareBytes1;
 220 }
 221
 222 /* Register functions */
 223
 224 #ifdef __i386__
 225 #define DEFINE_REGS_ENTRYPOINT( name, args ) \
 226     __ASM_GLOBAL_FUNC( name, \
 227                        ".byte 0x68\n\t"  /* pushl $__regs_func */       \
 228                        ".long " __ASM_NAME("__regs_") #name "-.-11\n\t" \
 229                        ".byte 0x6a," #args "\n\t" /* pushl $args */     \
 230                        "call " __ASM_NAME("__wine_call_from_32_regs"))
 231 #elif defined(__x86_64__)
 232 #define DEFINE_REGS_ENTRYPOINT( name, args ) \
 233     __ASM_GLOBAL_FUNC( name, \
 234                        "movq %rcx,8(%rsp)\n\t"  \
 235                        "movq %rdx,16(%rsp)\n\t" \
 236                        "movq $" #args ",%rcx\n\t" \
 237                        "leaq " __ASM_NAME("__regs_") #name "(%rip),%rdx\n\t" \
 238                        "call " __ASM_NAME("__wine_call_from_regs"))
 239 #endif
 240
 241 #endif