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