mpr: Remove unused variables.
[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 BOOL SIGNAL_Init(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 actctx_init(void);
62 extern void virtual_init(void);
63 extern void virtual_init_threading(void);
64
65 /* server support */
66 extern timeout_t server_start_time;
67 extern void server_init_process(void);
68 extern NTSTATUS server_init_process_done(void);
69 extern size_t server_init_thread( int unix_pid, int unix_tid, void *entry_point );
70 extern void DECLSPEC_NORETURN server_protocol_error( const char *err, ... );
71 extern void DECLSPEC_NORETURN server_protocol_perror( const char *err );
72 extern void DECLSPEC_NORETURN server_exit_thread( int status );
73 extern void DECLSPEC_NORETURN server_abort_thread( int status );
74 extern sigset_t server_block_set;
75 extern void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
76 extern void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
77 extern int server_remove_fd_from_cache( obj_handle_t handle );
78 extern int server_get_unix_fd( obj_handle_t handle, unsigned int access, int *unix_fd,
79                                int *needs_close, enum server_fd_type *type, unsigned int *options );
80
81 /* security descriptors */
82 NTSTATUS NTDLL_create_struct_sd(PSECURITY_DESCRIPTOR nt_sd, struct security_descriptor **server_sd,
83                                 data_size_t *server_sd_len);
84 void NTDLL_free_struct_sd(struct security_descriptor *server_sd);
85
86 /* module handling */
87 extern NTSTATUS MODULE_DllThreadAttach( LPVOID lpReserved );
88 extern FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
89                                      DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user );
90 extern FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
91                                      FARPROC origfun, DWORD ordinal, const WCHAR *user );
92 extern void RELAY_SetupDLL( HMODULE hmod );
93 extern void SNOOP_SetupDLL( HMODULE hmod );
94 extern UNICODE_STRING windows_dir;
95 extern UNICODE_STRING system_dir;
96
97 typedef LONG (WINAPI *PUNHANDLED_EXCEPTION_FILTER)(PEXCEPTION_POINTERS);
98 extern PUNHANDLED_EXCEPTION_FILTER unhandled_exception_filter;
99
100 /* redefine these to make sure we don't reference kernel symbols */
101 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
102 #define GetCurrentProcessId()  (HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess))
103 #define GetCurrentThreadId()   (HandleToULong(NtCurrentTeb()->ClientId.UniqueThread))
104
105 /* Device IO */
106 extern NTSTATUS CDROM_DeviceIoControl(HANDLE hDevice, 
107                                       HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
108                                       PVOID UserApcContext, 
109                                       PIO_STATUS_BLOCK piosb, 
110                                       ULONG IoControlCode,
111                                       LPVOID lpInBuffer, DWORD nInBufferSize,
112                                       LPVOID lpOutBuffer, DWORD nOutBufferSize);
113 extern NTSTATUS COMM_DeviceIoControl(HANDLE hDevice, 
114                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
115                                      PVOID UserApcContext, 
116                                      PIO_STATUS_BLOCK piosb, 
117                                      ULONG IoControlCode,
118                                      LPVOID lpInBuffer, DWORD nInBufferSize,
119                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
120 extern NTSTATUS TAPE_DeviceIoControl(HANDLE hDevice, 
121                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
122                                      PVOID UserApcContext, 
123                                      PIO_STATUS_BLOCK piosb, 
124                                      ULONG IoControlCode,
125                                      LPVOID lpInBuffer, DWORD nInBufferSize,
126                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
127
128 /* file I/O */
129 extern NTSTATUS FILE_GetNtStatus(void);
130 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name );
131 extern NTSTATUS DIR_unmount_device( HANDLE handle );
132 extern NTSTATUS DIR_get_unix_cwd( char **cwd );
133 extern unsigned int DIR_get_drives_info( struct drive_info info[MAX_DOS_DRIVES] );
134
135 /* virtual memory */
136 extern NTSTATUS virtual_alloc_thread_stack( void *base, SIZE_T stack_size );
137 extern BOOL virtual_handle_stack_fault( void *addr );
138 extern NTSTATUS VIRTUAL_HandleFault(LPCVOID addr);
139 extern void VIRTUAL_SetForceExec( BOOL enable );
140 extern void VIRTUAL_UseLargeAddressSpace(void);
141 extern struct _KUSER_SHARED_DATA *user_shared_data;
142
143 /* code pages */
144 extern int ntdll_umbstowcs(DWORD flags, const char* src, int srclen, WCHAR* dst, int dstlen);
145 extern int ntdll_wcstoumbs(DWORD flags, const WCHAR* src, int srclen, char* dst, int dstlen,
146                            const char* defchar, int *used );
147
148 /* load order */
149
150 enum loadorder
151 {
152     LO_INVALID,
153     LO_DISABLED,
154     LO_NATIVE,
155     LO_BUILTIN,
156     LO_NATIVE_BUILTIN,  /* native then builtin */
157     LO_BUILTIN_NATIVE,  /* builtin then native */
158     LO_DEFAULT          /* nothing specified, use default strategy */
159 };
160
161 extern enum loadorder get_load_order( const WCHAR *app_name, const WCHAR *path );
162
163 struct debug_info
164 {
165     char *str_pos;       /* current position in strings buffer */
166     char *out_pos;       /* current position in output buffer */
167     char  strings[1024]; /* buffer for temporary strings */
168     char  output[1024];  /* current output line */
169 };
170
171 /* thread private data, stored in NtCurrentTeb()->SystemReserved2 */
172 struct ntdll_thread_data
173 {
174     DWORD              fs;            /* 1d4 TEB selector */
175     DWORD              gs;            /* 1d8 libc selector; update winebuild if you move this! */
176     struct debug_info *debug_info;    /* 1dc info for debugstr functions */
177     int                request_fd;    /* 1e0 fd for sending server requests */
178     int                reply_fd;      /* 1e4 fd for receiving server replies */
179     int                wait_fd[2];    /* 1e8 fd for sleeping server requests */
180     void              *vm86_ptr;      /* 1f0 data for vm86 mode */
181
182     void              *pad[2];        /* 1f4 change this if you add fields! */
183 };
184
185 static inline struct ntdll_thread_data *ntdll_get_thread_data(void)
186 {
187     return (struct ntdll_thread_data *)NtCurrentTeb()->SystemReserved2;
188 }
189
190 /* thread debug_registers, stored in NtCurrentTeb()->SpareBytes1 */
191 struct ntdll_thread_regs
192 {
193     DWORD dr0;
194     DWORD dr1;
195     DWORD dr2;
196     DWORD dr3;
197     DWORD dr6;
198     DWORD dr7;
199 };
200
201 static inline struct ntdll_thread_regs *ntdll_get_thread_regs(void)
202 {
203     return (struct ntdll_thread_regs *)NtCurrentTeb()->SpareBytes1;
204 }
205
206 /* Completion */
207 extern NTSTATUS NTDLL_AddCompletion( HANDLE hFile, ULONG_PTR CompletionValue, NTSTATUS CompletionStatus, ULONG_PTR Information );
208
209 #endif