event.c 13.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 42 43 44 45

struct event
{
    struct object  obj;             /* object header */
    int            manual_reset;    /* is it a manual reset event? */
    int            signaled;        /* event has been signaled */
};

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

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


74 75 76 77 78 79 80
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 );
81
static int keyed_event_signaled( struct object *obj, struct wait_queue_entry *entry );
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
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 */
    no_open_file,                /* open_file */
    no_close_handle,             /* close_handle */
    no_destroy                   /* destroy */
};


105
struct event *create_event( struct directory *root, const struct unicode_str *name,
106 107
                            unsigned int attr, int manual_reset, int initial_state,
                            const struct security_descriptor *sd )
Alexandre Julliard's avatar
Alexandre Julliard committed
108 109 110
{
    struct event *event;

111
    if ((event = create_named_object_dir( root, name, attr, &event_ops )))
Alexandre Julliard's avatar
Alexandre Julliard committed
112
    {
113
        if (get_error() != STATUS_OBJECT_NAME_EXISTS)
114 115 116 117
        {
            /* initialize it if it didn't already exist */
            event->manual_reset = manual_reset;
            event->signaled     = initial_state;
118 119 120 121
            if (sd) default_set_sd( &event->obj, sd, OWNER_SECURITY_INFORMATION|
                                                     GROUP_SECURITY_INFORMATION|
                                                     DACL_SECURITY_INFORMATION|
                                                     SACL_SECURITY_INFORMATION );
122
        }
Alexandre Julliard's avatar
Alexandre Julliard committed
123
    }
124
    return event;
Alexandre Julliard's avatar
Alexandre Julliard committed
125 126
}

127
struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access )
Alexandre Julliard's avatar
Alexandre Julliard committed
128
{
129
    return (struct event *)get_handle_obj( process, handle, access, &event_ops );
130
}
Alexandre Julliard's avatar
Alexandre Julliard committed
131

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

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

147
void reset_event( struct event *event )
Alexandre Julliard's avatar
Alexandre Julliard committed
148 149 150 151
{
    event->signaled = 0;
}

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

162 163 164 165 166 167 168
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 );
}

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

176
static void event_satisfied( struct object *obj, struct wait_queue_entry *entry )
Alexandre Julliard's avatar
Alexandre Julliard committed
177 178 179 180 181 182 183
{
    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;
}

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

193 194 195 196 197 198 199 200 201 202 203 204 205 206
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;
}

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
struct keyed_event *create_keyed_event( struct directory *root, const struct unicode_str *name,
                                        unsigned int attr, const struct security_descriptor *sd )
{
    struct keyed_event *event;

    if ((event = create_named_object_dir( root, name, attr, &keyed_event_ops )))
    {
        if (get_error() != STATUS_OBJECT_NAME_EXISTS)
        {
            /* initialize it if it didn't already exist */
            if (sd) default_set_sd( &event->obj, sd, OWNER_SECURITY_INFORMATION|
                                                     GROUP_SECURITY_INFORMATION|
                                                     DACL_SECURITY_INFORMATION|
                                                     SACL_SECURITY_INFORMATION );
        }
    }
    return event;
}

226 227 228 229 230
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 );
}

231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
static void keyed_event_dump( struct object *obj, int verbose )
{
    struct keyed_event *event = (struct keyed_event *)obj;
    assert( obj->ops == &keyed_event_ops );
    fprintf( stderr, "Keyed event " );
    dump_object_name( &event->obj );
    fputc( '\n', stderr );
}

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 );
}

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

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

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

    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;
273 274 275 276
}

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

284 285 286
/* create an event */
DECL_HANDLER(create_event)
{
287
    struct event *event;
288
    struct unicode_str name;
289
    struct directory *root = NULL;
290 291
    const struct object_attributes *objattr = get_req_data();
    const struct security_descriptor *sd;
292

293
    reply->handle = 0;
294 295 296 297 298

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

    sd = objattr->sd_len ? (const struct security_descriptor *)(objattr + 1) : NULL;
299
    objattr_get_name( objattr, &name );
300 301

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

304
    if ((event = create_event( root, &name, req->attributes, req->manual_reset, req->initial_state, sd )))
305
    {
306 307 308 309
        if (get_error() == STATUS_OBJECT_NAME_EXISTS)
            reply->handle = alloc_handle( current->process, event, req->access, req->attributes );
        else
            reply->handle = alloc_handle_no_access_check( current->process, event, req->access, req->attributes );
310
        release_object( event );
311
    }
312 313

    if (root) release_object( root );
314 315 316 317 318
}

/* open a handle to an event */
DECL_HANDLER(open_event)
{
319
    struct unicode_str name;
320
    struct directory *root = NULL;
321
    struct event *event;
322 323

    get_req_unicode_str( &name );
324 325 326
    if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
        return;

327 328
    if ((event = open_object_dir( root, &name, req->attributes, &event_ops )))
    {
329
        reply->handle = alloc_handle( current->process, &event->obj, req->access, req->attributes );
330 331
        release_object( event );
    }
332 333

    if (root) release_object( root );
334 335 336 337 338
}

/* do an event operation */
DECL_HANDLER(event_op)
{
339 340 341
    struct event *event;

    if (!(event = get_event_obj( current->process, req->handle, EVENT_MODIFY_STATE ))) return;
342 343 344
    switch(req->op)
    {
    case PULSE_EVENT:
345
        pulse_event( event );
346 347
        break;
    case SET_EVENT:
348
        set_event( event );
349 350
        break;
    case RESET_EVENT:
351
        reset_event( event );
352 353
        break;
    default:
354 355
        set_error( STATUS_INVALID_PARAMETER );
        break;
356
    }
357
    release_object( event );
358
}
359

360 361 362 363 364 365 366 367 368 369 370 371 372
/* 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 );
}

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
/* create a keyed event */
DECL_HANDLER(create_keyed_event)
{
    struct keyed_event *event;
    struct unicode_str name;
    struct directory *root = NULL;
    const struct object_attributes *objattr = get_req_data();
    const struct security_descriptor *sd;

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

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

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

    if ((event = create_keyed_event( root, &name, req->attributes, sd )))
    {
        if (get_error() == STATUS_OBJECT_NAME_EXISTS)
            reply->handle = alloc_handle( current->process, event, req->access, req->attributes );
        else
            reply->handle = alloc_handle_no_access_check( current->process, event, req->access, req->attributes );
        release_object( event );
    }
    if (root) release_object( root );
}

/* open a handle to a keyed event */
DECL_HANDLER(open_keyed_event)
{
    struct unicode_str name;
    struct directory *root = NULL;
    struct keyed_event *event;

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

    if ((event = open_object_dir( root, &name, req->attributes, &keyed_event_ops )))
    {
        reply->handle = alloc_handle( current->process, &event->obj, req->access, req->attributes );
        release_object( event );
    }
    if (root) release_object( root );
}