Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

document sched_yield.

This commit is contained in:
yamt 2004-12-14 01:47:13 +00:00
parent 4b2ab8e45f
commit e19f3f9976
2 changed files with 66 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/libpthread/Makefile
View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.28 2004/12/10 16:40:40 nathanw Exp $
# $NetBSD: Makefile,v 1.29 2004/12/14 01:47:13 yamt Exp $
#
WARNS= 2
@ -99,7 +99,8 @@ MAN+= pthread.3 \
pthread_schedparam.3 pthread_self.3 \
pthread_setspecific.3 pthread_sigmask.3 pthread_spin_destroy.3 \
pthread_spin_init.3 pthread_spin_lock.3 pthread_spin_unlock.3 \
pthread_suspend_np.3 pthread_testcancel.3
pthread_suspend_np.3 pthread_testcancel.3 \
sched_yield.3
MLINKS+= pthread_attr.3 pthread_attr_init.3
MLINKS+= pthread_attr.3 pthread_attr_destroy.3

63
lib/libpthread/sched_yield.3 Normal file
View File

@ -0,0 +1,63 @@
.\" $NetBSD: sched_yield.3,v 1.1 2004/12/14 01:47:13 yamt Exp $
.\"
.\" Copyright (c)2004 YAMAMOTO Takashi,
.\" 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 AUTHOR 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.
.\"
.\" ------------------------------------------------------------
.Dd December 14, 2004
.Dt SCHED_YIELD 3
.Os
.Sh NAME
.Nm sched_yield
.Nd yield a processor
.\" ------------------------------------------------------------
.Sh LIBRARY
.Lb libc
.\" ------------------------------------------------------------
.Sh SYNOPSIS
.In sched.h
.Ft int
.Fn sched_yield
.\" ------------------------------------------------------------
.Sh DESCRIPTION
.Fn sched_yield
yields a processor voluntarily and gives other threads a chance
to run without waiting involuntary preemptive switch.
.\" ------------------------------------------------------------
.Sh RETURN VALUES
On success,
.Fn sched_yield
returns zero.
Otherwise, a value of \-1 is returned and
.Va errno
is set to indicate the error.
.\" ------------------------------------------------------------
.Sh SEE ALSO
.Xr pthread 3
.\" ------------------------------------------------------------
.Sh CAVEATS
This implementation of
.Fn sched_yield
gives processor to threads which belong to the same process.
In other words, it's no-op in a single threaded application.