4 * Copyright 1996, 2003 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #include "wine/port.h"
26 #include <sys/types.h>
27 #ifdef HAVE_SYS_MMAN_H
30 #ifdef HAVE_SYS_TIMES_H
31 #include <sys/times.h>
34 #define NONAMELESSUNION
36 #define WIN32_NO_STATUS
38 #include "wine/library.h"
39 #include "wine/server.h"
40 #include "wine/pthread.h"
41 #include "wine/debug.h"
42 #include "ntdll_misc.h"
44 #include "wine/exception.h"
46 WINE_DEFAULT_DEBUG_CHANNEL(thread
);
47 WINE_DECLARE_DEBUG_CHANNEL(relay
);
49 struct _KUSER_SHARED_DATA
*user_shared_data
= NULL
;
51 PUNHANDLED_EXCEPTION_FILTER unhandled_exception_filter
= NULL
;
53 /* info passed to a starting thread */
56 struct wine_pthread_thread_info pthread_info
;
57 PRTL_THREAD_START_ROUTINE entry_point
;
61 static PEB_LDR_DATA ldr
;
62 static RTL_USER_PROCESS_PARAMETERS params
; /* default parameters if no parent */
63 static WCHAR current_dir
[MAX_NT_PATH_LENGTH
];
64 static RTL_BITMAP tls_bitmap
;
65 static RTL_BITMAP tls_expansion_bitmap
;
66 static RTL_BITMAP fls_bitmap
;
67 static LIST_ENTRY tls_links
;
68 static size_t sigstack_total_size
;
69 static ULONG sigstack_zero_bits
;
71 struct wine_pthread_functions pthread_functions
= { NULL
};
74 static RTL_CRITICAL_SECTION ldt_section
;
75 static RTL_CRITICAL_SECTION_DEBUG critsect_debug
=
78 { &critsect_debug
.ProcessLocksList
, &critsect_debug
.ProcessLocksList
},
79 0, 0, { (DWORD_PTR
)(__FILE__
": ldt_section") }
81 static RTL_CRITICAL_SECTION ldt_section
= { &critsect_debug
, -1, 0, 0, 0, 0 };
82 static sigset_t ldt_sigset
;
84 /***********************************************************************
85 * locking for LDT routines
87 static void ldt_lock(void)
91 pthread_sigmask( SIG_BLOCK
, &server_block_set
, &sigset
);
92 RtlEnterCriticalSection( &ldt_section
);
93 if (ldt_section
.RecursionCount
== 1) ldt_sigset
= sigset
;
96 static void ldt_unlock(void)
98 if (ldt_section
.RecursionCount
== 1)
100 sigset_t sigset
= ldt_sigset
;
101 RtlLeaveCriticalSection( &ldt_section
);
102 pthread_sigmask( SIG_SETMASK
, &sigset
, NULL
);
104 else RtlLeaveCriticalSection( &ldt_section
);
108 /***********************************************************************
111 static inline NTSTATUS
init_teb( TEB
*teb
)
113 struct ntdll_thread_data
*thread_data
= (struct ntdll_thread_data
*)teb
->SystemReserved2
;
115 teb
->Tib
.ExceptionList
= (void *)~0UL;
116 teb
->Tib
.StackBase
= (void *)~0UL;
117 teb
->Tib
.Self
= &teb
->Tib
;
118 teb
->StaticUnicodeString
.Buffer
= teb
->StaticUnicodeBuffer
;
119 teb
->StaticUnicodeString
.MaximumLength
= sizeof(teb
->StaticUnicodeBuffer
);
121 if (!(thread_data
->fs
= wine_ldt_alloc_fs())) return STATUS_TOO_MANY_THREADS
;
122 thread_data
->request_fd
= -1;
123 thread_data
->reply_fd
= -1;
124 thread_data
->wait_fd
[0] = -1;
125 thread_data
->wait_fd
[1] = -1;
127 return STATUS_SUCCESS
;
131 /***********************************************************************
134 * Make sure the unicode string doesn't point beyond the end pointer
136 static inline void fix_unicode_string( UNICODE_STRING
*str
, const char *end_ptr
)
138 if ((char *)str
->Buffer
>= end_ptr
)
140 str
->Length
= str
->MaximumLength
= 0;
144 if ((char *)str
->Buffer
+ str
->MaximumLength
> end_ptr
)
146 str
->MaximumLength
= (end_ptr
- (char *)str
->Buffer
) & ~(sizeof(WCHAR
) - 1);
148 if (str
->Length
>= str
->MaximumLength
)
150 if (str
->MaximumLength
>= sizeof(WCHAR
))
151 str
->Length
= str
->MaximumLength
- sizeof(WCHAR
);
153 str
->Length
= str
->MaximumLength
= 0;
158 /***********************************************************************
159 * init_user_process_params
161 * Fill the RTL_USER_PROCESS_PARAMETERS structure from the server.
163 static NTSTATUS
init_user_process_params( SIZE_T info_size
, HANDLE
*exe_file
)
168 RTL_USER_PROCESS_PARAMETERS
*params
= NULL
;
170 status
= NtAllocateVirtualMemory( NtCurrentProcess(), (void **)¶ms
, 0, &info_size
,
171 MEM_COMMIT
, PAGE_READWRITE
);
172 if (status
!= STATUS_SUCCESS
) return status
;
174 params
->AllocationSize
= info_size
;
175 NtCurrentTeb()->Peb
->ProcessParameters
= params
;
177 SERVER_START_REQ( get_startup_info
)
179 wine_server_set_reply( req
, params
, info_size
);
180 if (!(status
= wine_server_call( req
)))
182 info_size
= wine_server_reply_size( reply
);
183 *exe_file
= wine_server_ptr_handle( reply
->exe_file
);
184 params
->hStdInput
= wine_server_ptr_handle( reply
->hstdin
);
185 params
->hStdOutput
= wine_server_ptr_handle( reply
->hstdout
);
186 params
->hStdError
= wine_server_ptr_handle( reply
->hstderr
);
190 if (status
!= STATUS_SUCCESS
) return status
;
192 if (params
->Size
> info_size
) params
->Size
= info_size
;
194 /* make sure the strings are valid */
195 fix_unicode_string( ¶ms
->CurrentDirectory
.DosPath
, (char *)info_size
);
196 fix_unicode_string( ¶ms
->DllPath
, (char *)info_size
);
197 fix_unicode_string( ¶ms
->ImagePathName
, (char *)info_size
);
198 fix_unicode_string( ¶ms
->CommandLine
, (char *)info_size
);
199 fix_unicode_string( ¶ms
->WindowTitle
, (char *)info_size
);
200 fix_unicode_string( ¶ms
->Desktop
, (char *)info_size
);
201 fix_unicode_string( ¶ms
->ShellInfo
, (char *)info_size
);
202 fix_unicode_string( ¶ms
->RuntimeInfo
, (char *)info_size
);
204 /* environment needs to be a separate memory block */
205 env_size
= info_size
- params
->Size
;
206 if (!env_size
) env_size
= 1;
208 status
= NtAllocateVirtualMemory( NtCurrentProcess(), &ptr
, 0, &env_size
,
209 MEM_COMMIT
, PAGE_READWRITE
);
210 if (status
!= STATUS_SUCCESS
) return status
;
211 memcpy( ptr
, (char *)params
+ params
->Size
, info_size
- params
->Size
);
212 params
->Environment
= ptr
;
214 RtlNormalizeProcessParams( params
);
219 /***********************************************************************
222 * Setup the initial thread.
224 * NOTES: The first allocated TEB on NT is at 0x7ffde000.
226 HANDLE
thread_init(void)
231 SIZE_T size
, info_size
;
234 struct ntdll_thread_data
*thread_data
;
235 struct wine_pthread_thread_info thread_info
;
236 static struct debug_info debug_info
; /* debug info for initial thread */
240 /* reserve space for shared user data */
242 addr
= (void *)0x7ffe0000;
244 NtAllocateVirtualMemory( NtCurrentProcess(), &addr
, 0, &size
, MEM_RESERVE
|MEM_COMMIT
, PAGE_READWRITE
);
245 user_shared_data
= addr
;
247 /* allocate and initialize the PEB */
251 NtAllocateVirtualMemory( NtCurrentProcess(), &addr
, 1, &size
,
252 MEM_COMMIT
| MEM_TOP_DOWN
, PAGE_READWRITE
);
255 peb
->NumberOfProcessors
= 1;
256 peb
->ProcessParameters
= ¶ms
;
257 peb
->TlsBitmap
= &tls_bitmap
;
258 peb
->TlsExpansionBitmap
= &tls_expansion_bitmap
;
259 peb
->FlsBitmap
= &fls_bitmap
;
261 params
.CurrentDirectory
.DosPath
.Buffer
= current_dir
;
262 params
.CurrentDirectory
.DosPath
.MaximumLength
= sizeof(current_dir
);
263 params
.wShowWindow
= 1; /* SW_SHOWNORMAL */
264 RtlInitializeBitMap( &tls_bitmap
, peb
->TlsBitmapBits
, sizeof(peb
->TlsBitmapBits
) * 8 );
265 RtlInitializeBitMap( &tls_expansion_bitmap
, peb
->TlsExpansionBitmapBits
,
266 sizeof(peb
->TlsExpansionBitmapBits
) * 8 );
267 RtlInitializeBitMap( &fls_bitmap
, peb
->FlsBitmapBits
, sizeof(peb
->FlsBitmapBits
) * 8 );
268 InitializeListHead( &peb
->FlsListHead
);
269 InitializeListHead( &ldr
.InLoadOrderModuleList
);
270 InitializeListHead( &ldr
.InMemoryOrderModuleList
);
271 InitializeListHead( &ldr
.InInitializationOrderModuleList
);
272 InitializeListHead( &tls_links
);
274 /* allocate and initialize the initial TEB */
276 sigstack_total_size
= get_signal_stack_total_size();
277 while (1U << sigstack_zero_bits
< sigstack_total_size
) sigstack_zero_bits
++;
278 assert( 1U << sigstack_zero_bits
== sigstack_total_size
); /* must be a power of 2 */
279 assert( sigstack_total_size
>= sizeof(TEB
) + sizeof(struct startup_info
) );
280 thread_info
.teb_size
= sigstack_total_size
;
283 size
= sigstack_total_size
;
284 NtAllocateVirtualMemory( NtCurrentProcess(), &addr
, sigstack_zero_bits
,
285 &size
, MEM_COMMIT
| MEM_TOP_DOWN
, PAGE_READWRITE
);
288 thread_info
.teb_size
= size
;
290 thread_data
= (struct ntdll_thread_data
*)teb
->SystemReserved2
;
291 thread_data
->debug_info
= &debug_info
;
292 InsertHeadList( &tls_links
, &teb
->TlsLinks
);
294 thread_info
.stack_base
= NULL
;
295 thread_info
.stack_size
= 0;
296 thread_info
.teb_base
= teb
;
297 thread_info
.teb_sel
= thread_data
->fs
;
298 wine_pthread_get_functions( &pthread_functions
, sizeof(pthread_functions
) );
299 signal_init_thread( teb
);
300 pthread_functions
.init_thread( &thread_info
);
301 virtual_init_threading();
303 debug_info
.str_pos
= debug_info
.strings
;
304 debug_info
.out_pos
= debug_info
.output
;
307 /* setup the server connection */
308 server_init_process();
309 info_size
= server_init_thread( NULL
);
311 /* create the process heap */
312 if (!(peb
->ProcessHeap
= RtlCreateHeap( HEAP_GROWABLE
, NULL
, 0, 0, NULL
, NULL
)))
314 MESSAGE( "wine: failed to create the process heap\n" );
318 /* allocate user parameters */
321 init_user_process_params( info_size
, &exe_file
);
325 /* This is wine specific: we have no parent (we're started from unix)
326 * so, create a simple console with bare handles to unix stdio
328 wine_server_fd_to_handle( 0, GENERIC_READ
|SYNCHRONIZE
, OBJ_INHERIT
, ¶ms
.hStdInput
);
329 wine_server_fd_to_handle( 1, GENERIC_WRITE
|SYNCHRONIZE
, OBJ_INHERIT
, ¶ms
.hStdOutput
);
330 wine_server_fd_to_handle( 2, GENERIC_WRITE
|SYNCHRONIZE
, OBJ_INHERIT
, ¶ms
.hStdError
);
333 /* initialize LDT locking */
334 wine_ldt_init_locking( ldt_lock
, ldt_unlock
);
336 /* initialize time values in user_shared_data */
337 NtQuerySystemTime( &now
);
338 user_shared_data
->SystemTime
.LowPart
= now
.u
.LowPart
;
339 user_shared_data
->SystemTime
.High1Time
= user_shared_data
->SystemTime
.High2Time
= now
.u
.HighPart
;
340 user_shared_data
->u
.TickCountQuad
= (now
.QuadPart
- server_start_time
) / 10000;
341 user_shared_data
->u
.TickCount
.High2Time
= user_shared_data
->u
.TickCount
.High1Time
;
342 user_shared_data
->TickCountLowDeprecated
= user_shared_data
->u
.TickCount
.LowPart
;
343 user_shared_data
->TickCountMultiplier
= 1 << 24;
350 /* wrapper for apps that don't declare the thread function correctly */
351 extern DWORD
call_thread_entry_point( PRTL_THREAD_START_ROUTINE entry
, void *arg
);
352 __ASM_GLOBAL_FUNC(call_thread_entry_point
,
357 "movl 8(%ebp),%eax\n\t"
362 static inline DWORD
call_thread_entry_point( PRTL_THREAD_START_ROUTINE entry
, void *arg
)
364 LPTHREAD_START_ROUTINE func
= (LPTHREAD_START_ROUTINE
)entry
;
369 /***********************************************************************
372 * Hack to make things compatible with the thread procedures used by kernel32.CreateThread.
374 static void DECLSPEC_NORETURN
call_thread_func( PRTL_THREAD_START_ROUTINE rtl_func
, void *arg
)
379 MODULE_DllThreadAttach( NULL
);
382 DPRINTF( "%04x:Starting thread proc %p (arg=%p)\n", GetCurrentThreadId(), rtl_func
, arg
);
384 exit_code
= call_thread_entry_point( rtl_func
, arg
);
386 /* send the exit code to the server */
387 SERVER_START_REQ( terminate_thread
)
389 req
->handle
= wine_server_obj_handle( GetCurrentThread() );
390 req
->exit_code
= exit_code
;
391 wine_server_call( req
);
398 LdrShutdownProcess();
404 server_exit_thread( exit_code
);
409 /***********************************************************************
412 * Startup routine for a newly created thread.
414 static void start_thread( struct wine_pthread_thread_info
*info
)
416 TEB
*teb
= info
->teb_base
;
417 struct ntdll_thread_data
*thread_data
= (struct ntdll_thread_data
*)teb
->SystemReserved2
;
418 struct startup_info
*startup_info
= (struct startup_info
*)info
;
419 PRTL_THREAD_START_ROUTINE func
= startup_info
->entry_point
;
420 void *arg
= startup_info
->entry_arg
;
421 struct debug_info debug_info
;
423 debug_info
.str_pos
= debug_info
.strings
;
424 debug_info
.out_pos
= debug_info
.output
;
425 thread_data
->debug_info
= &debug_info
;
427 signal_init_thread( teb
);
428 server_init_thread( func
);
429 pthread_functions
.init_thread( info
);
430 virtual_alloc_thread_stack( info
->stack_base
, info
->stack_size
);
431 pthread_sigmask( SIG_UNBLOCK
, &server_block_set
, NULL
);
434 InsertHeadList( &tls_links
, &teb
->TlsLinks
);
437 /* NOTE: Windows does not have an exception handler around the call to
438 * the thread attach. We do for ease of debugging */
439 if (unhandled_exception_filter
)
443 call_thread_func( func
, arg
);
445 __EXCEPT(unhandled_exception_filter
)
447 NtTerminateThread( GetCurrentThread(), GetExceptionCode() );
452 call_thread_func( func
, arg
);
456 /***********************************************************************
457 * RtlCreateUserThread (NTDLL.@)
459 NTSTATUS WINAPI
RtlCreateUserThread( HANDLE process
, const SECURITY_DESCRIPTOR
*descr
,
460 BOOLEAN suspended
, PVOID stack_addr
,
461 SIZE_T stack_reserve
, SIZE_T stack_commit
,
462 PRTL_THREAD_START_ROUTINE start
, void *param
,
463 HANDLE
*handle_ptr
, CLIENT_ID
*id
)
466 struct ntdll_thread_data
*thread_data
= NULL
;
467 struct ntdll_thread_regs
*thread_regs
;
468 struct startup_info
*info
= NULL
;
475 SIZE_T size
, page_size
= getpagesize();
477 if (process
!= NtCurrentProcess())
482 memset( &call
, 0, sizeof(call
) );
484 call
.create_thread
.type
= APC_CREATE_THREAD
;
485 call
.create_thread
.func
= wine_server_client_ptr( start
);
486 call
.create_thread
.arg
= wine_server_client_ptr( param
);
487 call
.create_thread
.reserve
= stack_reserve
;
488 call
.create_thread
.commit
= stack_commit
;
489 call
.create_thread
.suspend
= suspended
;
490 status
= NTDLL_queue_process_apc( process
, &call
, &result
);
491 if (status
!= STATUS_SUCCESS
) return status
;
493 if (result
.create_thread
.status
== STATUS_SUCCESS
)
495 if (id
) id
->UniqueThread
= ULongToHandle(result
.create_thread
.tid
);
496 if (handle_ptr
) *handle_ptr
= wine_server_ptr_handle( result
.create_thread
.handle
);
497 else NtClose( wine_server_ptr_handle( result
.create_thread
.handle
));
499 return result
.create_thread
.status
;
502 if (pipe( request_pipe
) == -1) return STATUS_TOO_MANY_OPENED_FILES
;
503 fcntl( request_pipe
[1], F_SETFD
, 1 ); /* set close on exec flag */
504 wine_server_send_fd( request_pipe
[0] );
506 SERVER_START_REQ( new_thread
)
508 req
->access
= THREAD_ALL_ACCESS
;
509 req
->attributes
= 0; /* FIXME */
510 req
->suspend
= suspended
;
511 req
->request_fd
= request_pipe
[0];
512 if (!(status
= wine_server_call( req
)))
514 handle
= wine_server_ptr_handle( reply
->handle
);
517 close( request_pipe
[0] );
523 close( request_pipe
[1] );
527 pthread_sigmask( SIG_BLOCK
, &server_block_set
, &sigset
);
530 size
= sigstack_total_size
;
531 if ((status
= NtAllocateVirtualMemory( NtCurrentProcess(), &addr
, sigstack_zero_bits
,
532 &size
, MEM_COMMIT
| MEM_TOP_DOWN
, PAGE_READWRITE
)))
535 teb
->Peb
= NtCurrentTeb()->Peb
;
536 info
= (struct startup_info
*)(teb
+ 1);
537 info
->pthread_info
.teb_size
= size
;
538 if ((status
= init_teb( teb
))) goto error
;
540 teb
->ClientId
.UniqueProcess
= ULongToHandle(GetCurrentProcessId());
541 teb
->ClientId
.UniqueThread
= ULongToHandle(tid
);
543 thread_data
= (struct ntdll_thread_data
*)teb
->SystemReserved2
;
544 thread_regs
= (struct ntdll_thread_regs
*)teb
->SpareBytes1
;
545 thread_data
->request_fd
= request_pipe
[1];
547 info
->pthread_info
.teb_base
= teb
;
548 info
->pthread_info
.teb_sel
= thread_data
->fs
;
550 /* inherit debug registers from parent thread */
551 thread_regs
->dr0
= ntdll_get_thread_regs()->dr0
;
552 thread_regs
->dr1
= ntdll_get_thread_regs()->dr1
;
553 thread_regs
->dr2
= ntdll_get_thread_regs()->dr2
;
554 thread_regs
->dr3
= ntdll_get_thread_regs()->dr3
;
555 thread_regs
->dr6
= ntdll_get_thread_regs()->dr6
;
556 thread_regs
->dr7
= ntdll_get_thread_regs()->dr7
;
558 if (!stack_reserve
|| !stack_commit
)
560 IMAGE_NT_HEADERS
*nt
= RtlImageNtHeader( NtCurrentTeb()->Peb
->ImageBaseAddress
);
561 if (!stack_reserve
) stack_reserve
= nt
->OptionalHeader
.SizeOfStackReserve
;
562 if (!stack_commit
) stack_commit
= nt
->OptionalHeader
.SizeOfStackCommit
;
564 if (stack_reserve
< stack_commit
) stack_reserve
= stack_commit
;
565 stack_reserve
+= page_size
; /* for the guard page */
566 stack_reserve
= (stack_reserve
+ 0xffff) & ~0xffff; /* round to 64K boundary */
567 if (stack_reserve
< 1024 * 1024) stack_reserve
= 1024 * 1024; /* Xlib needs a large stack */
569 info
->pthread_info
.stack_base
= NULL
;
570 info
->pthread_info
.stack_size
= stack_reserve
;
571 info
->pthread_info
.entry
= start_thread
;
572 info
->entry_point
= start
;
573 info
->entry_arg
= param
;
575 if (pthread_functions
.create_thread( &info
->pthread_info
) == -1)
577 status
= STATUS_NO_MEMORY
;
580 pthread_sigmask( SIG_SETMASK
, &sigset
, NULL
);
582 if (id
) id
->UniqueThread
= ULongToHandle(tid
);
583 if (handle_ptr
) *handle_ptr
= handle
;
584 else NtClose( handle
);
586 return STATUS_SUCCESS
;
589 if (thread_data
) wine_ldt_free_fs( thread_data
->fs
);
593 NtFreeVirtualMemory( NtCurrentProcess(), &addr
, &size
, MEM_RELEASE
);
595 if (handle
) NtClose( handle
);
596 pthread_sigmask( SIG_SETMASK
, &sigset
, NULL
);
597 close( request_pipe
[1] );
602 /***********************************************************************
603 * RtlExitUserThread (NTDLL.@)
605 void WINAPI
RtlExitUserThread( ULONG status
)
609 SERVER_START_REQ( terminate_thread
)
611 /* send the exit code to the server */
612 req
->handle
= wine_server_obj_handle( GetCurrentThread() );
613 req
->exit_code
= status
;
614 wine_server_call( req
);
621 LdrShutdownProcess();
627 server_exit_thread( status
);
632 /***********************************************************************
633 * NtOpenThread (NTDLL.@)
634 * ZwOpenThread (NTDLL.@)
636 NTSTATUS WINAPI
NtOpenThread( HANDLE
*handle
, ACCESS_MASK access
,
637 const OBJECT_ATTRIBUTES
*attr
, const CLIENT_ID
*id
)
641 SERVER_START_REQ( open_thread
)
643 req
->tid
= HandleToULong(id
->UniqueThread
);
644 req
->access
= access
;
645 req
->attributes
= attr
? attr
->Attributes
: 0;
646 ret
= wine_server_call( req
);
647 *handle
= wine_server_ptr_handle( reply
->handle
);
654 /******************************************************************************
655 * NtSuspendThread (NTDLL.@)
656 * ZwSuspendThread (NTDLL.@)
658 NTSTATUS WINAPI
NtSuspendThread( HANDLE handle
, PULONG count
)
662 SERVER_START_REQ( suspend_thread
)
664 req
->handle
= wine_server_obj_handle( handle
);
665 if (!(ret
= wine_server_call( req
))) *count
= reply
->count
;
672 /******************************************************************************
673 * NtResumeThread (NTDLL.@)
674 * ZwResumeThread (NTDLL.@)
676 NTSTATUS WINAPI
NtResumeThread( HANDLE handle
, PULONG count
)
680 SERVER_START_REQ( resume_thread
)
682 req
->handle
= wine_server_obj_handle( handle
);
683 if (!(ret
= wine_server_call( req
))) *count
= reply
->count
;
690 /******************************************************************************
691 * NtAlertResumeThread (NTDLL.@)
692 * ZwAlertResumeThread (NTDLL.@)
694 NTSTATUS WINAPI
NtAlertResumeThread( HANDLE handle
, PULONG count
)
696 FIXME( "stub: should alert thread %p\n", handle
);
697 return NtResumeThread( handle
, count
);
701 /******************************************************************************
702 * NtAlertThread (NTDLL.@)
703 * ZwAlertThread (NTDLL.@)
705 NTSTATUS WINAPI
NtAlertThread( HANDLE handle
)
707 FIXME( "stub: %p\n", handle
);
708 return STATUS_NOT_IMPLEMENTED
;
712 /******************************************************************************
713 * NtTerminateThread (NTDLL.@)
714 * ZwTerminateThread (NTDLL.@)
716 NTSTATUS WINAPI
NtTerminateThread( HANDLE handle
, LONG exit_code
)
721 SERVER_START_REQ( terminate_thread
)
723 req
->handle
= wine_server_obj_handle( handle
);
724 req
->exit_code
= exit_code
;
725 ret
= wine_server_call( req
);
726 self
= !ret
&& reply
->self
;
733 if (last
) exit( exit_code
);
734 else server_abort_thread( exit_code
);
740 /******************************************************************************
741 * NtQueueApcThread (NTDLL.@)
743 NTSTATUS WINAPI
NtQueueApcThread( HANDLE handle
, PNTAPCFUNC func
, ULONG_PTR arg1
,
744 ULONG_PTR arg2
, ULONG_PTR arg3
)
747 SERVER_START_REQ( queue_apc
)
749 req
->handle
= wine_server_obj_handle( handle
);
752 req
->call
.type
= APC_USER
;
753 req
->call
.user
.func
= wine_server_client_ptr( func
);
754 req
->call
.user
.args
[0] = arg1
;
755 req
->call
.user
.args
[1] = arg2
;
756 req
->call
.user
.args
[2] = arg3
;
758 else req
->call
.type
= APC_NONE
; /* wake up only */
759 ret
= wine_server_call( req
);
766 /***********************************************************************
767 * NtSetContextThread (NTDLL.@)
768 * ZwSetContextThread (NTDLL.@)
770 NTSTATUS WINAPI
NtSetContextThread( HANDLE handle
, const CONTEXT
*context
)
777 /* on i386 debug registers always require a server call */
778 self
= (handle
== GetCurrentThread());
779 if (self
&& (context
->ContextFlags
& (CONTEXT_DEBUG_REGISTERS
& ~CONTEXT_i386
)))
781 struct ntdll_thread_regs
* const regs
= ntdll_get_thread_regs();
782 self
= (regs
->dr0
== context
->Dr0
&& regs
->dr1
== context
->Dr1
&&
783 regs
->dr2
== context
->Dr2
&& regs
->dr3
== context
->Dr3
&&
784 regs
->dr6
== context
->Dr6
&& regs
->dr7
== context
->Dr7
);
790 SERVER_START_REQ( set_thread_context
)
792 req
->handle
= wine_server_obj_handle( handle
);
793 req
->flags
= context
->ContextFlags
;
795 wine_server_add_data( req
, context
, sizeof(*context
) );
796 ret
= wine_server_call( req
);
801 if (ret
== STATUS_PENDING
)
803 if (NtSuspendThread( handle
, &dummy
) == STATUS_SUCCESS
)
805 for (i
= 0; i
< 100; i
++)
807 SERVER_START_REQ( set_thread_context
)
809 req
->handle
= wine_server_obj_handle( handle
);
810 req
->flags
= context
->ContextFlags
;
812 wine_server_add_data( req
, context
, sizeof(*context
) );
813 ret
= wine_server_call( req
);
816 if (ret
== STATUS_PENDING
)
818 LARGE_INTEGER timeout
;
819 timeout
.QuadPart
= -10000;
820 NtDelayExecution( FALSE
, &timeout
);
824 NtResumeThread( handle
, &dummy
);
826 if (ret
== STATUS_PENDING
) ret
= STATUS_ACCESS_DENIED
;
832 if (self
) set_cpu_context( context
);
833 return STATUS_SUCCESS
;
837 /* copy a context structure according to the flags */
838 static inline void copy_context( CONTEXT
*to
, const CONTEXT
*from
, DWORD flags
)
841 flags
&= ~CONTEXT_i386
; /* get rid of CPU id */
842 if (flags
& CONTEXT_INTEGER
)
851 if (flags
& CONTEXT_CONTROL
)
856 to
->SegCs
= from
->SegCs
;
857 to
->SegSs
= from
->SegSs
;
858 to
->EFlags
= from
->EFlags
;
860 if (flags
& CONTEXT_SEGMENTS
)
862 to
->SegDs
= from
->SegDs
;
863 to
->SegEs
= from
->SegEs
;
864 to
->SegFs
= from
->SegFs
;
865 to
->SegGs
= from
->SegGs
;
867 if (flags
& CONTEXT_DEBUG_REGISTERS
)
876 if (flags
& CONTEXT_FLOATING_POINT
)
878 to
->FloatSave
= from
->FloatSave
;
880 if (flags
& CONTEXT_EXTENDED_REGISTERS
)
882 memcpy( to
->ExtendedRegisters
, from
->ExtendedRegisters
, sizeof(to
->ExtendedRegisters
) );
884 #elif defined(__x86_64__)
885 flags
&= ~CONTEXT_AMD64
; /* get rid of CPU id */
886 if (flags
& CONTEXT_CONTROL
)
891 to
->SegCs
= from
->SegCs
;
892 to
->SegSs
= from
->SegSs
;
893 to
->EFlags
= from
->EFlags
;
894 to
->MxCsr
= from
->MxCsr
;
896 if (flags
& CONTEXT_INTEGER
)
913 if (flags
& CONTEXT_SEGMENTS
)
915 to
->SegDs
= from
->SegDs
;
916 to
->SegEs
= from
->SegEs
;
917 to
->SegFs
= from
->SegFs
;
918 to
->SegGs
= from
->SegGs
;
920 if (flags
& CONTEXT_FLOATING_POINT
)
922 to
->u
.FltSave
= from
->u
.FltSave
;
924 if (flags
& CONTEXT_DEBUG_REGISTERS
)
933 #elif defined(__sparc__)
934 flags
&= ~CONTEXT_SPARC
; /* get rid of CPU id */
935 if (flags
& CONTEXT_CONTROL
)
944 if (flags
& CONTEXT_INTEGER
)
979 if (flags
& CONTEXT_FLOATING_POINT
)
983 #elif defined(__powerpc__)
985 if (flags
& CONTEXT_CONTROL
)
991 if (flags
& CONTEXT_INTEGER
)
993 to
->Gpr0
= from
->Gpr0
;
994 to
->Gpr1
= from
->Gpr1
;
995 to
->Gpr2
= from
->Gpr2
;
996 to
->Gpr3
= from
->Gpr3
;
997 to
->Gpr4
= from
->Gpr4
;
998 to
->Gpr5
= from
->Gpr5
;
999 to
->Gpr6
= from
->Gpr6
;
1000 to
->Gpr7
= from
->Gpr7
;
1001 to
->Gpr8
= from
->Gpr8
;
1002 to
->Gpr9
= from
->Gpr9
;
1003 to
->Gpr10
= from
->Gpr10
;
1004 to
->Gpr11
= from
->Gpr11
;
1005 to
->Gpr12
= from
->Gpr12
;
1006 to
->Gpr13
= from
->Gpr13
;
1007 to
->Gpr14
= from
->Gpr14
;
1008 to
->Gpr15
= from
->Gpr15
;
1009 to
->Gpr16
= from
->Gpr16
;
1010 to
->Gpr17
= from
->Gpr17
;
1011 to
->Gpr18
= from
->Gpr18
;
1012 to
->Gpr19
= from
->Gpr19
;
1013 to
->Gpr20
= from
->Gpr20
;
1014 to
->Gpr21
= from
->Gpr21
;
1015 to
->Gpr22
= from
->Gpr22
;
1016 to
->Gpr23
= from
->Gpr23
;
1017 to
->Gpr24
= from
->Gpr24
;
1018 to
->Gpr25
= from
->Gpr25
;
1019 to
->Gpr26
= from
->Gpr26
;
1020 to
->Gpr27
= from
->Gpr27
;
1021 to
->Gpr28
= from
->Gpr28
;
1022 to
->Gpr29
= from
->Gpr29
;
1023 to
->Gpr30
= from
->Gpr30
;
1024 to
->Gpr31
= from
->Gpr31
;
1025 to
->Xer
= from
->Xer
;
1028 if (flags
& CONTEXT_FLOATING_POINT
)
1030 to
->Fpr0
= from
->Fpr0
;
1031 to
->Fpr1
= from
->Fpr1
;
1032 to
->Fpr2
= from
->Fpr2
;
1033 to
->Fpr3
= from
->Fpr3
;
1034 to
->Fpr4
= from
->Fpr4
;
1035 to
->Fpr5
= from
->Fpr5
;
1036 to
->Fpr6
= from
->Fpr6
;
1037 to
->Fpr7
= from
->Fpr7
;
1038 to
->Fpr8
= from
->Fpr8
;
1039 to
->Fpr9
= from
->Fpr9
;
1040 to
->Fpr10
= from
->Fpr10
;
1041 to
->Fpr11
= from
->Fpr11
;
1042 to
->Fpr12
= from
->Fpr12
;
1043 to
->Fpr13
= from
->Fpr13
;
1044 to
->Fpr14
= from
->Fpr14
;
1045 to
->Fpr15
= from
->Fpr15
;
1046 to
->Fpr16
= from
->Fpr16
;
1047 to
->Fpr17
= from
->Fpr17
;
1048 to
->Fpr18
= from
->Fpr18
;
1049 to
->Fpr19
= from
->Fpr19
;
1050 to
->Fpr20
= from
->Fpr20
;
1051 to
->Fpr21
= from
->Fpr21
;
1052 to
->Fpr22
= from
->Fpr22
;
1053 to
->Fpr23
= from
->Fpr23
;
1054 to
->Fpr24
= from
->Fpr24
;
1055 to
->Fpr25
= from
->Fpr25
;
1056 to
->Fpr26
= from
->Fpr26
;
1057 to
->Fpr27
= from
->Fpr27
;
1058 to
->Fpr28
= from
->Fpr28
;
1059 to
->Fpr29
= from
->Fpr29
;
1060 to
->Fpr30
= from
->Fpr30
;
1061 to
->Fpr31
= from
->Fpr31
;
1062 to
->Fpscr
= from
->Fpscr
;
1065 #error You must implement context copying for your CPU
1070 /***********************************************************************
1071 * NtGetContextThread (NTDLL.@)
1072 * ZwGetContextThread (NTDLL.@)
1074 NTSTATUS WINAPI
NtGetContextThread( HANDLE handle
, CONTEXT
*context
)
1079 DWORD needed_flags
= context
->ContextFlags
;
1080 BOOL self
= (handle
== GetCurrentThread());
1083 /* on i386 debug registers always require a server call */
1084 if (context
->ContextFlags
& (CONTEXT_DEBUG_REGISTERS
& ~CONTEXT_i386
)) self
= FALSE
;
1089 SERVER_START_REQ( get_thread_context
)
1091 req
->handle
= wine_server_obj_handle( handle
);
1092 req
->flags
= context
->ContextFlags
;
1094 wine_server_set_reply( req
, &ctx
, sizeof(ctx
) );
1095 ret
= wine_server_call( req
);
1100 if (ret
== STATUS_PENDING
)
1102 if (NtSuspendThread( handle
, &dummy
) == STATUS_SUCCESS
)
1104 for (i
= 0; i
< 100; i
++)
1106 SERVER_START_REQ( get_thread_context
)
1108 req
->handle
= wine_server_obj_handle( handle
);
1109 req
->flags
= context
->ContextFlags
;
1111 wine_server_set_reply( req
, &ctx
, sizeof(ctx
) );
1112 ret
= wine_server_call( req
);
1115 if (ret
== STATUS_PENDING
)
1117 LARGE_INTEGER timeout
;
1118 timeout
.QuadPart
= -10000;
1119 NtDelayExecution( FALSE
, &timeout
);
1123 NtResumeThread( handle
, &dummy
);
1125 if (ret
== STATUS_PENDING
) ret
= STATUS_ACCESS_DENIED
;
1127 if (ret
) return ret
;
1128 copy_context( context
, &ctx
, context
->ContextFlags
& ctx
.ContextFlags
);
1129 needed_flags
&= ~ctx
.ContextFlags
;
1136 RtlCaptureContext( &ctx
);
1137 copy_context( context
, &ctx
, ctx
.ContextFlags
& needed_flags
);
1140 /* update the cached version of the debug registers */
1141 if (context
->ContextFlags
& (CONTEXT_DEBUG_REGISTERS
& ~CONTEXT_i386
))
1143 struct ntdll_thread_regs
* const regs
= ntdll_get_thread_regs();
1144 regs
->dr0
= context
->Dr0
;
1145 regs
->dr1
= context
->Dr1
;
1146 regs
->dr2
= context
->Dr2
;
1147 regs
->dr3
= context
->Dr3
;
1148 regs
->dr6
= context
->Dr6
;
1149 regs
->dr7
= context
->Dr7
;
1153 return STATUS_SUCCESS
;
1157 /******************************************************************************
1158 * NtQueryInformationThread (NTDLL.@)
1159 * ZwQueryInformationThread (NTDLL.@)
1161 NTSTATUS WINAPI
NtQueryInformationThread( HANDLE handle
, THREADINFOCLASS
class,
1162 void *data
, ULONG length
, ULONG
*ret_len
)
1168 case ThreadBasicInformation
:
1170 THREAD_BASIC_INFORMATION info
;
1171 const ULONG_PTR affinity_mask
= ((ULONG_PTR
)1 << NtCurrentTeb()->Peb
->NumberOfProcessors
) - 1;
1173 SERVER_START_REQ( get_thread_info
)
1175 req
->handle
= wine_server_obj_handle( handle
);
1177 if (!(status
= wine_server_call( req
)))
1179 info
.ExitStatus
= reply
->exit_code
;
1180 info
.TebBaseAddress
= wine_server_get_ptr( reply
->teb
);
1181 info
.ClientId
.UniqueProcess
= ULongToHandle(reply
->pid
);
1182 info
.ClientId
.UniqueThread
= ULongToHandle(reply
->tid
);
1183 info
.AffinityMask
= reply
->affinity
& affinity_mask
;
1184 info
.Priority
= reply
->priority
;
1185 info
.BasePriority
= reply
->priority
; /* FIXME */
1189 if (status
== STATUS_SUCCESS
)
1191 if (data
) memcpy( data
, &info
, min( length
, sizeof(info
) ));
1192 if (ret_len
) *ret_len
= min( length
, sizeof(info
) );
1196 case ThreadAffinityMask
:
1198 const ULONG_PTR affinity_mask
= ((ULONG_PTR
)1 << NtCurrentTeb()->Peb
->NumberOfProcessors
) - 1;
1199 ULONG_PTR affinity
= 0;
1201 SERVER_START_REQ( get_thread_info
)
1203 req
->handle
= wine_server_obj_handle( handle
);
1205 if (!(status
= wine_server_call( req
)))
1206 affinity
= reply
->affinity
& affinity_mask
;
1209 if (status
== STATUS_SUCCESS
)
1211 if (data
) memcpy( data
, &affinity
, min( length
, sizeof(affinity
) ));
1212 if (ret_len
) *ret_len
= min( length
, sizeof(affinity
) );
1218 KERNEL_USER_TIMES kusrt
;
1219 /* We need to do a server call to get the creation time or exit time */
1220 /* This works on any thread */
1221 SERVER_START_REQ( get_thread_info
)
1223 req
->handle
= wine_server_obj_handle( handle
);
1225 status
= wine_server_call( req
);
1226 if (status
== STATUS_SUCCESS
)
1228 kusrt
.CreateTime
.QuadPart
= reply
->creation_time
;
1229 kusrt
.ExitTime
.QuadPart
= reply
->exit_time
;
1233 if (status
== STATUS_SUCCESS
)
1235 /* We call times(2) for kernel time or user time */
1236 /* We can only (portably) do this for the current thread */
1237 if (handle
== GetCurrentThread())
1239 struct tms time_buf
;
1240 long clocks_per_sec
= sysconf(_SC_CLK_TCK
);
1243 kusrt
.KernelTime
.QuadPart
= (ULONGLONG
)time_buf
.tms_stime
* 10000000 / clocks_per_sec
;
1244 kusrt
.UserTime
.QuadPart
= (ULONGLONG
)time_buf
.tms_utime
* 10000000 / clocks_per_sec
;
1248 static BOOL reported
= FALSE
;
1250 kusrt
.KernelTime
.QuadPart
= 0;
1251 kusrt
.UserTime
.QuadPart
= 0;
1253 TRACE("Cannot get kerneltime or usertime of other threads\n");
1256 FIXME("Cannot get kerneltime or usertime of other threads\n");
1260 if (data
) memcpy( data
, &kusrt
, min( length
, sizeof(kusrt
) ));
1261 if (ret_len
) *ret_len
= min( length
, sizeof(kusrt
) );
1265 case ThreadDescriptorTableEntry
:
1268 THREAD_DESCRIPTOR_INFORMATION
* tdi
= data
;
1269 if (length
< sizeof(*tdi
))
1270 status
= STATUS_INFO_LENGTH_MISMATCH
;
1271 else if (!(tdi
->Selector
& 4)) /* GDT selector */
1273 unsigned sel
= tdi
->Selector
& ~3; /* ignore RPL */
1274 status
= STATUS_SUCCESS
;
1275 if (!sel
) /* null selector */
1276 memset( &tdi
->Entry
, 0, sizeof(tdi
->Entry
) );
1279 tdi
->Entry
.BaseLow
= 0;
1280 tdi
->Entry
.HighWord
.Bits
.BaseMid
= 0;
1281 tdi
->Entry
.HighWord
.Bits
.BaseHi
= 0;
1282 tdi
->Entry
.LimitLow
= 0xffff;
1283 tdi
->Entry
.HighWord
.Bits
.LimitHi
= 0xf;
1284 tdi
->Entry
.HighWord
.Bits
.Dpl
= 3;
1285 tdi
->Entry
.HighWord
.Bits
.Sys
= 0;
1286 tdi
->Entry
.HighWord
.Bits
.Pres
= 1;
1287 tdi
->Entry
.HighWord
.Bits
.Granularity
= 1;
1288 tdi
->Entry
.HighWord
.Bits
.Default_Big
= 1;
1289 tdi
->Entry
.HighWord
.Bits
.Type
= 0x12;
1290 /* it has to be one of the system GDT selectors */
1291 if (sel
!= (wine_get_ds() & ~3) && sel
!= (wine_get_ss() & ~3))
1293 if (sel
== (wine_get_cs() & ~3))
1294 tdi
->Entry
.HighWord
.Bits
.Type
|= 8; /* code segment */
1295 else status
= STATUS_ACCESS_DENIED
;
1301 SERVER_START_REQ( get_selector_entry
)
1303 req
->handle
= wine_server_obj_handle( handle
);
1304 req
->entry
= tdi
->Selector
>> 3;
1305 status
= wine_server_call( req
);
1308 if (!(reply
->flags
& WINE_LDT_FLAGS_ALLOCATED
))
1309 status
= STATUS_ACCESS_VIOLATION
;
1312 wine_ldt_set_base ( &tdi
->Entry
, (void *)reply
->base
);
1313 wine_ldt_set_limit( &tdi
->Entry
, reply
->limit
);
1314 wine_ldt_set_flags( &tdi
->Entry
, reply
->flags
);
1320 if (status
== STATUS_SUCCESS
&& ret_len
)
1321 /* yes, that's a bit strange, but it's the way it is */
1322 *ret_len
= sizeof(LDT_ENTRY
);
1324 status
= STATUS_NOT_IMPLEMENTED
;
1328 case ThreadAmILastThread
:
1330 SERVER_START_REQ(get_thread_info
)
1332 req
->handle
= wine_server_obj_handle( handle
);
1334 status
= wine_server_call( req
);
1335 if (status
== STATUS_SUCCESS
)
1337 BOOLEAN last
= reply
->last
;
1338 if (data
) memcpy( data
, &last
, min( length
, sizeof(last
) ));
1339 if (ret_len
) *ret_len
= min( length
, sizeof(last
) );
1345 case ThreadPriority
:
1346 case ThreadBasePriority
:
1347 case ThreadImpersonationToken
:
1348 case ThreadEnableAlignmentFaultFixup
:
1349 case ThreadEventPair_Reusable
:
1350 case ThreadQuerySetWin32StartAddress
:
1351 case ThreadZeroTlsCell
:
1352 case ThreadPerformanceCount
:
1353 case ThreadIdealProcessor
:
1354 case ThreadPriorityBoost
:
1355 case ThreadSetTlsArrayAddress
:
1356 case ThreadIsIoPending
:
1358 FIXME( "info class %d not supported yet\n", class );
1359 return STATUS_NOT_IMPLEMENTED
;
1364 /******************************************************************************
1365 * NtSetInformationThread (NTDLL.@)
1366 * ZwSetInformationThread (NTDLL.@)
1368 NTSTATUS WINAPI
NtSetInformationThread( HANDLE handle
, THREADINFOCLASS
class,
1369 LPCVOID data
, ULONG length
)
1374 case ThreadZeroTlsCell
:
1375 if (handle
== GetCurrentThread())
1380 if (length
!= sizeof(DWORD
)) return STATUS_INVALID_PARAMETER
;
1381 index
= *(const DWORD
*)data
;
1382 if (index
< TLS_MINIMUM_AVAILABLE
)
1384 RtlAcquirePebLock();
1385 for (entry
= tls_links
.Flink
; entry
!= &tls_links
; entry
= entry
->Flink
)
1387 TEB
*teb
= CONTAINING_RECORD(entry
, TEB
, TlsLinks
);
1388 teb
->TlsSlots
[index
] = 0;
1390 RtlReleasePebLock();
1394 index
-= TLS_MINIMUM_AVAILABLE
;
1395 if (index
>= 8 * sizeof(NtCurrentTeb()->Peb
->TlsExpansionBitmapBits
))
1396 return STATUS_INVALID_PARAMETER
;
1397 RtlAcquirePebLock();
1398 for (entry
= tls_links
.Flink
; entry
!= &tls_links
; entry
= entry
->Flink
)
1400 TEB
*teb
= CONTAINING_RECORD(entry
, TEB
, TlsLinks
);
1401 if (teb
->TlsExpansionSlots
) teb
->TlsExpansionSlots
[index
] = 0;
1403 RtlReleasePebLock();
1405 return STATUS_SUCCESS
;
1407 FIXME( "ZeroTlsCell not supported on other threads\n" );
1408 return STATUS_NOT_IMPLEMENTED
;
1410 case ThreadImpersonationToken
:
1412 const HANDLE
*phToken
= data
;
1413 if (length
!= sizeof(HANDLE
)) return STATUS_INVALID_PARAMETER
;
1414 TRACE("Setting ThreadImpersonationToken handle to %p\n", *phToken
);
1415 SERVER_START_REQ( set_thread_info
)
1417 req
->handle
= wine_server_obj_handle( handle
);
1418 req
->token
= wine_server_obj_handle( *phToken
);
1419 req
->mask
= SET_THREAD_INFO_TOKEN
;
1420 status
= wine_server_call( req
);
1425 case ThreadBasePriority
:
1427 const DWORD
*pprio
= data
;
1428 if (length
!= sizeof(DWORD
)) return STATUS_INVALID_PARAMETER
;
1429 SERVER_START_REQ( set_thread_info
)
1431 req
->handle
= wine_server_obj_handle( handle
);
1432 req
->priority
= *pprio
;
1433 req
->mask
= SET_THREAD_INFO_PRIORITY
;
1434 status
= wine_server_call( req
);
1439 case ThreadAffinityMask
:
1441 const ULONG_PTR affinity_mask
= ((ULONG_PTR
)1 << NtCurrentTeb()->Peb
->NumberOfProcessors
) - 1;
1442 const ULONG_PTR
*paff
= data
;
1443 if (length
!= sizeof(ULONG_PTR
)) return STATUS_INVALID_PARAMETER
;
1444 if (*paff
& ~affinity_mask
) return STATUS_INVALID_PARAMETER
;
1445 SERVER_START_REQ( set_thread_info
)
1447 req
->handle
= wine_server_obj_handle( handle
);
1448 req
->affinity
= *paff
;
1449 req
->mask
= SET_THREAD_INFO_AFFINITY
;
1450 status
= wine_server_call( req
);
1455 case ThreadBasicInformation
:
1457 case ThreadPriority
:
1458 case ThreadDescriptorTableEntry
:
1459 case ThreadEnableAlignmentFaultFixup
:
1460 case ThreadEventPair_Reusable
:
1461 case ThreadQuerySetWin32StartAddress
:
1462 case ThreadPerformanceCount
:
1463 case ThreadAmILastThread
:
1464 case ThreadIdealProcessor
:
1465 case ThreadPriorityBoost
:
1466 case ThreadSetTlsArrayAddress
:
1467 case ThreadIsIoPending
:
1469 FIXME( "info class %d not supported yet\n", class );
1470 return STATUS_NOT_IMPLEMENTED
;