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