server: Make the address argument for read/write_process_memory a client_ptr_t.
[wine] / 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
26 #include "windef.h"
27 #include "winnt.h"
28 #include "winternl.h"
29 #include "wine/server.h"
30
31 #define MAX_NT_PATH_LENGTH 277
32
33 #define MAX_DOS_DRIVES 26
34
35 struct drive_info
36 {
37     dev_t dev;
38     ino_t ino;
39 };
40
41 /* exceptions */
42 extern void wait_suspend( CONTEXT *context );
43 extern void WINAPI __regs_RtlRaiseException( PEXCEPTION_RECORD, PCONTEXT );
44 extern void get_cpu_context( CONTEXT *context );
45 extern void set_cpu_context( const CONTEXT *context );
46
47 /* debug helper */
48 extern LPCSTR debugstr_us( const UNICODE_STRING *str );
49 extern void dump_ObjectAttributes (const OBJECT_ATTRIBUTES *ObjectAttributes);
50
51 extern NTSTATUS NTDLL_queue_process_apc( HANDLE process, const apc_call_t *call, apc_result_t *result );
52 extern NTSTATUS NTDLL_wait_for_multiple_objects( UINT count, const HANDLE *handles, UINT flags,
53                                                  const LARGE_INTEGER *timeout, HANDLE signal_object );
54
55 /* init routines */
56 extern void signal_init_thread(void);
57 extern void signal_init_process(void);
58 extern size_t get_signal_stack_total_size(void);
59 extern void version_init( const WCHAR *appname );
60 extern void debug_init(void);
61 extern HANDLE thread_init(void);
62 extern void pthread_init(void);
63 extern void actctx_init(void);
64 extern void virtual_init(void);
65 extern void virtual_init_threading(void);
66
67 /* server support */
68 extern timeout_t server_start_time;
69 extern void server_init_process(void);
70 extern NTSTATUS server_init_process_done(void);
71 extern size_t server_init_thread( int unix_pid, int unix_tid, void *entry_point );
72 extern void DECLSPEC_NORETURN server_protocol_error( const char *err, ... );
73 extern void DECLSPEC_NORETURN server_protocol_perror( const char *err );
74 extern void DECLSPEC_NORETURN server_exit_thread( int status );
75 extern void DECLSPEC_NORETURN server_abort_thread( int status );
76 extern sigset_t server_block_set;
77 extern void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
78 extern void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
79 extern int server_remove_fd_from_cache( HANDLE handle );
80 extern int server_get_unix_fd( HANDLE handle, unsigned int access, int *unix_fd,
81                                int *needs_close, enum server_fd_type *type, unsigned int *options );
82
83 /* security descriptors */
84 NTSTATUS NTDLL_create_struct_sd(PSECURITY_DESCRIPTOR nt_sd, struct security_descriptor **server_sd,
85                                 data_size_t *server_sd_len);
86 void NTDLL_free_struct_sd(struct security_descriptor *server_sd);
87
88 /* module handling */
89 extern NTSTATUS MODULE_DllThreadAttach( LPVOID lpReserved );
90 extern FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
91                                      DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user );
92 extern FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
93                                      FARPROC origfun, DWORD ordinal, const WCHAR *user );
94 extern void RELAY_SetupDLL( HMODULE hmod );
95 extern void SNOOP_SetupDLL( HMODULE hmod );
96 extern UNICODE_STRING windows_dir;
97 extern UNICODE_STRING system_dir;
98
99 typedef LONG (WINAPI *PUNHANDLED_EXCEPTION_FILTER)(PEXCEPTION_POINTERS);
100 extern PUNHANDLED_EXCEPTION_FILTER unhandled_exception_filter;
101
102 /* redefine these to make sure we don't reference kernel symbols */
103 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
104 #define GetCurrentProcessId()  (HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess))
105 #define GetCurrentThreadId()   (HandleToULong(NtCurrentTeb()->ClientId.UniqueThread))
106
107 /* Device IO */
108 extern NTSTATUS CDROM_DeviceIoControl(HANDLE hDevice, 
109                                       HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
110                                       PVOID UserApcContext, 
111                                       PIO_STATUS_BLOCK piosb, 
112                                       ULONG IoControlCode,
113                                       LPVOID lpInBuffer, DWORD nInBufferSize,
114                                       LPVOID lpOutBuffer, DWORD nOutBufferSize);
115 extern NTSTATUS COMM_DeviceIoControl(HANDLE hDevice, 
116                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
117                                      PVOID UserApcContext, 
118                                      PIO_STATUS_BLOCK piosb, 
119                                      ULONG IoControlCode,
120                                      LPVOID lpInBuffer, DWORD nInBufferSize,
121                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
122 extern NTSTATUS TAPE_DeviceIoControl(HANDLE hDevice, 
123                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
124                                      PVOID UserApcContext, 
125                                      PIO_STATUS_BLOCK piosb, 
126                                      ULONG IoControlCode,
127                                      LPVOID lpInBuffer, DWORD nInBufferSize,
128                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
129
130 /* file I/O */
131 extern NTSTATUS FILE_GetNtStatus(void);
132 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name );
133 extern NTSTATUS DIR_unmount_device( HANDLE handle );
134 extern NTSTATUS DIR_get_unix_cwd( char **cwd );
135 extern unsigned int DIR_get_drives_info( struct drive_info info[MAX_DOS_DRIVES] );
136
137 /* virtual memory */
138 extern void virtual_get_system_info( SYSTEM_BASIC_INFORMATION *info );
139 extern NTSTATUS virtual_create_system_view( void *base, SIZE_T size, DWORD vprot );
140 extern SIZE_T virtual_free_system_view( PVOID *addr_ptr );
141 extern NTSTATUS virtual_alloc_thread_stack( void *base, SIZE_T stack_size );
142 extern void virtual_clear_thread_stack(void);
143 extern BOOL virtual_handle_stack_fault( void *addr );
144 extern NTSTATUS virtual_handle_fault( LPCVOID addr, DWORD err );
145 extern void VIRTUAL_SetForceExec( BOOL enable );
146 extern void VIRTUAL_UseLargeAddressSpace(void);
147 extern struct _KUSER_SHARED_DATA *user_shared_data;
148
149 /* completion */
150 extern NTSTATUS NTDLL_AddCompletion( HANDLE hFile, ULONG_PTR CompletionValue,
151                                      NTSTATUS CompletionStatus, ULONG Information );
152
153 /* code pages */
154 extern int ntdll_umbstowcs(DWORD flags, const char* src, int srclen, WCHAR* dst, int dstlen);
155 extern int ntdll_wcstoumbs(DWORD flags, const WCHAR* src, int srclen, char* dst, int dstlen,
156                            const char* defchar, int *used );
157
158 /* load order */
159
160 enum loadorder
161 {
162     LO_INVALID,
163     LO_DISABLED,
164     LO_NATIVE,
165     LO_BUILTIN,
166     LO_NATIVE_BUILTIN,  /* native then builtin */
167     LO_BUILTIN_NATIVE,  /* builtin then native */
168     LO_DEFAULT          /* nothing specified, use default strategy */
169 };
170
171 extern enum loadorder get_load_order( const WCHAR *app_name, const WCHAR *path );
172
173 struct debug_info
174 {
175     char *str_pos;       /* current position in strings buffer */
176     char *out_pos;       /* current position in output buffer */
177     char  strings[1024]; /* buffer for temporary strings */
178     char  output[1024];  /* current output line */
179 };
180
181 /* thread private data, stored in NtCurrentTeb()->SystemReserved2 */
182 struct ntdll_thread_data
183 {
184     DWORD              fs;            /* 1d4 TEB selector */
185     DWORD              gs;            /* 1d8 libc selector; update winebuild if you move this! */
186     struct debug_info *debug_info;    /* 1dc info for debugstr functions */
187     int                request_fd;    /* 1e0 fd for sending server requests */
188     int                reply_fd;      /* 1e4 fd for receiving server replies */
189     int                wait_fd[2];    /* 1e8 fd for sleeping server requests */
190     void              *vm86_ptr;      /* 1f0 data for vm86 mode */
191     void              *pthread_data;  /* 1f4 private data for pthread emulation */
192
193     void              *pad[1];        /* 1f8 change this if you add fields! */
194 };
195
196 static inline struct ntdll_thread_data *ntdll_get_thread_data(void)
197 {
198     return (struct ntdll_thread_data *)NtCurrentTeb()->SystemReserved2;
199 }
200
201 /* thread debug_registers, stored in NtCurrentTeb()->SpareBytes1 */
202 struct ntdll_thread_regs
203 {
204     DWORD dr0;
205     DWORD dr1;
206     DWORD dr2;
207     DWORD dr3;
208     DWORD dr6;
209     DWORD dr7;
210 };
211
212 static inline struct ntdll_thread_regs *ntdll_get_thread_regs(void)
213 {
214     return (struct ntdll_thread_regs *)NtCurrentTeb()->SpareBytes1;
215 }
216
217 /* Register functions */
218
219 #ifdef __i386__
220 #define DEFINE_REGS_ENTRYPOINT( name, args, pop_args ) \
221     __ASM_GLOBAL_FUNC( name, \
222                        "pushl %eax\n\t" \
223                        "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t" \
224                        ".long " __ASM_NAME("__regs_") #name "-.\n\t" \
225                        ".byte " #args "," #pop_args )
226 /* FIXME: add support for other CPUs */
227 #endif
228
229 #endif