|
111
|
1 /* os_mutex.h -*-C++-*-
|
|
|
2 *
|
|
|
3 *************************************************************************
|
|
|
4 *
|
|
|
5 * Copyright (C) 2009-2016, Intel Corporation
|
|
|
6 * All rights reserved.
|
|
|
7 *
|
|
|
8 * Redistribution and use in source and binary forms, with or without
|
|
|
9 * modification, are permitted provided that the following conditions
|
|
|
10 * are met:
|
|
|
11 *
|
|
|
12 * * Redistributions of source code must retain the above copyright
|
|
|
13 * notice, this list of conditions and the following disclaimer.
|
|
|
14 * * Redistributions in binary form must reproduce the above copyright
|
|
|
15 * notice, this list of conditions and the following disclaimer in
|
|
|
16 * the documentation and/or other materials provided with the
|
|
|
17 * distribution.
|
|
|
18 * * Neither the name of Intel Corporation nor the names of its
|
|
|
19 * contributors may be used to endorse or promote products derived
|
|
|
20 * from this software without specific prior written permission.
|
|
|
21 *
|
|
|
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
26 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
|
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
|
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
|
29 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
|
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
|
|
|
32 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
33 * POSSIBILITY OF SUCH DAMAGE.
|
|
|
34 *
|
|
|
35 * *********************************************************************
|
|
|
36 *
|
|
|
37 * PLEASE NOTE: This file is a downstream copy of a file mainitained in
|
|
|
38 * a repository at cilkplus.org. Changes made to this file that are not
|
|
|
39 * submitted through the contribution process detailed at
|
|
|
40 * http://www.cilkplus.org/submit-cilk-contribution will be lost the next
|
|
|
41 * time that a new version is released. Changes only submitted to the
|
|
|
42 * GNU compiler collection or posted to the git repository at
|
|
|
43 * https://bitbucket.org/intelcilkruntime/intel-cilk-runtime.git are
|
|
|
44 * not tracked.
|
|
|
45 *
|
|
|
46 * We welcome your contributions to this open source project. Thank you
|
|
|
47 * for your assistance in helping us improve Cilk Plus.
|
|
|
48 **************************************************************************/
|
|
|
49
|
|
|
50 /**
|
|
|
51 * @file os_mutex.h
|
|
|
52 *
|
|
|
53 * @brief Portable interface to operating-system mutexes.
|
|
|
54 *
|
|
|
55 * Do not confuse os_mutex with Cilk runtime-specific spinlock mutexes.
|
|
|
56 */
|
|
|
57
|
|
|
58 #ifndef INCLUDED_OS_MUTEX_DOT_H
|
|
|
59 #define INCLUDED_OS_MUTEX_DOT_H
|
|
|
60
|
|
|
61 #include <cilk/common.h>
|
|
|
62 #include "rts-common.h"
|
|
|
63
|
|
|
64 __CILKRTS_BEGIN_EXTERN_C
|
|
|
65
|
|
|
66 /// Opaque type
|
|
|
67 typedef struct os_mutex os_mutex;
|
|
|
68
|
|
|
69 /**
|
|
|
70 * Allocate and initialize an os_mutex
|
|
|
71 *
|
|
|
72 * @return A pointer to the initialized os_mutex
|
|
|
73 */
|
|
|
74 COMMON_SYSDEP os_mutex* __cilkrts_os_mutex_create(void);
|
|
|
75
|
|
|
76 /**
|
|
|
77 * Acquire the os_mutex for exclusive use
|
|
|
78 *
|
|
|
79 * @param m The os_mutex that is to be acquired.
|
|
|
80 */
|
|
|
81 COMMON_SYSDEP void __cilkrts_os_mutex_lock(os_mutex *m);
|
|
|
82
|
|
|
83 /**
|
|
|
84 * Try to acquire the os_mutex.
|
|
|
85 *
|
|
|
86 * @param m The os_mutex to try to acquire
|
|
|
87 * @return 0 if the lock acquire failed
|
|
|
88 * @return nonzero if the lock was acquired
|
|
|
89 */
|
|
|
90 COMMON_SYSDEP int __cilkrts_os_mutex_trylock(os_mutex *m);
|
|
|
91
|
|
|
92 /**
|
|
|
93 * Release the os_mutex
|
|
|
94 *
|
|
|
95 * @param m The os_mutex that is to be released.
|
|
|
96 */
|
|
|
97 COMMON_SYSDEP void __cilkrts_os_mutex_unlock(os_mutex *m);
|
|
|
98
|
|
|
99 /**
|
|
|
100 * Release any resources and deallocate the os_mutex.
|
|
|
101 *
|
|
|
102 * @param m The os_mutex that is to be deallocated.
|
|
|
103 */
|
|
|
104 COMMON_SYSDEP void __cilkrts_os_mutex_destroy(os_mutex *m);
|
|
|
105
|
|
|
106 /**
|
|
|
107 * Acquire the global os_mutex for exclusive use. The global os_mutex
|
|
|
108 * will be initialized the first time this function is called in a
|
|
|
109 * thread-safe manner.
|
|
|
110 */
|
|
|
111 COMMON_SYSDEP void global_os_mutex_lock();
|
|
|
112
|
|
|
113 /**
|
|
|
114 * Release the global os_mutex. global_os_mutex_lock() must have been
|
|
|
115 * called first.
|
|
|
116 */
|
|
|
117 COMMON_SYSDEP void global_os_mutex_unlock();
|
|
|
118
|
|
|
119
|
|
|
120 #ifdef _MSC_VER
|
|
|
121
|
|
|
122 /**
|
|
|
123 * @brief Create the global OS mutex - Windows only.
|
|
|
124 *
|
|
|
125 * On Windows we use DllMain() to create the global OS mutex when cilkrts20.dll
|
|
|
126 * is loaded. As opposed to Linux/MacOS where we use pthread_once to implement
|
|
|
127 * a singleton since there are no guarantees about constructor or destructor
|
|
|
128 * ordering between shared objects.
|
|
|
129 */
|
|
|
130 NON_COMMON void global_os_mutex_create();
|
|
|
131
|
|
|
132 /**
|
|
|
133 * @brief Destroy the global OS mutex - Windows only
|
|
|
134 *
|
|
|
135 * On Windows we use DllMain() to destroy the global OS mutex when
|
|
|
136 * cilkrts20.dll is unloaded. As opposed to Linux/MacOS where we cannot
|
|
|
137 * know when it's safe to destroy the global OS mutex since there are no
|
|
|
138 * guarantees about constructor or destructor ordering.
|
|
|
139 */
|
|
|
140 NON_COMMON void global_os_mutex_destroy();
|
|
|
141
|
|
|
142 #endif // _MSC_VER
|
|
|
143
|
|
|
144 __CILKRTS_END_EXTERN_C
|
|
|
145
|
|
|
146 #endif // ! defined(INCLUDED_OS_MUTEX_DOT_H)
|
