Add thread-safety primitives
[platform/upstream/fontconfig.git] / src / fcmutex.h
1 /*
2  * Atomic int and pointer operations.  Originally copied from HarfBuzz.
3  *
4  * Copyright © 2007  Chris Wilson
5  * Copyright © 2009,2010  Red Hat, Inc.
6  * Copyright © 2011,2012  Google, Inc.
7  *
8  * Permission is hereby granted, without written agreement and without
9  * license or royalty fees, to use, copy, modify, and distribute this
10  * software and its documentation for any purpose, provided that the
11  * above copyright notice and the following two paragraphs appear in
12  * all copies of this software.
13  *
14  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
15  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
16  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
17  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
18  * DAMAGE.
19  *
20  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
21  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
22  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
23  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
24  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
25  *
26  * Contributor(s):
27  *      Chris Wilson <chris@chris-wilson.co.uk>
28  * Red Hat Author(s): Behdad Esfahbod
29  * Google Author(s): Behdad Esfahbod
30  */
31
32 #ifndef _FCMUTEX_H_
33 #define _FCMUTEX_H_
34
35 #ifdef HAVE_CONFIG_H
36 #include <config.h>
37 #endif
38
39
40 /* mutex */
41
42 /* We need external help for these */
43
44 #if 0
45
46
47 #elif !defined(FC_NO_MT) && defined(_MSC_VER) || defined(__MINGW32__)
48
49 #define WIN32_LEAN_AND_MEAN
50 #include <windows.h>
51 typedef CRITICAL_SECTION fc_mutex_impl_t;
52 #define FC_MUTEX_IMPL_INIT      { NULL, 0, 0, NULL, NULL, 0 }
53 #define fc_mutex_impl_init(M)   InitializeCriticalSection (M)
54 #define fc_mutex_impl_lock(M)   EnterCriticalSection (M)
55 #define fc_mutex_impl_unlock(M) LeaveCriticalSection (M)
56 #define fc_mutex_impl_finish(M) DeleteCriticalSection (M)
57
58
59 #elif !defined(FC_NO_MT) && (defined(HAVE_PTHREAD) || defined(__APPLE__))
60
61 #include <pthread.h>
62 typedef pthread_mutex_t fc_mutex_impl_t;
63 #define FC_MUTEX_IMPL_INIT      PTHREAD_MUTEX_INITIALIZER
64 #define fc_mutex_impl_init(M)   pthread_mutex_init (M, NULL)
65 #define fc_mutex_impl_lock(M)   pthread_mutex_lock (M)
66 #define fc_mutex_impl_unlock(M) pthread_mutex_unlock (M)
67 #define fc_mutex_impl_finish(M) pthread_mutex_destroy (M)
68
69
70 #elif !defined(FC_NO_MT) && defined(HAVE_INTEL_ATOMIC_PRIMITIVES)
71
72 #if defined(HAVE_SCHED_H) && defined(HAVE_SCHED_YIELD)
73 # include <sched.h>
74 # define FC_SCHED_YIELD() sched_yield ()
75 #else
76 # define FC_SCHED_YIELD() FC_STMT_START {} FC_STMT_END
77 #endif
78
79 /* This actually is not a totally awful implementation. */
80 typedef volatile int fc_mutex_impl_t;
81 #define FC_MUTEX_IMPL_INIT      0
82 #define fc_mutex_impl_init(M)   *(M) = 0
83 #define fc_mutex_impl_lock(M)   FC_STMT_START { while (__sync_lock_test_and_set((M), 1)) FC_SCHED_YIELD (); } FC_STMT_END
84 #define fc_mutex_impl_unlock(M) __sync_lock_release (M)
85 #define fc_mutex_impl_finish(M) FC_STMT_START {} FC_STMT_END
86
87
88 #elif !defined(FC_NO_MT)
89
90 #if defined(HAVE_SCHED_H) && defined(HAVE_SCHED_YIELD)
91 # include <sched.h>
92 # define FC_SCHED_YIELD() sched_yield ()
93 #else
94 # define FC_SCHED_YIELD() FC_STMT_START {} FC_STMT_END
95 #endif
96
97 #define FC_MUTEX_INT_NIL 1 /* Warn that fallback implementation is in use. */
98 typedef volatile int fc_mutex_impl_t;
99 #define FC_MUTEX_IMPL_INIT      0
100 #define fc_mutex_impl_init(M)   *(M) = 0
101 #define fc_mutex_impl_lock(M)   FC_STMT_START { while (*(M)) FC_SCHED_YIELD (); (*(M))++; } FC_STMT_END
102 #define fc_mutex_impl_unlock(M) (*(M))--;
103 #define fc_mutex_impl_finish(M) FC_STMT_START {} FC_STMT_END
104
105
106 #else /* FC_NO_MT */
107
108 typedef int fc_mutex_impl_t;
109 #define FC_MUTEX_IMPL_INIT      0
110 #define fc_mutex_impl_init(M)   FC_STMT_START {} FC_STMT_END
111 #define fc_mutex_impl_lock(M)   FC_STMT_START {} FC_STMT_END
112 #define fc_mutex_impl_unlock(M) FC_STMT_START {} FC_STMT_END
113 #define fc_mutex_impl_finish(M) FC_STMT_START {} FC_STMT_END
114
115 #endif
116
117
118 #define FC_MUTEX_INIT           {FC_MUTEX_IMPL_INIT}
119 typedef fc_mutex_impl_t FcMutex;
120 static inline void FcMutexInit   (FcMutex *m) { fc_mutex_impl_init (m);   }
121 static inline void FcMutexLock   (FcMutex *m) { fc_mutex_impl_lock (m);   }
122 static inline void FcMutexUnlock (FcMutex *m) { fc_mutex_impl_unlock (m); }
123 static inline void FcMutexFinish (FcMutex *m) { fc_mutex_impl_finish (m); }
124
125
126 #endif /* _FCMUTEX_H_ */