inserted additional note to look for ChangeLog and AUTHORS file for a log
[platform/upstream/glib.git] / 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 #define posix_check_for_error( what ) G_STMT_START{             \
47   int error = (what);                                           \
48   if( error ) { posix_print_error( what, error ); }             \
49   }G_STMT_END
50
51 static GMutex *
52 g_mutex_new_posix_impl (void)
53 {
54   GMutex *result = (GMutex *) g_new (pthread_mutex_t, 1);
55   posix_check_for_error (pthread_mutex_init ((pthread_mutex_t *) result, NULL));
56   return result;
57 }
58
59 static void
60 g_mutex_free_posix_impl (GMutex * mutex)
61 {
62   posix_check_for_error (pthread_mutex_destroy ((pthread_mutex_t *) mutex));
63   g_free (mutex);
64 }
65
66 /* NOTE: the functions g_mutex_lock and g_mutex_unlock may not use
67    functions from gmem.c and gmessages.c; */
68
69 /* pthread_mutex_lock, pthread_mutex_unlock can be taken directly, as
70    signature and semantic are right, but without error check then!!!!,
71    we might want to change this therefore. */
72
73 static gboolean
74 g_mutex_trylock_posix_impl (GMutex * mutex)
75 {
76   int result;
77
78   result = pthread_mutex_trylock ((pthread_mutex_t *) mutex);
79   if (result != EBUSY)
80     return FALSE;
81
82   posix_check_for_error (result);
83   return TRUE;
84 }
85
86 static GCond *
87 g_cond_new_posix_impl (void)
88 {
89   GCond *result = (GCond *) g_new (pthread_cond_t, 1);
90   posix_check_for_error (pthread_cond_init ((pthread_cond_t *) result, NULL));
91   return result;
92 }
93
94 /* pthread_cond_signal, pthread_cond_broadcast and pthread_cond_wait
95    can be taken directly, as signature and semantic are right, but
96    without error check then!!!!, we might want to change this
97    therfore. */
98
99 #define G_MICROSEC 1000000
100 #define G_NANOSEC 1000000000
101
102 static gboolean
103 g_cond_timed_wait_posix_impl (GCond * cond,
104                               GMutex * entered_mutex,
105                               GTimeVal * abs_time)
106 {
107   int result;
108   struct timespec end_time;
109   gboolean timed_out;
110
111   g_return_val_if_fail (cond != NULL, FALSE);
112   g_return_val_if_fail (entered_mutex != NULL, FALSE);
113
114   if (!abs_time)
115     {
116       g_cond_wait (cond, entered_mutex);
117       return TRUE;
118     }
119
120   end_time.tv_sec = abs_time->tv_sec;
121   end_time.tv_nsec = abs_time->tv_usec * (G_NANOSEC / G_MICROSEC);
122   g_assert (end_time.tv_nsec < G_NANOSEC);
123   result = pthread_cond_timedwait ((pthread_cond_t *) cond,
124                                    (pthread_mutex_t *) entered_mutex,
125                                    &end_time);
126   timed_out = (result == ETIMEDOUT);
127   if (!timed_out)
128     posix_check_for_error (result);
129   return !timed_out;
130 }
131
132 static void
133 g_cond_free_posix_impl (GCond * cond)
134 {
135   posix_check_for_error (pthread_cond_destroy ((pthread_cond_t *) cond));
136   g_free (cond);
137 }
138
139 static GPrivate *
140 g_private_new_posix_impl (GDestroyNotify destructor)
141 {
142   GPrivate *result = (GPrivate *) g_new (pthread_key_t, 1);
143   posix_check_for_error (pthread_key_create ((pthread_key_t *) result,
144                                              destructor));
145   return result;
146 }
147
148 /* NOTE: the functions g_private_get and g_private_set may not use
149    functions from gmem.c and gmessages.c */
150
151 static void
152 g_private_set_posix_impl (GPrivate * private_key, gpointer value)
153 {
154   if (!private_key)
155     return;
156
157   pthread_setspecific (*(pthread_key_t *) private_key, value);
158 }
159
160 static gpointer
161 g_private_get_posix_impl (GPrivate * private_key)
162 {
163   if (!private_key)
164     return NULL;
165 #ifdef HAVE_PTHREAD_GETSPECIFIC_POSIX
166   return pthread_getspecific (*(pthread_key_t *) private_key);
167 #else /* HAVE_PTHREAD_GETSPECIFIC_POSIX */
168   {
169     void* data;
170     pthread_getspecific (*(pthread_key_t *) private_key, &data);
171     return data;
172   }
173 #endif /* HAVE_PTHREAD_GETSPECIFIC_POSIX */
174 }
175
176 static GThreadFunctions g_thread_functions_for_glib_use_default =
177 {
178   g_mutex_new_posix_impl,
179   (void (*)(GMutex *)) pthread_mutex_lock,
180   g_mutex_trylock_posix_impl,
181   (void (*)(GMutex *)) pthread_mutex_unlock,
182   g_mutex_free_posix_impl,
183   g_cond_new_posix_impl,
184   (void (*)(GCond *)) pthread_cond_signal,
185   (void (*)(GCond *)) pthread_cond_broadcast,
186   (void (*)(GCond *, GMutex *)) pthread_cond_wait,
187   g_cond_timed_wait_posix_impl,
188   g_cond_free_posix_impl,
189   g_private_new_posix_impl,
190   g_private_get_posix_impl,
191   g_private_set_posix_impl
192 };