freebsd-dev/lib/libthr/thread/thr_attr.c
Konstantin Belousov 20b8e1a25c Style.
Sponsored by:	The FreeBSD Foundation
MFC after: 3 days
2020-11-26 20:23:17 +00:00

679 lines
19 KiB
C

/*-
* SPDX-License-Identifier: BSD-4-Clause
*
* Copyright (c) 2003 Craig Rodrigues <rodrigc@attbi.com>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by Craig Rodrigues.
* 4. Neither the name of the author nor the names of any co-contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY CRAIG RODRIGUES AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/
/*
* Copyright (c) 1998 Daniel Eischen <eischen@vigrid.com>.
* Copyright (C) 2001 Jason Evans <jasone@freebsd.org>.
* Copyright (c) 2002,2003 Alexey Zelkin <phantom@FreeBSD.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice(s), this list of conditions and the following disclaimer
* unmodified other than the allowable addition of one or more
* copyright notices.
* 2. Redistributions in binary form must reproduce the above copyright
* notice(s), this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
* Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the author nor the names of any co-contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include "namespace.h"
#include <errno.h>
#include <pthread.h>
#include <stdlib.h>
#include <string.h>
#include <pthread_np.h>
#include <sys/sysctl.h>
#include "un-namespace.h"
#include "thr_private.h"
static size_t _get_kern_cpuset_size(void);
__weak_reference(_thr_attr_destroy, _pthread_attr_destroy);
__weak_reference(_thr_attr_destroy, pthread_attr_destroy);
int
_thr_attr_destroy(pthread_attr_t *attr)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL)
/* Invalid argument: */
ret = EINVAL;
else {
if ((*attr)->cpuset != NULL)
free((*attr)->cpuset);
/* Free the memory allocated to the attribute object: */
free(*attr);
/*
* Leave the attribute pointer NULL now that the memory
* has been freed:
*/
*attr = NULL;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_get_np, pthread_attr_get_np);
__weak_reference(_thr_attr_get_np, _pthread_attr_get_np);
int
_thr_attr_get_np(pthread_t pthread, pthread_attr_t *dstattr)
{
struct pthread *curthread;
struct pthread_attr attr, *dst;
int ret;
size_t kern_size;
if (pthread == NULL || dstattr == NULL || (dst = *dstattr) == NULL)
return (EINVAL);
kern_size = _get_kern_cpuset_size();
if (dst->cpuset == NULL) {
dst->cpuset = calloc(1, kern_size);
dst->cpusetsize = kern_size;
}
curthread = _get_curthread();
if ((ret = _thr_find_thread(curthread, pthread, /*include dead*/0)) != 0)
return (ret);
attr = pthread->attr;
if (pthread->flags & THR_FLAGS_DETACHED)
attr.flags |= PTHREAD_DETACHED;
ret = cpuset_getaffinity(CPU_LEVEL_WHICH, CPU_WHICH_TID, TID(pthread),
dst->cpusetsize, dst->cpuset);
if (ret == -1)
ret = errno;
THR_THREAD_UNLOCK(curthread, pthread);
if (ret == 0) {
memcpy(&dst->pthread_attr_start_copy,
&attr.pthread_attr_start_copy,
offsetof(struct pthread_attr, pthread_attr_end_copy) -
offsetof(struct pthread_attr, pthread_attr_start_copy));
}
return (ret);
}
__weak_reference(_thr_attr_getdetachstate, pthread_attr_getdetachstate);
__weak_reference(_thr_attr_getdetachstate, _pthread_attr_getdetachstate);
int
_thr_attr_getdetachstate(const pthread_attr_t *attr, int *detachstate)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL || detachstate == NULL)
ret = EINVAL;
else {
/* Check if the detached flag is set: */
if ((*attr)->flags & PTHREAD_DETACHED)
/* Return detached: */
*detachstate = PTHREAD_CREATE_DETACHED;
else
/* Return joinable: */
*detachstate = PTHREAD_CREATE_JOINABLE;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_getguardsize, pthread_attr_getguardsize);
__weak_reference(_thr_attr_getguardsize, _pthread_attr_getguardsize);
int
_thr_attr_getguardsize(const pthread_attr_t * __restrict attr,
size_t * __restrict guardsize)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL || guardsize == NULL)
ret = EINVAL;
else {
/* Return the guard size: */
*guardsize = (*attr)->guardsize_attr;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_getinheritsched, pthread_attr_getinheritsched);
__weak_reference(_thr_attr_getinheritsched, _pthread_attr_getinheritsched);
int
_thr_attr_getinheritsched(const pthread_attr_t * __restrict attr,
int * __restrict sched_inherit)
{
int ret = 0;
if ((attr == NULL) || (*attr == NULL))
ret = EINVAL;
else
*sched_inherit = (*attr)->sched_inherit;
return (ret);
}
__weak_reference(_thr_attr_getschedparam, pthread_attr_getschedparam);
__weak_reference(_thr_attr_getschedparam, _pthread_attr_getschedparam);
int
_thr_attr_getschedparam(const pthread_attr_t * __restrict attr,
struct sched_param * __restrict param)
{
int ret = 0;
if ((attr == NULL) || (*attr == NULL) || (param == NULL))
ret = EINVAL;
else
param->sched_priority = (*attr)->prio;
return (ret);
}
__weak_reference(_thr_attr_getschedpolicy, pthread_attr_getschedpolicy);
__weak_reference(_thr_attr_getschedpolicy, _pthread_attr_getschedpolicy);
int
_thr_attr_getschedpolicy(const pthread_attr_t * __restrict attr,
int * __restrict policy)
{
int ret = 0;
if ((attr == NULL) || (*attr == NULL) || (policy == NULL))
ret = EINVAL;
else
*policy = (*attr)->sched_policy;
return (ret);
}
__weak_reference(_thr_attr_getscope, pthread_attr_getscope);
__weak_reference(_thr_attr_getscope, _pthread_attr_getscope);
int
_thr_attr_getscope(const pthread_attr_t * __restrict attr,
int * __restrict contentionscope)
{
int ret = 0;
if ((attr == NULL) || (*attr == NULL) || (contentionscope == NULL))
/* Return an invalid argument: */
ret = EINVAL;
else
*contentionscope = (*attr)->flags & PTHREAD_SCOPE_SYSTEM ?
PTHREAD_SCOPE_SYSTEM : PTHREAD_SCOPE_PROCESS;
return (ret);
}
__weak_reference(_pthread_attr_getstack, pthread_attr_getstack);
int
_pthread_attr_getstack(const pthread_attr_t * __restrict attr,
void ** __restrict stackaddr, size_t * __restrict stacksize)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL || stackaddr == NULL
|| stacksize == NULL )
ret = EINVAL;
else {
/* Return the stack address and size */
*stackaddr = (*attr)->stackaddr_attr;
*stacksize = (*attr)->stacksize_attr;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_getstackaddr, pthread_attr_getstackaddr);
__weak_reference(_thr_attr_getstackaddr, _pthread_attr_getstackaddr);
int
_thr_attr_getstackaddr(const pthread_attr_t *attr, void **stackaddr)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL || stackaddr == NULL)
ret = EINVAL;
else {
/* Return the stack address: */
*stackaddr = (*attr)->stackaddr_attr;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_getstacksize, pthread_attr_getstacksize);
__weak_reference(_thr_attr_getstacksize, _pthread_attr_getstacksize);
int
_thr_attr_getstacksize(const pthread_attr_t * __restrict attr,
size_t * __restrict stacksize)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL || stacksize == NULL)
ret = EINVAL;
else {
/* Return the stack size: */
*stacksize = (*attr)->stacksize_attr;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_init, pthread_attr_init);
__weak_reference(_thr_attr_init, _pthread_attr_init);
int
_thr_attr_init(pthread_attr_t *attr)
{
int ret;
pthread_attr_t pattr;
_thr_check_init();
/* Allocate memory for the attribute object: */
if ((pattr = (pthread_attr_t) malloc(sizeof(struct pthread_attr))) == NULL)
/* Insufficient memory: */
ret = ENOMEM;
else {
/* Initialise the attribute object with the defaults: */
memcpy(pattr, &_pthread_attr_default, sizeof(struct pthread_attr));
/* Return a pointer to the attribute object: */
*attr = pattr;
ret = 0;
}
return (ret);
}
__weak_reference(_pthread_attr_setcreatesuspend_np, pthread_attr_setcreatesuspend_np);
int
_pthread_attr_setcreatesuspend_np(pthread_attr_t *attr)
{
int ret;
if (attr == NULL || *attr == NULL) {
ret = EINVAL;
} else {
(*attr)->suspend = THR_CREATE_SUSPENDED;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_setdetachstate, pthread_attr_setdetachstate);
__weak_reference(_thr_attr_setdetachstate, _pthread_attr_setdetachstate);
int
_thr_attr_setdetachstate(pthread_attr_t *attr, int detachstate)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL ||
(detachstate != PTHREAD_CREATE_DETACHED &&
detachstate != PTHREAD_CREATE_JOINABLE))
ret = EINVAL;
else {
/* Check if detached state: */
if (detachstate == PTHREAD_CREATE_DETACHED)
/* Set the detached flag: */
(*attr)->flags |= PTHREAD_DETACHED;
else
/* Reset the detached flag: */
(*attr)->flags &= ~PTHREAD_DETACHED;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_setguardsize, pthread_attr_setguardsize);
__weak_reference(_thr_attr_setguardsize, _pthread_attr_setguardsize);
int
_thr_attr_setguardsize(pthread_attr_t *attr, size_t guardsize)
{
int ret;
/* Check for invalid arguments. */
if (attr == NULL || *attr == NULL)
ret = EINVAL;
else {
/* Save the stack size. */
(*attr)->guardsize_attr = guardsize;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_setinheritsched, pthread_attr_setinheritsched);
__weak_reference(_thr_attr_setinheritsched, _pthread_attr_setinheritsched);
int
_thr_attr_setinheritsched(pthread_attr_t *attr, int sched_inherit)
{
int ret = 0;
if ((attr == NULL) || (*attr == NULL))
ret = EINVAL;
else if (sched_inherit != PTHREAD_INHERIT_SCHED &&
sched_inherit != PTHREAD_EXPLICIT_SCHED)
ret = ENOTSUP;
else
(*attr)->sched_inherit = sched_inherit;
return (ret);
}
__weak_reference(_thr_attr_setschedparam, pthread_attr_setschedparam);
__weak_reference(_thr_attr_setschedparam, _pthread_attr_setschedparam);
int
_thr_attr_setschedparam(pthread_attr_t * __restrict attr,
const struct sched_param * __restrict param)
{
int policy;
if ((attr == NULL) || (*attr == NULL))
return (EINVAL);
if (param == NULL)
return (ENOTSUP);
policy = (*attr)->sched_policy;
if (policy == SCHED_FIFO || policy == SCHED_RR) {
if (param->sched_priority < _thr_priorities[policy-1].pri_min ||
param->sched_priority > _thr_priorities[policy-1].pri_max)
return (ENOTSUP);
} else {
/*
* Ignore it for SCHED_OTHER now, patches for glib ports
* are wrongly using M:N thread library's internal macro
* THR_MIN_PRIORITY and THR_MAX_PRIORITY.
*/
}
(*attr)->prio = param->sched_priority;
return (0);
}
__weak_reference(_thr_attr_setschedpolicy, pthread_attr_setschedpolicy);
__weak_reference(_thr_attr_setschedpolicy, _pthread_attr_setschedpolicy);
int
_thr_attr_setschedpolicy(pthread_attr_t *attr, int policy)
{
int ret = 0;
if ((attr == NULL) || (*attr == NULL))
ret = EINVAL;
else if ((policy < SCHED_FIFO) || (policy > SCHED_RR)) {
ret = ENOTSUP;
} else {
(*attr)->sched_policy = policy;
(*attr)->prio = _thr_priorities[policy-1].pri_default;
}
return (ret);
}
__weak_reference(_thr_attr_setscope, pthread_attr_setscope);
__weak_reference(_thr_attr_setscope, _pthread_attr_setscope);
int
_thr_attr_setscope(pthread_attr_t *attr, int contentionscope)
{
int ret = 0;
if ((attr == NULL) || (*attr == NULL)) {
/* Return an invalid argument: */
ret = EINVAL;
} else if ((contentionscope != PTHREAD_SCOPE_PROCESS) &&
(contentionscope != PTHREAD_SCOPE_SYSTEM)) {
ret = EINVAL;
} else if (contentionscope == PTHREAD_SCOPE_SYSTEM) {
(*attr)->flags |= contentionscope;
} else {
(*attr)->flags &= ~PTHREAD_SCOPE_SYSTEM;
}
return (ret);
}
__weak_reference(_pthread_attr_setstack, pthread_attr_setstack);
int
_pthread_attr_setstack(pthread_attr_t *attr, void *stackaddr,
size_t stacksize)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL || stackaddr == NULL
|| stacksize < PTHREAD_STACK_MIN)
ret = EINVAL;
else {
/* Save the stack address and stack size */
(*attr)->stackaddr_attr = stackaddr;
(*attr)->stacksize_attr = stacksize;
ret = 0;
}
return (ret);
}
__weak_reference(_thr_attr_setstackaddr, pthread_attr_setstackaddr);
__weak_reference(_thr_attr_setstackaddr, _pthread_attr_setstackaddr);
int
_thr_attr_setstackaddr(pthread_attr_t *attr, void *stackaddr)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL || stackaddr == NULL)
ret = EINVAL;
else {
/* Save the stack address: */
(*attr)->stackaddr_attr = stackaddr;
ret = 0;
}
return(ret);
}
__weak_reference(_thr_attr_setstacksize, pthread_attr_setstacksize);
__weak_reference(_thr_attr_setstacksize, _pthread_attr_setstacksize);
int
_thr_attr_setstacksize(pthread_attr_t *attr, size_t stacksize)
{
int ret;
/* Check for invalid arguments: */
if (attr == NULL || *attr == NULL || stacksize < PTHREAD_STACK_MIN)
ret = EINVAL;
else {
/* Save the stack size: */
(*attr)->stacksize_attr = stacksize;
ret = 0;
}
return (ret);
}
static size_t
_get_kern_cpuset_size(void)
{
static int kern_cpuset_size = 0;
if (kern_cpuset_size == 0) {
size_t len;
len = sizeof(kern_cpuset_size);
if (sysctlbyname("kern.sched.cpusetsize", &kern_cpuset_size,
&len, NULL, 0))
PANIC("failed to get sysctl kern.sched.cpusetsize");
}
return (kern_cpuset_size);
}
__weak_reference(_pthread_attr_setaffinity_np, pthread_attr_setaffinity_np);
int
_pthread_attr_setaffinity_np(pthread_attr_t *pattr, size_t cpusetsize,
const cpuset_t *cpusetp)
{
pthread_attr_t attr;
int ret;
if (pattr == NULL || (attr = (*pattr)) == NULL)
ret = EINVAL;
else {
if (cpusetsize == 0 || cpusetp == NULL) {
if (attr->cpuset != NULL) {
free(attr->cpuset);
attr->cpuset = NULL;
attr->cpusetsize = 0;
}
return (0);
}
size_t kern_size = _get_kern_cpuset_size();
/* Kernel rejects small set, we check it here too. */
if (cpusetsize < kern_size)
return (ERANGE);
if (cpusetsize > kern_size) {
/* Kernel checks invalid bits, we check it here too. */
size_t i;
for (i = kern_size; i < cpusetsize; ++i) {
if (((const char *)cpusetp)[i])
return (EINVAL);
}
}
if (attr->cpuset == NULL) {
attr->cpuset = calloc(1, kern_size);
if (attr->cpuset == NULL)
return (errno);
attr->cpusetsize = kern_size;
}
memcpy(attr->cpuset, cpusetp, kern_size);
ret = 0;
}
return (ret);
}
__weak_reference(_pthread_attr_getaffinity_np, pthread_attr_getaffinity_np);
int
_pthread_attr_getaffinity_np(const pthread_attr_t *pattr, size_t cpusetsize,
cpuset_t *cpusetp)
{
pthread_attr_t attr;
int ret = 0;
if (pattr == NULL || (attr = (*pattr)) == NULL)
ret = EINVAL;
else {
/* Kernel rejects small set, we check it here too. */
size_t kern_size = _get_kern_cpuset_size();
if (cpusetsize < kern_size)
return (ERANGE);
if (attr->cpuset != NULL)
memcpy(cpusetp, attr->cpuset, MIN(cpusetsize,
attr->cpusetsize));
else
memset(cpusetp, -1, kern_size);
if (cpusetsize > kern_size)
memset(((char *)cpusetp) + kern_size, 0,
cpusetsize - kern_size);
}
return (ret);
}