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 #include <pthread.h>
  26
  27 #include "windef.h"
  28 #include "winnt.h"
  29 #include "winternl.h"
  30 #include "wine/server.h"
  31
  32 #define MAX_NT_PATH_LENGTH 277
  33
  34 #define MAX_DOS_DRIVES 26
  35
  36 struct drive_info
  37 {
  38     dev_t dev;
  39     ino_t ino;
  40 };
  41
  42 /* exceptions */
  43 extern void wait_suspend( CONTEXT *context );
  44 extern NTSTATUS send_debug_event( EXCEPTION_RECORD *rec, int first_chance, CONTEXT *context );
  45 extern LONG call_vectored_handlers( EXCEPTION_RECORD *rec, CONTEXT *context );
  46 extern void raise_status( NTSTATUS status, EXCEPTION_RECORD *rec ) DECLSPEC_NORETURN;
  47 extern void set_cpu_context( const CONTEXT *context );
  48 extern void copy_context( CONTEXT *to, const CONTEXT *from, DWORD flags );
  49 extern NTSTATUS context_to_server( context_t *to, const CONTEXT *from );
  50 extern NTSTATUS context_from_server( CONTEXT *to, const context_t *from );
  51 extern void call_thread_entry_point( LPTHREAD_START_ROUTINE entry, void *arg ) DECLSPEC_NORETURN;
  52
  53 /* debug helpers */
  54 extern LPCSTR debugstr_us( const UNICODE_STRING *str );
  55 extern LPCSTR debugstr_ObjectAttributes(const OBJECT_ATTRIBUTES *oa);
  56
  57 extern NTSTATUS NTDLL_queue_process_apc( HANDLE process, const apc_call_t *call, apc_result_t *result );
  58 extern NTSTATUS NTDLL_wait_for_multiple_objects( UINT count, const HANDLE *handles, UINT flags,
  59                                                  const LARGE_INTEGER *timeout, HANDLE signal_object );
  60
  61 /* init routines */
  62 extern void signal_init_thread( TEB *teb );
  63 extern void signal_init_process(void);
  64 extern size_t get_signal_stack_total_size(void);
  65 extern void version_init( const WCHAR *appname );
  66 extern void debug_init(void);
  67 extern HANDLE thread_init(void);
  68 extern void actctx_init(void);
  69 extern void virtual_init(void);
  70 extern void virtual_init_threading(void);
  71 extern void fill_cpu_info(void);
  72
  73 /* server support */
  74 extern timeout_t server_start_time;
  75 extern unsigned int server_cpus;
  76 extern int is_wow64;
  77 extern void server_init_process(void);
  78 extern NTSTATUS server_init_process_done(void);
  79 extern size_t server_init_thread( void *entry_point );
  80 extern void DECLSPEC_NORETURN server_protocol_error( const char *err, ... );
  81 extern void DECLSPEC_NORETURN server_protocol_perror( const char *err );
  82 extern void DECLSPEC_NORETURN abort_thread( int status );
  83 extern void DECLSPEC_NORETURN terminate_thread( int status );
  84 extern void DECLSPEC_NORETURN exit_thread( int status );
  85 extern sigset_t server_block_set;
  86 extern void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
  87 extern void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
  88 extern int server_remove_fd_from_cache( HANDLE handle );
  89 extern int server_get_unix_fd( HANDLE handle, unsigned int access, int *unix_fd,
  90                                int *needs_close, enum server_fd_type *type, unsigned int *options );
  91 extern int server_pipe( int fd[2] );
  92
  93 /* security descriptors */
  94 NTSTATUS NTDLL_create_struct_sd(PSECURITY_DESCRIPTOR nt_sd, struct security_descriptor **server_sd,
  95                                 data_size_t *server_sd_len);
  96 void NTDLL_free_struct_sd(struct security_descriptor *server_sd);
  97
  98 /* module handling */
  99 extern NTSTATUS MODULE_DllThreadAttach( LPVOID lpReserved );
 100 extern FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
 101                                      DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user );
 102 extern FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
 103                                      FARPROC origfun, DWORD ordinal, const WCHAR *user );
 104 extern void RELAY_SetupDLL( HMODULE hmod );
 105 extern void SNOOP_SetupDLL( HMODULE hmod );
 106 extern UNICODE_STRING windows_dir;
 107 extern UNICODE_STRING system_dir;
 108
 109 typedef LONG (WINAPI *PUNHANDLED_EXCEPTION_FILTER)(PEXCEPTION_POINTERS);
 110 extern PUNHANDLED_EXCEPTION_FILTER unhandled_exception_filter;
 111
 112 /* redefine these to make sure we don't reference kernel symbols */
 113 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
 114 #define GetCurrentProcessId()  (HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess))
 115 #define GetCurrentThreadId()   (HandleToULong(NtCurrentTeb()->ClientId.UniqueThread))
 116
 117 /* Device IO */
 118 extern NTSTATUS CDROM_DeviceIoControl(HANDLE hDevice,
 119                                       HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 120                                       PVOID UserApcContext,
 121                                       PIO_STATUS_BLOCK piosb,
 122                                       ULONG IoControlCode,
 123                                       LPVOID lpInBuffer, DWORD nInBufferSize,
 124                                       LPVOID lpOutBuffer, DWORD nOutBufferSize);
 125 extern NTSTATUS COMM_DeviceIoControl(HANDLE hDevice,
 126                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 127                                      PVOID UserApcContext,
 128                                      PIO_STATUS_BLOCK piosb,
 129                                      ULONG IoControlCode,
 130                                      LPVOID lpInBuffer, DWORD nInBufferSize,
 131                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
 132 extern NTSTATUS TAPE_DeviceIoControl(HANDLE hDevice,
 133                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 134                                      PVOID UserApcContext,
 135                                      PIO_STATUS_BLOCK piosb,
 136                                      ULONG IoControlCode,
 137                                      LPVOID lpInBuffer, DWORD nInBufferSize,
 138                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
 139
 140 /* file I/O */
 141 extern NTSTATUS FILE_GetNtStatus(void);
 142 extern void DIR_init_windows_dir( const WCHAR *windir, const WCHAR *sysdir );
 143 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name );
 144 extern NTSTATUS DIR_unmount_device( HANDLE handle );
 145 extern NTSTATUS DIR_get_unix_cwd( char **cwd );
 146 extern unsigned int DIR_get_drives_info( struct drive_info info[MAX_DOS_DRIVES] );
 147
 148 /* virtual memory */
 149 extern void virtual_get_system_info( SYSTEM_BASIC_INFORMATION *info );
 150 extern NTSTATUS virtual_create_system_view( void *base, SIZE_T size, DWORD vprot );
 151 extern NTSTATUS virtual_alloc_thread_stack( TEB *teb, SIZE_T reserve_size, SIZE_T commit_size );
 152 extern void virtual_clear_thread_stack(void);
 153 extern BOOL virtual_handle_stack_fault( void *addr );
 154 extern NTSTATUS virtual_handle_fault( LPCVOID addr, DWORD err );
 155 extern BOOL virtual_check_buffer_for_read( const void *ptr, SIZE_T size );
 156 extern BOOL virtual_check_buffer_for_write( void *ptr, SIZE_T size );
 157 extern void VIRTUAL_SetForceExec( BOOL enable );
 158 extern void virtual_release_address_space( BOOL free_high_mem );
 159 extern struct _KUSER_SHARED_DATA *user_shared_data;
 160
 161 /* completion */
 162 extern NTSTATUS NTDLL_AddCompletion( HANDLE hFile, ULONG_PTR CompletionValue,
 163                                      NTSTATUS CompletionStatus, ULONG Information );
 164
 165 /* code pages */
 166 extern int ntdll_umbstowcs(DWORD flags, const char* src, int srclen, WCHAR* dst, int dstlen);
 167 extern int ntdll_wcstoumbs(DWORD flags, const WCHAR* src, int srclen, char* dst, int dstlen,
 168                            const char* defchar, int *used );
 169
 170 extern int CDECL NTDLL__vsnprintf( char *str, SIZE_T len, const char *format, __ms_va_list args );
 171 extern int CDECL NTDLL__vsnwprintf( WCHAR *str, SIZE_T len, const WCHAR *format, __ms_va_list args );
 172
 173 /* load order */
 174
 175 enum loadorder
 176 {
 177     LO_INVALID,
 178     LO_DISABLED,
 179     LO_NATIVE,
 180     LO_BUILTIN,
 181     LO_NATIVE_BUILTIN,  /* native then builtin */
 182     LO_BUILTIN_NATIVE,  /* builtin then native */
 183     LO_DEFAULT          /* nothing specified, use default strategy */
 184 };
 185
 186 extern enum loadorder get_load_order( const WCHAR *app_name, const WCHAR *path );
 187
 188 struct debug_info
 189 {
 190     char *str_pos;       /* current position in strings buffer */
 191     char *out_pos;       /* current position in output buffer */
 192     char  strings[1024]; /* buffer for temporary strings */
 193     char  output[1024];  /* current output line */
 194 };
 195
 196 /* thread private data, stored in NtCurrentTeb()->SystemReserved2 */
 197 struct ntdll_thread_data
 198 {
 199     DWORD              fs;            /* 1d4/300 TEB selector */
 200     DWORD              gs;            /* 1d8/304 libc selector; update winebuild if you move this! */
 201     struct debug_info *debug_info;    /* 1dc/308 info for debugstr functions */
 202     int                request_fd;    /* 1e0/310 fd for sending server requests */
 203     int                reply_fd;      /* 1e4/314 fd for receiving server replies */
 204     int                wait_fd[2];    /* 1e8/318 fd for sleeping server requests */
 205     BOOL               wow64_redir;   /* 1f0/320 Wow64 filesystem redirection flag */
 206 #ifdef __i386__
 207     void              *vm86_ptr;      /* 1f4/328 data for vm86 mode */
 208 #else
 209     void              *exit_frame;    /* 1f4/328 exit frame pointer */
 210 #endif
 211     pthread_t          pthread_id;    /* 1f8/330 pthread thread id */
 212 };
 213
 214 static inline struct ntdll_thread_data *ntdll_get_thread_data(void)
 215 {
 216     return (struct ntdll_thread_data *)NtCurrentTeb()->SystemReserved2;
 217 }
 218
 219 /* thread debug_registers, stored in NtCurrentTeb()->SpareBytes1 */
 220 struct ntdll_thread_regs
 221 {
 222     DWORD dr0;
 223     DWORD dr1;
 224     DWORD dr2;
 225     DWORD dr3;
 226     DWORD dr6;
 227     DWORD dr7;
 228 };
 229
 230 static inline struct ntdll_thread_regs *ntdll_get_thread_regs(void)
 231 {
 232     return (struct ntdll_thread_regs *)NtCurrentTeb()->SpareBytes1;
 233 }
 234
 235 /* Register functions */
 236
 237 #ifdef __i386__
 238 #define DEFINE_REGS_ENTRYPOINT( name, args ) \
 239     __ASM_GLOBAL_FUNC( name, \
 240                        ".byte 0x68\n\t"  /* pushl $__regs_func */       \
 241                        ".long " __ASM_NAME("__regs_") #name "-.-11\n\t" \
 242                        ".byte 0x6a," #args "\n\t" /* pushl $args */     \
 243                        "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t" \
 244                        "ret $(4*" #args ")" ) /* fake ret to make copy protections happy */
 245 #elif defined(__x86_64__)
 246 #define DEFINE_REGS_ENTRYPOINT( name, args ) \
 247     __ASM_GLOBAL_FUNC( name, \
 248                        "movq %rcx,8(%rsp)\n\t"  \
 249                        "movq %rdx,16(%rsp)\n\t" \
 250                        "movq $" #args ",%rcx\n\t" \
 251                        "leaq " __ASM_NAME("__regs_") #name "(%rip),%rdx\n\t" \
 252                        "call " __ASM_NAME("__wine_call_from_regs"))
 253 #endif
 254
 255 #endif