mutex.c 8.6 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1 2 3 4
/*
 * Server-side mutex management
 *
 * Copyright (C) 1998 Alexandre Julliard
5 6 7 8 9 10 11 12 13 14 15 16 17
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * 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
Alexandre Julliard's avatar
Alexandre Julliard committed
19 20
 */

21 22 23
#include "config.h"
#include "wine/port.h"

Alexandre Julliard's avatar
Alexandre Julliard committed
24 25 26
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
27
#include <stdarg.h>
Alexandre Julliard's avatar
Alexandre Julliard committed
28

29 30
#include "ntstatus.h"
#define WIN32_NO_STATUS
31
#include "windef.h"
32
#include "winternl.h"
33 34 35

#include "handle.h"
#include "thread.h"
36
#include "request.h"
37
#include "security.h"
Alexandre Julliard's avatar
Alexandre Julliard committed
38 39 40 41 42 43 44

struct mutex
{
    struct object  obj;             /* object header */
    struct thread *owner;           /* mutex owner */
    unsigned int   count;           /* recursion count */
    int            abandoned;       /* has it been abandoned? */
45
    struct list    entry;           /* entry in owner thread mutex list */
Alexandre Julliard's avatar
Alexandre Julliard committed
46 47
};

48
static void mutex_dump( struct object *obj, int verbose );
49
static struct object_type *mutex_get_type( struct object *obj );
Alexandre Julliard's avatar
Alexandre Julliard committed
50 51
static int mutex_signaled( struct object *obj, struct thread *thread );
static int mutex_satisfied( struct object *obj, struct thread *thread );
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 );
Alexandre Julliard's avatar
Alexandre Julliard committed
55 56 57

static const struct object_ops mutex_ops =
{
58 59
    sizeof(struct mutex),      /* size */
    mutex_dump,                /* dump */
60
    mutex_get_type,            /* get_type */
61 62 63 64
    add_queue,                 /* add_queue */
    remove_queue,              /* remove_queue */
    mutex_signaled,            /* signaled */
    mutex_satisfied,           /* satisfied */
65
    mutex_signal,              /* signal */
66
    no_get_fd,                 /* get_fd */
67
    mutex_map_access,          /* map_access */
68 69
    default_get_sd,            /* get_sd */
    default_set_sd,            /* set_sd */
70
    no_lookup_name,            /* lookup_name */
71
    no_open_file,              /* open_file */
72
    no_close_handle,           /* close_handle */
73
    mutex_destroy              /* destroy */
Alexandre Julliard's avatar
Alexandre Julliard committed
74 75 76
};


77
static struct mutex *create_mutex( struct directory *root, const struct unicode_str *name,
78
                                   unsigned int attr, int owned, const struct security_descriptor *sd )
Alexandre Julliard's avatar
Alexandre Julliard committed
79 80 81
{
    struct mutex *mutex;

82
    if ((mutex = create_named_object_dir( root, name, attr, &mutex_ops )))
Alexandre Julliard's avatar
Alexandre Julliard committed
83
    {
84
        if (get_error() != STATUS_OBJECT_NAME_EXISTS)
85 86 87 88 89 90
        {
            /* initialize it if it didn't already exist */
            mutex->count = 0;
            mutex->owner = NULL;
            mutex->abandoned = 0;
            if (owned) mutex_satisfied( &mutex->obj, current );
91 92 93 94
            if (sd) default_set_sd( &mutex->obj, sd, OWNER_SECURITY_INFORMATION|
                                                     GROUP_SECURITY_INFORMATION|
                                                     DACL_SECURITY_INFORMATION|
                                                     SACL_SECURITY_INFORMATION );
95
        }
Alexandre Julliard's avatar
Alexandre Julliard committed
96
    }
97
    return mutex;
Alexandre Julliard's avatar
Alexandre Julliard committed
98 99 100
}

/* release a mutex once the recursion count is 0 */
101
static void do_release( struct mutex *mutex )
Alexandre Julliard's avatar
Alexandre Julliard committed
102 103 104
{
    assert( !mutex->count );
    /* remove the mutex from the thread list of owned mutexes */
105
    list_remove( &mutex->entry );
Alexandre Julliard's avatar
Alexandre Julliard committed
106 107 108 109 110 111
    mutex->owner = NULL;
    wake_up( &mutex->obj, 0 );
}

void abandon_mutexes( struct thread *thread )
{
112 113 114
    struct list *ptr;

    while ((ptr = list_head( &thread->mutex_list )) != NULL)
Alexandre Julliard's avatar
Alexandre Julliard committed
115
    {
116
        struct mutex *mutex = LIST_ENTRY( ptr, struct mutex, entry );
Alexandre Julliard's avatar
Alexandre Julliard committed
117 118 119
        assert( mutex->owner == thread );
        mutex->count = 0;
        mutex->abandoned = 1;
120
        do_release( mutex );
Alexandre Julliard's avatar
Alexandre Julliard committed
121 122 123
    }
}

