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

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