xref: /freebsd/lib/libthr/thread/thr_mutexattr.c (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1996 Jeffrey Hsu <hsu@freebsd.org>.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the author nor the names of any co-contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 /*
33  * Copyright (c) 1997 John Birrell <jb@cimlogic.com.au>.
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. Neither the name of the author nor the names of any co-contributors
45  *    may be used to endorse or promote products derived from this software
46  *    without specific prior written permission.
47  *
48  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58  * SUCH DAMAGE.
59  *
60  */
61 
62 #include <sys/cdefs.h>
63 #include "namespace.h"
64 #include <string.h>
65 #include <stdlib.h>
66 #include <errno.h>
67 #include <pthread.h>
68 #include <pthread_np.h>
69 #include "un-namespace.h"
70 
71 #include "thr_private.h"
72 
73 __weak_reference(_thr_mutexattr_init, pthread_mutexattr_init);
74 __weak_reference(_thr_mutexattr_init, _pthread_mutexattr_init);
75 __weak_reference(_pthread_mutexattr_setkind_np, pthread_mutexattr_setkind_np);
76 __weak_reference(_pthread_mutexattr_getkind_np, pthread_mutexattr_getkind_np);
77 __weak_reference(_pthread_mutexattr_gettype, pthread_mutexattr_gettype);
78 __weak_reference(_thr_mutexattr_settype, pthread_mutexattr_settype);
79 __weak_reference(_thr_mutexattr_settype, _pthread_mutexattr_settype);
80 __weak_reference(_thr_mutexattr_destroy, pthread_mutexattr_destroy);
81 __weak_reference(_thr_mutexattr_destroy, _pthread_mutexattr_destroy);
82 __weak_reference(_pthread_mutexattr_getpshared, pthread_mutexattr_getpshared);
83 __weak_reference(_pthread_mutexattr_setpshared, pthread_mutexattr_setpshared);
84 __weak_reference(_pthread_mutexattr_getprotocol, pthread_mutexattr_getprotocol);
85 __weak_reference(_pthread_mutexattr_setprotocol, pthread_mutexattr_setprotocol);
86 __weak_reference(_pthread_mutexattr_getprioceiling,
87     pthread_mutexattr_getprioceiling);
88 __weak_reference(_pthread_mutexattr_setprioceiling,
89     pthread_mutexattr_setprioceiling);
90 __weak_reference(_thr_mutexattr_getrobust, pthread_mutexattr_getrobust);
91 __weak_reference(_thr_mutexattr_getrobust, _pthread_mutexattr_getrobust);
92 __weak_reference(_thr_mutexattr_setrobust, pthread_mutexattr_setrobust);
93 __weak_reference(_thr_mutexattr_setrobust, _pthread_mutexattr_setrobust);
94 
95 int
96 _thr_mutexattr_init(pthread_mutexattr_t *attr)
97 {
98 	int ret;
99 	pthread_mutexattr_t pattr;
100 
101 	if ((pattr = (pthread_mutexattr_t)
102 	    malloc(sizeof(struct pthread_mutex_attr))) == NULL) {
103 		ret = ENOMEM;
104 	} else {
105 		memcpy(pattr, &_pthread_mutexattr_default,
106 		    sizeof(struct pthread_mutex_attr));
107 		*attr = pattr;
108 		ret = 0;
109 	}
110 	return (ret);
111 }
112 
113 int
114 _pthread_mutexattr_setkind_np(pthread_mutexattr_t *attr, int kind)
115 {
116 	int	ret;
117 	if (attr == NULL || *attr == NULL) {
118 		errno = EINVAL;
119 		ret = -1;
120 	} else {
121 		(*attr)->m_type = kind;
122 		ret = 0;
123 	}
124 	return(ret);
125 }
126 
127 int
128 _pthread_mutexattr_getkind_np(pthread_mutexattr_t attr)
129 {
130 	int	ret;
131 
132 	if (attr == NULL) {
133 		errno = EINVAL;
134 		ret = -1;
135 	} else {
136 		ret = attr->m_type;
137 	}
138 	return (ret);
139 }
140 
141 int
142 _thr_mutexattr_settype(pthread_mutexattr_t *attr, int type)
143 {
144 	int	ret;
145 
146 	if (attr == NULL || *attr == NULL || type >= PTHREAD_MUTEX_TYPE_MAX) {
147 		ret = EINVAL;
148 	} else {
149 		(*attr)->m_type = type;
150 		ret = 0;
151 	}
152 	return (ret);
153 }
154 
155 int
156 _pthread_mutexattr_gettype(const pthread_mutexattr_t * __restrict attr,
157     int * __restrict type)
158 {
159 	int	ret;
160 
161 	if (attr == NULL || *attr == NULL || (*attr)->m_type >=
162 	    PTHREAD_MUTEX_TYPE_MAX) {
163 		ret = EINVAL;
164 	} else {
165 		*type = (*attr)->m_type;
166 		ret = 0;
167 	}
168 	return (ret);
169 }
170 
171 int
172 _thr_mutexattr_destroy(pthread_mutexattr_t *attr)
173 {
174 	int	ret;
175 	if (attr == NULL || *attr == NULL) {
176 		ret = EINVAL;
177 	} else {
178 		free(*attr);
179 		*attr = NULL;
180 		ret = 0;
181 	}
182 	return (ret);
183 }
184 
185 int
186 _pthread_mutexattr_getpshared(const pthread_mutexattr_t *attr,
187 	int *pshared)
188 {
189 
190 	if (attr == NULL || *attr == NULL)
191 		return (EINVAL);
192 	*pshared = (*attr)->m_pshared;
193 	return (0);
194 }
195 
196 int
197 _pthread_mutexattr_setpshared(pthread_mutexattr_t *attr, int pshared)
198 {
199 
200 	if (attr == NULL || *attr == NULL ||
201 	    (pshared != PTHREAD_PROCESS_PRIVATE &&
202 	    pshared != PTHREAD_PROCESS_SHARED))
203 		return (EINVAL);
204 	(*attr)->m_pshared = pshared;
205 	return (0);
206 }
207 
208 int
209 _pthread_mutexattr_getprotocol(const pthread_mutexattr_t * __restrict mattr,
210     int * __restrict protocol)
211 {
212 	int ret = 0;
213 
214 	if (mattr == NULL || *mattr == NULL)
215 		ret = EINVAL;
216 	else
217 		*protocol = (*mattr)->m_protocol;
218 
219 	return (ret);
220 }
221 
222 int
223 _pthread_mutexattr_setprotocol(pthread_mutexattr_t *mattr, int protocol)
224 {
225 	int ret = 0;
226 
227 	if (mattr == NULL || *mattr == NULL ||
228 	    protocol < PTHREAD_PRIO_NONE || protocol > PTHREAD_PRIO_PROTECT)
229 		ret = EINVAL;
230 	else {
231 		(*mattr)->m_protocol = protocol;
232 		(*mattr)->m_ceiling = THR_MAX_RR_PRIORITY;
233 	}
234 	return (ret);
235 }
236 
237 int
238 _pthread_mutexattr_getprioceiling(const pthread_mutexattr_t * __restrict mattr,
239     int * __restrict prioceiling)
240 {
241 	int ret = 0;
242 
243 	if (mattr == NULL || *mattr == NULL)
244 		ret = EINVAL;
245 	else if ((*mattr)->m_protocol != PTHREAD_PRIO_PROTECT)
246 		ret = EINVAL;
247 	else
248 		*prioceiling = (*mattr)->m_ceiling;
249 
250 	return (ret);
251 }
252 
253 int
254 _pthread_mutexattr_setprioceiling(pthread_mutexattr_t *mattr, int prioceiling)
255 {
256 	int ret = 0;
257 
258 	if (mattr == NULL || *mattr == NULL)
259 		ret = EINVAL;
260 	else if ((*mattr)->m_protocol != PTHREAD_PRIO_PROTECT)
261 		ret = EINVAL;
262 	else
263 		(*mattr)->m_ceiling = prioceiling;
264 
265 	return (ret);
266 }
267 
268 int
269 _thr_mutexattr_getrobust(pthread_mutexattr_t *mattr, int *robust)
270 {
271 	int ret;
272 
273 	if (mattr == NULL || *mattr == NULL) {
274 		ret = EINVAL;
275 	} else {
276 		ret = 0;
277 		*robust = (*mattr)->m_robust;
278 	}
279 	return (ret);
280 }
281 
282 int
283 _thr_mutexattr_setrobust(pthread_mutexattr_t *mattr, int robust)
284 {
285 	int ret;
286 
287 	if (mattr == NULL || *mattr == NULL) {
288 		ret = EINVAL;
289 	} else if (robust != PTHREAD_MUTEX_STALLED &&
290 	    robust != PTHREAD_MUTEX_ROBUST) {
291 		ret = EINVAL;
292 	} else {
293 		ret = 0;
294 		(*mattr)->m_robust = robust;
295 	}
296 	return (ret);
297 }
298 
299