gthread/gthread-posix.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * gthread.c: posix thread system implementation
   5  * Copyright 1998 Sebastian Wilhelmi; University of Karlsruhe
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /*
  24  * Modified by the GLib Team and others 1997-1999.  See the AUTHORS
  25  * file for a list of people on the GLib Team.  See the ChangeLog
  26  * files for a list of changes.  These files are distributed with
  27  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  28  */
  29
  30 /*
  31  * MT safe
  32  */
  33
  34 #include <pthread.h>
  35 #include <errno.h>
  36 #include <stdlib.h>
  37 #ifdef HAVE_SYS_TIME_H
  38 #include <sys/time.h>
  39 #endif
  40
  41 #define posix_print_error( name, num )                          \
  42   g_error( "file %s: line %d (%s): error %s during %s",         \
  43            __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION,          \
  44            g_strerror((num)), #name )
  45
  46 #if defined(G_THREADS_IMPL_POSIX)
  47 # define posix_check_for_error( what ) G_STMT_START{             \
  48     int error = (what);                                           \
  49     if( error ) { posix_print_error( what, error ); }             \
  50     }G_STMT_END
  51 # define mutexattr_default NULL
  52 # define condattr_default NULL
  53 #elif defined(G_THREADS_IMPL_DCE)
  54 # define posix_check_for_error( what ) G_STMT_START{             \
  55     if( (what) == -1 ) { posix_print_error( what, errno ); }       \
  56     }G_STMT_END
  57 # define mutexattr_default (&pthread_mutexattr_default)
  58 # define condattr_default (&pthread_condattr_default)
  59 #else /* neither G_THREADS_IMPL_POSIX nor G_THREADS_IMPL_DCE are defined */
  60 # error This should not happen. Contact the GLb team.
  61 #endif
  62
  63 static GMutex *
  64 g_mutex_new_posix_impl (void)
  65 {
  66   GMutex *result = (GMutex *) g_new (pthread_mutex_t, 1);
  67   posix_check_for_error (pthread_mutex_init ((pthread_mutex_t *) result,
  68                                              mutexattr_default));
  69   return result;
  70 }
  71
  72 static void
  73 g_mutex_free_posix_impl (GMutex * mutex)
  74 {
  75   posix_check_for_error (pthread_mutex_destroy ((pthread_mutex_t *) mutex));
  76   g_free (mutex);
  77 }
  78
  79 /* NOTE: the functions g_mutex_lock and g_mutex_unlock may not use
  80    functions from gmem.c and gmessages.c; */
  81
  82 /* pthread_mutex_lock, pthread_mutex_unlock can be taken directly, as
  83    signature and semantic are right, but without error check then!!!!,
  84    we might want to change this therefore. */
  85
  86 static gboolean
  87 g_mutex_trylock_posix_impl (GMutex * mutex)
  88 {
  89   int result;
  90
  91   result = pthread_mutex_trylock ((pthread_mutex_t *) mutex);
  92
  93 #ifdef G_THREADS_IMPL_POSIX
  94   if (result == EBUSY)
  95     return FALSE;
  96 #else /* G_THREADS_IMPL_DCE */
  97   if (result == 0)
  98     return FALSE;
  99 #endif
 100
 101   posix_check_for_error (result);
 102   return TRUE;
 103 }
 104
 105 static GCond *
 106 g_cond_new_posix_impl (void)
 107 {
 108   GCond *result = (GCond *) g_new (pthread_cond_t, 1);
 109   posix_check_for_error (pthread_cond_init ((pthread_cond_t *) result,
 110                                             condattr_default));
 111   return result;
 112 }
 113
 114 /* pthread_cond_signal, pthread_cond_broadcast and pthread_cond_wait
 115    can be taken directly, as signature and semantic are right, but
 116    without error check then!!!!, we might want to change this
 117    therfore. */
 118
 119 #define G_MICROSEC 1000000
 120 #define G_NANOSEC 1000000000
 121
 122 static gboolean
 123 g_cond_timed_wait_posix_impl (GCond * cond,
 124                               GMutex * entered_mutex,
 125                               GTimeVal * abs_time)
 126 {
 127   int result;
 128   struct timespec end_time;
 129   gboolean timed_out;
 130
 131   g_return_val_if_fail (cond != NULL, FALSE);
 132   g_return_val_if_fail (entered_mutex != NULL, FALSE);
 133
 134   if (!abs_time)
 135     {
 136       g_cond_wait (cond, entered_mutex);
 137       return TRUE;
 138     }
 139
 140   end_time.tv_sec = abs_time->tv_sec;
 141   end_time.tv_nsec = abs_time->tv_usec * (G_NANOSEC / G_MICROSEC);
 142   g_assert (end_time.tv_nsec < G_NANOSEC);
 143   result = pthread_cond_timedwait ((pthread_cond_t *) cond,
 144                                    (pthread_mutex_t *) entered_mutex,
 145                                    &end_time);
 146
 147 #ifdef G_THREADS_IMPL_POSIX
 148   timed_out = (result == ETIMEDOUT);
 149 #else /* G_THREADS_IMPL_DCE */
 150   timed_out = (result == -1) && (errno = EAGAIN);
 151 #endif
 152
 153   if (!timed_out)
 154     posix_check_for_error (result);
 155   return !timed_out;
 156 }
 157
 158 static void
 159 g_cond_free_posix_impl (GCond * cond)
 160 {
 161   posix_check_for_error (pthread_cond_destroy ((pthread_cond_t *) cond));
 162   g_free (cond);
 163 }
 164
 165 static GPrivate *
 166 g_private_new_posix_impl (GDestroyNotify destructor)
 167 {
 168   GPrivate *result = (GPrivate *) g_new (pthread_key_t, 1);
 169   posix_check_for_error (pthread_key_create ((pthread_key_t *) result,
 170                                              destructor));
 171   return result;
 172 }
 173
 174 /* NOTE: the functions g_private_get and g_private_set may not use
 175    functions from gmem.c and gmessages.c */
 176
 177 static void
 178 g_private_set_posix_impl (GPrivate * private_key, gpointer value)
 179 {
 180   if (!private_key)
 181     return;
 182
 183   pthread_setspecific (*(pthread_key_t *) private_key, value);
 184 }
 185
 186 static gpointer
 187 g_private_get_posix_impl (GPrivate * private_key)
 188 {
 189   if (!private_key)
 190     return NULL;
 191 #ifdef G_THREADS_IMPL_POSIX
 192   return pthread_getspecific (*(pthread_key_t *) private_key);
 193 #else /* G_THREADS_IMPL_DCE */
 194   {
 195     void* data;
 196     posix_check_for_error (pthread_getspecific (*(pthread_key_t *)
 197                                                 private_key, &data));
 198     return data;
 199   }
 200 #endif
 201 }
 202
 203 static GThreadFunctions g_thread_functions_for_glib_use_default =
 204 {
 205   g_mutex_new_posix_impl,
 206   (void (*)(GMutex *)) pthread_mutex_lock,
 207   g_mutex_trylock_posix_impl,
 208   (void (*)(GMutex *)) pthread_mutex_unlock,
 209   g_mutex_free_posix_impl,
 210   g_cond_new_posix_impl,
 211   (void (*)(GCond *)) pthread_cond_signal,
 212   (void (*)(GCond *)) pthread_cond_broadcast,
 213   (void (*)(GCond *, GMutex *)) pthread_cond_wait,
 214   g_cond_timed_wait_posix_impl,
 215   g_cond_free_posix_impl,
 216   g_private_new_posix_impl,
 217   g_private_get_posix_impl,
 218   g_private_set_posix_impl
 219 };