share/man/man9/cpu_need_resched.9

   1 .\"     $NetBSD: cpu_need_resched.9,v 1.6 2008/04/30 13:10:58 martin 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 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd May 18, 2007
  31 .Dt CPU_NEED_RESCHED 9
  32 .Os
  33 .Sh NAME
  34 .Nm cpu_need_resched
  35 .Nd context switch notification
  36 .Sh SYNOPSIS
  37 .In sys/cpu.h
  38 .Ft void
  39 .Fn cpu_need_resched "struct cpu_info *ci" "int flags"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn cpu_need_resched
  43 function is the machine-independent interface for the scheduler to
  44 notify machine-dependent code that a context switch from the current
  45 LWP, on the cpu
  46 .Fa ci ,
  47 is required.
  48 This event may occur if a higher priority LWP appears on the run
  49 queue or if the current LWP has exceeded its time slice.
  50 .Pp
  51 If
  52 .Dv RESCHED_IMMED
  53 flag is specified in
  54 .Fa flags ,
  55 machine-dependent code should make a context switch happen as soon as possible.
  56 In that case, for example, if
  57 .Fa ci
  58 is not the current processor,
  59 .Fn cpu_need_resched
  60 typically issues an inter processor call to the processor to make it
  61 notice the need of a context switch as soon as possible.
  62 .Sh EXAMPLES
  63 Specifically, the
  64 .Fn cpu_need_resched
  65 function will perform the following operations:
  66 .Bl -bullet -offset indent
  67 .It
  68 Set a per-processor flag which is checked by
  69 .Xr userret 9
  70 when returning to user-mode execution.
  71 .It
  72 Post an asynchronous software trap (AST).
  73 .It
  74 Send an inter processor interrupt to wake up
  75 .Fn cpu_idle .
  76 .El
  77 .Sh SEE ALSO
  78 .Xr sched_4bsd 9 ,
  79 .Xr userret 9