2 * Server-side thread management
4 * Copyright (C) 1998 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #include "wine/port.h"
32 #include <sys/types.h>
43 #define WIN32_NO_STATUS
57 static const unsigned int supported_cpus = CPU_FLAG(CPU_x86);
58 #elif defined(__x86_64__)
59 static const unsigned int supported_cpus = CPU_FLAG(CPU_x86_64) | CPU_FLAG(CPU_x86);
60 #elif defined(__powerpc__)
61 static const unsigned int supported_cpus = CPU_FLAG(CPU_POWERPC);
62 #elif defined(__sparc__)
63 static const unsigned int supported_cpus = CPU_FLAG(CPU_SPARC);
64 #elif defined(__arm__)
65 static const unsigned int supported_cpus = CPU_FLAG(CPU_ARM);
67 #error Unsupported CPU
74 struct thread_wait *next; /* next wait structure for this thread */
75 struct thread *thread; /* owner thread */
76 int count; /* count of objects */
78 client_ptr_t cookie; /* magic cookie to return to client */
80 struct timeout_user *user;
81 struct wait_queue_entry queues[1];
84 /* asynchronous procedure calls */
88 struct object obj; /* object header */
89 struct list entry; /* queue linked list */
90 struct thread *caller; /* thread that queued this apc */
91 struct object *owner; /* object that queued this apc */
92 int executed; /* has it been executed by the client? */
93 apc_call_t call; /* call arguments */
94 apc_result_t result; /* call results once executed */
97 static void dump_thread_apc( struct object *obj, int verbose );
98 static int thread_apc_signaled( struct object *obj, struct thread *thread );
99 static void thread_apc_destroy( struct object *obj );
100 static void clear_apc_queue( struct list *queue );
102 static const struct object_ops thread_apc_ops =
104 sizeof(struct thread_apc), /* size */
105 dump_thread_apc, /* dump */
106 no_get_type, /* get_type */
107 add_queue, /* add_queue */
108 remove_queue, /* remove_queue */
109 thread_apc_signaled, /* signaled */
110 no_satisfied, /* satisfied */
111 no_signal, /* signal */
112 no_get_fd, /* get_fd */
113 no_map_access, /* map_access */
114 default_get_sd, /* get_sd */
115 default_set_sd, /* set_sd */
116 no_lookup_name, /* lookup_name */
117 no_open_file, /* open_file */
118 no_close_handle, /* close_handle */
119 thread_apc_destroy /* destroy */
123 /* thread operations */
125 static void dump_thread( struct object *obj, int verbose );
126 static int thread_signaled( struct object *obj, struct thread *thread );
127 static unsigned int thread_map_access( struct object *obj, unsigned int access );
128 static void thread_poll_event( struct fd *fd, int event );
129 static void destroy_thread( struct object *obj );
131 static const struct object_ops thread_ops =
133 sizeof(struct thread), /* size */
134 dump_thread, /* dump */
135 no_get_type, /* get_type */
136 add_queue, /* add_queue */
137 remove_queue, /* remove_queue */
138 thread_signaled, /* signaled */
139 no_satisfied, /* satisfied */
140 no_signal, /* signal */
141 no_get_fd, /* get_fd */
142 thread_map_access, /* map_access */
143 default_get_sd, /* get_sd */
144 default_set_sd, /* set_sd */
145 no_lookup_name, /* lookup_name */
146 no_open_file, /* open_file */
147 no_close_handle, /* close_handle */
148 destroy_thread /* destroy */
151 static const struct fd_ops thread_fd_ops =
153 NULL, /* get_poll_events */
154 thread_poll_event, /* poll_event */
156 NULL, /* get_fd_type */
158 NULL, /* queue_async */
159 NULL, /* reselect_async */
160 NULL /* cancel_async */
163 static struct list thread_list = LIST_INIT(thread_list);
165 /* initialize the structure for a newly allocated thread */
166 static inline void init_thread_structure( struct thread *thread )
170 thread->unix_pid = -1; /* not known yet */
171 thread->unix_tid = -1; /* not known yet */
172 thread->context = NULL;
173 thread->suspend_context = NULL;
175 thread->debug_ctx = NULL;
176 thread->debug_event = NULL;
177 thread->debug_break = 0;
178 thread->queue = NULL;
181 thread->req_data = NULL;
182 thread->req_toread = 0;
183 thread->reply_data = NULL;
184 thread->reply_towrite = 0;
185 thread->request_fd = NULL;
186 thread->reply_fd = NULL;
187 thread->wait_fd = NULL;
188 thread->state = RUNNING;
189 thread->exit_code = 0;
190 thread->priority = 0;
192 thread->desktop_users = 0;
193 thread->token = NULL;
195 thread->creation_time = current_time;
196 thread->exit_time = 0;
198 list_init( &thread->mutex_list );
199 list_init( &thread->system_apc );
200 list_init( &thread->user_apc );
202 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
203 thread->inflight[i].server = thread->inflight[i].client = -1;
206 /* check if address looks valid for a client-side data structure (TEB etc.) */
207 static inline int is_valid_address( client_ptr_t addr )
209 return addr && !(addr % sizeof(int));
212 /* create a new thread */
213 struct thread *create_thread( int fd, struct process *process )
215 struct thread *thread;
217 if (!(thread = alloc_object( &thread_ops ))) return NULL;
219 init_thread_structure( thread );
221 thread->process = (struct process *)grab_object( process );
222 thread->desktop = process->desktop;
223 thread->affinity = process->affinity;
224 if (!current) current = thread;
226 list_add_head( &thread_list, &thread->entry );
228 if (!(thread->id = alloc_ptid( thread )))
230 release_object( thread );
233 if (!(thread->request_fd = create_anonymous_fd( &thread_fd_ops, fd, &thread->obj, 0 )))
235 release_object( thread );
239 set_fd_events( thread->request_fd, POLLIN ); /* start listening to events */
240 add_process_thread( thread->process, thread );
244 /* handle a client event */
245 static void thread_poll_event( struct fd *fd, int event )
247 struct thread *thread = get_fd_user( fd );
248 assert( thread->obj.ops == &thread_ops );
250 grab_object( thread );
251 if (event & (POLLERR | POLLHUP)) kill_thread( thread, 0 );
252 else if (event & POLLIN) read_request( thread );
253 else if (event & POLLOUT) write_reply( thread );
254 release_object( thread );
257 /* cleanup everything that is no longer needed by a dead thread */
258 /* used by destroy_thread and kill_thread */
259 static void cleanup_thread( struct thread *thread )
263 clear_apc_queue( &thread->system_apc );
264 clear_apc_queue( &thread->user_apc );
265 free( thread->req_data );
266 free( thread->reply_data );
267 if (thread->request_fd) release_object( thread->request_fd );
268 if (thread->reply_fd) release_object( thread->reply_fd );
269 if (thread->wait_fd) release_object( thread->wait_fd );
270 free( thread->suspend_context );
271 cleanup_clipboard_thread(thread);
272 destroy_thread_windows( thread );
273 free_msg_queue( thread );
274 close_thread_desktop( thread );
275 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
277 if (thread->inflight[i].client != -1)
279 close( thread->inflight[i].server );
280 thread->inflight[i].client = thread->inflight[i].server = -1;
283 thread->req_data = NULL;
284 thread->reply_data = NULL;
285 thread->request_fd = NULL;
286 thread->reply_fd = NULL;
287 thread->wait_fd = NULL;
288 thread->context = NULL;
289 thread->suspend_context = NULL;
293 /* destroy a thread when its refcount is 0 */
294 static void destroy_thread( struct object *obj )
296 struct thread *thread = (struct thread *)obj;
297 assert( obj->ops == &thread_ops );
299 assert( !thread->debug_ctx ); /* cannot still be debugging something */
300 list_remove( &thread->entry );
301 cleanup_thread( thread );
302 release_object( thread->process );
303 if (thread->id) free_ptid( thread->id );
304 if (thread->token) release_object( thread->token );
307 /* dump a thread on stdout for debugging purposes */
308 static void dump_thread( struct object *obj, int verbose )
310 struct thread *thread = (struct thread *)obj;
311 assert( obj->ops == &thread_ops );
313 fprintf( stderr, "Thread id=%04x unix pid=%d unix tid=%d state=%d\n",
314 thread->id, thread->unix_pid, thread->unix_tid, thread->state );
317 static int thread_signaled( struct object *obj, struct thread *thread )
319 struct thread *mythread = (struct thread *)obj;
320 return (mythread->state == TERMINATED);
323 static unsigned int thread_map_access( struct object *obj, unsigned int access )
325 if (access & GENERIC_READ) access |= STANDARD_RIGHTS_READ | SYNCHRONIZE;
326 if (access & GENERIC_WRITE) access |= STANDARD_RIGHTS_WRITE | SYNCHRONIZE;
327 if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
328 if (access & GENERIC_ALL) access |= THREAD_ALL_ACCESS;
329 return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
332 static void dump_thread_apc( struct object *obj, int verbose )
334 struct thread_apc *apc = (struct thread_apc *)obj;
335 assert( obj->ops == &thread_apc_ops );
337 fprintf( stderr, "APC owner=%p type=%u\n", apc->owner, apc->call.type );
340 static int thread_apc_signaled( struct object *obj, struct thread *thread )
342 struct thread_apc *apc = (struct thread_apc *)obj;
343 return apc->executed;
346 static void thread_apc_destroy( struct object *obj )
348 struct thread_apc *apc = (struct thread_apc *)obj;
349 if (apc->caller) release_object( apc->caller );
350 if (apc->owner) release_object( apc->owner );
353 /* queue an async procedure call */
354 static struct thread_apc *create_apc( struct object *owner, const apc_call_t *call_data )
356 struct thread_apc *apc;
358 if ((apc = alloc_object( &thread_apc_ops )))
360 apc->call = *call_data;
364 apc->result.type = APC_NONE;
365 if (owner) grab_object( owner );
370 /* get a thread pointer from a thread id (and increment the refcount) */
371 struct thread *get_thread_from_id( thread_id_t id )
373 struct object *obj = get_ptid_entry( id );
375 if (obj && obj->ops == &thread_ops) return (struct thread *)grab_object( obj );
376 set_error( STATUS_INVALID_CID );
380 /* get a thread from a handle (and increment the refcount) */
381 struct thread *get_thread_from_handle( obj_handle_t handle, unsigned int access )
383 return (struct thread *)get_handle_obj( current->process, handle,
384 access, &thread_ops );
387 /* find a thread from a Unix tid */
388 struct thread *get_thread_from_tid( int tid )
390 struct thread *thread;
392 LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
394 if (thread->unix_tid == tid) return thread;
399 /* find a thread from a Unix pid */
400 struct thread *get_thread_from_pid( int pid )
402 struct thread *thread;
404 LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
406 if (thread->unix_pid == pid) return thread;
411 int set_thread_affinity( struct thread *thread, affinity_t affinity )
414 #ifdef HAVE_SCHED_SETAFFINITY
415 if (thread->unix_tid != -1)
422 for (i = 0, mask = 1; mask; i++, mask <<= 1)
423 if (affinity & mask) CPU_SET( i, &set );
425 ret = sched_setaffinity( thread->unix_tid, sizeof(set), &set );
428 if (!ret) thread->affinity = affinity;
432 affinity_t get_thread_affinity( struct thread *thread )
435 #ifdef HAVE_SCHED_SETAFFINITY
436 if (thread->unix_tid != -1)
441 if (!sched_getaffinity( thread->unix_tid, sizeof(set), &set ))
442 for (i = 0; i < 8 * sizeof(mask); i++)
443 if (CPU_ISSET( i, &set )) mask |= 1 << i;
446 if (!mask) mask = ~0;
450 #define THREAD_PRIORITY_REALTIME_HIGHEST 6
451 #define THREAD_PRIORITY_REALTIME_LOWEST -7
453 /* set all information about a thread */
454 static void set_thread_info( struct thread *thread,
455 const struct set_thread_info_request *req )
457 if (req->mask & SET_THREAD_INFO_PRIORITY)
459 int max = THREAD_PRIORITY_HIGHEST;
460 int min = THREAD_PRIORITY_LOWEST;
461 if (thread->process->priority == PROCESS_PRIOCLASS_REALTIME)
463 max = THREAD_PRIORITY_REALTIME_HIGHEST;
464 min = THREAD_PRIORITY_REALTIME_LOWEST;
466 if ((req->priority >= min && req->priority <= max) ||
467 req->priority == THREAD_PRIORITY_IDLE ||
468 req->priority == THREAD_PRIORITY_TIME_CRITICAL)
469 thread->priority = req->priority;
471 set_error( STATUS_INVALID_PARAMETER );
473 if (req->mask & SET_THREAD_INFO_AFFINITY)
475 if ((req->affinity & thread->process->affinity) != req->affinity)
476 set_error( STATUS_INVALID_PARAMETER );
477 else if (thread->state == TERMINATED)
478 set_error( STATUS_ACCESS_DENIED );
479 else if (set_thread_affinity( thread, req->affinity ))
482 if (req->mask & SET_THREAD_INFO_TOKEN)
483 security_set_thread_token( thread, req->token );
486 /* stop a thread (at the Unix level) */
487 void stop_thread( struct thread *thread )
489 if (thread->context) return; /* already inside a debug event, no need for a signal */
490 /* can't stop a thread while initialisation is in progress */
491 if (is_process_init_done(thread->process)) send_thread_signal( thread, SIGUSR1 );
494 /* stop a thread if it's supposed to be suspended */
495 void stop_thread_if_suspended( struct thread *thread )
497 if (thread->suspend + thread->process->suspend > 0) stop_thread( thread );
500 /* suspend a thread */
501 static int suspend_thread( struct thread *thread )
503 int old_count = thread->suspend;
504 if (thread->suspend < MAXIMUM_SUSPEND_COUNT)
506 if (!(thread->process->suspend + thread->suspend++)) stop_thread( thread );
508 else set_error( STATUS_SUSPEND_COUNT_EXCEEDED );
512 /* resume a thread */
513 static int resume_thread( struct thread *thread )
515 int old_count = thread->suspend;
516 if (thread->suspend > 0)
518 if (!(--thread->suspend + thread->process->suspend)) wake_thread( thread );
523 /* add a thread to an object wait queue; return 1 if OK, 0 on error */
524 int add_queue( struct object *obj, struct wait_queue_entry *entry )
528 list_add_tail( &obj->wait_queue, &entry->entry );
532 /* remove a thread from an object wait queue */
533 void remove_queue( struct object *obj, struct wait_queue_entry *entry )
535 list_remove( &entry->entry );
536 release_object( obj );
540 static void end_wait( struct thread *thread )
542 struct thread_wait *wait = thread->wait;
543 struct wait_queue_entry *entry;
547 thread->wait = wait->next;
548 for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
549 entry->obj->ops->remove_queue( entry->obj, entry );
550 if (wait->user) remove_timeout_user( wait->user );
554 /* build the thread wait structure */
555 static int wait_on( unsigned int count, struct object *objects[], int flags, timeout_t timeout )
557 struct thread_wait *wait;
558 struct wait_queue_entry *entry;
561 if (!(wait = mem_alloc( FIELD_OFFSET(struct thread_wait, queues[count]) ))) return 0;
562 wait->next = current->wait;
563 wait->thread = current;
567 wait->timeout = timeout;
568 current->wait = wait;
570 for (i = 0, entry = wait->queues; i < count; i++, entry++)
572 struct object *obj = objects[i];
573 entry->thread = current;
574 if (!obj->ops->add_queue( obj, entry ))
584 /* check if the thread waiting condition is satisfied */
585 static int check_wait( struct thread *thread )
588 struct thread_wait *wait = thread->wait;
589 struct wait_queue_entry *entry;
593 if ((wait->flags & SELECT_INTERRUPTIBLE) && !list_empty( &thread->system_apc ))
594 return STATUS_USER_APC;
596 /* Suspended threads may not acquire locks, but they can run system APCs */
597 if (thread->process->suspend + thread->suspend > 0) return -1;
599 if (wait->flags & SELECT_ALL)
602 /* Note: we must check them all anyway, as some objects may
603 * want to do something when signaled, even if others are not */
604 for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
605 not_ok |= !entry->obj->ops->signaled( entry->obj, thread );
606 if (not_ok) goto other_checks;
607 /* Wait satisfied: tell it to all objects */
609 for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
610 if (entry->obj->ops->satisfied( entry->obj, thread ))
611 signaled = STATUS_ABANDONED_WAIT_0;
616 for (i = 0, entry = wait->queues; i < wait->count; i++, entry++)
618 if (!entry->obj->ops->signaled( entry->obj, thread )) continue;
619 /* Wait satisfied: tell it to the object */
621 if (entry->obj->ops->satisfied( entry->obj, thread ))
622 signaled = i + STATUS_ABANDONED_WAIT_0;
628 if ((wait->flags & SELECT_ALERTABLE) && !list_empty(&thread->user_apc)) return STATUS_USER_APC;
629 if (wait->timeout <= current_time) return STATUS_TIMEOUT;
633 /* send the wakeup signal to a thread */
634 static int send_thread_wakeup( struct thread *thread, client_ptr_t cookie, int signaled )
636 struct wake_up_reply reply;
639 memset( &reply, 0, sizeof(reply) );
640 reply.cookie = cookie;
641 reply.signaled = signaled;
642 if ((ret = write( get_unix_fd( thread->wait_fd ), &reply, sizeof(reply) )) == sizeof(reply))
645 fatal_protocol_error( thread, "partial wakeup write %d\n", ret );
646 else if (errno == EPIPE)
647 kill_thread( thread, 0 ); /* normal death */
649 fatal_protocol_perror( thread, "write" );
653 /* attempt to wake up a thread */
654 /* return >0 if OK, 0 if the wait condition is still not satisfied */
655 int wake_thread( struct thread *thread )
660 for (count = 0; thread->wait; count++)
662 if ((signaled = check_wait( thread )) == -1) break;
664 cookie = thread->wait->cookie;
665 if (debug_level) fprintf( stderr, "%04x: *wakeup* signaled=%d\n", thread->id, signaled );
667 if (send_thread_wakeup( thread, cookie, signaled ) == -1) /* error */
673 /* thread wait timeout */
674 static void thread_timeout( void *ptr )
676 struct thread_wait *wait = ptr;
677 struct thread *thread = wait->thread;
678 client_ptr_t cookie = wait->cookie;
681 if (thread->wait != wait) return; /* not the top-level wait, ignore it */
682 if (thread->suspend + thread->process->suspend > 0) return; /* suspended, ignore it */
684 if (debug_level) fprintf( stderr, "%04x: *wakeup* signaled=TIMEOUT\n", thread->id );
686 if (send_thread_wakeup( thread, cookie, STATUS_TIMEOUT ) == -1) return;
687 /* check if other objects have become signaled in the meantime */
688 wake_thread( thread );
691 /* try signaling an event flag, a semaphore or a mutex */
692 static int signal_object( obj_handle_t handle )
697 obj = get_handle_obj( current->process, handle, 0, NULL );
700 ret = obj->ops->signal( obj, get_handle_access( current->process, handle ));
701 release_object( obj );
706 /* select on a list of handles */
707 static timeout_t select_on( unsigned int count, client_ptr_t cookie, const obj_handle_t *handles,
708 int flags, timeout_t timeout, obj_handle_t signal_obj )
712 struct object *objects[MAXIMUM_WAIT_OBJECTS];
714 if (timeout <= 0) timeout = current_time - timeout;
716 if (count > MAXIMUM_WAIT_OBJECTS)
718 set_error( STATUS_INVALID_PARAMETER );
721 for (i = 0; i < count; i++)
723 if (!(objects[i] = get_handle_obj( current->process, handles[i], SYNCHRONIZE, NULL )))
727 if (i < count) goto done;
728 if (!wait_on( count, objects, flags, timeout )) goto done;
730 /* signal the object */
733 if (!signal_object( signal_obj ))
738 /* check if we woke ourselves up */
739 if (!current->wait) goto done;
742 if ((ret = check_wait( current )) != -1)
744 /* condition is already satisfied */
750 /* now we need to wait */
751 if (current->wait->timeout != TIMEOUT_INFINITE)
753 if (!(current->wait->user = add_timeout_user( current->wait->timeout,
754 thread_timeout, current->wait )))
760 current->wait->cookie = cookie;
761 set_error( STATUS_PENDING );
764 while (i > 0) release_object( objects[--i] );
768 /* attempt to wake threads sleeping on the object wait queue */
769 void wake_up( struct object *obj, int max )
773 LIST_FOR_EACH( ptr, &obj->wait_queue )
775 struct wait_queue_entry *entry = LIST_ENTRY( ptr, struct wait_queue_entry, entry );
776 if (!wake_thread( entry->thread )) continue;
777 if (max && !--max) break;
778 /* restart at the head of the list since a wake up can change the object wait queue */
779 ptr = &obj->wait_queue;
783 /* return the apc queue to use for a given apc type */
784 static inline struct list *get_apc_queue( struct thread *thread, enum apc_type type )
791 return &thread->user_apc;
793 return &thread->system_apc;
797 /* check if thread is currently waiting for a (system) apc */
798 static inline int is_in_apc_wait( struct thread *thread )
800 return (thread->process->suspend || thread->suspend ||
801 (thread->wait && (thread->wait->flags & SELECT_INTERRUPTIBLE)));
804 /* queue an existing APC to a given thread */
805 static int queue_apc( struct process *process, struct thread *thread, struct thread_apc *apc )
809 if (!thread) /* find a suitable thread inside the process */
811 struct thread *candidate;
813 /* first try to find a waiting thread */
814 LIST_FOR_EACH_ENTRY( candidate, &process->thread_list, struct thread, proc_entry )
816 if (candidate->state == TERMINATED) continue;
817 if (is_in_apc_wait( candidate ))
825 /* then use the first one that accepts a signal */
826 LIST_FOR_EACH_ENTRY( candidate, &process->thread_list, struct thread, proc_entry )
828 if (send_thread_signal( candidate, SIGUSR1 ))
835 if (!thread) return 0; /* nothing found */
836 queue = get_apc_queue( thread, apc->call.type );
840 if (thread->state == TERMINATED) return 0;
841 queue = get_apc_queue( thread, apc->call.type );
842 /* send signal for system APCs if needed */
843 if (queue == &thread->system_apc && list_empty( queue ) && !is_in_apc_wait( thread ))
845 if (!send_thread_signal( thread, SIGUSR1 )) return 0;
847 /* cancel a possible previous APC with the same owner */
848 if (apc->owner) thread_cancel_apc( thread, apc->owner, apc->call.type );
852 list_add_tail( queue, &apc->entry );
853 if (!list_prev( queue, &apc->entry )) /* first one */
854 wake_thread( thread );
859 /* queue an async procedure call */
860 int thread_queue_apc( struct thread *thread, struct object *owner, const apc_call_t *call_data )
862 struct thread_apc *apc;
865 if ((apc = create_apc( owner, call_data )))
867 ret = queue_apc( NULL, thread, apc );
868 release_object( apc );
873 /* cancel the async procedure call owned by a specific object */
874 void thread_cancel_apc( struct thread *thread, struct object *owner, enum apc_type type )
876 struct thread_apc *apc;
877 struct list *queue = get_apc_queue( thread, type );
879 LIST_FOR_EACH_ENTRY( apc, queue, struct thread_apc, entry )
881 if (apc->owner != owner) continue;
882 list_remove( &apc->entry );
884 wake_up( &apc->obj, 0 );
885 release_object( apc );
890 /* remove the head apc from the queue; the returned object must be released by the caller */
891 static struct thread_apc *thread_dequeue_apc( struct thread *thread, int system_only )
893 struct thread_apc *apc = NULL;
894 struct list *ptr = list_head( &thread->system_apc );
896 if (!ptr && !system_only) ptr = list_head( &thread->user_apc );
899 apc = LIST_ENTRY( ptr, struct thread_apc, entry );
905 /* clear an APC queue, cancelling all the APCs on it */
906 static void clear_apc_queue( struct list *queue )
910 while ((ptr = list_head( queue )))
912 struct thread_apc *apc = LIST_ENTRY( ptr, struct thread_apc, entry );
913 list_remove( &apc->entry );
915 wake_up( &apc->obj, 0 );
916 release_object( apc );
920 /* add an fd to the inflight list */
921 /* return list index, or -1 on error */
922 int thread_add_inflight_fd( struct thread *thread, int client, int server )
926 if (server == -1) return -1;
933 /* first check if we already have an entry for this fd */
934 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
935 if (thread->inflight[i].client == client)
937 close( thread->inflight[i].server );
938 thread->inflight[i].server = server;
942 /* now find a free spot to store it */
943 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
944 if (thread->inflight[i].client == -1)
946 thread->inflight[i].client = client;
947 thread->inflight[i].server = server;
953 /* get an inflight fd and purge it from the list */
954 /* the fd must be closed when no longer used */
955 int thread_get_inflight_fd( struct thread *thread, int client )
959 if (client == -1) return -1;
963 for (i = 0; i < MAX_INFLIGHT_FDS; i++)
965 if (thread->inflight[i].client == client)
967 ret = thread->inflight[i].server;
968 thread->inflight[i].server = thread->inflight[i].client = -1;
972 } while (!receive_fd( thread->process )); /* in case it is still in the socket buffer */
976 /* kill a thread on the spot */
977 void kill_thread( struct thread *thread, int violent_death )
979 if (thread->state == TERMINATED) return; /* already killed */
980 thread->state = TERMINATED;
981 thread->exit_time = current_time;
982 if (current == thread) current = NULL;
984 fprintf( stderr,"%04x: *killed* exit_code=%d\n",
985 thread->id, thread->exit_code );
988 while (thread->wait) end_wait( thread );
989 send_thread_wakeup( thread, 0, thread->exit_code );
990 /* if it is waiting on the socket, we don't need to send a SIGQUIT */
993 kill_console_processes( thread, 0 );
994 debug_exit_thread( thread );
995 abandon_mutexes( thread );
996 wake_up( &thread->obj, 0 );
997 if (violent_death) send_thread_signal( thread, SIGQUIT );
998 cleanup_thread( thread );
999 remove_process_thread( thread->process, thread );
1000 release_object( thread );
1003 /* copy parts of a context structure */
1004 static void copy_context( context_t *to, const context_t *from, unsigned int flags )
1006 assert( to->cpu == from->cpu );
1008 if (flags & SERVER_CTX_CONTROL) to->ctl = from->ctl;
1009 if (flags & SERVER_CTX_INTEGER) to->integer = from->integer;
1010 if (flags & SERVER_CTX_SEGMENTS) to->seg = from->seg;
1011 if (flags & SERVER_CTX_FLOATING_POINT) to->fp = from->fp;
1012 if (flags & SERVER_CTX_DEBUG_REGISTERS) to->debug = from->debug;
1013 if (flags & SERVER_CTX_EXTENDED_REGISTERS) to->ext = from->ext;
1016 /* return the context flags that correspond to system regs */
1017 /* (system regs are the ones we can't access on the client side) */
1018 static unsigned int get_context_system_regs( enum cpu_type cpu )
1022 case CPU_x86: return SERVER_CTX_DEBUG_REGISTERS;
1023 case CPU_x86_64: return SERVER_CTX_DEBUG_REGISTERS;
1024 case CPU_POWERPC: return 0;
1025 case CPU_ARM: return 0;
1026 case CPU_SPARC: return 0;
1031 /* trigger a breakpoint event in a given thread */
1032 void break_thread( struct thread *thread )
1036 assert( thread->context );
1038 memset( &data, 0, sizeof(data) );
1039 data.exception.first = 1;
1040 data.exception.exc_code = STATUS_BREAKPOINT;
1041 data.exception.flags = EXCEPTION_CONTINUABLE;
1042 switch (thread->context->cpu)
1045 data.exception.address = thread->context->ctl.i386_regs.eip;
1048 data.exception.address = thread->context->ctl.x86_64_regs.rip;
1051 data.exception.address = thread->context->ctl.powerpc_regs.iar;
1054 data.exception.address = thread->context->ctl.sparc_regs.pc;
1057 data.exception.address = thread->context->ctl.arm_regs.pc;
1060 generate_debug_event( thread, EXCEPTION_DEBUG_EVENT, &data );
1061 thread->debug_break = 0;
1064 /* take a snapshot of currently running threads */
1065 struct thread_snapshot *thread_snap( int *count )
1067 struct thread_snapshot *snapshot, *ptr;
1068 struct thread *thread;
1071 LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
1072 if (thread->state != TERMINATED) total++;
1073 if (!total || !(snapshot = mem_alloc( sizeof(*snapshot) * total ))) return NULL;
1075 LIST_FOR_EACH_ENTRY( thread, &thread_list, struct thread, entry )
1077 if (thread->state == TERMINATED) continue;
1078 ptr->thread = thread;
1079 ptr->count = thread->obj.refcount;
1080 ptr->priority = thread->priority;
1081 grab_object( thread );
1088 /* gets the current impersonation token */
1089 struct token *thread_get_impersonation_token( struct thread *thread )
1092 return thread->token;
1094 return thread->process->token;
1097 /* create a new thread */
1098 DECL_HANDLER(new_thread)
1100 struct thread *thread;
1101 int request_fd = thread_get_inflight_fd( current, req->request_fd );
1103 if (request_fd == -1 || fcntl( request_fd, F_SETFL, O_NONBLOCK ) == -1)
1105 if (request_fd != -1) close( request_fd );
1106 set_error( STATUS_INVALID_HANDLE );
1110 if ((thread = create_thread( request_fd, current->process )))
1112 if (req->suspend) thread->suspend++;
1113 reply->tid = get_thread_id( thread );
1114 if ((reply->handle = alloc_handle( current->process, thread, req->access, req->attributes )))
1116 /* thread object will be released when the thread gets killed */
1119 kill_thread( thread, 1 );
1123 /* initialize a new thread */
1124 DECL_HANDLER(init_thread)
1126 unsigned int prefix_cpu_mask = get_prefix_cpu_mask();
1127 struct process *process = current->process;
1128 int wait_fd, reply_fd;
1130 if ((reply_fd = thread_get_inflight_fd( current, req->reply_fd )) == -1)
1132 set_error( STATUS_TOO_MANY_OPENED_FILES );
1135 if ((wait_fd = thread_get_inflight_fd( current, req->wait_fd )) == -1)
1137 set_error( STATUS_TOO_MANY_OPENED_FILES );
1141 if (current->reply_fd) /* already initialised */
1143 set_error( STATUS_INVALID_PARAMETER );
1147 if (fcntl( reply_fd, F_SETFL, O_NONBLOCK ) == -1) goto error;
1149 current->reply_fd = create_anonymous_fd( &thread_fd_ops, reply_fd, ¤t->obj, 0 );
1150 current->wait_fd = create_anonymous_fd( &thread_fd_ops, wait_fd, ¤t->obj, 0 );
1151 if (!current->reply_fd || !current->wait_fd) return;
1153 if (!is_valid_address(req->teb))
1155 set_error( STATUS_INVALID_PARAMETER );
1159 current->unix_pid = req->unix_pid;
1160 current->unix_tid = req->unix_tid;
1161 current->teb = req->teb;
1163 if (!process->peb) /* first thread, initialize the process too */
1165 if (!CPU_FLAG(req->cpu) || !(supported_cpus & prefix_cpu_mask & CPU_FLAG(req->cpu)))
1167 if (!(supported_cpus & CPU_64BIT_MASK))
1168 set_error( STATUS_NOT_SUPPORTED );
1170 set_error( STATUS_NOT_REGISTRY_FILE ); /* server supports it but not the prefix */
1173 process->unix_pid = current->unix_pid;
1174 process->peb = req->entry;
1175 process->cpu = req->cpu;
1176 reply->info_size = init_process( current );
1177 if (!process->parent)
1178 process->affinity = current->affinity = get_thread_affinity( current );
1180 set_thread_affinity( current, current->affinity );
1184 if (req->cpu != process->cpu)
1186 set_error( STATUS_INVALID_PARAMETER );
1189 if (process->unix_pid != current->unix_pid)
1190 process->unix_pid = -1; /* can happen with linuxthreads */
1191 stop_thread_if_suspended( current );
1192 generate_debug_event( current, CREATE_THREAD_DEBUG_EVENT, &req->entry );
1193 set_thread_affinity( current, current->affinity );
1195 debug_level = max( debug_level, req->debug_level );
1197 reply->pid = get_process_id( process );
1198 reply->tid = get_thread_id( current );
1199 reply->version = SERVER_PROTOCOL_VERSION;
1200 reply->server_start = server_start_time;
1201 reply->all_cpus = supported_cpus & prefix_cpu_mask;
1205 if (reply_fd != -1) close( reply_fd );
1206 if (wait_fd != -1) close( wait_fd );
1209 /* terminate a thread */
1210 DECL_HANDLER(terminate_thread)
1212 struct thread *thread;
1216 if ((thread = get_thread_from_handle( req->handle, THREAD_TERMINATE )))
1218 thread->exit_code = req->exit_code;
1219 if (thread != current) kill_thread( thread, 1 );
1223 reply->last = (thread->process->running_threads == 1);
1225 release_object( thread );
1229 /* open a handle to a thread */
1230 DECL_HANDLER(open_thread)
1232 struct thread *thread = get_thread_from_id( req->tid );
1237 reply->handle = alloc_handle( current->process, thread, req->access, req->attributes );
1238 release_object( thread );
1242 /* fetch information about a thread */
1243 DECL_HANDLER(get_thread_info)
1245 struct thread *thread;
1246 obj_handle_t handle = req->handle;
1248 if (!handle) thread = get_thread_from_id( req->tid_in );
1249 else thread = get_thread_from_handle( req->handle, THREAD_QUERY_INFORMATION );
1253 reply->pid = get_process_id( thread->process );
1254 reply->tid = get_thread_id( thread );
1255 reply->teb = thread->teb;
1256 reply->exit_code = (thread->state == TERMINATED) ? thread->exit_code : STATUS_PENDING;
1257 reply->priority = thread->priority;
1258 reply->affinity = thread->affinity;
1259 reply->creation_time = thread->creation_time;
1260 reply->exit_time = thread->exit_time;
1261 reply->last = thread->process->running_threads == 1;
1263 release_object( thread );
1267 /* set information about a thread */
1268 DECL_HANDLER(set_thread_info)
1270 struct thread *thread;
1272 if ((thread = get_thread_from_handle( req->handle, THREAD_SET_INFORMATION )))
1274 set_thread_info( thread, req );
1275 release_object( thread );
1279 /* suspend a thread */
1280 DECL_HANDLER(suspend_thread)
1282 struct thread *thread;
1284 if ((thread = get_thread_from_handle( req->handle, THREAD_SUSPEND_RESUME )))
1286 if (thread->state == TERMINATED) set_error( STATUS_ACCESS_DENIED );
1287 else reply->count = suspend_thread( thread );
1288 release_object( thread );
1292 /* resume a thread */
1293 DECL_HANDLER(resume_thread)
1295 struct thread *thread;
1297 if ((thread = get_thread_from_handle( req->handle, THREAD_SUSPEND_RESUME )))
1299 reply->count = resume_thread( thread );
1300 release_object( thread );
1304 /* select on a handle list */
1305 DECL_HANDLER(select)
1307 struct thread_apc *apc;
1309 const apc_result_t *result = get_req_data();
1310 const obj_handle_t *handles = (const obj_handle_t *)(result + 1);
1312 if (get_req_data_size() < sizeof(*result))
1314 set_error( STATUS_INVALID_PARAMETER );
1317 count = (get_req_data_size() - sizeof(*result)) / sizeof(obj_handle_t);
1319 /* first store results of previous apc */
1322 if (!(apc = (struct thread_apc *)get_handle_obj( current->process, req->prev_apc,
1323 0, &thread_apc_ops ))) return;
1324 apc->result = *result;
1326 if (apc->result.type == APC_CREATE_THREAD) /* transfer the handle to the caller process */
1328 obj_handle_t handle = duplicate_handle( current->process, apc->result.create_thread.handle,
1329 apc->caller->process, 0, 0, DUP_HANDLE_SAME_ACCESS );
1330 close_handle( current->process, apc->result.create_thread.handle );
1331 apc->result.create_thread.handle = handle;
1332 clear_error(); /* ignore errors from the above calls */
1334 else if (apc->result.type == APC_ASYNC_IO)
1337 async_set_result( apc->owner, apc->result.async_io.status,
1338 apc->result.async_io.total, apc->result.async_io.apc );
1340 wake_up( &apc->obj, 0 );
1341 close_handle( current->process, req->prev_apc );
1342 release_object( apc );
1345 reply->timeout = select_on( count, req->cookie, handles, req->flags, req->timeout, req->signal );
1347 if (get_error() == STATUS_USER_APC)
1351 if (!(apc = thread_dequeue_apc( current, !(req->flags & SELECT_ALERTABLE) )))
1353 /* Optimization: ignore APC_NONE calls, they are only used to
1354 * wake up a thread, but since we got here the thread woke up already.
1356 if (apc->call.type != APC_NONE)
1358 if ((reply->apc_handle = alloc_handle( current->process, apc, SYNCHRONIZE, 0 )))
1359 reply->call = apc->call;
1360 release_object( apc );
1364 wake_up( &apc->obj, 0 );
1365 release_object( apc );
1370 /* queue an APC for a thread or process */
1371 DECL_HANDLER(queue_apc)
1373 struct thread *thread = NULL;
1374 struct process *process = NULL;
1375 struct thread_apc *apc;
1377 if (!(apc = create_apc( NULL, &req->call ))) return;
1379 switch (apc->call.type)
1383 thread = get_thread_from_handle( req->handle, THREAD_SET_CONTEXT );
1385 case APC_VIRTUAL_ALLOC:
1386 case APC_VIRTUAL_FREE:
1387 case APC_VIRTUAL_PROTECT:
1388 case APC_VIRTUAL_FLUSH:
1389 case APC_VIRTUAL_LOCK:
1390 case APC_VIRTUAL_UNLOCK:
1391 case APC_UNMAP_VIEW:
1392 process = get_process_from_handle( req->handle, PROCESS_VM_OPERATION );
1394 case APC_VIRTUAL_QUERY:
1395 process = get_process_from_handle( req->handle, PROCESS_QUERY_INFORMATION );
1398 process = get_process_from_handle( req->handle, PROCESS_VM_OPERATION );
1399 if (process && process != current->process)
1401 /* duplicate the handle into the target process */
1402 obj_handle_t handle = duplicate_handle( current->process, apc->call.map_view.handle,
1403 process, 0, 0, DUP_HANDLE_SAME_ACCESS );
1404 if (handle) apc->call.map_view.handle = handle;
1407 release_object( process );
1412 case APC_CREATE_THREAD:
1413 process = get_process_from_handle( req->handle, PROCESS_CREATE_THREAD );
1416 set_error( STATUS_INVALID_PARAMETER );
1422 if (!queue_apc( NULL, thread, apc )) set_error( STATUS_THREAD_IS_TERMINATING );
1423 release_object( thread );
1427 reply->self = (process == current->process);
1430 obj_handle_t handle = alloc_handle( current->process, apc, SYNCHRONIZE, 0 );
1433 if (queue_apc( process, NULL, apc ))
1435 apc->caller = (struct thread *)grab_object( current );
1436 reply->handle = handle;
1440 close_handle( current->process, handle );
1441 set_error( STATUS_PROCESS_IS_TERMINATING );
1445 release_object( process );
1448 release_object( apc );
1451 /* Get the result of an APC call */
1452 DECL_HANDLER(get_apc_result)
1454 struct thread_apc *apc;
1456 if (!(apc = (struct thread_apc *)get_handle_obj( current->process, req->handle,
1457 0, &thread_apc_ops ))) return;
1458 if (!apc->executed) set_error( STATUS_PENDING );
1461 reply->result = apc->result;
1462 /* close the handle directly to avoid an extra round-trip */
1463 close_handle( current->process, req->handle );
1465 release_object( apc );
1468 /* retrieve the current context of a thread */
1469 DECL_HANDLER(get_thread_context)
1471 struct thread *thread;
1474 if (get_reply_max_size() < sizeof(context_t))
1476 set_error( STATUS_INVALID_PARAMETER );
1479 if (!(thread = get_thread_from_handle( req->handle, THREAD_GET_CONTEXT ))) return;
1480 reply->self = (thread == current);
1482 if (thread != current && !thread->context)
1484 /* thread is not suspended, retry (if it's still running) */
1485 if (thread->state == RUNNING)
1487 set_error( STATUS_PENDING );
1490 release_object( thread );
1491 /* make sure we have suspend access */
1492 if (!(thread = get_thread_from_handle( req->handle, THREAD_SUSPEND_RESUME ))) return;
1493 suspend_thread( thread );
1496 else set_error( STATUS_UNSUCCESSFUL );
1498 else if ((context = set_reply_data_size( sizeof(context_t) )))
1500 unsigned int flags = get_context_system_regs( thread->process->cpu );
1502 memset( context, 0, sizeof(context_t) );
1503 context->cpu = thread->process->cpu;
1504 if (thread->context) copy_context( context, thread->context, req->flags & ~flags );
1505 if (flags) get_thread_context( thread, context, flags );
1507 release_object( thread );
1510 /* set the current context of a thread */
1511 DECL_HANDLER(set_thread_context)
1513 struct thread *thread;
1514 const context_t *context = get_req_data();
1516 if (get_req_data_size() < sizeof(context_t))
1518 set_error( STATUS_INVALID_PARAMETER );
1521 if (!(thread = get_thread_from_handle( req->handle, THREAD_SET_CONTEXT ))) return;
1522 reply->self = (thread == current);
1524 if (thread != current && !thread->context)
1526 /* thread is not suspended, retry (if it's still running) */
1527 if (thread->state == RUNNING)
1529 set_error( STATUS_PENDING );
1532 release_object( thread );
1533 /* make sure we have suspend access */
1534 if (!(thread = get_thread_from_handle( req->handle, THREAD_SUSPEND_RESUME ))) return;
1535 suspend_thread( thread );
1538 else set_error( STATUS_UNSUCCESSFUL );
1540 else if (context->cpu == thread->process->cpu)
1542 unsigned int system_flags = get_context_system_regs(context->cpu) & context->flags;
1543 unsigned int client_flags = context->flags & ~system_flags;
1545 if (system_flags) set_thread_context( thread, context, system_flags );
1546 if (thread->context && !get_error()) copy_context( thread->context, context, client_flags );
1548 else set_error( STATUS_INVALID_PARAMETER );
1550 release_object( thread );
1553 /* retrieve the suspended context of a thread */
1554 DECL_HANDLER(get_suspend_context)
1556 if (get_reply_max_size() < sizeof(context_t))
1558 set_error( STATUS_INVALID_PARAMETER );
1562 if (current->suspend_context)
1564 set_reply_data_ptr( current->suspend_context, sizeof(context_t) );
1565 if (current->context == current->suspend_context)
1567 current->context = NULL;
1568 stop_thread_if_suspended( current );
1570 current->suspend_context = NULL;
1572 else set_error( STATUS_INVALID_PARAMETER ); /* not suspended, shouldn't happen */
1575 /* store the suspended context of a thread */
1576 DECL_HANDLER(set_suspend_context)
1578 const context_t *context = get_req_data();
1580 if (get_req_data_size() < sizeof(context_t))
1582 set_error( STATUS_INVALID_PARAMETER );
1586 if (current->context || context->cpu != current->process->cpu)
1588 /* nested suspend or exception, shouldn't happen */
1589 set_error( STATUS_INVALID_PARAMETER );
1591 else if ((current->suspend_context = mem_alloc( sizeof(context_t) )))
1593 memcpy( current->suspend_context, get_req_data(), sizeof(context_t) );
1594 current->context = current->suspend_context;
1595 if (current->debug_break) break_thread( current );
1599 /* fetch a selector entry for a thread */
1600 DECL_HANDLER(get_selector_entry)
1602 struct thread *thread;
1603 if ((thread = get_thread_from_handle( req->handle, THREAD_QUERY_INFORMATION )))
1605 get_selector_entry( thread, req->entry, &reply->base, &reply->limit, &reply->flags );
1606 release_object( thread );