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 NTSTATUS signal_alloc_thread( TEB **teb );
  63 extern void signal_free_thread( TEB *teb );
  64 extern void signal_init_thread( TEB *teb );
  65 extern void signal_init_process(void);
  66 extern void version_init( const WCHAR *appname );
  67 extern void debug_init(void);
  68 extern HANDLE thread_init(void);
  69 extern void actctx_init(void);
  70 extern void virtual_init(void);
  71 extern void virtual_init_threading(void);
  72 extern void fill_cpu_info(void);
  73 extern void heap_set_debug_flags( HANDLE handle );
  74 extern void exceptions_init(void);
  75
  76 /* server support */
  77 extern timeout_t server_start_time;
  78 extern unsigned int server_cpus;
  79 extern int is_wow64;
  80 extern void server_init_process(void);
  81 extern NTSTATUS server_init_process_done(void);
  82 extern size_t server_init_thread( void *entry_point );
  83 extern void DECLSPEC_NORETURN server_protocol_error( const char *err, ... );
  84 extern void DECLSPEC_NORETURN server_protocol_perror( const char *err );
  85 extern void DECLSPEC_NORETURN abort_thread( int status );
  86 extern void DECLSPEC_NORETURN terminate_thread( int status );
  87 extern void DECLSPEC_NORETURN exit_thread( int status );
  88 extern sigset_t server_block_set;
  89 extern void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
  90 extern void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
  91 extern int server_remove_fd_from_cache( HANDLE handle );
  92 extern int server_get_unix_fd( HANDLE handle, unsigned int access, int *unix_fd,
  93                                int *needs_close, enum server_fd_type *type, unsigned int *options );
  94 extern int server_pipe( int fd[2] );
  95
  96 /* security descriptors */
  97 NTSTATUS NTDLL_create_struct_sd(PSECURITY_DESCRIPTOR nt_sd, struct security_descriptor **server_sd,
  98                                 data_size_t *server_sd_len);
  99 void NTDLL_free_struct_sd(struct security_descriptor *server_sd);
 100
 101 /* module handling */
 102 extern NTSTATUS MODULE_DllThreadAttach( LPVOID lpReserved );
 103 extern FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
 104                                      DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user );
 105 extern FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
 106                                      FARPROC origfun, DWORD ordinal, const WCHAR *user );
 107 extern void RELAY_SetupDLL( HMODULE hmod );
 108 extern void SNOOP_SetupDLL( HMODULE hmod );
 109 extern UNICODE_STRING windows_dir;
 110 extern UNICODE_STRING system_dir;
 111
 112 typedef LONG (WINAPI *PUNHANDLED_EXCEPTION_FILTER)(PEXCEPTION_POINTERS);
 113 extern PUNHANDLED_EXCEPTION_FILTER unhandled_exception_filter;
 114
 115 /* redefine these to make sure we don't reference kernel symbols */
 116 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
 117 #define GetCurrentProcessId()  (HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess))
 118 #define GetCurrentThreadId()   (HandleToULong(NtCurrentTeb()->ClientId.UniqueThread))
 119
 120 /* Device IO */
 121 extern NTSTATUS CDROM_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 COMM_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 extern NTSTATUS TAPE_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);
 142
 143 /* file I/O */
 144 struct stat;
 145 extern NTSTATUS FILE_GetNtStatus(void);
 146 extern NTSTATUS fill_stat_info( const struct stat *st, void *ptr, FILE_INFORMATION_CLASS class );
 147 extern NTSTATUS server_get_unix_name( HANDLE handle, ANSI_STRING *unix_name );
 148 extern void DIR_init_windows_dir( const WCHAR *windir, const WCHAR *sysdir );
 149 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name );
 150 extern NTSTATUS DIR_unmount_device( HANDLE handle );
 151 extern NTSTATUS DIR_get_unix_cwd( char **cwd );
 152 extern unsigned int DIR_get_drives_info( struct drive_info info[MAX_DOS_DRIVES] );
 153 extern NTSTATUS file_id_to_unix_file_name( const OBJECT_ATTRIBUTES *attr, ANSI_STRING *unix_name_ret );
 154 extern NTSTATUS nt_to_unix_file_name_attr( const OBJECT_ATTRIBUTES *attr, ANSI_STRING *unix_name_ret,
 155                                            UINT disposition );
 156
 157 /* virtual memory */
 158 extern void virtual_get_system_info( SYSTEM_BASIC_INFORMATION *info );
 159 extern NTSTATUS virtual_create_builtin_view( void *base );
 160 extern NTSTATUS virtual_alloc_thread_stack( TEB *teb, SIZE_T reserve_size, SIZE_T commit_size );
 161 extern void virtual_clear_thread_stack(void);
 162 extern BOOL virtual_handle_stack_fault( void *addr );
 163 extern NTSTATUS virtual_handle_fault( LPCVOID addr, DWORD err );
 164 extern BOOL virtual_check_buffer_for_read( const void *ptr, SIZE_T size );
 165 extern BOOL virtual_check_buffer_for_write( void *ptr, SIZE_T size );
 166 extern void VIRTUAL_SetForceExec( BOOL enable );
 167 extern void virtual_release_address_space( BOOL free_high_mem );
 168 extern struct _KUSER_SHARED_DATA *user_shared_data;
 169
 170 /* completion */
 171 extern NTSTATUS NTDLL_AddCompletion( HANDLE hFile, ULONG_PTR CompletionValue,
 172                                      NTSTATUS CompletionStatus, ULONG Information );
 173
 174 /* code pages */
 175 extern int ntdll_umbstowcs(DWORD flags, const char* src, int srclen, WCHAR* dst, int dstlen);
 176 extern int ntdll_wcstoumbs(DWORD flags, const WCHAR* src, int srclen, char* dst, int dstlen,
 177                            const char* defchar, int *used );
 178
 179 extern int CDECL NTDLL__vsnprintf( char *str, SIZE_T len, const char *format, __ms_va_list args );
 180 extern int CDECL NTDLL__vsnwprintf( WCHAR *str, SIZE_T len, const WCHAR *format, __ms_va_list args );
 181
 182 /* load order */
 183
 184 enum loadorder
 185 {
 186     LO_INVALID,
 187     LO_DISABLED,
 188     LO_NATIVE,
 189     LO_BUILTIN,
 190     LO_NATIVE_BUILTIN,  /* native then builtin */
 191     LO_BUILTIN_NATIVE,  /* builtin then native */
 192     LO_DEFAULT          /* nothing specified, use default strategy */
 193 };
 194
 195 extern enum loadorder get_load_order( const WCHAR *app_name, const WCHAR *path );
 196
 197 struct debug_info
 198 {
 199     char *str_pos;       /* current position in strings buffer */
 200     char *out_pos;       /* current position in output buffer */
 201     char  strings[1024]; /* buffer for temporary strings */
 202     char  output[1024];  /* current output line */
 203 };
 204
 205 /* thread private data, stored in NtCurrentTeb()->SystemReserved2 */
 206 struct ntdll_thread_data
 207 {
 208 #ifdef __i386__
 209     DWORD              dr0;           /* 1bc Debug registers */
 210     DWORD              dr1;           /* 1c0 */
 211     DWORD              dr2;           /* 1c4 */
 212     DWORD              dr3;           /* 1c8 */
 213     DWORD              dr6;           /* 1cc */
 214     DWORD              dr7;           /* 1d0 */
 215     DWORD              fs;            /* 1d4 TEB selector */
 216     DWORD              gs;            /* 1d8 libc selector; update winebuild if you move this! */
 217     void              *vm86_ptr;      /* 1dc data for vm86 mode */
 218 #else
 219     void              *exit_frame;    /*    /2e8 exit frame pointer */
 220 #endif
 221     struct debug_info *debug_info;    /* 1e0/2f0 info for debugstr functions */
 222     int                request_fd;    /* 1e4/2f8 fd for sending server requests */
 223     int                reply_fd;      /* 1e8/2fc fd for receiving server replies */
 224     int                wait_fd[2];    /* 1ec/300 fd for sleeping server requests */
 225     BOOL               wow64_redir;   /* 1f4/308 Wow64 filesystem redirection flag */
 226     pthread_t          pthread_id;    /* 1f8/310 pthread thread id */
 227 };
 228
 229 static inline struct ntdll_thread_data *ntdll_get_thread_data(void)
 230 {
 231     return (struct ntdll_thread_data *)NtCurrentTeb()->SpareBytes1;
 232 }
 233
 234 /* Register functions */
 235
 236 #ifdef __i386__
 237 #define DEFINE_REGS_ENTRYPOINT( name, args ) \
 238     __ASM_GLOBAL_FUNC( name, \
 239                        ".byte 0x68\n\t"  /* pushl $__regs_func */       \
 240                        ".long " __ASM_NAME("__regs_") #name "-.-11\n\t" \
 241                        ".byte 0x6a," #args "\n\t" /* pushl $args */     \
 242                        "call " __ASM_NAME("__wine_call_from_regs") "\n\t" \
 243                        "ret $(4*" #args ")" ) /* fake ret to make copy protections happy */
 244 #elif defined(__x86_64__)
 245 #define DEFINE_REGS_ENTRYPOINT( name, args ) \
 246     __ASM_GLOBAL_FUNC( name, \
 247                        "movq %rcx,8(%rsp)\n\t"  \
 248                        "movq %rdx,16(%rsp)\n\t" \
 249                        "movq $" #args ",%rcx\n\t" \
 250                        "leaq " __ASM_NAME("__regs_") #name "(%rip),%rdx\n\t" \
 251                        "call " __ASM_NAME("__wine_call_from_regs"))
 252 #endif
 253
 254 #endif