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
  72 /* server support */
  73 extern timeout_t server_start_time;
  74 extern unsigned int server_cpus;
  75 extern void server_init_process(void);
  76 extern NTSTATUS server_init_process_done(void);
  77 extern size_t server_init_thread( void *entry_point );
  78 extern void DECLSPEC_NORETURN server_protocol_error( const char *err, ... );
  79 extern void DECLSPEC_NORETURN server_protocol_perror( const char *err );
  80 extern void DECLSPEC_NORETURN abort_thread( int status );
  81 extern void DECLSPEC_NORETURN exit_thread( int status );
  82 extern sigset_t server_block_set;
  83 extern void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
  84 extern void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
  85 extern int server_remove_fd_from_cache( HANDLE handle );
  86 extern int server_get_unix_fd( HANDLE handle, unsigned int access, int *unix_fd,
  87                                int *needs_close, enum server_fd_type *type, unsigned int *options );
  88
  89 /* security descriptors */
  90 NTSTATUS NTDLL_create_struct_sd(PSECURITY_DESCRIPTOR nt_sd, struct security_descriptor **server_sd,
  91                                 data_size_t *server_sd_len);
  92 void NTDLL_free_struct_sd(struct security_descriptor *server_sd);
  93
  94 /* module handling */
  95 extern NTSTATUS MODULE_DllThreadAttach( LPVOID lpReserved );
  96 extern FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
  97                                      DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user );
  98 extern FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
  99                                      FARPROC origfun, DWORD ordinal, const WCHAR *user );
 100 extern void RELAY_SetupDLL( HMODULE hmod );
 101 extern void SNOOP_SetupDLL( HMODULE hmod );
 102 extern UNICODE_STRING windows_dir;
 103 extern UNICODE_STRING system_dir;
 104
 105 typedef LONG (WINAPI *PUNHANDLED_EXCEPTION_FILTER)(PEXCEPTION_POINTERS);
 106 extern PUNHANDLED_EXCEPTION_FILTER unhandled_exception_filter;
 107
 108 /* redefine these to make sure we don't reference kernel symbols */
 109 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
 110 #define GetCurrentProcessId()  (HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess))
 111 #define GetCurrentThreadId()   (HandleToULong(NtCurrentTeb()->ClientId.UniqueThread))
 112
 113 /* Device IO */
 114 extern NTSTATUS CDROM_DeviceIoControl(HANDLE hDevice,
 115                                       HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 116                                       PVOID UserApcContext,
 117                                       PIO_STATUS_BLOCK piosb,
 118                                       ULONG IoControlCode,
 119                                       LPVOID lpInBuffer, DWORD nInBufferSize,
 120                                       LPVOID lpOutBuffer, DWORD nOutBufferSize);
 121 extern NTSTATUS COMM_DeviceIoControl(HANDLE hDevice,
 122                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
 123                                      PVOID UserApcContext,
 124                                      PIO_STATUS_BLOCK piosb,
 125                                      ULONG IoControlCode,
 126                                      LPVOID lpInBuffer, DWORD nInBufferSize,
 127                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
 128 extern NTSTATUS TAPE_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);
 135
 136 /* file I/O */
 137 extern NTSTATUS FILE_GetNtStatus(void);
 138 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name );
 139 extern NTSTATUS DIR_unmount_device( HANDLE handle );
 140 extern NTSTATUS DIR_get_unix_cwd( char **cwd );
 141 extern unsigned int DIR_get_drives_info( struct drive_info info[MAX_DOS_DRIVES] );
 142
 143 /* virtual memory */
 144 extern void virtual_get_system_info( SYSTEM_BASIC_INFORMATION *info );
 145 extern NTSTATUS virtual_create_system_view( void *base, SIZE_T size, DWORD vprot );
 146 extern NTSTATUS virtual_alloc_thread_stack( TEB *teb, SIZE_T reserve_size, SIZE_T commit_size );
 147 extern void virtual_clear_thread_stack(void);
 148 extern BOOL virtual_handle_stack_fault( void *addr );
 149 extern NTSTATUS virtual_handle_fault( LPCVOID addr, DWORD err );
 150 extern BOOL virtual_check_buffer_for_read( const void *ptr, SIZE_T size );
 151 extern BOOL virtual_check_buffer_for_write( void *ptr, SIZE_T size );
 152 extern void VIRTUAL_SetForceExec( BOOL enable );
 153 extern void VIRTUAL_UseLargeAddressSpace(void);
 154 extern struct _KUSER_SHARED_DATA *user_shared_data;
 155
 156 /* completion */
 157 extern NTSTATUS NTDLL_AddCompletion( HANDLE hFile, ULONG_PTR CompletionValue,
 158                                      NTSTATUS CompletionStatus, ULONG Information );
 159
 160 /* code pages */
 161 extern int ntdll_umbstowcs(DWORD flags, const char* src, int srclen, WCHAR* dst, int dstlen);
 162 extern int ntdll_wcstoumbs(DWORD flags, const WCHAR* src, int srclen, char* dst, int dstlen,
 163                            const char* defchar, int *used );
 164
 165 extern int CDECL NTDLL__vsnprintf( char *str, SIZE_T len, const char *format, __ms_va_list args );
 166 extern int CDECL NTDLL__vsnwprintf( WCHAR *str, SIZE_T len, const WCHAR *format, __ms_va_list args );
 167
 168 /* load order */
 169
 170 enum loadorder
 171 {
 172     LO_INVALID,
 173     LO_DISABLED,
 174     LO_NATIVE,
 175     LO_BUILTIN,
 176     LO_NATIVE_BUILTIN,  /* native then builtin */
 177     LO_BUILTIN_NATIVE,  /* builtin then native */
 178     LO_DEFAULT          /* nothing specified, use default strategy */
 179 };
 180
 181 extern enum loadorder get_load_order( const WCHAR *app_name, const WCHAR *path );
 182
 183 struct debug_info
 184 {
 185     char *str_pos;       /* current position in strings buffer */
 186     char *out_pos;       /* current position in output buffer */
 187     char  strings[1024]; /* buffer for temporary strings */
 188     char  output[1024];  /* current output line */
 189 };
 190
 191 /* thread private data, stored in NtCurrentTeb()->SystemReserved2 */
 192 struct ntdll_thread_data
 193 {
 194     DWORD              fs;            /* 1d4/300 TEB selector */
 195     DWORD              gs;            /* 1d8/304 libc selector; update winebuild if you move this! */
 196     struct debug_info *debug_info;    /* 1dc/308 info for debugstr functions */
 197     int                request_fd;    /* 1e0/310 fd for sending server requests */
 198     int                reply_fd;      /* 1e4/314 fd for receiving server replies */
 199     int                wait_fd[2];    /* 1e8/318 fd for sleeping server requests */
 200     void              *vm86_ptr;      /* 1f0/320 data for vm86 mode */
 201     pthread_t          pthread_id;    /* 1f4/328 pthread thread id */
 202 };
 203
 204 static inline struct ntdll_thread_data *ntdll_get_thread_data(void)
 205 {
 206     return (struct ntdll_thread_data *)NtCurrentTeb()->SystemReserved2;
 207 }
 208
 209 /* thread debug_registers, stored in NtCurrentTeb()->SpareBytes1 */
 210 struct ntdll_thread_regs
 211 {
 212     DWORD dr0;
 213     DWORD dr1;
 214     DWORD dr2;
 215     DWORD dr3;
 216     DWORD dr6;
 217     DWORD dr7;
 218 };
 219
 220 static inline struct ntdll_thread_regs *ntdll_get_thread_regs(void)
 221 {
 222     return (struct ntdll_thread_regs *)NtCurrentTeb()->SpareBytes1;
 223 }
 224
 225 /* Register functions */
 226
 227 #ifdef __i386__
 228 #define DEFINE_REGS_ENTRYPOINT( name, args ) \
 229     __ASM_GLOBAL_FUNC( name, \
 230                        ".byte 0x68\n\t"  /* pushl $__regs_func */       \
 231                        ".long " __ASM_NAME("__regs_") #name "-.-11\n\t" \
 232                        ".byte 0x6a," #args "\n\t" /* pushl $args */     \
 233                        "call " __ASM_NAME("__wine_call_from_32_regs"))
 234 #elif defined(__x86_64__)
 235 #define DEFINE_REGS_ENTRYPOINT( name, args ) \
 236     __ASM_GLOBAL_FUNC( name, \
 237                        "movq %rcx,8(%rsp)\n\t"  \
 238                        "movq %rdx,16(%rsp)\n\t" \
 239                        "movq $" #args ",%rcx\n\t" \
 240                        "leaq " __ASM_NAME("__regs_") #name "(%rip),%rdx\n\t" \
 241                        "call " __ASM_NAME("__wine_call_from_regs"))
 242 #endif
 243
 244 #endif