event.c 12.8 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1 2 3 4
/*
 * Server-side event 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

struct event
{
    struct object  obj;             /* object header */
42
    struct list    kernel_object;   /* list of kernel object pointers */
Alexandre Julliard's avatar
Alexandre Julliard committed
43 44 45 46
    int            manual_reset;    /* is it a manual reset event? */
    int            signaled;        /* event has been signaled */
};

47
static void event_dump( struct object *obj, int verbose );
48
static struct object_type *event_get_type( struct object *obj );
49
static int event_signaled( struct object *obj, struct wait_queue_entry *entry );
50
static void event_satisfied( struct object *obj, struct wait_queue_entry *entry );
51
static unsigned int event_map_access( struct object *obj, unsigned int access );
52
static int event_signal( struct object *obj, unsigned int access);
53
static struct list *event_get_kernel_obj_list( struct object *obj );
Alexandre Julliard's avatar
Alexandre Julliard committed
54 55 56

static const struct object_ops event_ops =
{
57 58
    sizeof(struct event),      /* size */
    event_dump,                /* dump */
59
    event_get_type,            /* get_type */
60 61 62 63
    add_queue,                 /* add_queue */
    remove_queue,              /* remove_queue */
    event_signaled,            /* signaled */
    event_satisfied,           /* satisfied */
64
    event_signal,              /* signal */
65
    no_get_fd,                 /* get_fd */
66
    event_map_access,          /* map_access */
67 68
    default_get_sd,            /* get_sd */
    default_set_sd,            /* set_sd */
69
    no_lookup_name,            /* lookup_name */
70 71
    directory_link_name,       /* link_name */
    default_unlink_name,       /* unlink_name */
72
    no_open_file,              /* open_file */
73
    event_get_kernel_obj_list, /* get_kernel_obj_list */
74
    no_close_handle,           /* close_handle */
75
    no_destroy                 /* destroy */
Alexandre Julliard's avatar
Alexandre Julliard committed
76 77 78
};


79 80 81 82 83 84 85
struct keyed_event
{
    struct object  obj;             /* object header */
};

static void keyed_event_dump( struct object *obj, int verbose );
static struct object_type *keyed_event_get_type( struct object *obj );
86
static int keyed_event_signaled( struct object *obj, struct wait_queue_entry *entry );
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
static unsigned int keyed_event_map_access( struct object *obj, unsigned int access );

static const struct object_ops keyed_event_ops =
{
    sizeof(struct keyed_event),  /* size */
    keyed_event_dump,            /* dump */
    keyed_event_get_type,        /* get_type */
    add_queue,                   /* add_queue */
    remove_queue,                /* remove_queue */
    keyed_event_signaled,        /* signaled */
    no_satisfied,                /* satisfied */
    no_signal,                   /* signal */
    no_get_fd,                   /* get_fd */
    keyed_event_map_access,      /* map_access */
    default_get_sd,              /* get_sd */
    default_set_sd,              /* set_sd */
    no_lookup_name,              /* lookup_name */
104 105
    directory_link_name,         /* link_name */
    default_unlink_name,         /* unlink_name */
106
    no_open_file,                /* open_file */
107
    no_kernel_obj_list,          /* get_kernel_obj_list */
108 109 110 111 112
    no_close_handle,             /* close_handle */
    no_destroy                   /* destroy */
};


113
struct event *create_event( struct object *root, const struct unicode_str *name,
114 115
                            unsigned int attr, int manual_reset, int initial_state,
                            const struct security_descriptor *sd )
Alexandre Julliard's avatar
Alexandre Julliard committed
116 117 118
{
    struct event *event;

119
    if ((event = create_named_object( root, &event_ops, name, attr, sd )))
Alexandre Julliard's avatar
Alexandre Julliard committed
120
    {
121
        if (get_error() != STATUS_OBJECT_NAME_EXISTS)
122 123
        {
            /* initialize it if it didn't already exist */
124
            list_init( &event->kernel_object );
125 126 127
            event->manual_reset = manual_reset;
            event->signaled     = initial_state;
        }
Alexandre Julliard's avatar
Alexandre Julliard committed
128
    }
129
    return event;
Alexandre Julliard's avatar
Alexandre Julliard committed
130 131
}

132
struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access )
Alexandre Julliard's avatar
Alexandre Julliard committed
133
{
134
    return (struct event *)get_handle_obj( process, handle, access, &event_ops );
135
}
Alexandre Julliard's avatar
Alexandre Julliard committed
136