124
static void mutex_dump( struct object *obj, int verbose )
Alexandre Julliard's avatar
Alexandre Julliard committed
125 126 127
{
    struct mutex *mutex = (struct mutex *)obj;
    assert( obj->ops == &mutex_ops );
128 129 130
    fprintf( stderr, "Mutex count=%u owner=%p ", mutex->count, mutex->owner );
    dump_object_name( &mutex->obj );
    fputc( '\n', stderr );
Alexandre Julliard's avatar
Alexandre Julliard committed
131 132
}

133 134 135 136 137 138 139
static struct object_type *mutex_get_type( struct object *obj )
{
    static const WCHAR name[] = {'M','u','t','a','n','t'};
    static const struct unicode_str str = { name, sizeof(name) };
    return get_object_type( &str );
}

Alexandre Julliard's avatar
Alexandre Julliard committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
static int mutex_signaled( struct object *obj, struct thread *thread )
{
    struct mutex *mutex = (struct mutex *)obj;
    assert( obj->ops == &mutex_ops );
    return (!mutex->count || (mutex->owner == thread));
}

static int mutex_satisfied( struct object *obj, struct thread *thread )
{
    struct mutex *mutex = (struct mutex *)obj;
    assert( obj->ops == &mutex_ops );
    assert( !mutex->count || (mutex->owner == thread) );

    if (!mutex->count++)  /* FIXME: avoid wrap-around */
    {
        assert( !mutex->owner );
        mutex->owner = thread;
157
        list_add_head( &thread->mutex_list, &mutex->entry );
Alexandre Julliard's avatar
Alexandre Julliard committed
158 159 160 161 162 163
    }
    if (!mutex->abandoned) return 0;
    mutex->abandoned = 0;
    return 1;
}

164 165 166 167 168 169 170 171 172
static unsigned int mutex_map_access( struct object *obj, unsigned int access )
{
    if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | SYNCHRONIZE;
    if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | MUTEX_MODIFY_STATE;
    if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
    if (access & GENERIC_ALL)     access |= STANDARD_RIGHTS_ALL | MUTEX_ALL_ACCESS;
    return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
}

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
static int mutex_signal( struct object *obj, unsigned int access )
{
    struct mutex *mutex = (struct mutex *)obj;
    assert( obj->ops == &mutex_ops );

    if (!(access & SYNCHRONIZE))  /* FIXME: MUTEX_MODIFY_STATE? */
    {
        set_error( STATUS_ACCESS_DENIED );
        return 0;
    }
    if (!mutex->count || (mutex->owner != current))
    {
        set_error( STATUS_MUTANT_NOT_OWNED );
        return 0;
    }
    if (!--mutex->count) do_release( mutex );
    return 1;
}

192 193 194 195 196 197 198 199 200 201
static void mutex_destroy( struct object *obj )
{
    struct mutex *mutex = (struct mutex *)obj;
    assert( obj->ops == &mutex_ops );

    if (!mutex->count) return;
    mutex->count = 0;
    do_release( mutex );
}

202 203 204
/* create a mutex */
DECL_HANDLER(create_mutex)
{
205
    struct mutex *mutex;
206
    struct unicode_str name;
207
    struct directory *root = NULL;
208 209
    const struct object_attributes *objattr = get_req_data();
    const struct security_descriptor *sd;
210

211
    reply->handle = 0;
212 213 214 215 216

    if (!objattr_is_valid( objattr, get_req_data_size() ))
        return;

    sd = objattr->sd_len ? (const struct security_descriptor *)(objattr + 1) : NULL;
217
    objattr_get_name( objattr, &name );
218 219

    if (objattr->rootdir && !(root = get_directory_obj( current->process, objattr->rootdir, 0 )))
220 221
        return;

222
    if ((mutex = create_mutex( root, &name, req->attributes, req->owned, sd )))
223
    {
224 225 226 227
        if (get_error() == STATUS_OBJECT_NAME_EXISTS)
            reply->handle = alloc_handle( current->process, mutex, req->access, req->attributes );
        else
            reply->handle = alloc_handle_no_access_check( current->process, mutex, req->access, req->attributes );
228
        release_object( mutex );
229
    }
230 231

    if (root) release_object( root );
232 233 234 235 236
}

/* open a handle to a mutex */
DECL_HANDLER(open_mutex)
{
237
    struct unicode_str name;
238
    struct directory *root = NULL;
239
    struct mutex *mutex;
240 241

    get_req_unicode_str( &name );
242 243 244
    if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
        return;

245 246
    if ((mutex = open_object_dir( root, &name, req->attributes, &mutex_ops )))
    {
247
        reply->handle = alloc_handle( current->process, &mutex->obj, req->access, req->attributes );
248 249
        release_object( mutex );
    }
250 251

    if (root) release_object( root );
252 253 254 255 256
}

/* release a mutex */
DECL_HANDLER(release_mutex)
{
257 258 259 260 261
    struct mutex *mutex;

    if ((mutex = (struct mutex *)get_handle_obj( current->process, req->handle,
                                                 MUTEX_MODIFY_STATE, &mutex_ops )))
    {
262
        if (!mutex->count || (mutex->owner != current)) set_error( STATUS_MUTANT_NOT_OWNED );
263 264 265 266 267
        else
        {
            reply->prev_count = mutex->count;
            if (!--mutex->count) do_release( mutex );
        }
268 269
        release_object( mutex );
    }
270
}