shell32: SHGFI_EXETYPE flag should have the files returning 0 if they are DLL images.
[wine/wine64.git] / server / thread.c
blobb8aff7122901b231c134c5a86076bcc035da75b1
1 /*
2 * Server-side thread management
4 * Copyright (C) 1998 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
21 #include "config.h"
22 #include "wine/port.h"
24 #include <assert.h>
25 #include <errno.h>
26 #include <fcntl.h>
27 #include <signal.h>
28 #include <stdarg.h>
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <sys/types.h>
33 #include <unistd.h>
34 #include <time.h>
35 #ifdef HAVE_POLL_H
36 #include <poll.h>
37 #endif
39 #include "ntstatus.h"
40 #define WIN32_NO_STATUS
41 #include "windef.h"
42 #include "winternl.h"
44 #include "file.h"
45 #include "handle.h"
46 #include "process.h"
47 #include "thread.h"
48 #include "request.h"
49 #include "user.h"
50 #include "security.h"
53 /* thread queues */
55 struct thread_wait
57 struct thread_wait *next; /* next wait structure for this thread */
58 struct thread *thread; /* owner thread */
59 int count; /* count of objects */
60 int flags;
61 void *cookie; /* magic cookie to return to client */
62 timeout_t timeout;
63 struct timeout_user *user;
64 struct wait_queue_entry queues[1];
67 /* asynchronous procedure calls */
69 struct thread_apc
71 struct object obj; /* object header */
72 struct list entry; /* queue linked list */
73 struct thread *caller; /* thread that queued this apc */
74 struct object *owner; /* object that queued this apc */
75 int executed; /* has it been executed by the client? */
76 apc_call_t call; /* call arguments */
77 apc_result_t result; /* call results once executed */
80 static void dump_thread_apc( struct object *obj, int verbose );
81 static int thread_apc_signaled( struct object *obj, struct thread *thread );
82 static void thread_apc_destroy( struct object *obj );
83 static void clear_apc_queue( struct list *queue );
85 static const struct object_ops thread_apc_ops =
87 sizeof(struct thread_apc), /* size */
88 dump_thread_apc, /* dump */
89 add_queue, /* add_queue */
90 remove_queue, /* remove_queue */
91 thread_apc_signaled, /* signaled */
92 no_satisfied, /* satisfied */
93 no_signal, /* signal */
94 no_get_fd, /* get_fd */
95 no_map_access, /* map_access */
96 no_lookup_name, /* lookup_name */
97 no_open_file, /* open_file */
98 no_close_handle, /* close_handle */
99 thread_apc_destroy /* destroy */
103 /* thread operations */
105 static void dump_thread( struct object *obj, int verbose );
106 static int thread_signaled( struct object *obj, struct thread *thread );
107 static unsigned int thread_map_access( struct object *obj, unsigned int access );
108 static void thread_poll_event( struct fd *fd, int event );
109 static void destroy_thread( struct object *obj );
111 static const struct object_ops thread_ops =
113 sizeof(struct thread), /* size */
114 dump_thread, /* dump */
115 add_queue, /* add_queue */
116 remove_queue, /* remove_queue */
117 thread_signaled, /* signaled */
118 no_satisfied, /* satisfied */
119 no_signal, /* signal */
120 no_get_fd, /* get_fd */
121 thread_map_access, /* map_access */
122 no_lookup_name, /* lookup_name */
123 no_open_file, /* open_file */
124 no_close_handle, /* close_handle */
125 destroy_thread /* destroy */
128 static const struct fd_ops thread_fd_ops =
130 NULL, /* get_poll_events */
131 thread_poll_event, /* poll_event */
132 NULL, /* flush */
133 NULL, /* get_fd_type */
134 NULL, /* ioctl */
135 NULL, /* queue_async */
136 NULL, /* reselect_async */
137 NULL /* cancel_async */
140 static struct list thread_list = LIST_INIT(thread_list);
142 /* initialize the structure for a newly allocated thread */
143 static inline void init_thread_structure( struct thread *thread )
145 int i;
147 thread->unix_pid = -1; /* not known yet */
148 thread->unix_tid = -1; /* not known yet */
149 thread->context = NULL;
150 thread->suspend_context = NULL;
151 thread->teb = NULL;
152 thread->debug_ctx = NULL;
153 thread->debug_event = NULL;
154 thread->debug_break = 0;
155 thread->queue = NULL;
156 thread->wait = NULL;
157 thread->error = 0;
158 thread->req_data = NULL;
159 thread->req_toread = 0;
160 thread->reply_data = NULL;
161 thread->reply_towrite = 0;
162 thread->request_fd = NULL;
163 thread->reply_fd = NULL;
164 thread->wait_fd = NULL;
165 thread->state = RUNNING;
166 thread->exit_code = 0;
167 thread->priority = 0;
168 thread->affinity = 1;
169 thread->suspend = 0;
170 thread->desktop_users = 0;
171 thread->token = NULL;
173 thread->creation_time = current_time;
174 thread->exit_time = 0;
176 list_init( &thread->mutex_list );
177 list_init( &thread->system_apc );
178 list_init( &thread->user_apc );
180 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
181 thread->inflight[i].server = thread->inflight[i].client = -1;
184 /* check if address looks valid for a client-side data structure (TEB etc.) */
185 static inline int is_valid_address( void *addr )
187 return addr && !((unsigned long)addr % sizeof(int));
190 /* create a new thread */
191 struct thread *create_thread( int fd, struct process *process )
193 struct thread *thread;
195 if (!(thread = alloc_object( &thread_ops ))) return NULL;
197 init_thread_structure( thread );
199 thread->process = (struct process *)grab_object( process );
200 thread->desktop = process->desktop;
201 if (!current) current = thread;
203 list_add_head( &thread_list, &thread->entry );
205 if (!(thread->id = alloc_ptid( thread )))
207 release_object( thread );
208 return NULL;
210 if (!(thread->request_fd = create_anonymous_fd( &thread_fd_ops, fd, &thread->obj, 0 )))
212 release_object( thread );
213 return NULL;
216 set_fd_events( thread->request_fd, POLLIN ); /* start listening to events */
217 add_process_thread( thread->process, thread );
218 return thread;
221 /* handle a client event */
222 static void thread_poll_event( struct fd *fd, int event )
224 struct thread *thread = get_fd_user( fd );
225 assert( thread->obj.ops == &thread_ops );
227 if (event & (POLLERR | POLLHUP)) kill_thread( thread, 0 );
228 else if (event & POLLIN) read_request( thread );
229 else if (event & POLLOUT) write_reply( thread );
232 /* cleanup everything that is no longer needed by a dead thread */
233 /* used by destroy_thread and kill_thread */
234 static void cleanup_thread( struct thread *thread )
236 int i;
238 clear_apc_queue( &thread->system_apc );
239 clear_apc_queue( &thread->user_apc );
240 free( thread->req_data );
241 free( thread->reply_data );
242 if (thread->request_fd) release_object( thread->request_fd );
243 if (thread->reply_fd) release_object( thread->reply_fd );
244 if (thread->wait_fd) release_object( thread->wait_fd );
245 free( thread->suspend_context );
246 free_msg_queue( thread );
247 cleanup_clipboard_thread(thread);
248 destroy_thread_windows( thread );
249 close_thread_desktop( thread );
250 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
252 if (thread->inflight[i].client != -1)
254 close( thread->inflight[i].server );
255 thread->inflight[i].client = thread->inflight[i].server = -1;
258 thread->req_data = NULL;
259 thread->reply_data = NULL;
260 thread->request_fd = NULL;
261 thread->reply_fd = NULL;
262 thread->wait_fd = NULL;
263 thread->context = NULL;
264 thread->suspend_context = NULL;
265 thread->desktop = 0;
268 /* destroy a thread when its refcount is 0 */
269 static void destroy_thread( struct object *obj )
271 struct thread *thread = (struct thread *)obj;
272 assert( obj->ops == &thread_ops );
274 assert( !thread->debug_ctx ); /* cannot still be debugging something */
275 list_remove( &thread->entry );
276 cleanup_thread( thread );
277 release_object( thread->process );
278 if (thread->id) free_ptid( thread->id );
279 if (thread->token) release_object( thread->token );
282 /* dump a thread on stdout for debugging purposes */
283 static void dump_thread( struct object *obj, int verbose )
285 struct thread *thread = (struct thread *)obj;
286 assert( obj->ops == &thread_ops );
288 fprintf( stderr, "Thread id=%04x unix pid=%d unix tid=%d teb=%p state=%d\n",
289 thread->id, thread->unix_pid, thread->unix_tid, thread->teb, thread->state );
292 static int thread_signaled( struct object *obj, struct thread *thread )
294 struct thread *mythread = (struct thread *)obj;
295 return (mythread->state == TERMINATED);
298 static unsigned int thread_map_access( struct object *obj, unsigned int access )
300 if (access & GENERIC_READ) access |= STANDARD_RIGHTS_READ | SYNCHRONIZE;
301 if (access & GENERIC_WRITE) access |= STANDARD_RIGHTS_WRITE | SYNCHRONIZE;
302 if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
303 if (access & GENERIC_ALL) access |= THREAD_ALL_ACCESS;
304 return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
307 static void dump_thread_apc( struct object *obj, int verbose )
309 struct thread_apc *apc = (struct thread_apc *)obj;
310 assert( obj->ops == &thread_apc_ops );
312 fprintf( stderr, "APC owner=%p type=%u\n", apc->owner, apc->call.type );
315 static int thread_apc_signaled( struct object *obj, struct thread *thread )
317 struct thread_apc *apc = (struct thread_apc *)obj;
318 return apc->executed;
321 static void thread_apc_destroy( struct object *obj )
323 struct thread_apc *apc = (struct thread_apc *)obj;
324 if (apc->caller) release_object( apc->caller );
325 if (apc->owner) release_object( apc->owner );
328 /* queue an async procedure call */
329 static struct thread_apc *create_apc( struct object *owner, const apc_call_t *call_data )
331 struct thread_apc *apc;
333 if ((apc = alloc_object( &thread_apc_ops )))
335 apc->call = *call_data;
336 apc->caller = NULL;
337 apc->owner = owner;
338 apc->executed = 0;
339 apc->result.type = APC_NONE;
340 if (owner) grab_object( owner );
342 return apc;
345 /* get a thread pointer from a thread id (and increment the refcount) */
346 struct thread *get_thread_from_id( thread_id_t id )
348 struct object *obj = get_ptid_entry( id );
350 if (obj && obj->ops == &thread_ops) return (struct thread *)grab_object( obj );
351 set_error( STATUS_INVALID_CID );
352 return NULL;
355 /* get a thread from a handle (and increment the refcount) */
356 struct thread *get_thread_from_handle( obj_handle_t handle, unsigned int access )
358 return (struct thread *)get_handle_obj( current->process, handle,
359 access, &thread_ops );
362 /* find a thread from a Unix tid */
363 struct thread *get_thread_from_tid( int tid )
365 struct thread *thread;
367 LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
369 if (thread->unix_tid == tid) return thread;
371 return NULL;
374 /* find a thread from a Unix pid */
375 struct thread *get_thread_from_pid( int pid )
377 struct thread *thread;
379 LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
381 if (thread->unix_pid == pid) return thread;
383 return NULL;
386 /* set all information about a thread */
387 static void set_thread_info( struct thread *thread,
388 const struct set_thread_info_request *req )
390 if (req->mask & SET_THREAD_INFO_PRIORITY)
391 thread->priority = req->priority;
392 if (req->mask & SET_THREAD_INFO_AFFINITY)
394 if (req->affinity != 1) set_error( STATUS_INVALID_PARAMETER );
395 else thread->affinity = req->affinity;
397 if (req->mask & SET_THREAD_INFO_TOKEN)
398 security_set_thread_token( thread, req->token );
401 /* stop a thread (at the Unix level) */
402 void stop_thread( struct thread *thread )
404 if (thread->context) return; /* already inside a debug event, no need for a signal */
405 /* can't stop a thread while initialisation is in progress */
406 if (is_process_init_done(thread->process)) send_thread_signal( thread, SIGUSR1 );
409 /* suspend a thread */
410 static int suspend_thread( struct thread *thread )
412 int old_count = thread->suspend;
413 if (thread->suspend < MAXIMUM_SUSPEND_COUNT)
415 if (!(thread->process->suspend + thread->suspend++)) stop_thread( thread );
417 else set_error( STATUS_SUSPEND_COUNT_EXCEEDED );
418 return old_count;
421 /* resume a thread */
422 static int resume_thread( struct thread *thread )
424 int old_count = thread->suspend;
425 if (thread->suspend > 0)
427 if (!(--thread->suspend + thread->process->suspend)) wake_thread( thread );
429 return old_count;
432 /* add a thread to an object wait queue; return 1 if OK, 0 on error */
433 int add_queue( struct object *obj, struct wait_queue_entry *entry )
435 grab_object( obj );
436 entry->obj = obj;
437 list_add_tail( &obj->wait_queue, &entry->entry );
438 return 1;
441 /* remove a thread from an object wait queue */
442 void remove_queue( struct object *obj, struct wait_queue_entry *entry )
444 list_remove( &entry->entry );
445 release_object( obj );
448 /* finish waiting */
449 static void end_wait( struct thread *thread )
451 struct thread_wait *wait = thread->wait;
452 struct wait_queue_entry *entry;
453 int i;
455 assert( wait );
456 thread->wait = wait->next;
457 for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
458 entry->obj->ops->remove_queue( entry->obj, entry );
459 if (wait->user) remove_timeout_user( wait->user );
460 free( wait );
463 /* build the thread wait structure */
464 static int wait_on( unsigned int count, struct object *objects[], int flags, timeout_t timeout )
466 struct thread_wait *wait;
467 struct wait_queue_entry *entry;
468 unsigned int i;
470 if (!(wait = mem_alloc( FIELD_OFFSET(struct thread_wait, queues[count]) ))) return 0;
471 wait->next = current->wait;
472 wait->thread = current;
473 wait->count = count;
474 wait->flags = flags;
475 wait->user = NULL;
476 wait->timeout = timeout;
477 current->wait = wait;
479 for (i = 0, entry = wait->queues; i < count; i++, entry++)
481 struct object *obj = objects[i];
482 entry->thread = current;
483 if (!obj->ops->add_queue( obj, entry ))
485 wait->count = i;
486 end_wait( current );
487 return 0;
490 return 1;
493 /* check if the thread waiting condition is satisfied */
494 static int check_wait( struct thread *thread )
496 int i, signaled;
497 struct thread_wait *wait = thread->wait;
498 struct wait_queue_entry *entry = wait->queues;
500 /* Suspended threads may not acquire locks, but they can run system APCs */
501 if (thread->process->suspend + thread->suspend > 0)
503 if ((wait->flags & SELECT_INTERRUPTIBLE) && !list_empty( &thread->system_apc ))
504 return STATUS_USER_APC;
505 return -1;
508 assert( wait );
509 if (wait->flags & SELECT_ALL)
511 int not_ok = 0;
512 /* Note: we must check them all anyway, as some objects may
513 * want to do something when signaled, even if others are not */
514 for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
515 not_ok |= !entry->obj->ops->signaled( entry->obj, thread );
516 if (not_ok) goto other_checks;
517 /* Wait satisfied: tell it to all objects */
518 signaled = 0;
519 for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
520 if (entry->obj->ops->satisfied( entry->obj, thread ))
521 signaled = STATUS_ABANDONED_WAIT_0;
522 return signaled;
524 else
526 for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
528 if (!entry->obj->ops->signaled( entry->obj, thread )) continue;
529 /* Wait satisfied: tell it to the object */
530 signaled = i;
531 if (entry->obj->ops->satisfied( entry->obj, thread ))
532 signaled = i + STATUS_ABANDONED_WAIT_0;
533 return signaled;
537 other_checks:
538 if ((wait->flags & SELECT_INTERRUPTIBLE) && !list_empty(&thread->system_apc)) return STATUS_USER_APC;
539 if ((wait->flags & SELECT_ALERTABLE) && !list_empty(&thread->user_apc)) return STATUS_USER_APC;
540 if (wait->timeout <= current_time) return STATUS_TIMEOUT;
541 return -1;
544 /* send the wakeup signal to a thread */
545 static int send_thread_wakeup( struct thread *thread, void *cookie, int signaled )
547 struct wake_up_reply reply;
548 int ret;
550 reply.cookie = cookie;
551 reply.signaled = signaled;
552 if ((ret = write( get_unix_fd( thread->wait_fd ), &reply, sizeof(reply) )) == sizeof(reply))
553 return 0;
554 if (ret >= 0)
555 fatal_protocol_error( thread, "partial wakeup write %d\n", ret );
556 else if (errno == EPIPE)
557 kill_thread( thread, 0 ); /* normal death */
558 else
559 fatal_protocol_perror( thread, "write" );
560 return -1;
563 /* attempt to wake up a thread */
564 /* return >0 if OK, 0 if the wait condition is still not satisfied */
565 int wake_thread( struct thread *thread )
567 int signaled, count;
568 void *cookie;
570 for (count = 0; thread->wait; count++)
572 if ((signaled = check_wait( thread )) == -1) break;
574 cookie = thread->wait->cookie;
575 if (debug_level) fprintf( stderr, "%04x: *wakeup* signaled=%d cookie=%p\n",
576 thread->id, signaled, cookie );
577 end_wait( thread );
578 if (send_thread_wakeup( thread, cookie, signaled ) == -1) /* error */
579 break;
581 return count;
584 /* thread wait timeout */
585 static void thread_timeout( void *ptr )
587 struct thread_wait *wait = ptr;
588 struct thread *thread = wait->thread;
589 void *cookie = wait->cookie;
591 wait->user = NULL;
592 if (thread->wait != wait) return; /* not the top-level wait, ignore it */
593 if (thread->suspend + thread->process->suspend > 0) return; /* suspended, ignore it */
595 if (debug_level) fprintf( stderr, "%04x: *wakeup* signaled=%d cookie=%p\n",
596 thread->id, (int)STATUS_TIMEOUT, cookie );
597 end_wait( thread );
598 if (send_thread_wakeup( thread, cookie, STATUS_TIMEOUT ) == -1) return;
599 /* check if other objects have become signaled in the meantime */
600 wake_thread( thread );
603 /* try signaling an event flag, a semaphore or a mutex */
604 static int signal_object( obj_handle_t handle )
606 struct object *obj;
607 int ret = 0;
609 obj = get_handle_obj( current->process, handle, 0, NULL );
610 if (obj)
612 ret = obj->ops->signal( obj, get_handle_access( current->process, handle ));
613 release_object( obj );
615 return ret;
618 /* select on a list of handles */
619 static timeout_t select_on( unsigned int count, void *cookie, const obj_handle_t *handles,
620 int flags, timeout_t timeout, obj_handle_t signal_obj )
622 int ret;
623 unsigned int i;
624 struct object *objects[MAXIMUM_WAIT_OBJECTS];
626 if (timeout <= 0) timeout = current_time - timeout;
628 if (count > MAXIMUM_WAIT_OBJECTS)
630 set_error( STATUS_INVALID_PARAMETER );
631 return 0;
633 for (i = 0; i < count; i++)
635 if (!(objects[i] = get_handle_obj( current->process, handles[i], SYNCHRONIZE, NULL )))
636 break;
639 if (i < count) goto done;
640 if (!wait_on( count, objects, flags, timeout )) goto done;
642 /* signal the object */
643 if (signal_obj)
645 if (!signal_object( signal_obj ))
647 end_wait( current );
648 goto done;
650 /* check if we woke ourselves up */
651 if (!current->wait) goto done;
654 if ((ret = check_wait( current )) != -1)
656 /* condition is already satisfied */
657 end_wait( current );
658 set_error( ret );
659 goto done;
662 /* now we need to wait */
663 if (current->wait->timeout != TIMEOUT_INFINITE)
665 if (!(current->wait->user = add_timeout_user( current->wait->timeout,
666 thread_timeout, current->wait )))
668 end_wait( current );
669 goto done;
672 current->wait->cookie = cookie;
673 set_error( STATUS_PENDING );
675 done:
676 while (i > 0) release_object( objects[--i] );
677 return timeout;
680 /* attempt to wake threads sleeping on the object wait queue */
681 void wake_up( struct object *obj, int max )
683 struct list *ptr, *next;
685 LIST_FOR_EACH_SAFE( ptr, next, &obj->wait_queue )
687 struct wait_queue_entry *entry = LIST_ENTRY( ptr, struct wait_queue_entry, entry );
688 if (wake_thread( entry->thread ))
690 if (max && !--max) break;
695 /* return the apc queue to use for a given apc type */
696 static inline struct list *get_apc_queue( struct thread *thread, enum apc_type type )
698 switch(type)
700 case APC_NONE:
701 case APC_USER:
702 case APC_TIMER:
703 return &thread->user_apc;
704 default:
705 return &thread->system_apc;
709 /* queue an existing APC to a given thread */
710 static int queue_apc( struct process *process, struct thread *thread, struct thread_apc *apc )
712 struct list *queue;
714 if (!thread) /* find a suitable thread inside the process */
716 struct thread *candidate;
718 /* first try to find a waiting thread */
719 LIST_FOR_EACH_ENTRY( candidate, &process->thread_list, struct thread, proc_entry )
721 if (candidate->state == TERMINATED) continue;
722 if (process->suspend || candidate->suspend ||
723 (candidate->wait && (candidate->wait->flags & SELECT_INTERRUPTIBLE)))
725 thread = candidate;
726 break;
729 if (!thread)
731 /* then use the first one that accepts a signal */
732 LIST_FOR_EACH_ENTRY( candidate, &process->thread_list, struct thread, proc_entry )
734 if (send_thread_signal( candidate, SIGUSR1 ))
736 thread = candidate;
737 break;
741 if (!thread) return 0; /* nothing found */
743 else
745 if (thread->state == TERMINATED) return 0;
746 /* cancel a possible previous APC with the same owner */
747 if (apc->owner) thread_cancel_apc( thread, apc->owner, apc->call.type );
750 queue = get_apc_queue( thread, apc->call.type );
751 grab_object( apc );
752 list_add_tail( queue, &apc->entry );
753 if (!list_prev( queue, &apc->entry )) /* first one */
754 wake_thread( thread );
756 return 1;
759 /* queue an async procedure call */
760 int thread_queue_apc( struct thread *thread, struct object *owner, const apc_call_t *call_data )
762 struct thread_apc *apc;
763 int ret = 0;
765 if ((apc = create_apc( owner, call_data )))
767 ret = queue_apc( NULL, thread, apc );
768 release_object( apc );
770 return ret;
773 /* cancel the async procedure call owned by a specific object */
774 void thread_cancel_apc( struct thread *thread, struct object *owner, enum apc_type type )
776 struct thread_apc *apc;
777 struct list *queue = get_apc_queue( thread, type );
779 LIST_FOR_EACH_ENTRY( apc, queue, struct thread_apc, entry )
781 if (apc->owner != owner) continue;
782 list_remove( &apc->entry );
783 apc->executed = 1;
784 wake_up( &apc->obj, 0 );
785 release_object( apc );
786 return;
790 /* remove the head apc from the queue; the returned object must be released by the caller */
791 static struct thread_apc *thread_dequeue_apc( struct thread *thread, int system_only )
793 struct thread_apc *apc = NULL;
794 struct list *ptr = list_head( &thread->system_apc );
796 if (!ptr && !system_only) ptr = list_head( &thread->user_apc );
797 if (ptr)
799 apc = LIST_ENTRY( ptr, struct thread_apc, entry );
800 list_remove( ptr );
802 return apc;
805 /* clear an APC queue, cancelling all the APCs on it */
806 static void clear_apc_queue( struct list *queue )
808 struct list *ptr;
810 while ((ptr = list_head( queue )))
812 struct thread_apc *apc = LIST_ENTRY( ptr, struct thread_apc, entry );
813 list_remove( &apc->entry );
814 apc->executed = 1;
815 wake_up( &apc->obj, 0 );
816 release_object( apc );
820 /* add an fd to the inflight list */
821 /* return list index, or -1 on error */
822 int thread_add_inflight_fd( struct thread *thread, int client, int server )
824 int i;
826 if (server == -1) return -1;
827 if (client == -1)
829 close( server );
830 return -1;
833 /* first check if we already have an entry for this fd */
834 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
835 if (thread->inflight[i].client == client)
837 close( thread->inflight[i].server );
838 thread->inflight[i].server = server;
839 return i;
842 /* now find a free spot to store it */
843 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
844 if (thread->inflight[i].client == -1)
846 thread->inflight[i].client = client;
847 thread->inflight[i].server = server;
848 return i;
850 return -1;
853 /* get an inflight fd and purge it from the list */
854 /* the fd must be closed when no longer used */
855 int thread_get_inflight_fd( struct thread *thread, int client )
857 int i, ret;
859 if (client == -1) return -1;
863 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
865 if (thread->inflight[i].client == client)
867 ret = thread->inflight[i].server;
868 thread->inflight[i].server = thread->inflight[i].client = -1;
869 return ret;
872 } while (!receive_fd( thread->process )); /* in case it is still in the socket buffer */
873 return -1;
876 /* kill a thread on the spot */
877 void kill_thread( struct thread *thread, int violent_death )
879 if (thread->state == TERMINATED) return; /* already killed */
880 thread->state = TERMINATED;
881 thread->exit_time = current_time;
882 if (current == thread) current = NULL;
883 if (debug_level)
884 fprintf( stderr,"%04x: *killed* exit_code=%d\n",
885 thread->id, thread->exit_code );
886 if (thread->wait)
888 while (thread->wait) end_wait( thread );
889 send_thread_wakeup( thread, NULL, STATUS_PENDING );
890 /* if it is waiting on the socket, we don't need to send a SIGTERM */
891 violent_death = 0;
893 kill_console_processes( thread, 0 );
894 debug_exit_thread( thread );
895 abandon_mutexes( thread );
896 wake_up( &thread->obj, 0 );
897 if (violent_death) send_thread_signal( thread, SIGTERM );
898 cleanup_thread( thread );
899 remove_process_thread( thread->process, thread );
900 release_object( thread );
903 /* trigger a breakpoint event in a given thread */
904 void break_thread( struct thread *thread )
906 struct debug_event_exception data;
908 assert( thread->context );
910 data.record.ExceptionCode = STATUS_BREAKPOINT;
911 data.record.ExceptionFlags = EXCEPTION_CONTINUABLE;
912 data.record.ExceptionRecord = NULL;
913 data.record.ExceptionAddress = get_context_ip( thread->context );
914 data.record.NumberParameters = 0;
915 data.first = 1;
916 generate_debug_event( thread, EXCEPTION_DEBUG_EVENT, &data );
917 thread->debug_break = 0;
920 /* take a snapshot of currently running threads */
921 struct thread_snapshot *thread_snap( int *count )
923 struct thread_snapshot *snapshot, *ptr;
924 struct thread *thread;
925 int total = 0;
927 LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
928 if (thread->state != TERMINATED) total++;
929 if (!total || !(snapshot = mem_alloc( sizeof(*snapshot) * total ))) return NULL;
930 ptr = snapshot;
931 LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
933 if (thread->state == TERMINATED) continue;
934 ptr->thread = thread;
935 ptr->count = thread->obj.refcount;
936 ptr->priority = thread->priority;
937 grab_object( thread );
938 ptr++;
940 *count = total;
941 return snapshot;
944 /* gets the current impersonation token */
945 struct token *thread_get_impersonation_token( struct thread *thread )
947 if (thread->token)
948 return thread->token;
949 else
950 return thread->process->token;
953 /* create a new thread */
954 DECL_HANDLER(new_thread)
956 struct thread *thread;
957 int request_fd = thread_get_inflight_fd( current, req->request_fd );
959 if (request_fd == -1 || fcntl( request_fd, F_SETFL, O_NONBLOCK ) == -1)
961 if (request_fd != -1) close( request_fd );
962 set_error( STATUS_INVALID_HANDLE );
963 return;
966 if ((thread = create_thread( request_fd, current->process )))
968 if (req->suspend) thread->suspend++;
969 reply->tid = get_thread_id( thread );
970 if ((reply->handle = alloc_handle( current->process, thread, req->access, req->attributes )))
972 /* thread object will be released when the thread gets killed */
973 return;
975 kill_thread( thread, 1 );
979 /* initialize a new thread */
980 DECL_HANDLER(init_thread)
982 struct process *process = current->process;
983 int reply_fd = thread_get_inflight_fd( current, req->reply_fd );
984 int wait_fd = thread_get_inflight_fd( current, req->wait_fd );
986 if (current->reply_fd) /* already initialised */
988 set_error( STATUS_INVALID_PARAMETER );
989 goto error;
992 if (reply_fd == -1 || fcntl( reply_fd, F_SETFL, O_NONBLOCK ) == -1) goto error;
994 current->reply_fd = create_anonymous_fd( &thread_fd_ops, reply_fd, &current->obj, 0 );
995 reply_fd = -1;
996 if (!current->reply_fd) goto error;
998 if (wait_fd == -1)
1000 set_error( STATUS_TOO_MANY_OPENED_FILES ); /* most likely reason */
1001 return;
1003 if (!(current->wait_fd = create_anonymous_fd( &thread_fd_ops, wait_fd, &current->obj, 0 )))
1004 return;
1006 if (!is_valid_address(req->teb) || !is_valid_address(req->peb) || !is_valid_address(req->ldt_copy))
1008 set_error( STATUS_INVALID_PARAMETER );
1009 return;
1012 current->unix_pid = req->unix_pid;
1013 current->unix_tid = req->unix_tid;
1014 current->teb = req->teb;
1016 if (!process->peb) /* first thread, initialize the process too */
1018 process->unix_pid = current->unix_pid;
1019 process->peb = req->peb;
1020 process->ldt_copy = req->ldt_copy;
1021 reply->info_size = init_process( current );
1023 else
1025 if (process->unix_pid != current->unix_pid)
1026 process->unix_pid = -1; /* can happen with linuxthreads */
1027 if (current->suspend + process->suspend > 0) stop_thread( current );
1028 generate_debug_event( current, CREATE_THREAD_DEBUG_EVENT, req->entry );
1030 debug_level = max( debug_level, req->debug_level );
1032 reply->pid = get_process_id( process );
1033 reply->tid = get_thread_id( current );
1034 reply->version = SERVER_PROTOCOL_VERSION;
1035 reply->server_start = server_start_time;
1036 return;
1038 error:
1039 if (reply_fd != -1) close( reply_fd );
1040 if (wait_fd != -1) close( wait_fd );
1043 /* terminate a thread */
1044 DECL_HANDLER(terminate_thread)
1046 struct thread *thread;
1048 reply->self = 0;
1049 reply->last = 0;
1050 if ((thread = get_thread_from_handle( req->handle, THREAD_TERMINATE )))
1052 thread->exit_code = req->exit_code;
1053 if (thread != current) kill_thread( thread, 1 );
1054 else
1056 reply->self = 1;
1057 reply->last = (thread->process->running_threads == 1);
1059 release_object( thread );
1063 /* open a handle to a thread */
1064 DECL_HANDLER(open_thread)
1066 struct thread *thread = get_thread_from_id( req->tid );
1068 reply->handle = 0;
1069 if (thread)
1071 reply->handle = alloc_handle( current->process, thread, req->access, req->attributes );
1072 release_object( thread );
1076 /* fetch information about a thread */
1077 DECL_HANDLER(get_thread_info)
1079 struct thread *thread;
1080 obj_handle_t handle = req->handle;
1082 if (!handle) thread = get_thread_from_id( req->tid_in );
1083 else thread = get_thread_from_handle( req->handle, THREAD_QUERY_INFORMATION );
1085 if (thread)
1087 reply->pid = get_process_id( thread->process );
1088 reply->tid = get_thread_id( thread );
1089 reply->teb = thread->teb;
1090 reply->exit_code = (thread->state == TERMINATED) ? thread->exit_code : STATUS_PENDING;
1091 reply->priority = thread->priority;
1092 reply->affinity = thread->affinity;
1093 reply->creation_time = thread->creation_time;
1094 reply->exit_time = thread->exit_time;
1095 reply->last = thread->process->running_threads == 1;
1097 release_object( thread );
1101 /* set information about a thread */
1102 DECL_HANDLER(set_thread_info)
1104 struct thread *thread;
1106 if ((thread = get_thread_from_handle( req->handle, THREAD_SET_INFORMATION )))
1108 set_thread_info( thread, req );
1109 release_object( thread );
1113 /* suspend a thread */
1114 DECL_HANDLER(suspend_thread)
1116 struct thread *thread;
1118 if ((thread = get_thread_from_handle( req->handle, THREAD_SUSPEND_RESUME )))
1120 if (thread->state == TERMINATED) set_error( STATUS_ACCESS_DENIED );
1121 else reply->count = suspend_thread( thread );
1122 release_object( thread );
1126 /* resume a thread */
1127 DECL_HANDLER(resume_thread)
1129 struct thread *thread;
1131 if ((thread = get_thread_from_handle( req->handle, THREAD_SUSPEND_RESUME )))
1133 if (thread->state == TERMINATED) set_error( STATUS_ACCESS_DENIED );
1134 else reply->count = resume_thread( thread );
1135 release_object( thread );
1139 /* select on a handle list */
1140 DECL_HANDLER(select)
1142 unsigned int count = get_req_data_size() / sizeof(obj_handle_t);
1143 reply->timeout = select_on( count, req->cookie, get_req_data(), req->flags, req->timeout, req->signal );
1146 /* queue an APC for a thread or process */
1147 DECL_HANDLER(queue_apc)
1149 struct thread *thread = NULL;
1150 struct process *process = NULL;
1151 struct thread_apc *apc;
1153 if (!(apc = create_apc( NULL, &req->call ))) return;
1155 switch (apc->call.type)
1157 case APC_NONE:
1158 case APC_USER:
1159 thread = get_thread_from_handle( req->thread, THREAD_SET_CONTEXT );
1160 break;
1161 case APC_VIRTUAL_ALLOC:
1162 case APC_VIRTUAL_FREE:
1163 case APC_VIRTUAL_PROTECT:
1164 case APC_VIRTUAL_FLUSH:
1165 case APC_VIRTUAL_LOCK:
1166 case APC_VIRTUAL_UNLOCK:
1167 case APC_UNMAP_VIEW:
1168 process = get_process_from_handle( req->process, PROCESS_VM_OPERATION );
1169 break;
1170 case APC_VIRTUAL_QUERY:
1171 process = get_process_from_handle( req->process, PROCESS_QUERY_INFORMATION );
1172 break;
1173 case APC_MAP_VIEW:
1174 process = get_process_from_handle( req->process, PROCESS_VM_OPERATION );
1175 if (process && process != current->process)
1177 /* duplicate the handle into the target process */
1178 obj_handle_t handle = duplicate_handle( current->process, apc->call.map_view.handle,
1179 process, 0, 0, DUP_HANDLE_SAME_ACCESS );
1180 if (handle) apc->call.map_view.handle = handle;
1181 else
1183 release_object( process );
1184 process = NULL;
1187 break;
1188 case APC_CREATE_THREAD:
1189 process = get_process_from_handle( req->process, PROCESS_CREATE_THREAD );
1190 break;
1191 default:
1192 set_error( STATUS_INVALID_PARAMETER );
1193 break;
1196 if (thread)
1198 if (!queue_apc( NULL, thread, apc )) set_error( STATUS_THREAD_IS_TERMINATING );
1199 release_object( thread );
1201 else if (process)
1203 reply->self = (process == current->process);
1204 if (!reply->self)
1206 obj_handle_t handle = alloc_handle( current->process, apc, SYNCHRONIZE, 0 );
1207 if (handle)
1209 if (queue_apc( process, NULL, apc ))
1211 apc->caller = (struct thread *)grab_object( current );
1212 reply->handle = handle;
1214 else
1216 close_handle( current->process, handle );
1217 set_error( STATUS_PROCESS_IS_TERMINATING );
1221 release_object( process );
1224 release_object( apc );
1227 /* get next APC to call */
1228 DECL_HANDLER(get_apc)
1230 struct thread_apc *apc;
1231 int system_only = !req->alertable;
1233 if (req->prev)
1235 if (!(apc = (struct thread_apc *)get_handle_obj( current->process, req->prev,
1236 0, &thread_apc_ops ))) return;
1237 apc->result = req->result;
1238 apc->executed = 1;
1239 if (apc->result.type == APC_CREATE_THREAD) /* transfer the handle to the caller process */
1241 obj_handle_t handle = duplicate_handle( current->process, apc->result.create_thread.handle,
1242 apc->caller->process, 0, 0, DUP_HANDLE_SAME_ACCESS );
1243 close_handle( current->process, apc->result.create_thread.handle );
1244 apc->result.create_thread.handle = handle;
1245 clear_error(); /* ignore errors from the above calls */
1247 else if (apc->result.type == APC_ASYNC_IO)
1249 if (apc->owner) async_set_result( apc->owner, apc->result.async_io.status );
1251 wake_up( &apc->obj, 0 );
1252 close_handle( current->process, req->prev );
1253 release_object( apc );
1256 if (current->suspend + current->process->suspend > 0) system_only = 1;
1258 for (;;)
1260 if (!(apc = thread_dequeue_apc( current, system_only )))
1262 /* no more APCs */
1263 set_error( STATUS_PENDING );
1264 return;
1266 /* Optimization: ignore APC_NONE calls, they are only used to
1267 * wake up a thread, but since we got here the thread woke up already.
1269 if (apc->call.type != APC_NONE) break;
1270 apc->executed = 1;
1271 wake_up( &apc->obj, 0 );
1272 release_object( apc );
1275 if ((reply->handle = alloc_handle( current->process, apc, SYNCHRONIZE, 0 )))
1276 reply->call = apc->call;
1277 release_object( apc );
1280 /* Get the result of an APC call */
1281 DECL_HANDLER(get_apc_result)
1283 struct thread_apc *apc;
1285 if (!(apc = (struct thread_apc *)get_handle_obj( current->process, req->handle,
1286 0, &thread_apc_ops ))) return;
1287 if (!apc->executed) set_error( STATUS_PENDING );
1288 else
1290 reply->result = apc->result;
1291 /* close the handle directly to avoid an extra round-trip */
1292 close_handle( current->process, req->handle );
1294 release_object( apc );
1297 /* retrieve the current context of a thread */
1298 DECL_HANDLER(get_thread_context)
1300 struct thread *thread;
1301 CONTEXT *context;
1303 if (get_reply_max_size() < sizeof(CONTEXT))
1305 set_error( STATUS_INVALID_PARAMETER );
1306 return;
1308 if (!(thread = get_thread_from_handle( req->handle, THREAD_GET_CONTEXT ))) return;
1310 if (req->suspend)
1312 if (thread != current || !thread->suspend_context)
1314 /* not suspended, shouldn't happen */
1315 set_error( STATUS_INVALID_PARAMETER );
1317 else
1319 if (thread->context == thread->suspend_context) thread->context = NULL;
1320 set_reply_data_ptr( thread->suspend_context, sizeof(CONTEXT) );
1321 thread->suspend_context = NULL;
1324 else if (thread != current && !thread->context)
1326 /* thread is not suspended, retry (if it's still running) */
1327 if (thread->state != RUNNING) set_error( STATUS_ACCESS_DENIED );
1328 else set_error( STATUS_PENDING );
1330 else if ((context = set_reply_data_size( sizeof(CONTEXT) )))
1332 unsigned int flags = get_context_system_regs( req->flags );
1334 memset( context, 0, sizeof(CONTEXT) );
1335 context->ContextFlags = get_context_cpu_flag();
1336 if (thread->context) copy_context( context, thread->context, req->flags & ~flags );
1337 if (flags) get_thread_context( thread, context, flags );
1339 reply->self = (thread == current);
1340 release_object( thread );
1343 /* set the current context of a thread */
1344 DECL_HANDLER(set_thread_context)
1346 struct thread *thread;
1348 if (get_req_data_size() < sizeof(CONTEXT))
1350 set_error( STATUS_INVALID_PARAMETER );
1351 return;
1353 if (!(thread = get_thread_from_handle( req->handle, THREAD_SET_CONTEXT ))) return;
1355 if (req->suspend)
1357 if (thread != current || thread->context)
1359 /* nested suspend or exception, shouldn't happen */
1360 set_error( STATUS_INVALID_PARAMETER );
1362 else if ((thread->suspend_context = mem_alloc( sizeof(CONTEXT) )))
1364 memcpy( thread->suspend_context, get_req_data(), sizeof(CONTEXT) );
1365 thread->context = thread->suspend_context;
1366 if (thread->debug_break) break_thread( thread );
1369 else if (thread != current && !thread->context)
1371 /* thread is not suspended, retry (if it's still running) */
1372 if (thread->state != RUNNING) set_error( STATUS_ACCESS_DENIED );
1373 else set_error( STATUS_PENDING );
1375 else
1377 const CONTEXT *context = get_req_data();
1378 unsigned int flags = get_context_system_regs( req->flags );
1380 if (flags) set_thread_context( thread, context, flags );
1381 if (thread->context && !get_error())
1382 copy_context( thread->context, context, req->flags & ~flags );
1384 reply->self = (thread == current);
1385 release_object( thread );
1388 /* fetch a selector entry for a thread */
1389 DECL_HANDLER(get_selector_entry)
1391 struct thread *thread;
1392 if ((thread = get_thread_from_handle( req->handle, THREAD_QUERY_INFORMATION )))
1394 get_selector_entry( thread, req->entry, &reply->base, &reply->limit, &reply->flags );
1395 release_object( thread );