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