xref: /netbsd/share/man/man9/preempt.9 (revision c4a72b64)
1.\"     $NetBSD: preempt.9,v 1.2 2002/09/27 08:38:59 wiz Exp $
2.\"
3.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Gregory McGarry.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd September 21, 2002
38.Dt PREEMPT 9
39.Os
40.Sh NAME
41.Nm preempt
42.Nd general preempt function
43.Sh SYNOPSIS
44.Fd #include \*[Lt]sys/proc.h\*[Gt]
45.Fd #include \*[Lt]sys/sched.h\*[Gt]
46.Ft void
47.Fn preempt "struct proc *p"
48.Sh DESCRIPTION
49The
50.Fn preempt
51function puts the current process back on the system run queue
52and performs an involuntary context switch.
53If the specified process argument
54.Fa p
55is not
56.Dv NULL
57then a context switch is done to that process.
58Otherwise, the normal process selection criteria inside
59.Xr mi_switch 9
60is used to select the new process.
61.Pp
62The
63.Fn preempt
64function must not be called with the scheduler lock held.
65.Sh SEE ALSO
66.Xr mi_switch 9 ,
67.Xr setrunqueue 9 ,
68.Xr userret 9
69