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