vcs.maemo.org Git - monky/blob - src/timed_thread.c

   1 /* $Id$ */
   2
   3 /*
   4  * timed_thread.c: Abstraction layer for timed threads
   5  *
   6  * Copyright (C) 2006-2007 Philip Kovacs pkovacs@users.sourceforge.net
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  21  * USA.
  22  *
  23  */
  24
  25 #include <pthread.h>
  26 #include <assert.h>
  27 #include <errno.h>
  28 #include <stdlib.h>
  29 #include <stdio.h>
  30 #include <time.h>
  31 #ifndef HAVE_CLOCK_GETTIME
  32 #include <sys/time.h>
  33 #endif
  34 #include "timed_thread.h"
  35
  36 /* Abstraction layer for timed threads */
  37
  38 static int now (struct timespec *);
  39
  40 /* private */
  41 struct _timed_thread
  42 {
  43   pthread_t thread;               /* thread itself */
  44   pthread_attr_t thread_attr;     /* thread attributes */
  45   pthread_mutex_t cs_mutex;       /* critical section mutex */
  46   pthread_mutex_t runnable_mutex; /* only for the runnable_cond */
  47   pthread_cond_t runnable_cond;   /* signalled to stop the thread */
  48   void *(*start_routine)(void*);  /* thread function to run */
  49   void *arg;                      /* thread function argument */
  50   struct timespec interval_time;  /* interval_usecs as a struct timespec */
  51 };
  52
  53 /* linked list of created threads */
  54 typedef struct _timed_thread_list
  55 {
  56   timed_thread *p_timed_thread;
  57   timed_thread **addr_of_p_timed_thread;
  58   struct _timed_thread_list *next;
  59 } timed_thread_node, timed_thread_list;
  60
  61 static timed_thread_list *p_timed_thread_list_head = NULL;
  62 static timed_thread_list *p_timed_thread_list_tail = NULL;
  63
  64 static int now (struct timespec *abstime)
  65 {
  66   if (!abstime)
  67     return (-1);
  68
  69 #ifdef HAVE_CLOCK_GETTIME
  70   return clock_gettime (CLOCK_REALTIME, &abstime);
  71 #else
  72   /* fallback to gettimeofday () */
  73   struct timeval tv;
  74   if (gettimeofday (&tv, NULL) != 0)
  75     return (-1);
  76
  77   abstime->tv_sec = tv.tv_sec;
  78   abstime->tv_nsec = tv.tv_usec * 1000;
  79   return 0;
  80 #endif
  81 }
  82
  83
  84 /* create a timed thread (object creation only) */
  85 timed_thread*
  86 timed_thread_create (void *(*start_routine)(void*), void *arg, unsigned int interval_usecs)
  87 {
  88   timed_thread *p_timed_thread;
  89
  90   assert ((start_routine != NULL) && (interval_usecs >= MINIMUM_INTERVAL_USECS));
  91
  92   if ((p_timed_thread = calloc (sizeof(timed_thread), 1)) == 0)
  93     return NULL;
  94
  95   /* init attributes, e.g. joinable thread */
  96   pthread_attr_init (&p_timed_thread->thread_attr);
  97   pthread_attr_setdetachstate (&p_timed_thread->thread_attr, PTHREAD_CREATE_JOINABLE);
  98   /* init mutexes */
  99   pthread_mutex_init (&p_timed_thread->cs_mutex, NULL);
 100   pthread_mutex_init (&p_timed_thread->runnable_mutex, NULL);
 101   /* init cond */
 102   pthread_cond_init (&p_timed_thread->runnable_cond, NULL);
 103
 104   p_timed_thread->start_routine = start_routine;
 105   p_timed_thread->arg = arg;
 106
 107   /* seconds portion of the microseconds interval */
 108   p_timed_thread->interval_time.tv_sec = (time_t)(interval_usecs / 1000000);
 109   /* remaining microseconds convert to nanoseconds */
 110   p_timed_thread->interval_time.tv_nsec = (long)((interval_usecs % 1000000) * 1000);
 111
 112   /*
 113   printf ("interval_time.tv_sec = %li, .tv_nsec = %li\n",
 114             p_timed_thread->interval_time.tv_sec,
 115             p_timed_thread->interval_time.tv_nsec);
 116   */
 117   return p_timed_thread;
 118 }
 119
 120 /* run a timed thread (drop the thread and run it) */
 121 int
 122 timed_thread_run (timed_thread* p_timed_thread)
 123 {
 124   return pthread_create (&p_timed_thread->thread, &p_timed_thread->thread_attr,
 125                          p_timed_thread->start_routine, p_timed_thread->arg);
 126 }
 127
 128 /* destroy a timed thread.
 129  * optional addr_of_p_timed_thread to set callers pointer to NULL as a convenience. */
 130 void
 131 timed_thread_destroy (timed_thread* p_timed_thread, timed_thread** addr_of_p_timed_thread)
 132 {
 133   assert (p_timed_thread != NULL);
 134   assert ((addr_of_p_timed_thread == NULL) || (*addr_of_p_timed_thread == p_timed_thread));
 135
 136   /* signal thread to stop */
 137   pthread_mutex_lock (&p_timed_thread->runnable_mutex);
 138   pthread_cond_signal (&p_timed_thread->runnable_cond);
 139   pthread_mutex_unlock (&p_timed_thread->runnable_mutex);
 140
 141   /* join the terminating thread */
 142   pthread_join (p_timed_thread->thread, NULL);
 143
 144   /* clean up */
 145   pthread_attr_destroy (&p_timed_thread->thread_attr);
 146   pthread_mutex_destroy (&p_timed_thread->cs_mutex);
 147   pthread_mutex_destroy (&p_timed_thread->runnable_mutex);
 148   pthread_cond_destroy (&p_timed_thread->runnable_cond);
 149
 150   free (p_timed_thread);
 151   if (addr_of_p_timed_thread)
 152     *addr_of_p_timed_thread = NULL;
 153 }
 154
 155
 156 /* lock a timed thread for critical section activity */
 157 int
 158 timed_thread_lock (timed_thread* p_timed_thread)
 159 {
 160   assert (p_timed_thread != NULL);
 161
 162   return pthread_mutex_lock (&p_timed_thread->cs_mutex);
 163 }
 164
 165
 166 /* unlock a timed thread after critical section activity */
 167 int
 168 timed_thread_unlock (timed_thread* p_timed_thread)
 169 {
 170   assert (p_timed_thread != NULL);
 171
 172   return pthread_mutex_unlock (&p_timed_thread->cs_mutex);
 173 }
 174
 175
 176 /* thread waits interval_usecs for runnable_cond to be signaled.  returns 1 if signaled,
 177  * -1 on error, and 0 otherwise.  caller should call timed_thread_exit() on any non-zero
 178  * return value. */
 179 int
 180 timed_thread_test (timed_thread* p_timed_thread)
 181 {
 182   struct timespec wait_time;
 183   int rc;
 184
 185   assert (p_timed_thread != NULL);
 186
 187   if (now (&wait_time)) return (-1);
 188   /*printf ("PRE:wait_time.tv_secs = %li, .tv_nsecs = %li\n", wait_time.tv_sec, wait_time.tv_nsec);*/
 189
 190   /* add in the wait interval */
 191   if (1000000000-wait_time.tv_nsec <= p_timed_thread->interval_time.tv_nsec)
 192   {
 193     /* adjust for impending overflow of wait_time.tv_nsec */
 194     wait_time.tv_sec += p_timed_thread->interval_time.tv_sec + 1;
 195     wait_time.tv_nsec = wait_time.tv_nsec - (1000000000 - p_timed_thread->interval_time.tv_nsec);
 196     /*printf ("001:wait_time.tv_secs = %li, .tv_nsecs = %li\n", wait_time.tv_sec, wait_time.tv_nsec);*/
 197   }
 198   else
 199   {
 200     /* no overflow will occur, just add respective components */
 201     wait_time.tv_sec += p_timed_thread->interval_time.tv_sec;
 202     wait_time.tv_nsec += p_timed_thread->interval_time.tv_nsec;
 203     /*printf ("002:wait_time.tv_secs = %li, .tv_nsecs = %li\n", wait_time.tv_sec, wait_time.tv_nsec);*/
 204   }
 205
 206   /* acquire runnable_cond mutex */
 207   if (pthread_mutex_lock (&p_timed_thread->runnable_mutex))
 208     return (-1);  /* could not acquire runnable_cond mutex, so tell caller to exit thread */
 209
 210   /* release mutex and wait until future time for runnable_cond to signal */
 211   rc = pthread_cond_timedwait (&p_timed_thread->runnable_cond,
 212                                &p_timed_thread->runnable_mutex,
 213                                &wait_time);
 214   /* mutex re-acquired, so release it */
 215   pthread_mutex_unlock (&p_timed_thread->runnable_mutex);
 216
 217   if (rc==0)
 218     return 1; /* runnable_cond was signaled, so tell caller to exit thread */
 219
 220   /* tell caller not to exit yet */
 221   return 0;
 222 }
 223
 224
 225 /* exit a timed thread */
 226 void
 227 timed_thread_exit (timed_thread* p_timed_thread)
 228 {
 229   assert (p_timed_thread != NULL);
 230
 231   pthread_exit (NULL);
 232 }
 233
 234
 235 /* register a timed thread for future destruction via timed_thread_destroy_registered_threads() */
 236 int
 237 timed_thread_register (timed_thread* p_timed_thread, timed_thread** addr_of_p_timed_thread)
 238 {
 239   timed_thread_node *p_node;
 240
 241   assert ((addr_of_p_timed_thread == NULL) || (*addr_of_p_timed_thread == p_timed_thread));
 242
 243   if ((p_node = calloc (sizeof (timed_thread_node), 1)) == 0)
 244     return 0;
 245
 246   p_node->p_timed_thread = p_timed_thread;
 247   p_node->addr_of_p_timed_thread = addr_of_p_timed_thread;
 248   p_node->next = NULL;
 249
 250   if (!p_timed_thread_list_tail)
 251   {
 252     /* first node of empty list */
 253     p_timed_thread_list_tail = p_node;
 254     p_timed_thread_list_head = p_node;
 255   }
 256   else
 257   {
 258     /* add node to tail of non-empty list */
 259     p_timed_thread_list_tail->next = p_node;
 260     p_timed_thread_list_tail = p_node;
 261   }
 262
 263   return 0;
 264 }
 265
 266
 267 /* destroy all registered timed threads */
 268 void
 269 timed_thread_destroy_registered_threads (void)
 270 {
 271   timed_thread_node *p_node, *p_next;
 272
 273   for (p_node=p_timed_thread_list_head;
 274        p_node;
 275        p_node=p_next)
 276   {
 277     p_next = p_node->next;
 278     timed_thread_destroy (p_node->p_timed_thread, p_node->addr_of_p_timed_thread);
 279     free (p_node);
 280     p_node = NULL;
 281   }
 282
 283   p_timed_thread_list_head = NULL;
 284   p_timed_thread_list_tail = NULL;
 285 }
 286