ntdll: Setup the shared user data structure at 0x7ffe0000.
[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 virtual_init(void);
53 extern void virtual_init_threading(void);
54
55 /* server support */
56 extern timeout_t server_start_time;
57 extern void server_init_process(void);
58 extern NTSTATUS server_init_process_done(void);
59 extern size_t server_init_thread( int unix_pid, int unix_tid, void *entry_point );
60 extern void DECLSPEC_NORETURN server_protocol_error( const char *err, ... );
61 extern void DECLSPEC_NORETURN server_protocol_perror( const char *err );
62 extern void DECLSPEC_NORETURN server_exit_thread( int status );
63 extern void DECLSPEC_NORETURN server_abort_thread( int status );
64 extern sigset_t server_block_set;
65 extern void server_enter_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
66 extern void server_leave_uninterrupted_section( RTL_CRITICAL_SECTION *cs, sigset_t *sigset );
67 extern int server_remove_fd_from_cache( obj_handle_t handle );
68 extern int server_get_unix_fd( obj_handle_t handle, unsigned int access, int *unix_fd,
69                                int *needs_close, enum server_fd_type *type, unsigned int *options );
70
71 /* module handling */
72 extern NTSTATUS MODULE_DllThreadAttach( LPVOID lpReserved );
73 extern FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
74                                      DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user );
75 extern FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
76                                      FARPROC origfun, DWORD ordinal, const WCHAR *user );
77 extern void RELAY_SetupDLL( HMODULE hmod );
78 extern void SNOOP_SetupDLL( HMODULE hmod );
79 extern UNICODE_STRING system_dir;
80
81 /* redefine these to make sure we don't reference kernel symbols */
82 #define GetProcessHeap()       (NtCurrentTeb()->Peb->ProcessHeap)
83 #define GetCurrentProcessId()  ((DWORD)NtCurrentTeb()->ClientId.UniqueProcess)
84 #define GetCurrentThreadId()   ((DWORD)NtCurrentTeb()->ClientId.UniqueThread)
85
86 /* Device IO */
87 extern NTSTATUS CDROM_DeviceIoControl(HANDLE hDevice, 
88                                       HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
89                                       PVOID UserApcContext, 
90                                       PIO_STATUS_BLOCK piosb, 
91                                       ULONG IoControlCode,
92                                       LPVOID lpInBuffer, DWORD nInBufferSize,
93                                       LPVOID lpOutBuffer, DWORD nOutBufferSize);
94 extern NTSTATUS COMM_DeviceIoControl(HANDLE hDevice, 
95                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
96                                      PVOID UserApcContext, 
97                                      PIO_STATUS_BLOCK piosb, 
98                                      ULONG IoControlCode,
99                                      LPVOID lpInBuffer, DWORD nInBufferSize,
100                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
101 extern NTSTATUS TAPE_DeviceIoControl(HANDLE hDevice, 
102                                      HANDLE hEvent, PIO_APC_ROUTINE UserApcRoutine,
103                                      PVOID UserApcContext, 
104                                      PIO_STATUS_BLOCK piosb, 
105                                      ULONG IoControlCode,
106                                      LPVOID lpInBuffer, DWORD nInBufferSize,
107                                      LPVOID lpOutBuffer, DWORD nOutBufferSize);
108
109 /* file I/O */
110 extern NTSTATUS FILE_GetNtStatus(void);
111 extern BOOL DIR_is_hidden_file( const UNICODE_STRING *name );
112 extern NTSTATUS DIR_unmount_device( HANDLE handle );
113 extern NTSTATUS DIR_get_unix_cwd( char **cwd );
114
115 /* virtual memory */
116 extern NTSTATUS VIRTUAL_HandleFault(LPCVOID addr);
117 extern void VIRTUAL_SetForceExec( BOOL enable );
118 extern void VIRTUAL_UseLargeAddressSpace(void);
119 extern struct _KUSER_SHARED_DATA *user_shared_data;
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