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