]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - lib/libthr/thread/thr_attr.c
To support stack unwinding for cancellation points, add -fexceptions flag
[FreeBSD/FreeBSD.git] / lib / libthr / thread / thr_attr.c
1 /*
2  * Copyright (c) 2003 Craig Rodrigues <rodrigc@attbi.com>.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by Craig Rodrigues.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY CRAIG RODRIGUES AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  */
33
34 /*
35  * Copyright (c) 1998 Daniel Eischen <eischen@vigrid.com>.
36  * Copyright (C) 2001 Jason Evans <jasone@freebsd.org>.
37  * Copyright (c) 2002,2003 Alexey Zelkin <phantom@FreeBSD.org>
38  * All rights reserved.
39  *
40  * Redistribution and use in source and binary forms, with or without
41  * modification, are permitted provided that the following conditions
42  * are met:
43  * 1. Redistributions of source code must retain the above copyright
44  *    notice(s), this list of conditions and the following disclaimer
45  *    unmodified other than the allowable addition of one or more
46  *    copyright notices.
47  * 2. Redistributions in binary form must reproduce the above copyright
48  *    notice(s), this list of conditions and the following disclaimer in
49  *    the documentation and/or other materials provided with the
50  *    distribution.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
53  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
55  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
56  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
57  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
58  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
59  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
60  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
61  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
62  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63  */
64
65 /*
66  * Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
67  * All rights reserved.
68  *
69  * Redistribution and use in source and binary forms, with or without
70  * modification, are permitted provided that the following conditions
71  * are met:
72  * 1. Redistributions of source code must retain the above copyright
73  *    notice, this list of conditions and the following disclaimer.
74  * 2. Redistributions in binary form must reproduce the above copyright
75  *    notice, this list of conditions and the following disclaimer in the
76  *    documentation and/or other materials provided with the distribution.
77  * 3. Neither the name of the author nor the names of any co-contributors
78  *    may be used to endorse or promote products derived from this software
79  *    without specific prior written permission.
80  *
81  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
82  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
83  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
84  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
85  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
86  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
87  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
88  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
89  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
90  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
91  * SUCH DAMAGE.
92  *
93  * $FreeBSD$
94  */
95
96 #include "namespace.h"
97 #include <errno.h>
98 #include <pthread.h>
99 #include <stdlib.h>
100 #include <string.h>
101 #include <pthread_np.h>
102 #include <sys/sysctl.h>
103 #include "un-namespace.h"
104
105 #include "thr_private.h"
106
107 __weak_reference(_pthread_attr_destroy, pthread_attr_destroy);
108
109 int
110 _pthread_attr_destroy(pthread_attr_t *attr)
111 {
112         int     ret;
113
114         /* Check for invalid arguments: */
115         if (attr == NULL || *attr == NULL)
116                 /* Invalid argument: */
117                 ret = EINVAL;
118         else {
119                 /* Free the memory allocated to the attribute object: */
120                 free(*attr);
121
122                 /*
123                  * Leave the attribute pointer NULL now that the memory
124                  * has been freed:
125                  */
126                 *attr = NULL;
127                 ret = 0;
128         }
129         return(ret);
130 }
131
132 __weak_reference(_pthread_attr_get_np, pthread_attr_get_np);
133
134 int
135 _pthread_attr_get_np(pthread_t pthread, pthread_attr_t *dst)
136 {
137         struct pthread *curthread;
138         struct pthread_attr attr;
139         int     ret;
140
141         if (pthread == NULL || dst == NULL || *dst == NULL)
142                 return (EINVAL);
143
144         curthread = _get_curthread();
145         if ((ret = _thr_find_thread(curthread, pthread, /*include dead*/0)) != 0)
146                 return (ret);
147         attr = pthread->attr;
148         if (pthread->flags & THR_FLAGS_DETACHED)
149                 attr.flags |= PTHREAD_DETACHED;
150         THR_THREAD_UNLOCK(curthread, pthread);
151
152         memcpy(*dst, &attr, sizeof(struct pthread_attr));
153         /* XXX */
154         (*dst)->cpuset = NULL;
155         (*dst)->cpusetsize = 0;
156         return (0);
157 }
158
159 __weak_reference(_pthread_attr_getdetachstate, pthread_attr_getdetachstate);
160
161 int
162 _pthread_attr_getdetachstate(const pthread_attr_t *attr, int *detachstate)
163 {
164         int     ret;
165
166         /* Check for invalid arguments: */
167         if (attr == NULL || *attr == NULL || detachstate == NULL)
168                 ret = EINVAL;
169         else {
170                 /* Check if the detached flag is set: */
171                 if ((*attr)->flags & PTHREAD_DETACHED)
172                         /* Return detached: */
173                         *detachstate = PTHREAD_CREATE_DETACHED;
174                 else
175                         /* Return joinable: */
176                         *detachstate = PTHREAD_CREATE_JOINABLE;
177                 ret = 0;
178         }
179         return(ret);
180 }
181
182 __weak_reference(_pthread_attr_getguardsize, pthread_attr_getguardsize);
183
184 int
185 _pthread_attr_getguardsize(const pthread_attr_t *attr, size_t *guardsize)
186 {
187         int     ret;
188
189         /* Check for invalid arguments: */
190         if (attr == NULL || *attr == NULL || guardsize == NULL)
191                 ret = EINVAL;
192         else {
193                 /* Return the guard size: */
194                 *guardsize = (*attr)->guardsize_attr;
195                 ret = 0;
196         }
197         return(ret);
198 }
199
200 __weak_reference(_pthread_attr_getinheritsched, pthread_attr_getinheritsched);
201
202 int
203 _pthread_attr_getinheritsched(const pthread_attr_t *attr, int *sched_inherit)
204 {
205         int ret = 0;
206
207         if ((attr == NULL) || (*attr == NULL))
208                 ret = EINVAL;
209         else
210                 *sched_inherit = (*attr)->sched_inherit;
211
212         return(ret);
213 }
214
215 __weak_reference(_pthread_attr_getschedparam, pthread_attr_getschedparam);
216
217 int
218 _pthread_attr_getschedparam(const pthread_attr_t *attr, struct sched_param *param)
219 {
220         int ret = 0;
221
222         if ((attr == NULL) || (*attr == NULL) || (param == NULL))
223                 ret = EINVAL;
224         else
225                 param->sched_priority = (*attr)->prio;
226
227         return(ret);
228 }
229
230 __weak_reference(_pthread_attr_getschedpolicy, pthread_attr_getschedpolicy);
231
232 int
233 _pthread_attr_getschedpolicy(const pthread_attr_t *attr, int *policy)
234 {
235         int ret = 0;
236
237         if ((attr == NULL) || (*attr == NULL) || (policy == NULL))
238                 ret = EINVAL;
239         else
240                 *policy = (*attr)->sched_policy;
241
242         return(ret);
243 }
244
245 __weak_reference(_pthread_attr_getscope, pthread_attr_getscope);
246
247 int
248 _pthread_attr_getscope(const pthread_attr_t *attr, int *contentionscope)
249 {
250         int ret = 0;
251
252         if ((attr == NULL) || (*attr == NULL) || (contentionscope == NULL))
253                 /* Return an invalid argument: */
254                 ret = EINVAL;
255
256         else
257                 *contentionscope = (*attr)->flags & PTHREAD_SCOPE_SYSTEM ?
258                     PTHREAD_SCOPE_SYSTEM : PTHREAD_SCOPE_PROCESS;
259
260         return(ret);
261 }
262
263 __weak_reference(_pthread_attr_getstack, pthread_attr_getstack);
264
265 int
266 _pthread_attr_getstack(const pthread_attr_t * __restrict attr,
267                         void ** __restrict stackaddr,
268                         size_t * __restrict stacksize)
269 {
270         int     ret;
271
272         /* Check for invalid arguments: */
273         if (attr == NULL || *attr == NULL || stackaddr == NULL
274             || stacksize == NULL )
275                 ret = EINVAL;
276         else {
277                 /* Return the stack address and size */
278                 *stackaddr = (*attr)->stackaddr_attr;
279                 *stacksize = (*attr)->stacksize_attr;
280                 ret = 0;
281         }
282         return(ret);
283 }
284
285 __weak_reference(_pthread_attr_getstackaddr, pthread_attr_getstackaddr);
286
287 int
288 _pthread_attr_getstackaddr(const pthread_attr_t *attr, void **stackaddr)
289 {
290         int     ret;
291
292         /* Check for invalid arguments: */
293         if (attr == NULL || *attr == NULL || stackaddr == NULL)
294                 ret = EINVAL;
295         else {
296                 /* Return the stack address: */
297                 *stackaddr = (*attr)->stackaddr_attr;
298                 ret = 0;
299         }
300         return(ret);
301 }
302
303 __weak_reference(_pthread_attr_getstacksize, pthread_attr_getstacksize);
304
305 int
306 _pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize)
307 {
308         int     ret;
309
310         /* Check for invalid arguments: */
311         if (attr == NULL || *attr == NULL || stacksize  == NULL)
312                 ret = EINVAL;
313         else {
314                 /* Return the stack size: */
315                 *stacksize = (*attr)->stacksize_attr;
316                 ret = 0;
317         }
318         return(ret);
319 }
320
321 __weak_reference(_pthread_attr_init, pthread_attr_init);
322
323 int
324 _pthread_attr_init(pthread_attr_t *attr)
325 {
326         int     ret;
327         pthread_attr_t  pattr;
328
329         _thr_check_init();
330
331         /* Allocate memory for the attribute object: */
332         if ((pattr = (pthread_attr_t) malloc(sizeof(struct pthread_attr))) == NULL)
333                 /* Insufficient memory: */
334                 ret = ENOMEM;
335         else {
336                 /* Initialise the attribute object with the defaults: */
337                 memcpy(pattr, &_pthread_attr_default, sizeof(struct pthread_attr));
338
339                 /* Return a pointer to the attribute object: */
340                 *attr = pattr;
341                 ret = 0;
342         }
343         return(ret);
344 }
345
346 __weak_reference(_pthread_attr_setcreatesuspend_np, pthread_attr_setcreatesuspend_np);
347
348 int
349 _pthread_attr_setcreatesuspend_np(pthread_attr_t *attr)
350 {
351         int     ret;
352
353         if (attr == NULL || *attr == NULL) {
354                 ret = EINVAL;
355         } else {
356                 (*attr)->suspend = THR_CREATE_SUSPENDED;
357                 ret = 0;
358         }
359         return(ret);
360 }
361
362 __weak_reference(_pthread_attr_setdetachstate, pthread_attr_setdetachstate);
363
364 int
365 _pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate)
366 {
367         int     ret;
368
369         /* Check for invalid arguments: */
370         if (attr == NULL || *attr == NULL ||
371             (detachstate != PTHREAD_CREATE_DETACHED &&
372             detachstate != PTHREAD_CREATE_JOINABLE))
373                 ret = EINVAL;
374         else {
375                 /* Check if detached state: */
376                 if (detachstate == PTHREAD_CREATE_DETACHED)
377                         /* Set the detached flag: */
378                         (*attr)->flags |= PTHREAD_DETACHED;
379                 else
380                         /* Reset the detached flag: */
381                         (*attr)->flags &= ~PTHREAD_DETACHED;
382                 ret = 0;
383         }
384         return(ret);
385 }
386
387 __weak_reference(_pthread_attr_setguardsize, pthread_attr_setguardsize);
388
389 int
390 _pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize)
391 {
392         int     ret;
393
394         /* Check for invalid arguments. */
395         if (attr == NULL || *attr == NULL)
396                 ret = EINVAL;
397         else {
398                 /* Save the stack size. */
399                 (*attr)->guardsize_attr = guardsize;
400                 ret = 0;
401         }
402         return(ret);
403 }
404
405 __weak_reference(_pthread_attr_setinheritsched, pthread_attr_setinheritsched);
406
407 int
408 _pthread_attr_setinheritsched(pthread_attr_t *attr, int sched_inherit)
409 {
410         int ret = 0;
411
412         if ((attr == NULL) || (*attr == NULL))
413                 ret = EINVAL;
414         else if (sched_inherit != PTHREAD_INHERIT_SCHED &&
415                  sched_inherit != PTHREAD_EXPLICIT_SCHED)
416                 ret = ENOTSUP;
417         else
418                 (*attr)->sched_inherit = sched_inherit;
419
420         return(ret);
421 }
422
423 __weak_reference(_pthread_attr_setschedparam, pthread_attr_setschedparam);
424
425 int
426 _pthread_attr_setschedparam(pthread_attr_t *attr, const struct sched_param *param)
427 {
428         int policy;
429
430         if ((attr == NULL) || (*attr == NULL))
431                 return (EINVAL);
432
433         if (param == NULL)
434                 return (ENOTSUP);
435
436         policy = (*attr)->sched_policy;
437
438         if (policy == SCHED_FIFO || policy == SCHED_RR) {
439                 if (param->sched_priority < _thr_priorities[policy-1].pri_min ||
440                     param->sched_priority > _thr_priorities[policy-1].pri_max)
441                 return (ENOTSUP);
442         } else {
443                 /*
444                  * Ignore it for SCHED_OTHER now, patches for glib ports
445                  * are wrongly using M:N thread library's internal macro
446                  * THR_MIN_PRIORITY and THR_MAX_PRIORITY.
447                  */
448         }
449
450         (*attr)->prio = param->sched_priority;
451
452         return (0);
453 }
454
455 __weak_reference(_pthread_attr_setschedpolicy, pthread_attr_setschedpolicy);
456
457 int
458 _pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy)
459 {
460         int ret = 0;
461
462         if ((attr == NULL) || (*attr == NULL))
463                 ret = EINVAL;
464         else if ((policy < SCHED_FIFO) || (policy > SCHED_RR)) {
465                 ret = ENOTSUP;
466         } else {
467                 (*attr)->sched_policy = policy;
468                 (*attr)->prio = _thr_priorities[policy-1].pri_default;
469         }
470         return(ret);
471 }
472
473 __weak_reference(_pthread_attr_setscope, pthread_attr_setscope);
474
475 int
476 _pthread_attr_setscope(pthread_attr_t *attr, int contentionscope)
477 {
478         int ret = 0;
479
480         if ((attr == NULL) || (*attr == NULL)) {
481                 /* Return an invalid argument: */
482                 ret = EINVAL;
483         } else if ((contentionscope != PTHREAD_SCOPE_PROCESS) &&
484             (contentionscope != PTHREAD_SCOPE_SYSTEM)) {
485                 ret = EINVAL;
486         } else if (contentionscope == PTHREAD_SCOPE_SYSTEM) {
487                 (*attr)->flags |= contentionscope;
488         } else {
489                 (*attr)->flags &= ~PTHREAD_SCOPE_SYSTEM;
490         }
491         return (ret);
492 }
493
494 __weak_reference(_pthread_attr_setstack, pthread_attr_setstack);
495
496 int
497 _pthread_attr_setstack(pthread_attr_t *attr, void *stackaddr,
498                         size_t stacksize)
499 {
500         int     ret;
501
502         /* Check for invalid arguments: */
503         if (attr == NULL || *attr == NULL || stackaddr == NULL
504             || stacksize < PTHREAD_STACK_MIN)
505                 ret = EINVAL;
506         else {
507                 /* Save the stack address and stack size */
508                 (*attr)->stackaddr_attr = stackaddr;
509                 (*attr)->stacksize_attr = stacksize;
510                 ret = 0;
511         }
512         return(ret);
513 }
514
515 __weak_reference(_pthread_attr_setstackaddr, pthread_attr_setstackaddr);
516
517 int
518 _pthread_attr_setstackaddr(pthread_attr_t *attr, void *stackaddr)
519 {
520         int     ret;
521
522         /* Check for invalid arguments: */
523         if (attr == NULL || *attr == NULL || stackaddr == NULL)
524                 ret = EINVAL;
525         else {
526                 /* Save the stack address: */
527                 (*attr)->stackaddr_attr = stackaddr;
528                 ret = 0;
529         }
530         return(ret);
531 }
532
533 __weak_reference(_pthread_attr_setstacksize, pthread_attr_setstacksize);
534
535 int
536 _pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
537 {
538         int     ret;
539
540         /* Check for invalid arguments: */
541         if (attr == NULL || *attr == NULL || stacksize < PTHREAD_STACK_MIN)
542                 ret = EINVAL;
543         else {
544                 /* Save the stack size: */
545                 (*attr)->stacksize_attr = stacksize;
546                 ret = 0;
547         }
548         return(ret);
549 }
550
551 static size_t
552 _get_kern_cpuset_size(void)
553 {
554         static int kern_cpuset_size = 0;
555
556         if (kern_cpuset_size == 0) {
557                 size_t len;
558
559                 len = sizeof(kern_cpuset_size);
560                 if (sysctlbyname("kern.smp.maxcpus", &kern_cpuset_size,
561                     &len, NULL, 0))
562                         PANIC("failed to get sysctl kern.smp.maxcpus");
563
564                 kern_cpuset_size = (kern_cpuset_size + 7) / 8;
565         }
566
567         return (kern_cpuset_size);
568 }
569
570 __weak_reference(_pthread_attr_setaffinity_np, pthread_attr_setaffinity_np);
571 int
572 _pthread_attr_setaffinity_np(pthread_attr_t *pattr, size_t cpusetsize,
573         const cpuset_t *cpusetp)
574 {
575         pthread_attr_t attr;
576         int ret;
577
578         if (pattr == NULL || (attr = (*pattr)) == NULL)
579                 ret = EINVAL;
580         else {
581                 if (cpusetsize == 0 || cpusetp == NULL) {
582                         if (attr->cpuset != NULL) {
583                                 free(attr->cpuset);
584                                 attr->cpuset = NULL;
585                                 attr->cpusetsize = 0;
586                         }
587                         return (0);
588                 }
589                         
590                 if (cpusetsize > attr->cpusetsize) {
591                         size_t kern_size = _get_kern_cpuset_size();
592                         if (cpusetsize > kern_size) {
593                                 size_t i;
594                                 for (i = kern_size; i < cpusetsize; ++i) {
595                                         if (((char *)cpusetp)[i])
596                                                 return (EINVAL);
597                                 }
598                         }
599                         void *newset = realloc(attr->cpuset, cpusetsize);
600                         if (newset == NULL)
601                             return (ENOMEM);
602                         attr->cpuset = newset;
603                         attr->cpusetsize = cpusetsize;
604                 } else {
605                         memset(((char *)attr->cpuset) + cpusetsize, 0,
606                                 attr->cpusetsize - cpusetsize);
607                         attr->cpusetsize = cpusetsize;
608                 }
609                 memcpy(attr->cpuset, cpusetp, cpusetsize);
610                 ret = 0;
611         }
612         return (ret);
613 }
614
615 __weak_reference(_pthread_attr_getaffinity_np, pthread_attr_getaffinity_np);
616 int
617 _pthread_attr_getaffinity_np(const pthread_attr_t *pattr, size_t cpusetsize,
618         cpuset_t *cpusetp)
619 {
620         pthread_attr_t attr;
621         int ret = 0;
622
623         if (pattr == NULL || (attr = (*pattr)) == NULL)
624                 ret = EINVAL;
625         else if (attr->cpuset != NULL) {
626                 memcpy(cpusetp, attr->cpuset, MIN(cpusetsize, attr->cpusetsize));
627                 if (cpusetsize > attr->cpusetsize)
628                         memset(((char *)cpusetp) + attr->cpusetsize, 0, 
629                                 cpusetsize - attr->cpusetsize);
630         } else {
631                 size_t kern_size = _get_kern_cpuset_size();
632                 memset(cpusetp, -1, MIN(cpusetsize, kern_size));
633                 if (cpusetsize > kern_size)
634                         memset(((char *)cpusetp) + kern_size, 0,
635                                 cpusetsize - kern_size);
636         }
637         return (ret);
638 }