Copyright (c) 2002 The NetBSD Foundation, Inc.
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 NetBSD Foundation nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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) 2000 Jason Evans <jasone (at] 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 as
the first lines of this file unmodified other than the possible
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.
$FreeBSD: src/lib/libpthread/man/pthread_attr.3,v 1.11 2002/09/16 19:29:28 mini Exp $
.Dd January 30, 2003 .Dt PTHREAD_ATTR 3 .Os .Sh NAME .Nm pthread_attr_init , .Nm pthread_attr_destroy , ./" .Nm pthread_attr_setstacksize , ./" .Nm pthread_attr_getstacksize , ./" .Nm pthread_attr_setguardsize , ./" .Nm pthread_attr_getguardsize , ./" .Nm pthread_attr_setstackaddr , ./" .Nm pthread_attr_getstackaddr , .Nm pthread_attr_setdetachstate , .Nm pthread_attr_getdetachstate , ./" .Nm pthread_attr_setinheritsched , ./" .Nm pthread_attr_getinheritsched , .Nm pthread_attr_setschedparam , .Nm pthread_attr_getschedparam ./" .Nm pthread_attr_setschedpolicy , ./" .Nm pthread_attr_getschedpolicy , ./" .Nm pthread_attr_setscope , ./" .Nm pthread_attr_getscope .Nd thread attribute operations .Sh LIBRARY .Lb libpthread .Sh SYNOPSIS n pthread.h .Ft int .Fn pthread_attr_init "pthread_attr_t *attr" .Ft int .Fn pthread_attr_destroy "pthread_attr_t *attr" ./" .Ft int ./" .Fn pthread_attr_setstacksize "pthread_attr_t *attr" "size_t stacksize" ./" .Ft int ./" .Fn pthread_attr_getstacksize "const pthread_attr_t *attr" "size_t *stacksize" ./" .Ft int ./" .Fn pthread_attr_setguardsize "pthread_attr_t *attr" "size_t guardsize" ./" .Ft int ./" .Fn pthread_attr_getguardsize "const pthread_attr_t *attr" "size_t *guardsize" ./" .Ft int ./" .Fn pthread_attr_setstackaddr "pthread_attr_t *attr" "void *stackaddr" ./" .Ft int ./" .Fn pthread_attr_getstackaddr "const pthread_attr_t *attr" "void **stackaddr" .Ft int .Fn pthread_attr_setdetachstate "pthread_attr_t *attr" "int detachstate" .Ft int .Fn pthread_attr_getdetachstate "const pthread_attr_t *attr" "int *detachstate" ./" .Ft int ./" .Fn pthread_attr_setinheritsched "pthread_attr_t *attr" "int inheritsched" ./" .Ft int ./" .Fn pthread_attr_getinheritsched "const pthread_attr_t *attr" "int *inheritsched" .Ft int .Fn pthread_attr_setschedparam "pthread_attr_t *attr" "const struct sched_param *param" .Ft int .Fn pthread_attr_getschedparam "const pthread_attr_t *attr" "struct sched_param *param" ./" .Ft int ./" .Fn pthread_attr_setschedpolicy "pthread_attr_t *attr" "int policy" ./" .Ft int ./" .Fn pthread_attr_getschedpolicy "const pthread_attr_t *attr" "int *policy" ./" .Ft int ./" .Fn pthread_attr_setscope "pthread_attr_t *attr" "int contentionscope" ./" .Ft int ./" .Fn pthread_attr_getscope "const pthread_attr_t *attr" "int *contentionscope" .Sh DESCRIPTION Thread attributes are used to specify parameters to .Fn pthread_create . One attribute object can be used in multiple calls to .Fn pthread_create , with or without modifications between calls.
p The .Fn pthread_attr_init function initializes .Fa attr with all the default thread attributes.
p The .Fn pthread_attr_destroy function destroys .Fa attr .
p The .Fn pthread_attr_set* functions set the attribute that corresponds to each function name.
p The .Fn pthread_attr_get* functions copy the value of the attribute that corresponds to each function name to the location pointed to by the second function parameter. .Sh RETURN VALUES If successful, these functions return 0. Otherwise, an error number is returned to indicate the error. .Sh ERRORS .Fn pthread_attr_init shall fail if: l -tag -width Er t Bq Er ENOMEM Out of memory. .El
p .Fn pthread_attr_destroy may fail if: l -tag -width Er t Bq Er EINVAL The value specified by .Fa attr is invalid. .El
p
.Fn pthread_attr_setstacksize
may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa stacksize
is less than
.Dv PTHREAD_STACK_MIN .
.El
.Pp
.Fn pthread_attr_setdetachstate
shall fail if:
l -tag -width Er t Bq Er EINVAL The value specified by
.Fa detachstate
is invalid.
.El
p
Fn pthread_attr_setinheritsched
may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.El
.Pp
.Fn pthread_attr_setschedparam
may fail if:
l -tag -width Er t Bq Er EINVAL The value specified by
.Fa attr
is invalid.
t Bq Er ENOTSUP The value specified by
.Fa param
is invalid.
.El
p
.Fn pthread_attr_setschedpolicy
may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.It Bq Er ENOTSUP
Invalid or unsupported value for
.Fa policy .
.El
.Pp
.Fn pthread_attr_setscope
may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.It Bq Er ENOTSUP
Invalid or unsupported value for
.Fa contentionscope .
.El
.Sh SEE ALSO
.Xr pthread_create 3
.Sh STANDARDS
.Fn pthread_attr_init ,
.Fn pthread_attr_destroy ,
.Fn pthread_attr_setstacksize ,
.Fn pthread_attr_getstacksize ,
.Fn pthread_attr_setstackaddr ,
.Fn pthread_attr_getstackaddr ,
.Fn pthread_attr_setdetachstate ,
.Fn pthread_attr_getdetachstate ,
.Fn pthread_attr_setinheritsched ,
.Fn pthread_attr_getinheritsched ,
.Fn pthread_attr_setschedparam ,
.Fn pthread_attr_setschedparam ,
and
.Fn pthread_attr_getschedparam
.Fn pthread_attr_setschedpolicy ,
.Fn pthread_attr_getschedpolicy ,
.Fn pthread_attr_setscope ,
and
.Fn pthread_attr_getscope
conform to
.St -p1003.1-96 .
Indexes created Tue Sep 30 20:09:53 GMT 2025