server/timer.c

   1 /*
   2  * Waitable timers management
   3  *
   4  * Copyright (C) 1999 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 <sys/time.h>
  28 #include <sys/types.h>
  29 #include <stdarg.h>
  30
  31 #include "ntstatus.h"
  32 #define WIN32_NO_STATUS
  33 #include "windef.h"
  34 #include "winternl.h"
  35
  36 #include "file.h"
  37 #include "handle.h"
  38 #include "request.h"
  39
  40 struct timer
  41 {
  42     struct object        obj;       /* object header */
  43     int                  manual;    /* manual reset */
  44     int                  signaled;  /* current signaled state */
  45     unsigned int         period;    /* timer period in ms */
  46     timeout_t            when;      /* next expiration */
  47     struct timeout_user *timeout;   /* timeout user */
  48     struct thread       *thread;    /* thread that set the APC function */
  49     client_ptr_t         callback;  /* callback APC function */
  50     client_ptr_t         arg;       /* callback argument */
  51 };
  52
  53 static void timer_dump( struct object *obj, int verbose );
  54 static struct object_type *timer_get_type( struct object *obj );
  55 static int timer_signaled( struct object *obj, struct wait_queue_entry *entry );
  56 static void timer_satisfied( struct object *obj, struct wait_queue_entry *entry );
  57 static unsigned int timer_map_access( struct object *obj, unsigned int access );
  58 static void timer_destroy( struct object *obj );
  59
  60 static const struct object_ops timer_ops =
  61 {
  62     sizeof(struct timer),      /* size */
  63     timer_dump,                /* dump */
  64     timer_get_type,            /* get_type */
  65     add_queue,                 /* add_queue */
  66     remove_queue,              /* remove_queue */
  67     timer_signaled,            /* signaled */
  68     timer_satisfied,           /* satisfied */
  69     no_signal,                 /* signal */
  70     no_get_fd,                 /* get_fd */
  71     timer_map_access,          /* map_access */
  72     default_get_sd,            /* get_sd */
  73     default_set_sd,            /* set_sd */
  74     no_lookup_name,            /* lookup_name */
  75     directory_link_name,       /* link_name */
  76     default_unlink_name,       /* unlink_name */
  77     no_open_file,              /* open_file */
  78     no_kernel_obj_list,        /* get_kernel_obj_list */
  79     no_close_handle,           /* close_handle */
  80     timer_destroy              /* destroy */
  81 };
  82
  83
  84 /* create a timer object */
  85 static struct timer *create_timer( struct object *root, const struct unicode_str *name,
  86                                    unsigned int attr, int manual, const struct security_descriptor *sd )
  87 {
  88     struct timer *timer;
  89
  90     if ((timer = create_named_object( root, &timer_ops, name, attr, sd )))
  91     {
  92         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
  93         {
  94             /* initialize it if it didn't already exist */
  95             timer->manual   = manual;
  96             timer->signaled = 0;
  97             timer->when     = 0;
  98             timer->period   = 0;
  99             timer->timeout  = NULL;
 100             timer->thread   = NULL;
 101         }
 102     }
 103     return timer;
 104 }
 105
 106 /* callback on timer expiration */
 107 static void timer_callback( void *private )
 108 {
 109     struct timer *timer = (struct timer *)private;
 110
 111     /* queue an APC */
 112     if (timer->thread)
 113     {
 114         apc_call_t data;
 115
 116         memset( &data, 0, sizeof(data) );
 117         if (timer->callback)
 118         {
 119             data.type       = APC_TIMER;
 120             data.timer.func = timer->callback;
 121             data.timer.time = timer->when;
 122             data.timer.arg  = timer->arg;
 123         }
 124         else data.type = APC_NONE;  /* wake up only */
 125
 126         if (!thread_queue_apc( NULL, timer->thread, &timer->obj, &data ))
 127         {
 128             release_object( timer->thread );
 129             timer->thread = NULL;
 130         }
 131     }
 132
 133     if (timer->period)  /* schedule the next expiration */
 134     {
 135         timer->when += (timeout_t)timer->period * 10000;
 136         timer->timeout = add_timeout_user( timer->when, timer_callback, timer );
 137     }
 138     else timer->timeout = NULL;
 139
 140     /* wake up waiters */
 141     timer->signaled = 1;
 142     wake_up( &timer->obj, 0 );
 143 }
 144
 145 /* cancel a running timer */
 146 static int cancel_timer( struct timer *timer )
 147 {
 148     int signaled = timer->signaled;
 149
 150     if (timer->timeout)
 151     {
 152         remove_timeout_user( timer->timeout );
 153         timer->timeout = NULL;
 154     }
 155     if (timer->thread)
 156     {
 157         thread_cancel_apc( timer->thread, &timer->obj, APC_TIMER );
 158         release_object( timer->thread );
 159         timer->thread = NULL;
 160     }
 161     return signaled;
 162 }
 163
 164 /* set the timer expiration and period */
 165 static int set_timer( struct timer *timer, timeout_t expire, unsigned int period,
 166                       client_ptr_t callback, client_ptr_t arg )
 167 {
 168     int signaled = cancel_timer( timer );
 169     if (timer->manual)
 170     {
 171         period = 0;  /* period doesn't make any sense for a manual timer */
 172         timer->signaled = 0;
 173     }
 174     timer->when     = (expire <= 0) ? current_time - expire : max( expire, current_time );
 175     timer->period   = period;
 176     timer->callback = callback;
 177     timer->arg      = arg;
 178     if (callback) timer->thread = (struct thread *)grab_object( current );
 179     timer->timeout = add_timeout_user( timer->when, timer_callback, timer );
 180     return signaled;
 181 }
 182
 183 static void timer_dump( struct object *obj, int verbose )
 184 {
 185     struct timer *timer = (struct timer *)obj;
 186     assert( obj->ops == &timer_ops );
 187     fprintf( stderr, "Timer manual=%d when=%s period=%u\n",
 188              timer->manual, get_timeout_str(timer->when), timer->period );
 189 }
 190
 191 static struct object_type *timer_get_type( struct object *obj )
 192 {
 193     static const WCHAR name[] = {'T','i','m','e','r'};
 194     static const struct unicode_str str = { name, sizeof(name) };
 195     return get_object_type( &str );
 196 }
 197
 198 static int timer_signaled( struct object *obj, struct wait_queue_entry *entry )
 199 {
 200     struct timer *timer = (struct timer *)obj;
 201     assert( obj->ops == &timer_ops );
 202     return timer->signaled;
 203 }
 204
 205 static void timer_satisfied( struct object *obj, struct wait_queue_entry *entry )
 206 {
 207     struct timer *timer = (struct timer *)obj;
 208     assert( obj->ops == &timer_ops );
 209     if (!timer->manual) timer->signaled = 0;
 210 }
 211
 212 static unsigned int timer_map_access( struct object *obj, unsigned int access )
 213 {
 214     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | SYNCHRONIZE | TIMER_QUERY_STATE;
 215     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | TIMER_MODIFY_STATE;
 216     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
 217     if (access & GENERIC_ALL)     access |= TIMER_ALL_ACCESS;
 218     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 219 }
 220
 221 static void timer_destroy( struct object *obj )
 222 {
 223     struct timer *timer = (struct timer *)obj;
 224     assert( obj->ops == &timer_ops );
 225
 226     if (timer->timeout) remove_timeout_user( timer->timeout );
 227     if (timer->thread) release_object( timer->thread );
 228 }
 229
 230 /* create a timer */
 231 DECL_HANDLER(create_timer)
 232 {
 233     struct timer *timer;
 234     struct unicode_str name;
 235     struct object *root;
 236     const struct security_descriptor *sd;
 237     const struct object_attributes *objattr = get_req_object_attributes( &sd, &name, &root );
 238
 239     if (!objattr) return;
 240
 241     if ((timer = create_timer( root, &name, objattr->attributes, req->manual, sd )))
 242     {
 243         reply->handle = alloc_handle( current->process, timer, req->access, objattr->attributes );
 244         release_object( timer );
 245     }
 246
 247     if (root) release_object( root );
 248 }
 249
 250 /* open a handle to a timer */
 251 DECL_HANDLER(open_timer)
 252 {
 253     struct unicode_str name = get_req_unicode_str();
 254
 255     reply->handle = open_object( current->process, req->rootdir, req->access,
 256                                  &timer_ops, &name, req->attributes );
 257 }
 258
 259 /* set a waitable timer */
 260 DECL_HANDLER(set_timer)
 261 {
 262     struct timer *timer;
 263
 264     if ((timer = (struct timer *)get_handle_obj( current->process, req->handle,
 265                                                  TIMER_MODIFY_STATE, &timer_ops )))
 266     {
 267         reply->signaled = set_timer( timer, req->expire, req->period, req->callback, req->arg );
 268         release_object( timer );
 269     }
 270 }
 271
 272 /* cancel a waitable timer */
 273 DECL_HANDLER(cancel_timer)
 274 {
 275     struct timer *timer;
 276
 277     if ((timer = (struct timer *)get_handle_obj( current->process, req->handle,
 278                                                  TIMER_MODIFY_STATE, &timer_ops )))
 279     {
 280         reply->signaled = cancel_timer( timer );
 281         release_object( timer );
 282     }
 283 }
 284
 285 /* Get information on a waitable timer */
 286 DECL_HANDLER(get_timer_info)
 287 {
 288     struct timer *timer;
 289
 290     if ((timer = (struct timer *)get_handle_obj( current->process, req->handle,
 291                                                  TIMER_QUERY_STATE, &timer_ops )))
 292     {
 293         reply->when      = timer->when;
 294         reply->signaled  = timer->signaled;
 295         release_object( timer );
 296     }
 297 }