server: Give system APCs priority over signaled objects.
[wine] / server / thread.c
1 /*
2  * Server-side thread management
3  *
4  * Copyright (C) 1998 Alexandre Julliard
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #include "config.h"
22 #include "wine/port.h"
23
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
38
39 #include "ntstatus.h"
40 #define WIN32_NO_STATUS
41 #include "windef.h"
42 #include "winternl.h"
43
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"
51
52
53 /* thread queues */
54
55 struct thread_wait
56 {
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];
65 };
66
67 /* asynchronous procedure calls */
68
69 struct thread_apc
70 {
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 */
78 };
79
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 );
84
85 static const struct object_ops thread_apc_ops =
86 {
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 */
100 };
101
102
103 /* thread operations */
104
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 );
110
111 static const struct object_ops thread_ops =
112 {
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 */
126 };
127
128 static const struct fd_ops thread_fd_ops =
129 {
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 */
138 };
139
140 static struct list thread_list = LIST_INIT(thread_list);
141
142 /* initialize the structure for a newly allocated thread */
143 static inline void init_thread_structure( struct thread *thread )
144 {
145     int i;
146
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;
172
173     thread->creation_time = current_time;
174     thread->exit_time     = 0;
175
176     list_init( &thread->mutex_list );
177     list_init( &thread->system_apc );
178     list_init( &thread->user_apc );
179
180     for (i = 0; i < MAX_INFLIGHT_FDS; i++)
181         thread->inflight[i].server = thread->inflight[i].client = -1;
182 }
183
184 /* check if address looks valid for a client-side data structure (TEB etc.) */
185 static inline int is_valid_address( void *addr )
186 {
187     return addr && !((unsigned long)addr % sizeof(int));
188 }
189
190 /* create a new thread */
191 struct thread *create_thread( int fd, struct process *process )
192 {
193     struct thread *thread;
194
195     if (!(thread = alloc_object( &thread_ops ))) return NULL;
196
197     init_thread_structure( thread );
198
199     thread->process = (struct process *)grab_object( process );
200     thread->desktop = process->desktop;
201     if (!current) current = thread;
202
203     list_add_head( &thread_list, &thread->entry );
204
205     if (!(thread->id = alloc_ptid( thread )))
206     {
207         release_object( thread );
208         return NULL;
209     }
210     if (!(thread->request_fd = create_anonymous_fd( &thread_fd_ops, fd, &thread->obj, 0 )))
211     {
212         release_object( thread );
213         return NULL;
214     }
215
216     set_fd_events( thread->request_fd, POLLIN );  /* start listening to events */
217     add_process_thread( thread->process, thread );
218     return thread;
219 }
220
221 /* handle a client event */
222 static void thread_poll_event( struct fd *fd, int event )
223 {
224     struct thread *thread = get_fd_user( fd );
225     assert( thread->obj.ops == &thread_ops );
226
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 );
230 }
231
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 )
235 {
236     int i;
237
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++)
251     {
252         if (thread->inflight[i].client != -1)
253         {
254             close( thread->inflight[i].server );
255             thread->inflight[i].client = thread->inflight[i].server = -1;
256         }
257     }
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;
266 }
267
268 /* destroy a thread when its refcount is 0 */
269 static void destroy_thread( struct object *obj )
270 {
271     struct thread *thread = (struct thread *)obj;
272     assert( obj->ops == &thread_ops );
273
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 );
280 }
281
282 /* dump a thread on stdout for debugging purposes */
283 static void dump_thread( struct object *obj, int verbose )
284 {
285     struct thread *thread = (struct thread *)obj;
286     assert( obj->ops == &thread_ops );
287
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 );
290 }
291
292 static int thread_signaled( struct object *obj, struct thread *thread )
293 {
294     struct thread *mythread = (struct thread *)obj;
295     return (mythread->state == TERMINATED);
296 }
297
298 static unsigned int thread_map_access( struct object *obj, unsigned int access )
299 {
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);
305 }
306
307 static void dump_thread_apc( struct object *obj, int verbose )
308 {
309     struct thread_apc *apc = (struct thread_apc *)obj;
310     assert( obj->ops == &thread_apc_ops );
311
312     fprintf( stderr, "APC owner=%p type=%u\n", apc->owner, apc->call.type );
313 }
314
315 static int thread_apc_signaled( struct object *obj, struct thread *thread )
316 {
317     struct thread_apc *apc = (struct thread_apc *)obj;
318     return apc->executed;
319 }
320
321 static void thread_apc_destroy( struct object *obj )
322 {
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 );
326 }
327
328 /* queue an async procedure call */
329 static struct thread_apc *create_apc( struct object *owner, const apc_call_t *call_data )
330 {
331     struct thread_apc *apc;
332
333     if ((apc = alloc_object( &thread_apc_ops )))
334     {
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 );
341     }
342     return apc;
343 }
344
345 /* get a thread pointer from a thread id (and increment the refcount) */
346 struct thread *get_thread_from_id( thread_id_t id )
347 {
348     struct object *obj = get_ptid_entry( id );
349
350     if (obj && obj->ops == &thread_ops) return (struct thread *)grab_object( obj );
351     set_error( STATUS_INVALID_CID );
352     return NULL;
353 }
354
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 )
357 {
358     return (struct thread *)get_handle_obj( current->process, handle,
359                                             access, &thread_ops );
360 }
361
362 /* find a thread from a Unix tid */
363 struct thread *get_thread_from_tid( int tid )
364 {
365     struct thread *thread;
366
367     LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
368     {
369         if (thread->unix_tid == tid) return thread;
370     }
371     return NULL;
372 }
373
374 /* find a thread from a Unix pid */
375 struct thread *get_thread_from_pid( int pid )
376 {
377     struct thread *thread;
378
379     LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
380     {
381         if (thread->unix_pid == pid) return thread;
382     }
383     return NULL;
384 }
385
386 /* set all information about a thread */
387 static void set_thread_info( struct thread *thread,
388                              const struct set_thread_info_request *req )
389 {
390     if (req->mask & SET_THREAD_INFO_PRIORITY)
391         thread->priority = req->priority;
392     if (req->mask & SET_THREAD_INFO_AFFINITY)
393     {
394         if (req->affinity != 1) set_error( STATUS_INVALID_PARAMETER );
395         else thread->affinity = req->affinity;
396     }
397     if (req->mask & SET_THREAD_INFO_TOKEN)
398         security_set_thread_token( thread, req->token );
399 }
400
401 /* stop a thread (at the Unix level) */
402 void stop_thread( struct thread *thread )
403 {
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 );
407 }
408
409 /* suspend a thread */
410 static int suspend_thread( struct thread *thread )
411 {
412     int old_count = thread->suspend;
413     if (thread->suspend < MAXIMUM_SUSPEND_COUNT)
414     {
415         if (!(thread->process->suspend + thread->suspend++)) stop_thread( thread );
416     }
417     else set_error( STATUS_SUSPEND_COUNT_EXCEEDED );
418     return old_count;
419 }
420
421 /* resume a thread */
422 static int resume_thread( struct thread *thread )
423 {
424     int old_count = thread->suspend;
425     if (thread->suspend > 0)
426     {
427         if (!(--thread->suspend + thread->process->suspend)) wake_thread( thread );
428     }
429     return old_count;
430 }
431
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 )
434 {
435     grab_object( obj );
436     entry->obj = obj;
437     list_add_tail( &obj->wait_queue, &entry->entry );
438     return 1;
439 }
440
441 /* remove a thread from an object wait queue */
442 void remove_queue( struct object *obj, struct wait_queue_entry *entry )
443 {
444     list_remove( &entry->entry );
445     release_object( obj );
446 }
447
448 /* finish waiting */
449 static void end_wait( struct thread *thread )
450 {
451     struct thread_wait *wait = thread->wait;
452     struct wait_queue_entry *entry;
453     int i;
454
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 );
461 }
462
463 /* build the thread wait structure */
464 static int wait_on( unsigned int count, struct object *objects[], int flags, timeout_t timeout )
465 {
466     struct thread_wait *wait;
467     struct wait_queue_entry *entry;
468     unsigned int i;
469
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;
478
479     for (i = 0, entry = wait->queues; i < count; i++, entry++)
480     {
481         struct object *obj = objects[i];
482         entry->thread = current;
483         if (!obj->ops->add_queue( obj, entry ))
484         {
485             wait->count = i;
486             end_wait( current );
487             return 0;
488         }
489     }
490     return 1;
491 }
492
493 /* check if the thread waiting condition is satisfied */
494 static int check_wait( struct thread *thread )
495 {
496     int i, signaled;
497     struct thread_wait *wait = thread->wait;
498     struct wait_queue_entry *entry = wait->queues;
499
500     assert( wait );
501
502     if ((wait->flags & SELECT_INTERRUPTIBLE) && !list_empty( &thread->system_apc ))
503         return STATUS_USER_APC;
504
505     /* Suspended threads may not acquire locks, but they can run system APCs */
506     if (thread->process->suspend + thread->suspend > 0) return -1;
507
508     if (wait->flags & SELECT_ALL)
509     {
510         int not_ok = 0;
511         /* Note: we must check them all anyway, as some objects may
512          * want to do something when signaled, even if others are not */
513         for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
514             not_ok |= !entry->obj->ops->signaled( entry->obj, thread );
515         if (not_ok) goto other_checks;
516         /* Wait satisfied: tell it to all objects */
517         signaled = 0;
518         for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
519             if (entry->obj->ops->satisfied( entry->obj, thread ))
520                 signaled = STATUS_ABANDONED_WAIT_0;
521         return signaled;
522     }
523     else
524     {
525         for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
526         {
527             if (!entry->obj->ops->signaled( entry->obj, thread )) continue;
528             /* Wait satisfied: tell it to the object */
529             signaled = i;
530             if (entry->obj->ops->satisfied( entry->obj, thread ))
531                 signaled = i + STATUS_ABANDONED_WAIT_0;
532             return signaled;
533         }
534     }
535
536  other_checks:
537     if ((wait->flags & SELECT_ALERTABLE) && !list_empty(&thread->user_apc)) return STATUS_USER_APC;
538     if (wait->timeout <= current_time) return STATUS_TIMEOUT;
539     return -1;
540 }
541
542 /* send the wakeup signal to a thread */
543 static int send_thread_wakeup( struct thread *thread, void *cookie, int signaled )
544 {
545     struct wake_up_reply reply;
546     int ret;
547
548     reply.cookie   = cookie;
549     reply.signaled = signaled;
550     if ((ret = write( get_unix_fd( thread->wait_fd ), &reply, sizeof(reply) )) == sizeof(reply))
551         return 0;
552     if (ret >= 0)
553         fatal_protocol_error( thread, "partial wakeup write %d\n", ret );
554     else if (errno == EPIPE)
555         kill_thread( thread, 0 );  /* normal death */
556     else
557         fatal_protocol_perror( thread, "write" );
558     return -1;
559 }
560
561 /* attempt to wake up a thread */
562 /* return >0 if OK, 0 if the wait condition is still not satisfied */
563 int wake_thread( struct thread *thread )
564 {
565     int signaled, count;
566     void *cookie;
567
568     for (count = 0; thread->wait; count++)
569     {
570         if ((signaled = check_wait( thread )) == -1) break;
571
572         cookie = thread->wait->cookie;
573         if (debug_level) fprintf( stderr, "%04x: *wakeup* signaled=%d cookie=%p\n",
574                                   thread->id, signaled, cookie );
575         end_wait( thread );
576         if (send_thread_wakeup( thread, cookie, signaled ) == -1) /* error */
577             break;
578     }
579     return count;
580 }
581
582 /* thread wait timeout */
583 static void thread_timeout( void *ptr )
584 {
585     struct thread_wait *wait = ptr;
586     struct thread *thread = wait->thread;
587     void *cookie = wait->cookie;
588
589     wait->user = NULL;
590     if (thread->wait != wait) return; /* not the top-level wait, ignore it */
591     if (thread->suspend + thread->process->suspend > 0) return;  /* suspended, ignore it */
592
593     if (debug_level) fprintf( stderr, "%04x: *wakeup* signaled=%d cookie=%p\n",
594                               thread->id, (int)STATUS_TIMEOUT, cookie );
595     end_wait( thread );
596     if (send_thread_wakeup( thread, cookie, STATUS_TIMEOUT ) == -1) return;
597     /* check if other objects have become signaled in the meantime */
598     wake_thread( thread );
599 }
600
601 /* try signaling an event flag, a semaphore or a mutex */
602 static int signal_object( obj_handle_t handle )
603 {
604     struct object *obj;
605     int ret = 0;
606
607     obj = get_handle_obj( current->process, handle, 0, NULL );
608     if (obj)
609     {
610         ret = obj->ops->signal( obj, get_handle_access( current->process, handle ));
611         release_object( obj );
612     }
613     return ret;
614 }
615
616 /* select on a list of handles */
617 static timeout_t select_on( unsigned int count, void *cookie, const obj_handle_t *handles,
618                             int flags, timeout_t timeout, obj_handle_t signal_obj )
619 {
620     int ret;
621     unsigned int i;
622     struct object *objects[MAXIMUM_WAIT_OBJECTS];
623
624     if (timeout <= 0) timeout = current_time - timeout;
625
626     if (count > MAXIMUM_WAIT_OBJECTS)
627     {
628         set_error( STATUS_INVALID_PARAMETER );
629         return 0;
630     }
631     for (i = 0; i < count; i++)
632     {
633         if (!(objects[i] = get_handle_obj( current->process, handles[i], SYNCHRONIZE, NULL )))
634             break;
635     }
636
637     if (i < count) goto done;
638     if (!wait_on( count, objects, flags, timeout )) goto done;
639
640     /* signal the object */
641     if (signal_obj)
642     {
643         if (!signal_object( signal_obj ))
644         {
645             end_wait( current );
646             goto done;
647         }
648         /* check if we woke ourselves up */
649         if (!current->wait) goto done;
650     }
651
652     if ((ret = check_wait( current )) != -1)
653     {
654         /* condition is already satisfied */
655         end_wait( current );
656         set_error( ret );
657         goto done;
658     }
659
660     /* now we need to wait */
661     if (current->wait->timeout != TIMEOUT_INFINITE)
662     {
663         if (!(current->wait->user = add_timeout_user( current->wait->timeout,
664                                                       thread_timeout, current->wait )))
665         {
666             end_wait( current );
667             goto done;
668         }
669     }
670     current->wait->cookie = cookie;
671     set_error( STATUS_PENDING );
672
673 done:
674     while (i > 0) release_object( objects[--i] );
675     return timeout;
676 }
677
678 /* attempt to wake threads sleeping on the object wait queue */
679 void wake_up( struct object *obj, int max )
680 {
681     struct list *ptr, *next;
682
683     LIST_FOR_EACH_SAFE( ptr, next, &obj->wait_queue )
684     {
685         struct wait_queue_entry *entry = LIST_ENTRY( ptr, struct wait_queue_entry, entry );
686         if (wake_thread( entry->thread ))
687         {
688             if (max && !--max) break;
689         }
690     }
691 }
692
693 /* return the apc queue to use for a given apc type */
694 static inline struct list *get_apc_queue( struct thread *thread, enum apc_type type )
695 {
696     switch(type)
697     {
698     case APC_NONE:
699     case APC_USER:
700     case APC_TIMER:
701         return &thread->user_apc;
702     default:
703         return &thread->system_apc;
704     }
705 }
706
707 /* queue an existing APC to a given thread */
708 static int queue_apc( struct process *process, struct thread *thread, struct thread_apc *apc )
709 {
710     struct list *queue;
711
712     if (!thread)  /* find a suitable thread inside the process */
713     {
714         struct thread *candidate;
715
716         /* first try to find a waiting thread */
717         LIST_FOR_EACH_ENTRY( candidate, &process->thread_list, struct thread, proc_entry )
718         {
719             if (candidate->state == TERMINATED) continue;
720             if (process->suspend || candidate->suspend ||
721                 (candidate->wait && (candidate->wait->flags & SELECT_INTERRUPTIBLE)))
722             {
723                 thread = candidate;
724                 break;
725             }
726         }
727         if (!thread)
728         {
729             /* then use the first one that accepts a signal */
730             LIST_FOR_EACH_ENTRY( candidate, &process->thread_list, struct thread, proc_entry )
731             {
732                 if (send_thread_signal( candidate, SIGUSR1 ))
733                 {
734                     thread = candidate;
735                     break;
736                 }
737             }
738         }
739         if (!thread) return 0;  /* nothing found */
740     }
741     else
742     {
743         if (thread->state == TERMINATED) return 0;
744         /* cancel a possible previous APC with the same owner */
745         if (apc->owner) thread_cancel_apc( thread, apc->owner, apc->call.type );
746     }
747
748     queue = get_apc_queue( thread, apc->call.type );
749     grab_object( apc );
750     list_add_tail( queue, &apc->entry );
751     if (!list_prev( queue, &apc->entry ))  /* first one */
752         wake_thread( thread );
753
754     return 1;
755 }
756
757 /* queue an async procedure call */
758 int thread_queue_apc( struct thread *thread, struct object *owner, const apc_call_t *call_data )
759 {
760     struct thread_apc *apc;
761     int ret = 0;
762
763     if ((apc = create_apc( owner, call_data )))
764     {
765         ret = queue_apc( NULL, thread, apc );
766         release_object( apc );
767     }
768     return ret;
769 }
770
771 /* cancel the async procedure call owned by a specific object */
772 void thread_cancel_apc( struct thread *thread, struct object *owner, enum apc_type type )
773 {
774     struct thread_apc *apc;
775     struct list *queue = get_apc_queue( thread, type );
776
777     LIST_FOR_EACH_ENTRY( apc, queue, struct thread_apc, entry )
778     {
779         if (apc->owner != owner) continue;
780         list_remove( &apc->entry );
781         apc->executed = 1;
782         wake_up( &apc->obj, 0 );
783         release_object( apc );
784         return;
785     }
786 }
787
788 /* remove the head apc from the queue; the returned object must be released by the caller */
789 static struct thread_apc *thread_dequeue_apc( struct thread *thread, int system_only )
790 {
791     struct thread_apc *apc = NULL;
792     struct list *ptr = list_head( &thread->system_apc );
793
794     if (!ptr && !system_only) ptr = list_head( &thread->user_apc );
795     if (ptr)
796     {
797         apc = LIST_ENTRY( ptr, struct thread_apc, entry );
798         list_remove( ptr );
799     }
800     return apc;
801 }
802
803 /* clear an APC queue, cancelling all the APCs on it */
804 static void clear_apc_queue( struct list *queue )
805 {
806     struct list *ptr;
807
808     while ((ptr = list_head( queue )))
809     {
810         struct thread_apc *apc = LIST_ENTRY( ptr, struct thread_apc, entry );
811         list_remove( &apc->entry );
812         apc->executed = 1;
813         wake_up( &apc->obj, 0 );
814         release_object( apc );
815     }
816 }
817
818 /* add an fd to the inflight list */
819 /* return list index, or -1 on error */
820 int thread_add_inflight_fd( struct thread *thread, int client, int server )
821 {
822     int i;
823
824     if (server == -1) return -1;
825     if (client == -1)
826     {
827         close( server );
828         return -1;
829     }
830
831     /* first check if we already have an entry for this fd */
832     for (i = 0; i < MAX_INFLIGHT_FDS; i++)
833         if (thread->inflight[i].client == client)
834         {
835             close( thread->inflight[i].server );
836             thread->inflight[i].server = server;
837             return i;
838         }
839
840     /* now find a free spot to store it */
841     for (i = 0; i < MAX_INFLIGHT_FDS; i++)
842         if (thread->inflight[i].client == -1)
843         {
844             thread->inflight[i].client = client;
845             thread->inflight[i].server = server;
846             return i;
847         }
848     return -1;
849 }
850
851 /* get an inflight fd and purge it from the list */
852 /* the fd must be closed when no longer used */
853 int thread_get_inflight_fd( struct thread *thread, int client )
854 {
855     int i, ret;
856
857     if (client == -1) return -1;
858
859     do
860     {
861         for (i = 0; i < MAX_INFLIGHT_FDS; i++)
862         {
863             if (thread->inflight[i].client == client)
864             {
865                 ret = thread->inflight[i].server;
866                 thread->inflight[i].server = thread->inflight[i].client = -1;
867                 return ret;
868             }
869         }
870     } while (!receive_fd( thread->process ));  /* in case it is still in the socket buffer */
871     return -1;
872 }
873
874 /* kill a thread on the spot */
875 void kill_thread( struct thread *thread, int violent_death )
876 {
877     if (thread->state == TERMINATED) return;  /* already killed */
878     thread->state = TERMINATED;
879     thread->exit_time = current_time;
880     if (current == thread) current = NULL;
881     if (debug_level)
882         fprintf( stderr,"%04x: *killed* exit_code=%d\n",
883                  thread->id, thread->exit_code );
884     if (thread->wait)
885     {
886         while (thread->wait) end_wait( thread );
887         send_thread_wakeup( thread, NULL, STATUS_PENDING );
888         /* if it is waiting on the socket, we don't need to send a SIGTERM */
889         violent_death = 0;
890     }
891     kill_console_processes( thread, 0 );
892     debug_exit_thread( thread );
893     abandon_mutexes( thread );
894     wake_up( &thread->obj, 0 );
895     if (violent_death) send_thread_signal( thread, SIGTERM );
896     cleanup_thread( thread );
897     remove_process_thread( thread->process, thread );
898     release_object( thread );
899 }
900
901 /* trigger a breakpoint event in a given thread */
902 void break_thread( struct thread *thread )
903 {
904     struct debug_event_exception data;
905
906     assert( thread->context );
907
908     data.record.ExceptionCode    = STATUS_BREAKPOINT;
909     data.record.ExceptionFlags   = EXCEPTION_CONTINUABLE;
910     data.record.ExceptionRecord  = NULL;
911     data.record.ExceptionAddress = get_context_ip( thread->context );
912     data.record.NumberParameters = 0;
913     data.first = 1;
914     generate_debug_event( thread, EXCEPTION_DEBUG_EVENT, &data );
915     thread->debug_break = 0;
916 }
917
918 /* take a snapshot of currently running threads */
919 struct thread_snapshot *thread_snap( int *count )
920 {
921     struct thread_snapshot *snapshot, *ptr;
922     struct thread *thread;
923     int total = 0;
924
925     LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
926         if (thread->state != TERMINATED) total++;
927     if (!total || !(snapshot = mem_alloc( sizeof(*snapshot) * total ))) return NULL;
928     ptr = snapshot;
929     LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
930     {
931         if (thread->state == TERMINATED) continue;
932         ptr->thread   = thread;
933         ptr->count    = thread->obj.refcount;
934         ptr->priority = thread->priority;
935         grab_object( thread );
936         ptr++;
937     }
938     *count = total;
939     return snapshot;
940 }
941
942 /* gets the current impersonation token */
943 struct token *thread_get_impersonation_token( struct thread *thread )
944 {
945     if (thread->token)
946         return thread->token;
947     else
948         return thread->process->token;
949 }
950
951 /* create a new thread */
952 DECL_HANDLER(new_thread)
953 {
954     struct thread *thread;
955     int request_fd = thread_get_inflight_fd( current, req->request_fd );
956
957     if (request_fd == -1 || fcntl( request_fd, F_SETFL, O_NONBLOCK ) == -1)
958     {
959         if (request_fd != -1) close( request_fd );
960         set_error( STATUS_INVALID_HANDLE );
961         return;
962     }
963
964     if ((thread = create_thread( request_fd, current->process )))
965     {
966         if (req->suspend) thread->suspend++;
967         reply->tid = get_thread_id( thread );
968         if ((reply->handle = alloc_handle( current->process, thread, req->access, req->attributes )))
969         {
970             /* thread object will be released when the thread gets killed */
971             return;
972         }
973         kill_thread( thread, 1 );
974     }
975 }
976
977 /* initialize a new thread */
978 DECL_HANDLER(init_thread)
979 {
980     struct process *process = current->process;
981     int reply_fd = thread_get_inflight_fd( current, req->reply_fd );
982     int wait_fd = thread_get_inflight_fd( current, req->wait_fd );
983
984     if (current->reply_fd)  /* already initialised */
985     {
986         set_error( STATUS_INVALID_PARAMETER );
987         goto error;
988     }
989
990     if (reply_fd == -1 || fcntl( reply_fd, F_SETFL, O_NONBLOCK ) == -1) goto error;
991
992     current->reply_fd = create_anonymous_fd( &thread_fd_ops, reply_fd, &current->obj, 0 );
993     reply_fd = -1;
994     if (!current->reply_fd) goto error;
995
996     if (wait_fd == -1)
997     {
998         set_error( STATUS_TOO_MANY_OPENED_FILES );  /* most likely reason */
999         return;
1000     }
1001     if (!(current->wait_fd  = create_anonymous_fd( &thread_fd_ops, wait_fd, &current->obj, 0 )))
1002         return;
1003
1004     if (!is_valid_address(req->teb) || !is_valid_address(req->peb) || !is_valid_address(req->ldt_copy))
1005     {
1006         set_error( STATUS_INVALID_PARAMETER );
1007         return;
1008     }
1009
1010     current->unix_pid = req->unix_pid;
1011     current->unix_tid = req->unix_tid;
1012     current->teb      = req->teb;
1013
1014     if (!process->peb)  /* first thread, initialize the process too */
1015     {
1016         process->unix_pid = current->unix_pid;
1017         process->peb      = req->peb;
1018         process->ldt_copy = req->ldt_copy;
1019         reply->info_size  = init_process( current );
1020     }
1021     else
1022     {
1023         if (process->unix_pid != current->unix_pid)
1024             process->unix_pid = -1;  /* can happen with linuxthreads */
1025         if (current->suspend + process->suspend > 0) stop_thread( current );
1026         generate_debug_event( current, CREATE_THREAD_DEBUG_EVENT, req->entry );
1027     }
1028     debug_level = max( debug_level, req->debug_level );
1029
1030     reply->pid     = get_process_id( process );
1031     reply->tid     = get_thread_id( current );
1032     reply->version = SERVER_PROTOCOL_VERSION;
1033     reply->server_start = server_start_time;
1034     return;
1035
1036  error:
1037     if (reply_fd != -1) close( reply_fd );
1038     if (wait_fd != -1) close( wait_fd );
1039 }
1040
1041 /* terminate a thread */
1042 DECL_HANDLER(terminate_thread)
1043 {
1044     struct thread *thread;
1045
1046     reply->self = 0;
1047     reply->last = 0;
1048     if ((thread = get_thread_from_handle( req->handle, THREAD_TERMINATE )))
1049     {
1050         thread->exit_code = req->exit_code;
1051         if (thread != current) kill_thread( thread, 1 );
1052         else
1053         {
1054             reply->self = 1;
1055             reply->last = (thread->process->running_threads == 1);
1056         }
1057         release_object( thread );
1058     }
1059 }
1060
1061 /* open a handle to a thread */
1062 DECL_HANDLER(open_thread)
1063 {
1064     struct thread *thread = get_thread_from_id( req->tid );
1065
1066     reply->handle = 0;
1067     if (thread)
1068     {
1069         reply->handle = alloc_handle( current->process, thread, req->access, req->attributes );
1070         release_object( thread );
1071     }
1072 }
1073
1074 /* fetch information about a thread */
1075 DECL_HANDLER(get_thread_info)
1076 {
1077     struct thread *thread;
1078     obj_handle_t handle = req->handle;
1079
1080     if (!handle) thread = get_thread_from_id( req->tid_in );
1081     else thread = get_thread_from_handle( req->handle, THREAD_QUERY_INFORMATION );
1082
1083     if (thread)
1084     {
1085         reply->pid            = get_process_id( thread->process );
1086         reply->tid            = get_thread_id( thread );
1087         reply->teb            = thread->teb;
1088         reply->exit_code      = (thread->state == TERMINATED) ? thread->exit_code : STATUS_PENDING;
1089         reply->priority       = thread->priority;
1090         reply->affinity       = thread->affinity;
1091         reply->creation_time  = thread->creation_time;
1092         reply->exit_time      = thread->exit_time;
1093         reply->last           = thread->process->running_threads == 1;
1094
1095         release_object( thread );
1096     }
1097 }
1098
1099 /* set information about a thread */
1100 DECL_HANDLER(set_thread_info)
1101 {
1102     struct thread *thread;
1103
1104     if ((thread = get_thread_from_handle( req->handle, THREAD_SET_INFORMATION )))
1105     {
1106         set_thread_info( thread, req );
1107         release_object( thread );
1108     }
1109 }
1110
1111 /* suspend a thread */
1112 DECL_HANDLER(suspend_thread)
1113 {
1114     struct thread *thread;
1115
1116     if ((thread = get_thread_from_handle( req->handle, THREAD_SUSPEND_RESUME )))
1117     {
1118         if (thread->state == TERMINATED) set_error( STATUS_ACCESS_DENIED );
1119         else reply->count = suspend_thread( thread );
1120         release_object( thread );
1121     }
1122 }
1123
1124 /* resume a thread */
1125 DECL_HANDLER(resume_thread)
1126 {
1127     struct thread *thread;
1128
1129     if ((thread = get_thread_from_handle( req->handle, THREAD_SUSPEND_RESUME )))
1130     {
1131         if (thread->state == TERMINATED) set_error( STATUS_ACCESS_DENIED );
1132         else reply->count = resume_thread( thread );
1133         release_object( thread );
1134     }
1135 }
1136
1137 /* select on a handle list */
1138 DECL_HANDLER(select)
1139 {
1140     unsigned int count = get_req_data_size() / sizeof(obj_handle_t);
1141     reply->timeout = select_on( count, req->cookie, get_req_data(), req->flags, req->timeout, req->signal );
1142 }
1143
1144 /* queue an APC for a thread or process */
1145 DECL_HANDLER(queue_apc)
1146 {
1147     struct thread *thread = NULL;
1148     struct process *process = NULL;
1149     struct thread_apc *apc;
1150
1151     if (!(apc = create_apc( NULL, &req->call ))) return;
1152
1153     switch (apc->call.type)
1154     {
1155     case APC_NONE:
1156     case APC_USER:
1157         thread = get_thread_from_handle( req->thread, THREAD_SET_CONTEXT );
1158         break;
1159     case APC_VIRTUAL_ALLOC:
1160     case APC_VIRTUAL_FREE:
1161     case APC_VIRTUAL_PROTECT:
1162     case APC_VIRTUAL_FLUSH:
1163     case APC_VIRTUAL_LOCK:
1164     case APC_VIRTUAL_UNLOCK:
1165     case APC_UNMAP_VIEW:
1166         process = get_process_from_handle( req->process, PROCESS_VM_OPERATION );
1167         break;
1168     case APC_VIRTUAL_QUERY:
1169         process = get_process_from_handle( req->process, PROCESS_QUERY_INFORMATION );
1170         break;
1171     case APC_MAP_VIEW:
1172         process = get_process_from_handle( req->process, PROCESS_VM_OPERATION );
1173         if (process && process != current->process)
1174         {
1175             /* duplicate the handle into the target process */
1176             obj_handle_t handle = duplicate_handle( current->process, apc->call.map_view.handle,
1177                                                     process, 0, 0, DUP_HANDLE_SAME_ACCESS );
1178             if (handle) apc->call.map_view.handle = handle;
1179             else
1180             {
1181                 release_object( process );
1182                 process = NULL;
1183             }
1184         }
1185         break;
1186     case APC_CREATE_THREAD:
1187         process = get_process_from_handle( req->process, PROCESS_CREATE_THREAD );
1188         break;
1189     default:
1190         set_error( STATUS_INVALID_PARAMETER );
1191         break;
1192     }
1193
1194     if (thread)
1195     {
1196         if (!queue_apc( NULL, thread, apc )) set_error( STATUS_THREAD_IS_TERMINATING );
1197         release_object( thread );
1198     }
1199     else if (process)
1200     {
1201         reply->self = (process == current->process);
1202         if (!reply->self)
1203         {
1204             obj_handle_t handle = alloc_handle( current->process, apc, SYNCHRONIZE, 0 );
1205             if (handle)
1206             {
1207                 if (queue_apc( process, NULL, apc ))
1208                 {
1209                     apc->caller = (struct thread *)grab_object( current );
1210                     reply->handle = handle;
1211                 }
1212                 else
1213                 {
1214                     close_handle( current->process, handle );
1215                     set_error( STATUS_PROCESS_IS_TERMINATING );
1216                 }
1217             }
1218         }
1219         release_object( process );
1220     }
1221
1222     release_object( apc );
1223 }
1224
1225 /* get next APC to call */
1226 DECL_HANDLER(get_apc)
1227 {
1228     struct thread_apc *apc;
1229     int system_only = !req->alertable;
1230
1231     if (req->prev)
1232     {
1233         if (!(apc = (struct thread_apc *)get_handle_obj( current->process, req->prev,
1234                                                          0, &thread_apc_ops ))) return;
1235         apc->result = req->result;
1236         apc->executed = 1;
1237         if (apc->result.type == APC_CREATE_THREAD)  /* transfer the handle to the caller process */
1238         {
1239             obj_handle_t handle = duplicate_handle( current->process, apc->result.create_thread.handle,
1240                                                     apc->caller->process, 0, 0, DUP_HANDLE_SAME_ACCESS );
1241             close_handle( current->process, apc->result.create_thread.handle );
1242             apc->result.create_thread.handle = handle;
1243             clear_error();  /* ignore errors from the above calls */
1244         }
1245         else if (apc->result.type == APC_ASYNC_IO)
1246         {
1247             if (apc->owner) async_set_result( apc->owner, apc->result.async_io.status );
1248         }
1249         wake_up( &apc->obj, 0 );
1250         close_handle( current->process, req->prev );
1251         release_object( apc );
1252     }
1253
1254     if (current->suspend + current->process->suspend > 0) system_only = 1;
1255
1256     for (;;)
1257     {
1258         if (!(apc = thread_dequeue_apc( current, system_only )))
1259         {
1260             /* no more APCs */
1261             set_error( STATUS_PENDING );
1262             return;
1263         }
1264         /* Optimization: ignore APC_NONE calls, they are only used to
1265          * wake up a thread, but since we got here the thread woke up already.
1266          */
1267         if (apc->call.type != APC_NONE) break;
1268         apc->executed = 1;
1269         wake_up( &apc->obj, 0 );
1270         release_object( apc );
1271     }
1272
1273     if ((reply->handle = alloc_handle( current->process, apc, SYNCHRONIZE, 0 )))
1274         reply->call = apc->call;
1275     release_object( apc );
1276 }
1277
1278 /* Get the result of an APC call */
1279 DECL_HANDLER(get_apc_result)
1280 {
1281     struct thread_apc *apc;
1282
1283     if (!(apc = (struct thread_apc *)get_handle_obj( current->process, req->handle,
1284                                                      0, &thread_apc_ops ))) return;
1285     if (!apc->executed) set_error( STATUS_PENDING );
1286     else
1287     {
1288         reply->result = apc->result;
1289         /* close the handle directly to avoid an extra round-trip */
1290         close_handle( current->process, req->handle );
1291     }
1292     release_object( apc );
1293 }
1294
1295 /* retrieve the current context of a thread */
1296 DECL_HANDLER(get_thread_context)
1297 {
1298     struct thread *thread;
1299     CONTEXT *context;
1300
1301     if (get_reply_max_size() < sizeof(CONTEXT))
1302     {
1303         set_error( STATUS_INVALID_PARAMETER );
1304         return;
1305     }
1306     if (!(thread = get_thread_from_handle( req->handle, THREAD_GET_CONTEXT ))) return;
1307
1308     if (req->suspend)
1309     {
1310         if (thread != current || !thread->suspend_context)
1311         {
1312             /* not suspended, shouldn't happen */
1313             set_error( STATUS_INVALID_PARAMETER );
1314         }
1315         else
1316         {
1317             if (thread->context == thread->suspend_context) thread->context = NULL;
1318             set_reply_data_ptr( thread->suspend_context, sizeof(CONTEXT) );
1319             thread->suspend_context = NULL;
1320         }
1321     }
1322     else if (thread != current && !thread->context)
1323     {
1324         /* thread is not suspended, retry (if it's still running) */
1325         if (thread->state != RUNNING) set_error( STATUS_ACCESS_DENIED );
1326         else set_error( STATUS_PENDING );
1327     }
1328     else if ((context = set_reply_data_size( sizeof(CONTEXT) )))
1329     {
1330         unsigned int flags = get_context_system_regs( req->flags );
1331
1332         memset( context, 0, sizeof(CONTEXT) );
1333         context->ContextFlags = get_context_cpu_flag();
1334         if (thread->context) copy_context( context, thread->context, req->flags & ~flags );
1335         if (flags) get_thread_context( thread, context, flags );
1336     }
1337     reply->self = (thread == current);
1338     release_object( thread );
1339 }
1340
1341 /* set the current context of a thread */
1342 DECL_HANDLER(set_thread_context)
1343 {
1344     struct thread *thread;
1345
1346     if (get_req_data_size() < sizeof(CONTEXT))
1347     {
1348         set_error( STATUS_INVALID_PARAMETER );
1349         return;
1350     }
1351     if (!(thread = get_thread_from_handle( req->handle, THREAD_SET_CONTEXT ))) return;
1352
1353     if (req->suspend)
1354     {
1355         if (thread != current || thread->context)
1356         {
1357             /* nested suspend or exception, shouldn't happen */
1358             set_error( STATUS_INVALID_PARAMETER );
1359         }
1360         else if ((thread->suspend_context = mem_alloc( sizeof(CONTEXT) )))
1361         {
1362             memcpy( thread->suspend_context, get_req_data(), sizeof(CONTEXT) );
1363             thread->context = thread->suspend_context;
1364             if (thread->debug_break) break_thread( thread );
1365         }
1366     }
1367     else if (thread != current && !thread->context)
1368     {
1369         /* thread is not suspended, retry (if it's still running) */
1370         if (thread->state != RUNNING) set_error( STATUS_ACCESS_DENIED );
1371         else set_error( STATUS_PENDING );
1372     }
1373     else
1374     {
1375         const CONTEXT *context = get_req_data();
1376         unsigned int flags = get_context_system_regs( req->flags );
1377
1378         if (flags) set_thread_context( thread, context, flags );
1379         if (thread->context && !get_error())
1380             copy_context( thread->context, context, req->flags & ~flags );
1381     }
1382     reply->self = (thread == current);
1383     release_object( thread );
1384 }
1385
1386 /* fetch a selector entry for a thread */
1387 DECL_HANDLER(get_selector_entry)
1388 {
1389     struct thread *thread;
1390     if ((thread = get_thread_from_handle( req->handle, THREAD_QUERY_INFORMATION )))
1391     {
1392         get_selector_entry( thread, req->entry, &reply->base, &reply->limit, &reply->flags );
1393         release_object( thread );
1394     }
1395 }