137 138
void pulse_event( struct event *event )
{
Alexandre Julliard's avatar
Alexandre Julliard committed
139 140 141 142 143 144
    event->signaled = 1;
    /* wake up all waiters if manual reset, a single one otherwise */
    wake_up( &event->obj, !event->manual_reset );
    event->signaled = 0;
}

145
void set_event( struct event *event )
Alexandre Julliard's avatar
Alexandre Julliard committed
146 147 148 149 150 151
{
    event->signaled = 1;
    /* wake up all waiters if manual reset, a single one otherwise */
    wake_up( &event->obj, !event->manual_reset );
}

152
void reset_event( struct event *event )
Alexandre Julliard's avatar
Alexandre Julliard committed
153 154 155 156
{
    event->signaled = 0;
}

157
static void event_dump( struct object *obj, int verbose )
Alexandre Julliard's avatar
Alexandre Julliard committed
158 159 160
{
    struct event *event = (struct event *)obj;
    assert( obj->ops == &event_ops );
161
    fprintf( stderr, "Event manual=%d signaled=%d\n",
162
             event->manual_reset, event->signaled );
Alexandre Julliard's avatar
Alexandre Julliard committed
163 164
}

165 166 167 168 169 170 171
static struct object_type *event_get_type( struct object *obj )
{
    static const WCHAR name[] = {'E','v','e','n','t'};
    static const struct unicode_str str = { name, sizeof(name) };
    return get_object_type( &str );
}

172
static int event_signaled( struct object *obj, struct wait_queue_entry *entry )
Alexandre Julliard's avatar
Alexandre Julliard committed
173 174 175 176 177 178
{
    struct event *event = (struct event *)obj;
    assert( obj->ops == &event_ops );
    return event->signaled;
}

179
static void event_satisfied( struct object *obj, struct wait_queue_entry *entry )
Alexandre Julliard's avatar
Alexandre Julliard committed
180 181 182 183 184 185 186
{
    struct event *event = (struct event *)obj;
    assert( obj->ops == &event_ops );
    /* Reset if it's an auto-reset event */
    if (!event->manual_reset) event->signaled = 0;
}

187 188
static unsigned int event_map_access( struct object *obj, unsigned int access )
{
189 190 191 192
    if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | EVENT_QUERY_STATE;
    if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | EVENT_MODIFY_STATE;
    if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE | SYNCHRONIZE;
    if (access & GENERIC_ALL)     access |= STANDARD_RIGHTS_ALL | EVENT_QUERY_STATE | EVENT_MODIFY_STATE;
193 194 195
    return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
}

196 197 198 199 200 201 202 203 204 205 206 207 208 209
static int event_signal( struct object *obj, unsigned int access )
{
    struct event *event = (struct event *)obj;
    assert( obj->ops == &event_ops );

    if (!(access & EVENT_MODIFY_STATE))
    {
        set_error( STATUS_ACCESS_DENIED );
        return 0;
    }
    set_event( event );
    return 1;
}

210 211 212 213 214 215
static struct list *event_get_kernel_obj_list( struct object *obj )
{
    struct event *event = (struct event *)obj;
    return &event->kernel_object;
}

216
struct keyed_event *create_keyed_event( struct object *root, const struct unicode_str *name,
217 218 219 220
                                        unsigned int attr, const struct security_descriptor *sd )
{
    struct keyed_event *event;

221
    if ((event = create_named_object( root, &keyed_event_ops, name, attr, sd )))
222 223 224 225 226 227 228 229 230
    {
        if (get_error() != STATUS_OBJECT_NAME_EXISTS)
        {
            /* initialize it if it didn't already exist */
        }
    }
    return event;
}

231 232 233 234 235
struct keyed_event *get_keyed_event_obj( struct process *process, obj_handle_t handle, unsigned int access )
{
    return (struct keyed_event *)get_handle_obj( process, handle, access, &keyed_event_ops );
}

236 237
static void keyed_event_dump( struct object *obj, int verbose )
{
238
    fputs( "Keyed event\n", stderr );
239 240 241 242 243 244 245 246 247
}

static struct object_type *keyed_event_get_type( struct object *obj )
{
    static const WCHAR name[] = {'K','e','y','e','d','E','v','e','n','t'};
    static const struct unicode_str str = { name, sizeof(name) };
    return get_object_type( &str );
}

248 249 250 251 252
static enum select_op matching_op( enum select_op op )
{
    return op ^ (SELECT_KEYED_EVENT_WAIT ^ SELECT_KEYED_EVENT_RELEASE);
}

