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 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);
  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 wait_queue_entry *entry );
  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
 105 struct event *create_event( struct directory *root, const struct unicode_str *name,
 106                             unsigned int attr, int manual_reset, int initial_state,
 107                             const struct security_descriptor *sd )
 108 {
 109     struct event *event;
 110
 111     if ((event = create_named_object_dir( root, name, attr, &event_ops )))
 112     {
 113         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
 114         {
 115             /* initialize it if it didn't already exist */
 116             event->manual_reset = manual_reset;
 117             event->signaled     = initial_state;
 118             if (sd) default_set_sd( &event->obj, sd, OWNER_SECURITY_INFORMATION|
 119                                                      GROUP_SECURITY_INFORMATION|
 120                                                      DACL_SECURITY_INFORMATION|
 121                                                      SACL_SECURITY_INFORMATION );
 122         }
 123     }
 124     return event;
 125 }
 126
 127 struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access )
 128 {
 129     return (struct event *)get_handle_obj( process, handle, access, &event_ops );
 130 }
 131
 132 void pulse_event( struct event *event )
 133 {
 134     event->signaled = 1;
 135     /* wake up all waiters if manual reset, a single one otherwise */
 136     wake_up( &event->obj, !event->manual_reset );
 137     event->signaled = 0;
 138 }
 139
 140 void set_event( struct event *event )
 141 {
 142     event->signaled = 1;
 143     /* wake up all waiters if manual reset, a single one otherwise */
 144     wake_up( &event->obj, !event->manual_reset );
 145 }
 146
 147 void reset_event( struct event *event )
 148 {
 149     event->signaled = 0;
 150 }
 151
 152 static void event_dump( struct object *obj, int verbose )
 153 {
 154     struct event *event = (struct event *)obj;
 155     assert( obj->ops == &event_ops );
 156     fprintf( stderr, "Event manual=%d signaled=%d\n",
 157              event->manual_reset, event->signaled );
 158 }
 159
 160 static struct object_type *event_get_type( struct object *obj )
 161 {
 162     static const WCHAR name[] = {'E','v','e','n','t'};
 163     static const struct unicode_str str = { name, sizeof(name) };
 164     return get_object_type( &str );
 165 }
 166
 167 static int event_signaled( struct object *obj, struct wait_queue_entry *entry )
 168 {
 169     struct event *event = (struct event *)obj;
 170     assert( obj->ops == &event_ops );
 171     return event->signaled;
 172 }
 173
 174 static void event_satisfied( struct object *obj, struct wait_queue_entry *entry )
 175 {
 176     struct event *event = (struct event *)obj;
 177     assert( obj->ops == &event_ops );
 178     /* Reset if it's an auto-reset event */
 179     if (!event->manual_reset) event->signaled = 0;
 180 }
 181
 182 static unsigned int event_map_access( struct object *obj, unsigned int access )
 183 {
 184     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | EVENT_QUERY_STATE;
 185     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | EVENT_MODIFY_STATE;
 186     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE | SYNCHRONIZE;
 187     if (access & GENERIC_ALL)     access |= STANDARD_RIGHTS_ALL | EVENT_QUERY_STATE | EVENT_MODIFY_STATE;
 188     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 189 }
 190
 191 static int event_signal( struct object *obj, unsigned int access )
 192 {
 193     struct event *event = (struct event *)obj;
 194     assert( obj->ops == &event_ops );
 195
 196     if (!(access & EVENT_MODIFY_STATE))
 197     {
 198         set_error( STATUS_ACCESS_DENIED );
 199         return 0;
 200     }
 201     set_event( event );
 202     return 1;
 203 }
 204
 205 struct keyed_event *create_keyed_event( struct directory *root, const struct unicode_str *name,
 206                                         unsigned int attr, const struct security_descriptor *sd )
 207 {
 208     struct keyed_event *event;
 209
 210     if ((event = create_named_object_dir( root, name, attr, &keyed_event_ops )))
 211     {
 212         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
 213         {
 214             /* initialize it if it didn't already exist */
 215             if (sd) default_set_sd( &event->obj, sd, OWNER_SECURITY_INFORMATION|
 216                                                      GROUP_SECURITY_INFORMATION|
 217                                                      DACL_SECURITY_INFORMATION|
 218                                                      SACL_SECURITY_INFORMATION );
 219         }
 220     }
 221     return event;
 222 }
 223
 224 struct keyed_event *get_keyed_event_obj( struct process *process, obj_handle_t handle, unsigned int access )
 225 {
 226     return (struct keyed_event *)get_handle_obj( process, handle, access, &keyed_event_ops );
 227 }
 228
 229 static void keyed_event_dump( struct object *obj, int verbose )
 230 {
 231     fputs( "Keyed event\n", stderr );
 232 }
 233
 234 static struct object_type *keyed_event_get_type( struct object *obj )
 235 {
 236     static const WCHAR name[] = {'K','e','y','e','d','E','v','e','n','t'};
 237     static const struct unicode_str str = { name, sizeof(name) };
 238     return get_object_type( &str );
 239 }
 240
 241 static enum select_op matching_op( enum select_op op )
 242 {
 243     return op ^ (SELECT_KEYED_EVENT_WAIT ^ SELECT_KEYED_EVENT_RELEASE);
 244 }
 245
 246 static int keyed_event_signaled( struct object *obj, struct wait_queue_entry *entry )
 247 {
 248     struct wait_queue_entry *ptr;
 249     struct process *process;
 250     enum select_op select_op;
 251
 252     assert( obj->ops == &keyed_event_ops );
 253
 254     process = get_wait_queue_thread( entry )->process;
 255     select_op = get_wait_queue_select_op( entry );
 256     if (select_op != SELECT_KEYED_EVENT_WAIT && select_op != SELECT_KEYED_EVENT_RELEASE) return 1;
 257
 258     LIST_FOR_EACH_ENTRY( ptr, &obj->wait_queue, struct wait_queue_entry, entry )
 259     {
 260         if (ptr == entry) continue;
 261         if (get_wait_queue_thread( ptr )->process != process) continue;
 262         if (get_wait_queue_select_op( ptr ) != matching_op( select_op )) continue;
 263         if (get_wait_queue_key( ptr ) != get_wait_queue_key( entry )) continue;
 264         if (wake_thread_queue_entry( ptr )) return 1;
 265     }
 266     return 0;
 267 }
 268
 269 static unsigned int keyed_event_map_access( struct object *obj, unsigned int access )
 270 {
 271     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | KEYEDEVENT_WAIT;
 272     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | KEYEDEVENT_WAKE;
 273     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
 274     if (access & GENERIC_ALL)     access |= KEYEDEVENT_ALL_ACCESS;
 275     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 276 }
 277
 278 /* create an event */
 279 DECL_HANDLER(create_event)
 280 {
 281     struct event *event;
 282     struct unicode_str name;
 283     struct directory *root;
 284     const struct security_descriptor *sd;
 285     const struct object_attributes *objattr = get_req_object_attributes( &sd, &name, &root );
 286
 287     if (!objattr) return;
 288
 289     if ((event = create_event( root, &name, objattr->attributes,
 290                                req->manual_reset, req->initial_state, sd )))
 291     {
 292         if (get_error() == STATUS_OBJECT_NAME_EXISTS)
 293             reply->handle = alloc_handle( current->process, event, req->access, objattr->attributes );
 294         else
 295             reply->handle = alloc_handle_no_access_check( current->process, event,
 296                                                           req->access, objattr->attributes );
 297         release_object( event );
 298     }
 299
 300     if (root) release_object( root );
 301 }
 302
 303 /* open a handle to an event */
 304 DECL_HANDLER(open_event)
 305 {
 306     struct unicode_str name = get_req_unicode_str();
 307
 308     reply->handle = open_object( current->process, req->rootdir, req->access,
 309                                  &event_ops, &name, req->attributes );
 310 }
 311
 312 /* do an event operation */
 313 DECL_HANDLER(event_op)
 314 {
 315     struct event *event;
 316
 317     if (!(event = get_event_obj( current->process, req->handle, EVENT_MODIFY_STATE ))) return;
 318     switch(req->op)
 319     {
 320     case PULSE_EVENT:
 321         pulse_event( event );
 322         break;
 323     case SET_EVENT:
 324         set_event( event );
 325         break;
 326     case RESET_EVENT:
 327         reset_event( event );
 328         break;
 329     default:
 330         set_error( STATUS_INVALID_PARAMETER );
 331         break;
 332     }
 333     release_object( event );
 334 }
 335
 336 /* return details about the event */
 337 DECL_HANDLER(query_event)
 338 {
 339     struct event *event;
 340
 341     if (!(event = get_event_obj( current->process, req->handle, EVENT_QUERY_STATE ))) return;
 342
 343     reply->manual_reset = event->manual_reset;
 344     reply->state = event->signaled;
 345
 346     release_object( event );
 347 }
 348
 349 /* create a keyed event */
 350 DECL_HANDLER(create_keyed_event)
 351 {
 352     struct keyed_event *event;
 353     struct unicode_str name;
 354     struct directory *root;
 355     const struct security_descriptor *sd;
 356     const struct object_attributes *objattr = get_req_object_attributes( &sd, &name, &root );
 357
 358     if (!objattr) return;
 359
 360     if ((event = create_keyed_event( root, &name, objattr->attributes, sd )))
 361     {
 362         if (get_error() == STATUS_OBJECT_NAME_EXISTS)
 363             reply->handle = alloc_handle( current->process, event, req->access, objattr->attributes );
 364         else
 365             reply->handle = alloc_handle_no_access_check( current->process, event,
 366                                                           req->access, objattr->attributes );
 367         release_object( event );
 368     }
 369     if (root) release_object( root );
 370 }
 371
 372 /* open a handle to a keyed event */
 373 DECL_HANDLER(open_keyed_event)
 374 {
 375     struct unicode_str name = get_req_unicode_str();
 376
 377     reply->handle = open_object( current->process, req->rootdir, req->access,
 378                                  &keyed_event_ops, &name, req->attributes );
 379 }