advapi32/ntdll: MakeRelativeSD should preserve NULL pointers (with testcase).
[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
25 #include "windef.h"
26 #include "winnt.h"
27 #include "winternl.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 NTSTATUS NTDLL_queue_process_apc( HANDLE process, const apc_call_t *call, apc_result_t *result );
43 extern NTSTATUS NTDLL_wait_for_multiple_objects( UINT count, const HANDLE *handles, UINT flags,
44                                                  const LARGE_INTEGER *timeout, HANDLE signal_object );
45
46 /* init routines */
47 extern BOOL SIGNAL_Init(void);
48 extern size_t get_signal_stack_total_size(void);
49 extern void version_init( const WCHAR *appname );
50 extern void debug_init(void);
51 extern HANDLE thread_init(void);
52 extern void actctx_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 windows_dir;
81 extern UNICODE_STRING system_dir;
82
83 /* redefine these to make sure we don't reference kernel symbols */
84 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
85 #define GetCurrentProcessId()  (HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess))
86 #define GetCurrentThreadId()   (HandleToULong(NtCurrentTeb()->ClientId.UniqueThread))
87
88 /* Device IO */
89 extern NTSTATUS CDROM_DeviceIoControl(HANDLE hDevice, 
90                                       HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
91                                       PVOID UserApcContext, 
92                                       PIO_STATUS_BLOCK piosb, 
93                                       ULONG IoControlCode,
94                                       LPVOID lpInBuffer, DWORD nInBufferSize,
95                                       LPVOID lpOutBuffer, DWORD nOutBufferSize);
96 extern NTSTATUS COMM_DeviceIoControl(HANDLE hDevice, 
97                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
98                                      PVOID UserApcContext, 
99                                      PIO_STATUS_BLOCK piosb, 
100                                      ULONG IoControlCode,
101                                      LPVOID lpInBuffer, DWORD nInBufferSize,
102                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
103 extern NTSTATUS TAPE_DeviceIoControl(HANDLE hDevice, 
104                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
105                                      PVOID UserApcContext, 
106                                      PIO_STATUS_BLOCK piosb, 
107                                      ULONG IoControlCode,
108                                      LPVOID lpInBuffer, DWORD nInBufferSize,
109                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
110
111 /* file I/O */
112 extern NTSTATUS FILE_GetNtStatus(void);
113 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name );
114 extern NTSTATUS DIR_unmount_device( HANDLE handle );
115 extern NTSTATUS DIR_get_unix_cwd( char **cwd );
116
117 /* virtual memory */
118 extern NTSTATUS VIRTUAL_HandleFault(LPCVOID addr);
119 extern void VIRTUAL_SetForceExec( BOOL enable );
120 extern void VIRTUAL_UseLargeAddressSpace(void);
121 extern struct _KUSER_SHARED_DATA *user_shared_data;
122
123 /* code pages */
124 extern int ntdll_umbstowcs(DWORD flags, const char* src, int srclen, WCHAR* dst, int dstlen);
125 extern int ntdll_wcstoumbs(DWORD flags, const WCHAR* src, int srclen, char* dst, int dstlen,
126                            const char* defchar, int *used );
127
128 /* load order */
129
130 enum loadorder
131 {
132     LO_INVALID,
133     LO_DISABLED,
134     LO_NATIVE,
135     LO_BUILTIN,
136     LO_NATIVE_BUILTIN,  /* native then builtin */
137     LO_BUILTIN_NATIVE,  /* builtin then native */
138     LO_DEFAULT          /* nothing specified, use default strategy */
139 };
140
141 extern enum loadorder get_load_order( const WCHAR *app_name, const WCHAR *path );
142
143 struct debug_info
144 {
145     char *str_pos;       /* current position in strings buffer */
146     char *out_pos;       /* current position in output buffer */
147     char  strings[1024]; /* buffer for temporary strings */
148     char  output[1024];  /* current output line */
149 };
150
151 /* thread private data, stored in NtCurrentTeb()->SystemReserved2 */
152 struct ntdll_thread_data
153 {
154     DWORD              fs;            /* 1d4 TEB selector */
155     DWORD              gs;            /* 1d8 libc selector; update winebuild if you move this! */
156     struct debug_info *debug_info;    /* 1dc info for debugstr functions */
157     int                request_fd;    /* 1e0 fd for sending server requests */
158     int                reply_fd;      /* 1e4 fd for receiving server replies */
159     int                wait_fd[2];    /* 1e8 fd for sleeping server requests */
160     void              *vm86_ptr;      /* 1f0 data for vm86 mode */
161
162     void              *pad[2];        /* 1f4 change this if you add fields! */
163 };
164
165 static inline struct ntdll_thread_data *ntdll_get_thread_data(void)
166 {
167     return (struct ntdll_thread_data *)NtCurrentTeb()->SystemReserved2;
168 }
169
170 /* thread debug_registers, stored in NtCurrentTeb()->SpareBytes1 */
171 struct ntdll_thread_regs
172 {
173     DWORD dr0;
174     DWORD dr1;
175     DWORD dr2;
176     DWORD dr3;
177     DWORD dr6;
178     DWORD dr7;
179 };
180
181 static inline struct ntdll_thread_regs *ntdll_get_thread_regs(void)
182 {
183     return (struct ntdll_thread_regs *)NtCurrentTeb()->SpareBytes1;
184 }
185
186 #endif