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 extern ULONG_PTR get_system_affinity_mask(void) DECLSPEC_HIDDEN;
  50
  51 /* exceptions */
  52 extern void wait_suspend( CONTEXT *context ) DECLSPEC_HIDDEN;
  53 extern NTSTATUS send_debug_event( EXCEPTION_RECORD *rec, int first_chance, CONTEXT *context ) DECLSPEC_HIDDEN;
  54 extern LONG call_vectored_handlers( EXCEPTION_RECORD *rec, CONTEXT *context ) DECLSPEC_HIDDEN;
  55 extern void raise_status( NTSTATUS status, EXCEPTION_RECORD *rec ) DECLSPEC_NORETURN DECLSPEC_HIDDEN;
  56 extern NTSTATUS context_to_server( context_t *to, const CONTEXT *from ) DECLSPEC_HIDDEN;
  57 extern NTSTATUS context_from_server( CONTEXT *to, const context_t *from ) DECLSPEC_HIDDEN;
  58 extern NTSTATUS set_thread_context( HANDLE handle, const CONTEXT *context, BOOL *self ) DECLSPEC_HIDDEN;
  59 extern NTSTATUS get_thread_context( HANDLE handle, CONTEXT *context, BOOL *self ) 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 /* init routines */
  66 extern NTSTATUS signal_alloc_thread( TEB **teb ) DECLSPEC_HIDDEN;
  67 extern void signal_free_thread( TEB *teb ) DECLSPEC_HIDDEN;
  68 extern void signal_init_thread( TEB *teb ) DECLSPEC_HIDDEN;
  69 extern void signal_init_process(void) DECLSPEC_HIDDEN;
  70 extern void signal_start_thread( LPTHREAD_START_ROUTINE entry, void *arg, BOOL suspend ) DECLSPEC_HIDDEN;
  71 extern void signal_start_process( LPTHREAD_START_ROUTINE entry, BOOL suspend ) DECLSPEC_HIDDEN;
  72 extern void DECLSPEC_NORETURN signal_exit_thread( int status ) DECLSPEC_HIDDEN;
  73 extern void DECLSPEC_NORETURN signal_exit_process( int status ) 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 BOOL is_wow64 DECLSPEC_HIDDEN;
  87 extern void server_init_process(void) DECLSPEC_HIDDEN;
  88 extern void server_init_process_done(void) DECLSPEC_HIDDEN;
  89 extern size_t server_init_thread( void *entry_point, BOOL *suspend ) DECLSPEC_HIDDEN;
  90 extern void DECLSPEC_NORETURN abort_thread( int status ) DECLSPEC_HIDDEN;
  91 extern void DECLSPEC_NORETURN exit_thread( int status ) DECLSPEC_HIDDEN;
  92 extern sigset_t server_block_set DECLSPEC_HIDDEN;
  93 extern unsigned int server_call_unlocked( void *req_ptr ) DECLSPEC_HIDDEN;
  94 extern void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset ) DECLSPEC_HIDDEN;
  95 extern void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset ) DECLSPEC_HIDDEN;
  96 extern unsigned int server_select( const select_op_t *select_op, data_size_t size,
  97                                    UINT flags, const LARGE_INTEGER *timeout ) DECLSPEC_HIDDEN;
  98 extern unsigned int server_queue_process_apc( HANDLE process, const apc_call_t *call, apc_result_t *result ) DECLSPEC_HIDDEN;
  99 extern int server_remove_fd_from_cache( HANDLE handle ) DECLSPEC_HIDDEN;
 100 extern int server_get_unix_fd( HANDLE handle, unsigned int access, int *unix_fd,
 101                                int *needs_close, enum server_fd_type *type, unsigned int *options ) DECLSPEC_HIDDEN;
 102 extern int server_pipe( int fd[2] ) DECLSPEC_HIDDEN;
 103 extern NTSTATUS alloc_object_attributes( const OBJECT_ATTRIBUTES *attr, struct object_attributes **ret,
 104                                          data_size_t *ret_len ) DECLSPEC_HIDDEN;
 105 extern NTSTATUS validate_open_object_attributes( const OBJECT_ATTRIBUTES *attr ) DECLSPEC_HIDDEN;
 106
 107 /* module handling */
 108 extern LIST_ENTRY tls_links DECLSPEC_HIDDEN;
 109 extern NTSTATUS attach_dlls( CONTEXT *context, BOOL suspend ) 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 extern void (WINAPI *kernel32_start_process)(LPTHREAD_START_ROUTINE,void*) DECLSPEC_HIDDEN;
 121
 122 /* redefine these to make sure we don't reference kernel symbols */
 123 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
 124 #define GetCurrentProcessId()  (HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess))
 125 #define GetCurrentThreadId()   (HandleToULong(NtCurrentTeb()->ClientId.UniqueThread))
 126
 127 /* Device IO */
 128 extern NTSTATUS CDROM_DeviceIoControl(HANDLE hDevice,
 129                                       HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 130                                       PVOID UserApcContext,
 131                                       PIO_STATUS_BLOCK piosb,
 132                                       ULONG IoControlCode,
 133                                       LPVOID lpInBuffer, DWORD nInBufferSize,
 134                                       LPVOID lpOutBuffer, DWORD nOutBufferSize) DECLSPEC_HIDDEN;
 135 extern NTSTATUS COMM_DeviceIoControl(HANDLE hDevice,
 136                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 137                                      PVOID UserApcContext,
 138                                      PIO_STATUS_BLOCK piosb,
 139                                      ULONG IoControlCode,
 140                                      LPVOID lpInBuffer, DWORD nInBufferSize,
 141                                      LPVOID lpOutBuffer, DWORD nOutBufferSize) DECLSPEC_HIDDEN;
 142 extern NTSTATUS TAPE_DeviceIoControl(HANDLE hDevice,
 143                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 144                                      PVOID UserApcContext,
 145                                      PIO_STATUS_BLOCK piosb,
 146                                      ULONG IoControlCode,
 147                                      LPVOID lpInBuffer, DWORD nInBufferSize,
 148                                      LPVOID lpOutBuffer, DWORD nOutBufferSize) DECLSPEC_HIDDEN;
 149 extern NTSTATUS COMM_FlushBuffersFile( int fd ) DECLSPEC_HIDDEN;
 150
 151 /* file I/O */
 152 struct stat;
 153 extern NTSTATUS FILE_GetNtStatus(void) DECLSPEC_HIDDEN;
 154 extern int get_file_info( const char *path, struct stat *st, ULONG *attr ) DECLSPEC_HIDDEN;
 155 extern NTSTATUS fill_file_info( const struct stat *st, ULONG attr, void *ptr,
 156                                 FILE_INFORMATION_CLASS class ) DECLSPEC_HIDDEN;
 157 extern NTSTATUS server_get_unix_name( HANDLE handle, ANSI_STRING *unix_name ) DECLSPEC_HIDDEN;
 158 extern void DIR_init_windows_dir( const WCHAR *windir, const WCHAR *sysdir ) DECLSPEC_HIDDEN;
 159 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name ) DECLSPEC_HIDDEN;
 160 extern NTSTATUS DIR_unmount_device( HANDLE handle ) DECLSPEC_HIDDEN;
 161 extern NTSTATUS DIR_get_unix_cwd( char **cwd ) DECLSPEC_HIDDEN;
 162 extern unsigned int DIR_get_drives_info( struct drive_info info[MAX_DOS_DRIVES] ) DECLSPEC_HIDDEN;
 163 extern NTSTATUS file_id_to_unix_file_name( const OBJECT_ATTRIBUTES *attr, ANSI_STRING *unix_name_ret ) DECLSPEC_HIDDEN;
 164 extern NTSTATUS nt_to_unix_file_name_attr( const OBJECT_ATTRIBUTES *attr, ANSI_STRING *unix_name_ret,
 165                                            UINT disposition ) DECLSPEC_HIDDEN;
 166
 167 /* virtual memory */
 168 extern void virtual_get_system_info( SYSTEM_BASIC_INFORMATION *info ) DECLSPEC_HIDDEN;
 169 extern NTSTATUS virtual_create_builtin_view( void *base ) DECLSPEC_HIDDEN;
 170 extern NTSTATUS virtual_alloc_thread_stack( TEB *teb, SIZE_T reserve_size,
 171                                             SIZE_T commit_size, SIZE_T extra_size ) DECLSPEC_HIDDEN;
 172 extern void virtual_clear_thread_stack( void *stack_end ) DECLSPEC_HIDDEN;
 173 extern BOOL virtual_handle_stack_fault( void *addr ) DECLSPEC_HIDDEN;
 174 extern BOOL virtual_is_valid_code_address( const void *addr, SIZE_T size ) DECLSPEC_HIDDEN;
 175 extern NTSTATUS virtual_handle_fault( LPCVOID addr, DWORD err, BOOL on_signal_stack ) DECLSPEC_HIDDEN;
 176 extern unsigned int virtual_locked_server_call( void *req_ptr ) DECLSPEC_HIDDEN;
 177 extern ssize_t virtual_locked_read( int fd, void *addr, size_t size ) DECLSPEC_HIDDEN;
 178 extern ssize_t virtual_locked_pread( int fd, void *addr, size_t size, off_t offset ) DECLSPEC_HIDDEN;
 179 extern BOOL virtual_check_buffer_for_read( const void *ptr, SIZE_T size ) DECLSPEC_HIDDEN;
 180 extern BOOL virtual_check_buffer_for_write( void *ptr, SIZE_T size ) DECLSPEC_HIDDEN;
 181 extern SIZE_T virtual_uninterrupted_read_memory( const void *addr, void *buffer, SIZE_T size ) DECLSPEC_HIDDEN;
 182 extern NTSTATUS virtual_uninterrupted_write_memory( void *addr, const void *buffer, SIZE_T size ) DECLSPEC_HIDDEN;
 183 extern void VIRTUAL_SetForceExec( BOOL enable ) DECLSPEC_HIDDEN;
 184 extern void virtual_release_address_space(void) DECLSPEC_HIDDEN;
 185 extern void virtual_set_large_address_space(void) DECLSPEC_HIDDEN;
 186 extern struct _KUSER_SHARED_DATA *user_shared_data DECLSPEC_HIDDEN;
 187
 188 /* completion */
 189 extern NTSTATUS NTDLL_AddCompletion( HANDLE hFile, ULONG_PTR CompletionValue,
 190                                      NTSTATUS CompletionStatus, ULONG Information ) DECLSPEC_HIDDEN;
 191
 192 /* code pages */
 193 extern int ntdll_umbstowcs(DWORD flags, const char* src, int srclen, WCHAR* dst, int dstlen) DECLSPEC_HIDDEN;
 194 extern int ntdll_wcstoumbs(DWORD flags, const WCHAR* src, int srclen, char* dst, int dstlen,
 195                            const char* defchar, int *used ) DECLSPEC_HIDDEN;
 196
 197 extern int CDECL NTDLL__vsnprintf( char *str, SIZE_T len, const char *format, __ms_va_list args ) DECLSPEC_HIDDEN;
 198 extern int CDECL NTDLL__vsnwprintf( WCHAR *str, SIZE_T len, const WCHAR *format, __ms_va_list args ) DECLSPEC_HIDDEN;
 199
 200 /* load order */
 201
 202 enum loadorder
 203 {
 204     LO_INVALID,
 205     LO_DISABLED,
 206     LO_NATIVE,
 207     LO_BUILTIN,
 208     LO_NATIVE_BUILTIN,  /* native then builtin */
 209     LO_BUILTIN_NATIVE,  /* builtin then native */
 210     LO_DEFAULT          /* nothing specified, use default strategy */
 211 };
 212
 213 extern enum loadorder get_load_order( const WCHAR *app_name, const WCHAR *path ) DECLSPEC_HIDDEN;
 214
 215 struct debug_info
 216 {
 217     char *str_pos;       /* current position in strings buffer */
 218     char *out_pos;       /* current position in output buffer */
 219     char  strings[1024]; /* buffer for temporary strings */
 220     char  output[1024];  /* current output line */
 221 };
 222
 223 /* thread private data, stored in NtCurrentTeb()->GdiTebBatch */
 224 struct ntdll_thread_data
 225 {
 226 #ifdef __i386__
 227     WINE_VM86_TEB_INFO __vm86;        /* FIXME: placeholder for vm86 data from struct x86_thread_data */
 228 #endif
 229     struct debug_info *debug_info;    /* info for debugstr functions */
 230     void              *start_stack;   /* stack for thread startup */
 231     int                request_fd;    /* fd for sending server requests */
 232     int                reply_fd;      /* fd for receiving server replies */
 233     int                wait_fd[2];    /* fd for sleeping server requests */
 234     BOOL               wow64_redir;   /* Wow64 filesystem redirection flag */
 235     pthread_t          pthread_id;    /* pthread thread id */
 236 };
 237
 238 C_ASSERT( sizeof(struct ntdll_thread_data) <= sizeof(((TEB *)0)->GdiTebBatch) );
 239 #ifdef __i386__
 240 C_ASSERT( offsetof( TEB, GdiTebBatch ) + offsetof( struct ntdll_thread_data, __vm86 ) == 0x1fc );
 241 #endif
 242
 243 static inline struct ntdll_thread_data *ntdll_get_thread_data(void)
 244 {
 245     return (struct ntdll_thread_data *)&NtCurrentTeb()->GdiTebBatch;
 246 }
 247
 248 extern mode_t FILE_umask DECLSPEC_HIDDEN;
 249 extern HANDLE keyed_event DECLSPEC_HIDDEN;
 250
 251 #define HASH_STRING_ALGORITHM_DEFAULT  0
 252 #define HASH_STRING_ALGORITHM_X65599   1
 253 #define HASH_STRING_ALGORITHM_INVALID  0xffffffff
 254
 255 NTSTATUS WINAPI RtlHashUnicodeString(PCUNICODE_STRING,BOOLEAN,ULONG,ULONG*);
 256
 257 #endif