253
static int keyed_event_signaled( struct object *obj, struct wait_queue_entry *entry )
254
{
255 256 257 258
    struct wait_queue_entry *ptr;
    struct process *process;
    enum select_op select_op;

259
    assert( obj->ops == &keyed_event_ops );
260 261 262 263 264 265 266 267 268 269 270 271 272 273

    process = get_wait_queue_thread( entry )->process;
    select_op = get_wait_queue_select_op( entry );
    if (select_op != SELECT_KEYED_EVENT_WAIT && select_op != SELECT_KEYED_EVENT_RELEASE) return 1;

    LIST_FOR_EACH_ENTRY( ptr, &obj->wait_queue, struct wait_queue_entry, entry )
    {
        if (ptr == entry) continue;
        if (get_wait_queue_thread( ptr )->process != process) continue;
        if (get_wait_queue_select_op( ptr ) != matching_op( select_op )) continue;
        if (get_wait_queue_key( ptr ) != get_wait_queue_key( entry )) continue;
        if (wake_thread_queue_entry( ptr )) return 1;
    }
    return 0;
274 275 276 277
}

static unsigned int keyed_event_map_access( struct object *obj, unsigned int access )
{
278
    if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | KEYEDEVENT_WAIT;
279 280
    if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | KEYEDEVENT_WAKE;
    if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
281
    if (access & GENERIC_ALL)     access |= KEYEDEVENT_ALL_ACCESS;
282 283 284
    return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
}

285 286 287
/* create an event */
DECL_HANDLER(create_event)
{
288
    struct event *event;
289
    struct unicode_str name;
290
    struct object *root;
291
    const struct security_descriptor *sd;
292
    const struct object_attributes *objattr = get_req_object_attributes( &sd, &name, &root );
293

294
    if (!objattr) return;
295

296 297
    if ((event = create_event( root, &name, objattr->attributes,
                               req->manual_reset, req->initial_state, sd )))
298
    {
299
        if (get_error() == STATUS_OBJECT_NAME_EXISTS)
300
            reply->handle = alloc_handle( current->process, event, req->access, objattr->attributes );
301
        else
302 303
            reply->handle = alloc_handle_no_access_check( current->process, event,
                                                          req->access, objattr->attributes );
304
        release_object( event );
305
    }
306 307

    if (root) release_object( root );
308 309 310 311 312
}

/* open a handle to an event */
DECL_HANDLER(open_event)
{
313
    struct unicode_str name = get_req_unicode_str();
314

315 316
    reply->handle = open_object( current->process, req->rootdir, req->access,
                                 &event_ops, &name, req->attributes );
317 318 319 320 321
}

/* do an event operation */
DECL_HANDLER(event_op)
{
322 323 324
    struct event *event;

    if (!(event = get_event_obj( current->process, req->handle, EVENT_MODIFY_STATE ))) return;
325
    reply->state = event->signaled;
326 327 328
    switch(req->op)
    {
    case PULSE_EVENT:
329
        pulse_event( event );
330 331
        break;
    case SET_EVENT:
332
        set_event( event );
333 334
        break;
    case RESET_EVENT:
335
        reset_event( event );
336 337
        break;
    default:
338 339
        set_error( STATUS_INVALID_PARAMETER );
        break;
340
    }
341
    release_object( event );
342
}
343

344 345 346 347 348 349 350 351 352 353 354 355 356
/* return details about the event */
DECL_HANDLER(query_event)
{
    struct event *event;

    if (!(event = get_event_obj( current->process, req->handle, EVENT_QUERY_STATE ))) return;

    reply->manual_reset = event->manual_reset;
    reply->state = event->signaled;

    release_object( event );
}

357 358 359 360 361
/* create a keyed event */
DECL_HANDLER(create_keyed_event)
{
    struct keyed_event *event;
    struct unicode_str name;
362
    struct object *root;
363
    const struct security_descriptor *sd;
364
    const struct object_attributes *objattr = get_req_object_attributes( &sd, &name, &root );
365

366
    if (!objattr) return;
367

368
    if ((event = create_keyed_event( root, &name, objattr->attributes, sd )))
369 370
    {
        if (get_error() == STATUS_OBJECT_NAME_EXISTS)
371
            reply->handle = alloc_handle( current->process, event, req->access, objattr->attributes );
372
        else
373 374
            reply->handle = alloc_handle_no_access_check( current->process, event,
                                                          req->access, objattr->attributes );
375 376 377 378 379 380 381 382
        release_object( event );
    }
    if (root) release_object( root );
}

/* open a handle to a keyed event */
DECL_HANDLER(open_keyed_event)
{
383
    struct unicode_str name = get_req_unicode_str();
384

385 386
    reply->handle = open_object( current->process, req->rootdir, req->access,
                                 &keyed_event_ops, &name, req->attributes );
387
}