[src/trunk]: src/lib/libpthread Split pthread_attr_getschedparam() and pthrea...

[jruoho <jruoho%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/c2b1248f6f24
branches:  trunk
changeset: 756159:c2b1248f6f24
user:      jruoho <jruoho%NetBSD.org@localhost>
date:      Wed Jul 07 16:04:19 2010 +0000

description:
Split pthread_attr_getschedparam() and pthread_attr_setschedparam() to a
separate page.

diffstat:

 lib/libpthread/Makefile                     |   6 +-
 lib/libpthread/pthread_attr.3               |  25 +--------
 lib/libpthread/pthread_attr_getschedparam.3 |  86 +++++++++++++++++++++++++++++
 3 files changed, 90 insertions(+), 27 deletions(-)

diffs (183 lines):

diff -r b77ab59c058a -r c2b1248f6f24 lib/libpthread/Makefile
--- a/lib/libpthread/Makefile   Wed Jul 07 15:30:32 2010 +0000
+++ b/lib/libpthread/Makefile   Wed Jul 07 16:04:19 2010 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.63 2010/07/07 15:30:32 jruoho Exp $
+#      $NetBSD: Makefile,v 1.64 2010/07/07 16:04:19 jruoho Exp $
 #
 
 WARNS= 4
@@ -94,6 +94,7 @@
        pthread_attr_getguardsize.3 \
        pthread_attr_getinheritsched.3 \
        pthread_attr_getname_np.3 \
+       pthread_attr_getschedparam.3 \
        pthread_attr_getscope.3 \
        pthread_attr_getstack.3 \
        pthread_attr_setcreatesuspend_np.3 \
@@ -124,14 +125,13 @@
 
 MLINKS+=       pthread_attr.3 pthread_attr_init.3
 MLINKS+=       pthread_attr.3 pthread_attr_destroy.3
-MLINKS+=       pthread_attr.3 pthread_attr_setschedparam.3
-MLINKS+=       pthread_attr.3 pthread_attr_getschedparam.3
 MLINKS+=       pthread_attr.3 pthread_attr_setschedpolicy.3
 MLINKS+=       pthread_attr.3 pthread_attr_getschedpolicy.3
 
 MLINKS+=       pthread_attr_getdetachstate.3 pthread_attr_setdetachstate.3
 MLINKS+=       pthread_attr_getguardsize.3 pthread_attr_setguardsize.3
 MLINKS+=       pthread_attr_getinheritsched.3 pthread_attr_setinheritsched.3
+MLINKS+=       pthread_attr_getschedparam.3 pthread_attr_setschedparam.3
 MLINKS+=       pthread_attr_getscope.3 pthread_attr_setscope.3
 MLINKS+=       pthread_attr_getstack.3 pthread_attr_setstack.3 \
                pthread_attr_getstack.3 pthread_attr_getstacksize.3 \
diff -r b77ab59c058a -r c2b1248f6f24 lib/libpthread/pthread_attr.3
--- a/lib/libpthread/pthread_attr.3     Wed Jul 07 15:30:32 2010 +0000
+++ b/lib/libpthread/pthread_attr.3     Wed Jul 07 16:04:19 2010 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: pthread_attr.3,v 1.16 2010/07/07 15:30:32 jruoho Exp $
+.\"    $NetBSD: pthread_attr.3,v 1.17 2010/07/07 16:04:19 jruoho Exp $
 .\"
 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -59,8 +59,6 @@
 .Sh NAME
 .Nm pthread_attr_init ,
 .Nm pthread_attr_destroy ,
-.Nm pthread_attr_setschedparam ,
-.Nm pthread_attr_getschedparam
 .Nm pthread_attr_setschedpolicy ,
 .Nm pthread_attr_getschedpolicy
 .Nd thread attribute operations
@@ -73,10 +71,6 @@
 .Ft int
 .Fn pthread_attr_destroy "pthread_attr_t *attr"
 .Ft int
-.Fn pthread_attr_setschedparam "pthread_attr_t * restrict attr" "const struct sched_param * restrict param"
-.Ft int
-.Fn pthread_attr_getschedparam "const pthread_attr_t * restrict attr" "struct sched_param * restrict param"
-.Ft int
 .Fn pthread_attr_setschedpolicy "pthread_attr_t *attr" "int policy"
 .Ft int
 .Fn pthread_attr_getschedpolicy "const pthread_attr_t * restrict attr" "int * restrict policy"
@@ -126,19 +120,6 @@
 is invalid.
 .El
 .Pp
-.Fn pthread_attr_setschedparam
-may fail if:
-.Bl -tag -width Er
-.It Bq Er EINVAL
-The value specified by
-.Fa attr
-is invalid.
-.It Bq Er ENOTSUP
-The value specified by
-.Fa param
-is invalid.
-.El
-.Pp
 .Fn pthread_attr_setschedpolicy
 may fail if:
 .Bl -tag -width Er
@@ -155,10 +136,6 @@
 .Sh STANDARDS
 .Fn pthread_attr_init ,
 .Fn pthread_attr_destroy ,
-.Fn pthread_attr_setschedparam ,
-.Fn pthread_attr_setschedparam ,
-and
-.Fn pthread_attr_getschedparam
 .Fn pthread_attr_setschedpolicy ,
 and
 .Fn pthread_attr_getschedpolicy
diff -r b77ab59c058a -r c2b1248f6f24 lib/libpthread/pthread_attr_getschedparam.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpthread/pthread_attr_getschedparam.3       Wed Jul 07 16:04:19 2010 +0000
@@ -0,0 +1,86 @@
+.\"    $NetBSD: pthread_attr_getschedparam.3,v 1.1 2010/07/07 16:04:19 jruoho Exp $
+.\"
+.\" Copyright (c) 2010 Jukka Ruohonen <jruohonen%iki.fi@localhost>
+.\" 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.
+.\"
+.\" 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.
+.\"
+.Dd July 7, 2010
+.Dt PTHREAD_ATTR_GETSCHEDPARAM 3
+.Os
+.Sh NAME
+.Nm pthread_attr_getschedparam
+.Nd get and set scheduling parameter attribute
+.Sh LIBRARY
+.Lb libpthread
+.Sh SYNOPSIS
+.In pthread.h
+.Ft int
+.Fn pthread_attr_getschedparam \
+"const pthread_attr_t * restrict attr" "struct sched_param * restrict param"
+.Ft int
+.Fn pthread_attr_setschedparam \
+"pthread_attr_t *attr" "const struct sched_param *param"
+.Sh DESCRIPTION
+The
+.Fn pthread_attr_getschedparam
+and
+.Fn pthread_attr_setschedparam
+functions obtain and set the scheduling parameter attribute in the
+.Fa attr
+object.
+The
+.Vt sched_param
+structure is defined in
+.In sched.h .
+At minimum this structure contains only a single member,
+.Vt sched_priority .
+Refer to
+.Xr pthread_schedparam 3
+and
+.Xr sched 3
+for additional details.
+.Sh RETURN VALUES
+If successful, both functions return 0.
+Otherwise, an error number is returned to indicate the error.
+.Sh ERRORS
+Both functions may fail if:
+.Bl -tag -width Er
+.It Bq Er EINVAL
+An invalid parameter was specified.
+.El
+.Pp
+The
+.Fn pthread_attr_setschedparam
+function may also fail if:
+.Bl -tag -width Er
+.It Bq Er ENOMEM
+There was insufficient memory.
+.El
+.Sh SEE ALSO
+.Xr pthread_attr 3 ,
+.Xr pthread_schedparam 3 ,
+.Xr sched 3
+.Sh STANDARDS
+Both functions conform to
+.St -p1003.1-2008 .