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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
  30 #include "windef.h"
  31 #include "winternl.h"
  32
  33 #include "file.h"
  34 #include "handle.h"
  35 #include "request.h"
  36
  37 struct timer
  38 {
  39     struct object        obj;       /* object header */
  40     int                  manual;    /* manual reset */
  41     int                  signaled;  /* current signaled state */
  42     int                  period;    /* timer period in ms */
  43     struct timeval       when;      /* next expiration */
  44     struct timeout_user *timeout;   /* timeout user */
  45     struct thread       *thread;    /* thread that set the APC function */
  46     void                *callback;  /* callback APC function */
  47     void                *arg;       /* callback argument */
  48 };
  49
  50 static void timer_dump( struct object *obj, int verbose );
  51 static int timer_signaled( struct object *obj, struct thread *thread );
  52 static int timer_satisfied( struct object *obj, struct thread *thread );
  53 static void timer_destroy( struct object *obj );
  54
  55 static const struct object_ops timer_ops =
  56 {
  57     sizeof(struct timer),      /* size */
  58     timer_dump,                /* dump */
  59     add_queue,                 /* add_queue */
  60     remove_queue,              /* remove_queue */
  61     timer_signaled,            /* signaled */
  62     timer_satisfied,           /* satisfied */
  63     no_signal,                 /* signal */
  64     no_get_fd,                 /* get_fd */
  65     no_close_handle,           /* close_handle */
  66     timer_destroy              /* destroy */
  67 };
  68
  69
  70 /* create a timer object */
  71 static struct timer *create_timer( const WCHAR *name, size_t len, unsigned int attr,
  72                                    int manual )
  73 {
  74     struct timer *timer;
  75
  76     if ((timer = create_named_object( sync_namespace, &timer_ops, name, len, attr )))
  77     {
  78         if (get_error() != STATUS_OBJECT_NAME_COLLISION)
  79         {
  80             /* initialize it if it didn't already exist */
  81             timer->manual       = manual;
  82             timer->signaled     = 0;
  83             timer->when.tv_sec  = 0;
  84             timer->when.tv_usec = 0;
  85             timer->period       = 0;
  86             timer->timeout      = NULL;
  87             timer->thread       = NULL;
  88         }
  89     }
  90     return timer;
  91 }
  92
  93 /* callback on timer expiration */
  94 static void timer_callback( void *private )
  95 {
  96     struct timer *timer = (struct timer *)private;
  97
  98     /* queue an APC */
  99     if (timer->thread)
 100     {
 101         if (!thread_queue_apc( timer->thread, &timer->obj, timer->callback, APC_TIMER, 0,
 102                                (void *)timer->when.tv_sec, (void *)timer->when.tv_usec, timer->arg))
 103         {
 104             release_object( timer->thread );
 105             timer->thread = NULL;
 106         }
 107     }
 108
 109     if (timer->period)  /* schedule the next expiration */
 110     {
 111         add_timeout( &timer->when, timer->period );
 112         timer->timeout = add_timeout_user( &timer->when, timer_callback, timer );
 113     }
 114     else timer->timeout = NULL;
 115
 116     /* wake up waiters */
 117     timer->signaled = 1;
 118     wake_up( &timer->obj, 0 );
 119 }
 120
 121 /* cancel a running timer */
 122 static int cancel_timer( struct timer *timer )
 123 {
 124     int signaled = timer->signaled;
 125
 126     if (timer->timeout)
 127     {
 128         remove_timeout_user( timer->timeout );
 129         timer->timeout = NULL;
 130     }
 131     if (timer->thread)
 132     {
 133         thread_cancel_apc( timer->thread, &timer->obj, 0 );
 134         release_object( timer->thread );
 135         timer->thread = NULL;
 136     }
 137     return signaled;
 138 }
 139
 140 /* set the timer expiration and period */
 141 static int set_timer( struct timer *timer, const abs_time_t *expire, int period,
 142                       void *callback, void *arg )
 143 {
 144     int signaled = cancel_timer( timer );
 145     if (timer->manual)
 146     {
 147         period = 0;  /* period doesn't make any sense for a manual timer */
 148         timer->signaled = 0;
 149     }
 150     if (!expire->sec && !expire->usec)
 151     {
 152         /* special case: use now + period as first expiration */
 153         gettimeofday( &timer->when, NULL );
 154         add_timeout( &timer->when, period );
 155     }
 156     else
 157     {
 158         timer->when.tv_sec  = expire->sec;
 159         timer->when.tv_usec = expire->usec;
 160     }
 161     timer->period       = period;
 162     timer->callback     = callback;
 163     timer->arg          = arg;
 164     if (callback) timer->thread = (struct thread *)grab_object( current );
 165     timer->timeout = add_timeout_user( &timer->when, timer_callback, timer );
 166     return signaled;
 167 }
 168
 169 static void timer_dump( struct object *obj, int verbose )
 170 {
 171     struct timer *timer = (struct timer *)obj;
 172     assert( obj->ops == &timer_ops );
 173     fprintf( stderr, "Timer manual=%d when=%ld.%06ld period=%d ",
 174              timer->manual, timer->when.tv_sec, timer->when.tv_usec, timer->period );
 175     dump_object_name( &timer->obj );
 176     fputc( '\n', stderr );
 177 }
 178
 179 static int timer_signaled( struct object *obj, struct thread *thread )
 180 {
 181     struct timer *timer = (struct timer *)obj;
 182     assert( obj->ops == &timer_ops );
 183     return timer->signaled;
 184 }
 185
 186 static int timer_satisfied( struct object *obj, struct thread *thread )
 187 {
 188     struct timer *timer = (struct timer *)obj;
 189     assert( obj->ops == &timer_ops );
 190     if (!timer->manual) timer->signaled = 0;
 191     return 0;
 192 }
 193
 194 static void timer_destroy( struct object *obj )
 195 {
 196     struct timer *timer = (struct timer *)obj;
 197     assert( obj->ops == &timer_ops );
 198
 199     if (timer->timeout) remove_timeout_user( timer->timeout );
 200     if (timer->thread) release_object( timer->thread );
 201 }
 202
 203 /* create a timer */
 204 DECL_HANDLER(create_timer)
 205 {
 206     struct timer *timer;
 207
 208     reply->handle = 0;
 209     if ((timer = create_timer( get_req_data(), get_req_data_size(), req->attributes, req->manual )))
 210     {
 211         reply->handle = alloc_handle( current->process, timer, req->access,
 212                                       req->attributes & OBJ_INHERIT );
 213         release_object( timer );
 214     }
 215 }
 216
 217 /* open a handle to a timer */
 218 DECL_HANDLER(open_timer)
 219 {
 220     reply->handle = open_object( sync_namespace, get_req_data(), get_req_data_size(),
 221                                  &timer_ops, req->access, req->attributes );
 222 }
 223
 224 /* set a waitable timer */
 225 DECL_HANDLER(set_timer)
 226 {
 227     struct timer *timer;
 228
 229     if ((timer = (struct timer *)get_handle_obj( current->process, req->handle,
 230                                                  TIMER_MODIFY_STATE, &timer_ops )))
 231     {
 232         reply->signaled = set_timer( timer, &req->expire, req->period, req->callback, req->arg );
 233         release_object( timer );
 234     }
 235 }
 236
 237 /* cancel a waitable timer */
 238 DECL_HANDLER(cancel_timer)
 239 {
 240     struct timer *timer;
 241
 242     if ((timer = (struct timer *)get_handle_obj( current->process, req->handle,
 243                                                  TIMER_MODIFY_STATE, &timer_ops )))
 244     {
 245         reply->signaled = cancel_timer( timer );
 246         release_object( timer );
 247     }
 248 }
 249
 250 /* Get information on a waitable timer */
 251 DECL_HANDLER(get_timer_info)
 252 {
 253     struct timer *timer;
 254
 255     if ((timer = (struct timer *)get_handle_obj( current->process, req->handle,
 256                                                  TIMER_QUERY_STATE, &timer_ops )))
 257     {
 258         reply->when.sec  = timer->when.tv_sec;
 259         reply->when.usec = timer->when.tv_usec;
 260         reply->signaled  = timer->signaled;
 261         release_object( timer );
 262     }
 263 }