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
  24 #include "windef.h"
  25 #include "winnt.h"
  26 #include "winternl.h"
  27 #include "winioctl.h"
  28 #include "wine/server.h"
  29
  30 #define MAX_NT_PATH_LENGTH 277
  31
  32 /* exceptions */
  33 extern void wait_suspend( CONTEXT *context );
  34 extern void WINAPI __regs_RtlRaiseException( PEXCEPTION_RECORD, PCONTEXT );
  35 extern void get_cpu_context( CONTEXT *context );
  36 extern void set_cpu_context( const CONTEXT *context );
  37
  38 /* debug helper */
  39 extern LPCSTR debugstr_us( const UNICODE_STRING *str );
  40 extern void dump_ObjectAttributes (const OBJECT_ATTRIBUTES *ObjectAttributes);
  41
  42 extern void NTDLL_get_server_timeout( abs_time_t *when, const LARGE_INTEGER *timeout );
  43 extern void NTDLL_from_server_timeout( LARGE_INTEGER *timeout, const abs_time_t *when );
  44 extern NTSTATUS NTDLL_wait_for_multiple_objects( UINT count, const HANDLE *handles, UINT flags,
  45                                                  const LARGE_INTEGER *timeout, HANDLE signal_object );
  46
  47 /* init routines */
  48 extern BOOL SIGNAL_Init(void);
  49 extern size_t get_signal_stack_total_size(void);
  50 extern void version_init( const WCHAR *appname );
  51 extern void debug_init(void);
  52 extern HANDLE thread_init(void);
  53
  54 /* server support */
  55 extern time_t server_start_time;
  56 extern void server_init_process(void);
  57 extern size_t server_init_thread( int unix_pid, int unix_tid, void *entry_point );
  58 extern void DECLSPEC_NORETURN server_protocol_error( const char *err, ... );
  59 extern void DECLSPEC_NORETURN server_protocol_perror( const char *err );
  60 extern void DECLSPEC_NORETURN server_exit_thread( int status );
  61 extern void DECLSPEC_NORETURN server_abort_thread( int status );
  62
  63 /* module handling */
  64 extern NTSTATUS MODULE_DllThreadAttach( LPVOID lpReserved );
  65 extern FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
  66                                      DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user );
  67 extern FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
  68                                      FARPROC origfun, DWORD ordinal, const WCHAR *user );
  69 extern void RELAY_SetupDLL( HMODULE hmod );
  70 extern void SNOOP_SetupDLL( HMODULE hmod );
  71 extern UNICODE_STRING system_dir;
  72
  73 /* redefine these to make sure we don't reference kernel symbols */
  74 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
  75 #define GetCurrentProcessId()  ((DWORD)NtCurrentTeb()->ClientId.UniqueProcess)
  76 #define GetCurrentThreadId()   ((DWORD)NtCurrentTeb()->ClientId.UniqueThread)
  77
  78 /* Device IO */
  79 extern NTSTATUS CDROM_DeviceIoControl(HANDLE hDevice,
  80                                       HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
  81                                       PVOID UserApcContext,
  82                                       PIO_STATUS_BLOCK piosb,
  83                                       ULONG IoControlCode,
  84                                       LPVOID lpInBuffer, DWORD nInBufferSize,
  85                                       LPVOID lpOutBuffer, DWORD nOutBufferSize);
  86 extern NTSTATUS COMM_DeviceIoControl(HANDLE hDevice,
  87                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
  88                                      PVOID UserApcContext,
  89                                      PIO_STATUS_BLOCK piosb,
  90                                      ULONG IoControlCode,
  91                                      LPVOID lpInBuffer, DWORD nInBufferSize,
  92                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
  93 extern NTSTATUS TAPE_DeviceIoControl(HANDLE hDevice,
  94                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
  95                                      PVOID UserApcContext,
  96                                      PIO_STATUS_BLOCK piosb,
  97                                      ULONG IoControlCode,
  98                                      LPVOID lpInBuffer, DWORD nInBufferSize,
  99                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
 100
 101 /* file I/O */
 102 extern NTSTATUS FILE_GetNtStatus(void);
 103 extern NTSTATUS FILE_GetDeviceInfo( int fd, FILE_FS_DEVICE_INFORMATION *info );
 104 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name );
 105 extern NTSTATUS DIR_unmount_device( HANDLE handle );
 106 extern NTSTATUS DIR_get_unix_cwd( char **cwd );
 107
 108 /* virtual memory */
 109 extern NTSTATUS VIRTUAL_alloc_teb( void **ret, size_t size, BOOL first );
 110 extern NTSTATUS VIRTUAL_HandleFault(LPCVOID addr);
 111 extern BOOL VIRTUAL_HasMapping( LPCVOID addr );
 112 extern void VIRTUAL_UseLargeAddressSpace(void);
 113
 114 extern BOOL is_current_process( HANDLE handle );
 115
 116 /* code pages */
 117 extern int ntdll_umbstowcs(DWORD flags, const char* src, int srclen, WCHAR* dst, int dstlen);
 118 extern int ntdll_wcstoumbs(DWORD flags, const WCHAR* src, int srclen, char* dst, int dstlen,
 119                            const char* defchar, int *used );
 120
 121 /* load order */
 122
 123 enum loadorder
 124 {
 125     LO_INVALID,
 126     LO_DISABLED,
 127     LO_NATIVE,
 128     LO_BUILTIN,
 129     LO_NATIVE_BUILTIN,  /* native then builtin */
 130     LO_BUILTIN_NATIVE,  /* builtin then native */
 131     LO_DEFAULT          /* nothing specified, use default strategy */
 132 };
 133
 134 extern enum loadorder get_load_order( const WCHAR *app_name, const WCHAR *path );
 135
 136 struct debug_info
 137 {
 138     char *str_pos;       /* current position in strings buffer */
 139     char *out_pos;       /* current position in output buffer */
 140     char  strings[1024]; /* buffer for temporary strings */
 141     char  output[1024];  /* current output line */
 142 };
 143
 144 struct ntdll_thread_data
 145 {
 146     struct debug_info *debug_info;    /* info for debugstr functions */
 147     int                request_fd;    /* fd for sending server requests */
 148     int                reply_fd;      /* fd for receiving server replies */
 149     int                wait_fd[2];    /* fd for sleeping server requests */
 150     void              *vm86_ptr;      /* data for vm86 mode */
 151
 152     void              *pad[4];        /* change this if you add fields! */
 153 };
 154
 155 static inline struct ntdll_thread_data *ntdll_get_thread_data(void)
 156 {
 157     return (struct ntdll_thread_data *)NtCurrentTeb()->SystemReserved2;
 158 }
 159
 160 /* thread registers, stored in NtCurrentTeb()->SpareBytes1 */
 161 struct ntdll_thread_regs
 162 {
 163     DWORD              fs;            /* 00 TEB selector */
 164     DWORD              gs;            /* 04 libc selector; update winebuild if you move this! */
 165     DWORD              dr0;           /* 08 debug registers */
 166     DWORD              dr1;           /* 0c */
 167     DWORD              dr2;           /* 10 */
 168     DWORD              dr3;           /* 14 */
 169     DWORD              dr6;           /* 18 */
 170     DWORD              dr7;           /* 1c */
 171     DWORD              spare[2];      /* 20 change this if you add fields! */
 172 };
 173
 174 static inline struct ntdll_thread_regs *ntdll_get_thread_regs(void)
 175 {
 176     return (struct ntdll_thread_regs *)NtCurrentTeb()->SpareBytes1;
 177 }
 178
 179 #endif