server/mutex.c

   1 /*
   2  * Server-side mutex 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 <stdio.h>
  26 #include <stdlib.h>
  27 #include <stdarg.h>
  28
  29 #include "ntstatus.h"
  30 #define WIN32_NO_STATUS
  31 #include "windef.h"
  32 #include "winternl.h"
  33
  34 #include "handle.h"
  35 #include "thread.h"
  36 #include "request.h"
  37 #include "security.h"
  38
  39 struct mutex
  40 {
  41     struct object  obj;             /* object header */
  42     struct thread *owner;           /* mutex owner */
  43     unsigned int   count;           /* recursion count */
  44     int            abandoned;       /* has it been abandoned? */
  45     struct list    entry;           /* entry in owner thread mutex list */
  46 };
  47
  48 static void mutex_dump( struct object *obj, int verbose );
  49 static struct object_type *mutex_get_type( struct object *obj );
  50 static int mutex_signaled( struct object *obj, struct wait_queue_entry *entry );
  51 static void mutex_satisfied( struct object *obj, struct wait_queue_entry *entry );
  52 static unsigned int mutex_map_access( struct object *obj, unsigned int access );
  53 static void mutex_destroy( struct object *obj );
  54 static int mutex_signal( struct object *obj, unsigned int access );
  55
  56 static const struct object_ops mutex_ops =
  57 {
  58     sizeof(struct mutex),      /* size */
  59     mutex_dump,                /* dump */
  60     mutex_get_type,            /* get_type */
  61     add_queue,                 /* add_queue */
  62     remove_queue,              /* remove_queue */
  63     mutex_signaled,            /* signaled */
  64     mutex_satisfied,           /* satisfied */
  65     mutex_signal,              /* signal */
  66     no_get_fd,                 /* get_fd */
  67     mutex_map_access,          /* map_access */
  68     default_get_sd,            /* get_sd */
  69     default_set_sd,            /* set_sd */
  70     default_get_full_name,     /* get_full_name */
  71     no_lookup_name,            /* lookup_name */
  72     directory_link_name,       /* link_name */
  73     default_unlink_name,       /* unlink_name */
  74     no_open_file,              /* open_file */
  75     no_kernel_obj_list,        /* get_kernel_obj_list */
  76     no_close_handle,           /* close_handle */
  77     mutex_destroy              /* destroy */
  78 };
  79
  80
  81 /* grab a mutex for a given thread */
  82 static void do_grab( struct mutex *mutex, struct thread *thread )
  83 {
  84     assert( !mutex->count || (mutex->owner == thread) );
  85
  86     if (!mutex->count++)  /* FIXME: avoid wrap-around */
  87     {
  88         assert( !mutex->owner );
  89         mutex->owner = thread;
  90         list_add_head( &thread->mutex_list, &mutex->entry );
  91     }
  92 }
  93
  94 /* release a mutex once the recursion count is 0 */
  95 static void do_release( struct mutex *mutex )
  96 {
  97     assert( !mutex->count );
  98     /* remove the mutex from the thread list of owned mutexes */
  99     list_remove( &mutex->entry );
 100     mutex->owner = NULL;
 101     wake_up( &mutex->obj, 0 );
 102 }
 103
 104 static struct mutex *create_mutex( struct object *root, const struct unicode_str *name,
 105                                    unsigned int attr, int owned, const struct security_descriptor *sd )
 106 {
 107     struct mutex *mutex;
 108
 109     if ((mutex = create_named_object( root, &mutex_ops, name, attr, sd )))
 110     {
 111         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
 112         {
 113             /* initialize it if it didn't already exist */
 114             mutex->count = 0;
 115             mutex->owner = NULL;
 116             mutex->abandoned = 0;
 117             if (owned) do_grab( mutex, current );
 118         }
 119     }
 120     return mutex;
 121 }
 122
 123 void abandon_mutexes( struct thread *thread )
 124 {
 125     struct list *ptr;
 126
 127     while ((ptr = list_head( &thread->mutex_list )) != NULL)
 128     {
 129         struct mutex *mutex = LIST_ENTRY( ptr, struct mutex, entry );
 130         assert( mutex->owner == thread );
 131         mutex->count = 0;
 132         mutex->abandoned = 1;
 133         do_release( mutex );
 134     }
 135 }
 136
 137 static void mutex_dump( struct object *obj, int verbose )
 138 {
 139     struct mutex *mutex = (struct mutex *)obj;
 140     assert( obj->ops == &mutex_ops );
 141     fprintf( stderr, "Mutex count=%u owner=%p\n", mutex->count, mutex->owner );
 142 }
 143
 144 static struct object_type *mutex_get_type( struct object *obj )
 145 {
 146     static const WCHAR name[] = {'M','u','t','a','n','t'};
 147     static const struct unicode_str str = { name, sizeof(name) };
 148     return get_object_type( &str );
 149 }
 150
 151 static int mutex_signaled( struct object *obj, struct wait_queue_entry *entry )
 152 {
 153     struct mutex *mutex = (struct mutex *)obj;
 154     assert( obj->ops == &mutex_ops );
 155     return (!mutex->count || (mutex->owner == get_wait_queue_thread( entry )));
 156 }
 157
 158 static void mutex_satisfied( struct object *obj, struct wait_queue_entry *entry )
 159 {
 160     struct mutex *mutex = (struct mutex *)obj;
 161     assert( obj->ops == &mutex_ops );
 162
 163     do_grab( mutex, get_wait_queue_thread( entry ));
 164     if (mutex->abandoned) make_wait_abandoned( entry );
 165     mutex->abandoned = 0;
 166 }
 167
 168 static unsigned int mutex_map_access( struct object *obj, unsigned int access )
 169 {
 170     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | MUTANT_QUERY_STATE;
 171     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE;
 172     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE | SYNCHRONIZE;
 173     if (access & GENERIC_ALL)     access |= STANDARD_RIGHTS_ALL | MUTEX_ALL_ACCESS;
 174     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 175 }
 176
 177 static int mutex_signal( struct object *obj, unsigned int access )
 178 {
 179     struct mutex *mutex = (struct mutex *)obj;
 180     assert( obj->ops == &mutex_ops );
 181
 182     if (!(access & SYNCHRONIZE))
 183     {
 184         set_error( STATUS_ACCESS_DENIED );
 185         return 0;
 186     }
 187     if (!mutex->count || (mutex->owner != current))
 188     {
 189         set_error( STATUS_MUTANT_NOT_OWNED );
 190         return 0;
 191     }
 192     if (!--mutex->count) do_release( mutex );
 193     return 1;
 194 }
 195
 196 static void mutex_destroy( struct object *obj )
 197 {
 198     struct mutex *mutex = (struct mutex *)obj;
 199     assert( obj->ops == &mutex_ops );
 200
 201     if (!mutex->count) return;
 202     mutex->count = 0;
 203     do_release( mutex );
 204 }
 205
 206 /* create a mutex */
 207 DECL_HANDLER(create_mutex)
 208 {
 209     struct mutex *mutex;
 210     struct unicode_str name;
 211     struct object *root;
 212     const struct security_descriptor *sd;
 213     const struct object_attributes *objattr = get_req_object_attributes( &sd, &name, &root );
 214
 215     if (!objattr) return;
 216
 217     if ((mutex = create_mutex( root, &name, objattr->attributes, req->owned, sd )))
 218     {
 219         if (get_error() == STATUS_OBJECT_NAME_EXISTS)
 220             reply->handle = alloc_handle( current->process, mutex, req->access, objattr->attributes );
 221         else
 222             reply->handle = alloc_handle_no_access_check( current->process, mutex,
 223                                                           req->access, objattr->attributes );
 224         release_object( mutex );
 225     }
 226
 227     if (root) release_object( root );
 228 }
 229
 230 /* open a handle to a mutex */
 231 DECL_HANDLER(open_mutex)
 232 {
 233     struct unicode_str name = get_req_unicode_str();
 234
 235     reply->handle = open_object( current->process, req->rootdir, req->access,
 236                                  &mutex_ops, &name, req->attributes );
 237 }
 238
 239 /* release a mutex */
 240 DECL_HANDLER(release_mutex)
 241 {
 242     struct mutex *mutex;
 243
 244     if ((mutex = (struct mutex *)get_handle_obj( current->process, req->handle,
 245                                                  0, &mutex_ops )))
 246     {
 247         if (!mutex->count || (mutex->owner != current)) set_error( STATUS_MUTANT_NOT_OWNED );
 248         else
 249         {
 250             reply->prev_count = mutex->count;
 251             if (!--mutex->count) do_release( mutex );
 252         }
 253         release_object( mutex );
 254     }
 255 }
 256
 257 /* return details about the mutex */
 258 DECL_HANDLER(query_mutex)
 259 {
 260     struct mutex *mutex;
 261
 262     if ((mutex = (struct mutex *)get_handle_obj( current->process, req->handle,
 263                                                  MUTANT_QUERY_STATE, &mutex_ops )))
 264     {
 265         reply->count = mutex->count;
 266         reply->owned = (mutex->owner == current);
 267         reply->abandoned = mutex->abandoned;
 268
 269         release_object( mutex );
 270     }
 271 }