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

add manpages for yamt-idlelwp branch. not enabled in the makefile yet.

This commit is contained in:
yamt 2007-02-17 16:23:08 +00:00
parent 9a8941e52a
commit 29f0b10c51
2 changed files with 153 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
share/man/man9/cpu_idle.9 Normal file
View File

@ -0,0 +1,68 @@
.\" $NetBSD: cpu_idle.9,v 1.5 2007/02/17 16:23:08 yamt Exp $
.\"
.\" Copyright (c)2007 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 February 17, 2007
.Dt CPU_IDLE 9
.Os
.\" ------------------------------------------------------------
.Sh NAME
.Nm cpu_idle
.Nd machine-dependent processor idling interface
.\" ------------------------------------------------------------
.Sh SYNOPSIS
.In sys/proc.h
.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.Ft void
.Fn cpu_idle \
"void"
.\" ------------------------------------------------------------
.Sh DESCRIPTION
.Fn cpu_idle
is called by machine-independent code when the processor has
nothing to do.
It can be used to conserve the processor power, for example.
.Pp
.Fn cpu_idle
returns as soon as possible when
.Fn cpu_need_resched
is called for the processor.
Otherwise, it returns whenever it likes.
.\" ------------------------------------------------------------
.Sh EXAMPLES
The simplest (and, in some cases, the best) implementation of
.Fn cpu_idle
is the following.
.Bd -literal
void
cpu_idle(void)
{
/* nothing */
}
.Ed
.\" ------------------------------------------------------------
.Sh SEE ALSO
.Xr intro 9

85
share/man/man9/cpu_switchto.9 Normal file
View File

@ -0,0 +1,85 @@
.\" $NetBSD: cpu_switchto.9,v 1.1 2007/02/17 16:23:08 yamt Exp $
.\"
.\" Copyright (c)2007 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 February 17, 2007
.Dt CPU_SWITCHTO 9
.Os
.\" ------------------------------------------------------------
.Sh NAME
.Nm cpu_switchto
.Nd machine-dependent LWP context switching interface
.\" ------------------------------------------------------------
.Sh SYNOPSIS
.In sys/lwp.h
.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.Ft struct lwp *
.Fn cpu_switchto \
"struct lwp *oldlwp" "struct lwp *newlwp"
.\" ------------------------------------------------------------
.Sh DESCRIPTION
.Fn cpu_switchto
saves the context of the LWP which is currenly running on the processor,
and restores the context of the LWP specified by
.Fa newlwp .
.Pp
.Fn cpu_switchto
doesn't switch address spaces.
.Fn cpu_switchto
doesn't modify
.Dv curlwp
or
.Dv curproc .
.Pp
It takes the following arguments.
.Bl -tag -width oldlwp
.It Fa oldlwp
Specify the lwp from which we are going to switch, i.e.,
the calling LWP.
If it was
.Dv NULL ,
the context of the LWP currently running on this processor is not saved.
.It Fa newlwp
Specify the lwp to which we are going to switch.
It must not be
.Dv NULL .
.El
.\" ------------------------------------------------------------
.Sh RETURN VALUES
.Fn cpu_switchto
does not return until another LWP calls
.Fn cpu_switchto
to switch to us.
It returns an lwp from which we have been switched, i.e.,
an LWP which called
.Fa cpu_switchto
to switch to us.
.\" ------------------------------------------------------------
.Sh SEE ALSO
.Xr swapcontext 3 ,
.Xr intro 9 ,
.Xr mutex 9 ,
.Xr spl 9