server/event.c

   1 /*
   2  * Server-side event 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 event
  40 {
  41     struct object  obj;             /* object header */
  42     int            manual_reset;    /* is it a manual reset event? */
  43     int            signaled;        /* event has been signaled */
  44 };
  45
  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 thread *thread );
  49 static int event_satisfied( struct object *obj, struct thread *thread );
  50 static unsigned int event_map_access( struct object *obj, unsigned int access );
  51 static int event_signal( struct object *obj, unsigned int access);
  52
  53 static const struct object_ops event_ops =
  54 {
  55     sizeof(struct event),      /* size */
  56     event_dump,                /* dump */
  57     event_get_type,            /* get_type */
  58     add_queue,                 /* add_queue */
  59     remove_queue,              /* remove_queue */
  60     event_signaled,            /* signaled */
  61     event_satisfied,           /* satisfied */
  62     event_signal,              /* signal */
  63     no_get_fd,                 /* get_fd */
  64     event_map_access,          /* map_access */
  65     default_get_sd,            /* get_sd */
  66     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 */
  71 };
  72
  73
  74 struct keyed_event
  75 {
  76     struct object  obj;             /* object header */
  77 };
  78
  79 static void keyed_event_dump( struct object *obj, int verbose );
  80 static struct object_type *keyed_event_get_type( struct object *obj );
  81 static int keyed_event_signaled( struct object *obj, struct thread *thread );
  82 static unsigned int keyed_event_map_access( struct object *obj, unsigned int access );
  83
  84 static const struct object_ops keyed_event_ops =
  85 {
  86     sizeof(struct keyed_event),  /* size */
  87     keyed_event_dump,            /* dump */
  88     keyed_event_get_type,        /* get_type */
  89     add_queue,                   /* add_queue */
  90     remove_queue,                /* remove_queue */
  91     keyed_event_signaled,        /* signaled */
  92     no_satisfied,                /* satisfied */
  93     no_signal,                   /* signal */
  94     no_get_fd,                   /* get_fd */
  95     keyed_event_map_access,      /* map_access */
  96     default_get_sd,              /* get_sd */
  97     default_set_sd,              /* set_sd */
  98     no_lookup_name,              /* lookup_name */
  99     no_open_file,                /* open_file */
 100     no_close_handle,             /* close_handle */
 101     no_destroy                   /* destroy */
 102 };
 103
 104 #define KEYEDEVENT_WAIT       0x0001
 105 #define KEYEDEVENT_WAKE       0x0002
 106 #define KEYEDEVENT_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | 0x0003)
 107
 108
 109 struct event *create_event( struct directory *root, const struct unicode_str *name,
 110                             unsigned int attr, int manual_reset, int initial_state,
 111                             const struct security_descriptor *sd )
 112 {
 113     struct event *event;
 114
 115     if ((event = create_named_object_dir( root, name, attr, &event_ops )))
 116     {
 117         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
 118         {
 119             /* initialize it if it didn't already exist */
 120             event->manual_reset = manual_reset;
 121             event->signaled     = initial_state;
 122             if (sd) default_set_sd( &event->obj, sd, OWNER_SECURITY_INFORMATION|
 123                                                      GROUP_SECURITY_INFORMATION|
 124                                                      DACL_SECURITY_INFORMATION|
 125                                                      SACL_SECURITY_INFORMATION );
 126         }
 127     }
 128     return event;
 129 }
 130
 131 struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access )
 132 {
 133     return (struct event *)get_handle_obj( process, handle, access, &event_ops );
 134 }
 135
 136 void pulse_event( struct event *event )
 137 {
 138     event->signaled = 1;
 139     /* wake up all waiters if manual reset, a single one otherwise */
 140     wake_up( &event->obj, !event->manual_reset );
 141     event->signaled = 0;
 142 }
 143
 144 void set_event( struct event *event )
 145 {
 146     event->signaled = 1;
 147     /* wake up all waiters if manual reset, a single one otherwise */
 148     wake_up( &event->obj, !event->manual_reset );
 149 }
 150
 151 void reset_event( struct event *event )
 152 {
 153     event->signaled = 0;
 154 }
 155
 156 static void event_dump( struct object *obj, int verbose )
 157 {
 158     struct event *event = (struct event *)obj;
 159     assert( obj->ops == &event_ops );
 160     fprintf( stderr, "Event manual=%d signaled=%d ",
 161              event->manual_reset, event->signaled );
 162     dump_object_name( &event->obj );
 163     fputc( '\n', stderr );
 164 }
 165
 166 static struct object_type *event_get_type( struct object *obj )
 167 {
 168     static const WCHAR name[] = {'E','v','e','n','t'};
 169     static const struct unicode_str str = { name, sizeof(name) };
 170     return get_object_type( &str );
 171 }
 172
 173 static int event_signaled( struct object *obj, struct thread *thread )
 174 {
 175     struct event *event = (struct event *)obj;
 176     assert( obj->ops == &event_ops );
 177     return event->signaled;
 178 }
 179
 180 static int event_satisfied( struct object *obj, struct thread *thread )
 181 {
 182     struct event *event = (struct event *)obj;
 183     assert( obj->ops == &event_ops );
 184     /* Reset if it's an auto-reset event */
 185     if (!event->manual_reset) event->signaled = 0;
 186     return 0;  /* Not abandoned */
 187 }
 188
 189 static unsigned int event_map_access( struct object *obj, unsigned int access )
 190 {
 191     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | SYNCHRONIZE | EVENT_QUERY_STATE;
 192     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE;
 193     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
 194     if (access & GENERIC_ALL)     access |= STANDARD_RIGHTS_ALL | EVENT_ALL_ACCESS;
 195     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 196 }
 197
 198 static int event_signal( struct object *obj, unsigned int access )
 199 {
 200     struct event *event = (struct event *)obj;
 201     assert( obj->ops == &event_ops );
 202
 203     if (!(access & EVENT_MODIFY_STATE))
 204     {
 205         set_error( STATUS_ACCESS_DENIED );
 206         return 0;
 207     }
 208     set_event( event );
 209     return 1;
 210 }
 211
 212 struct keyed_event *create_keyed_event( struct directory *root, const struct unicode_str *name,
 213                                         unsigned int attr, const struct security_descriptor *sd )
 214 {
 215     struct keyed_event *event;
 216
 217     if ((event = create_named_object_dir( root, name, attr, &keyed_event_ops )))
 218     {
 219         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
 220         {
 221             /* initialize it if it didn't already exist */
 222             if (sd) default_set_sd( &event->obj, sd, OWNER_SECURITY_INFORMATION|
 223                                                      GROUP_SECURITY_INFORMATION|
 224                                                      DACL_SECURITY_INFORMATION|
 225                                                      SACL_SECURITY_INFORMATION );
 226         }
 227     }
 228     return event;
 229 }
 230
 231 static void keyed_event_dump( struct object *obj, int verbose )
 232 {
 233     struct keyed_event *event = (struct keyed_event *)obj;
 234     assert( obj->ops == &keyed_event_ops );
 235     fprintf( stderr, "Keyed event " );
 236     dump_object_name( &event->obj );
 237     fputc( '\n', stderr );
 238 }
 239
 240 static struct object_type *keyed_event_get_type( struct object *obj )
 241 {
 242     static const WCHAR name[] = {'K','e','y','e','d','E','v','e','n','t'};
 243     static const struct unicode_str str = { name, sizeof(name) };
 244     return get_object_type( &str );
 245 }
 246
 247 static int keyed_event_signaled( struct object *obj, struct thread *thread )
 248 {
 249     assert( obj->ops == &keyed_event_ops );
 250     return 1;
 251 }
 252
 253 static unsigned int keyed_event_map_access( struct object *obj, unsigned int access )
 254 {
 255     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | KEYEDEVENT_WAIT;
 256     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | KEYEDEVENT_WAKE;
 257     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
 258     if (access & GENERIC_ALL)     access |= KEYEDEVENT_ALL_ACCESS;
 259     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 260 }
 261
 262 /* create an event */
 263 DECL_HANDLER(create_event)
 264 {
 265     struct event *event;
 266     struct unicode_str name;
 267     struct directory *root = NULL;
 268     const struct object_attributes *objattr = get_req_data();
 269     const struct security_descriptor *sd;
 270
 271     reply->handle = 0;
 272
 273     if (!objattr_is_valid( objattr, get_req_data_size() ))
 274         return;
 275
 276     sd = objattr->sd_len ? (const struct security_descriptor *)(objattr + 1) : NULL;
 277     objattr_get_name( objattr, &name );
 278
 279     if (objattr->rootdir && !(root = get_directory_obj( current->process, objattr->rootdir, 0 )))
 280         return;
 281
 282     if ((event = create_event( root, &name, req->attributes, req->manual_reset, req->initial_state, sd )))
 283     {
 284         if (get_error() == STATUS_OBJECT_NAME_EXISTS)
 285             reply->handle = alloc_handle( current->process, event, req->access, req->attributes );
 286         else
 287             reply->handle = alloc_handle_no_access_check( current->process, event, req->access, req->attributes );
 288         release_object( event );
 289     }
 290
 291     if (root) release_object( root );
 292 }
 293
 294 /* open a handle to an event */
 295 DECL_HANDLER(open_event)
 296 {
 297     struct unicode_str name;
 298     struct directory *root = NULL;
 299     struct event *event;
 300
 301     get_req_unicode_str( &name );
 302     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
 303         return;
 304
 305     if ((event = open_object_dir( root, &name, req->attributes, &event_ops )))
 306     {
 307         reply->handle = alloc_handle( current->process, &event->obj, req->access, req->attributes );
 308         release_object( event );
 309     }
 310
 311     if (root) release_object( root );
 312 }
 313
 314 /* do an event operation */
 315 DECL_HANDLER(event_op)
 316 {
 317     struct event *event;
 318
 319     if (!(event = get_event_obj( current->process, req->handle, EVENT_MODIFY_STATE ))) return;
 320     switch(req->op)
 321     {
 322     case PULSE_EVENT:
 323         pulse_event( event );
 324         break;
 325     case SET_EVENT:
 326         set_event( event );
 327         break;
 328     case RESET_EVENT:
 329         reset_event( event );
 330         break;
 331     default:
 332         set_error( STATUS_INVALID_PARAMETER );
 333         break;
 334     }
 335     release_object( event );
 336 }
 337
 338 /* return details about the event */
 339 DECL_HANDLER(query_event)
 340 {
 341     struct event *event;
 342
 343     if (!(event = get_event_obj( current->process, req->handle, EVENT_QUERY_STATE ))) return;
 344
 345     reply->manual_reset = event->manual_reset;
 346     reply->state = event->signaled;
 347
 348     release_object( event );
 349 }
 350
 351 /* create a keyed event */
 352 DECL_HANDLER(create_keyed_event)
 353 {
 354     struct keyed_event *event;
 355     struct unicode_str name;
 356     struct directory *root = NULL;
 357     const struct object_attributes *objattr = get_req_data();
 358     const struct security_descriptor *sd;
 359
 360     if (!objattr_is_valid( objattr, get_req_data_size() )) return;
 361
 362     sd = objattr->sd_len ? (const struct security_descriptor *)(objattr + 1) : NULL;
 363     objattr_get_name( objattr, &name );
 364
 365     if (objattr->rootdir && !(root = get_directory_obj( current->process, objattr->rootdir, 0 ))) return;
 366
 367     if ((event = create_keyed_event( root, &name, req->attributes, sd )))
 368     {
 369         if (get_error() == STATUS_OBJECT_NAME_EXISTS)
 370             reply->handle = alloc_handle( current->process, event, req->access, req->attributes );
 371         else
 372             reply->handle = alloc_handle_no_access_check( current->process, event, req->access, req->attributes );
 373         release_object( event );
 374     }
 375     if (root) release_object( root );
 376 }
 377
 378 /* open a handle to a keyed event */
 379 DECL_HANDLER(open_keyed_event)
 380 {
 381     struct unicode_str name;
 382     struct directory *root = NULL;
 383     struct keyed_event *event;
 384
 385     get_req_unicode_str( &name );
 386     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 ))) return;
 387
 388     if ((event = open_object_dir( root, &name, req->attributes, &keyed_event_ops )))
 389     {
 390         reply->handle = alloc_handle( current->process, &event->obj, req->access, req->attributes );
 391         release_object( event );
 392     }
 393     if (root) release_object( root );
 394 }