sbin/usched/usched.8

   1 .\"
   2 .\" Copyright (c) 2012
   3 .\"     The DragonFly Project.  All rights reserved.
   4 .\" This code is derived from software contributed to The DragonFly Project
   5 .\" by Matthew Dillon <dillon@backplane.com> and Thomas Nikolajsen
   6 .\" <thomas.nikolajsen@mail.dk>
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\"
  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
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\" 3. Neither the name of The DragonFly Project nor the names of its
  19 .\"    contributors may be used to endorse or promote products derived
  20 .\"    from this software without specific, prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  26 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  29 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  30 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  31 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  32 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .Dd October 21, 2012
  36 .Dt USCHED 8
  37 .Os
  38 .Sh NAME
  39 .Nm usched
  40 .Nd run a program with a specified userland scheduler and cpumask
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl d
  44 .Brq Ar scheduler Ns Oo Cm \&: Ns Ar cpumask Oc | Cm \&: Ns Ar cpumask
  45 .Ar program
  46 .Op Ar argument ...
  47 .Sh DESCRIPTION
  48 Run
  49 .Ar program
  50 using the specified userland
  51 .Ar scheduler
  52 on
  53 .Tn CPUs
  54 given in
  55 .Ar cpumask .
  56 The userland
  57 .Ar scheduler
  58 can have value
  59 .Sq bsd4
  60 or
  61 .Sq dfly .
  62 If
  63 .Ar scheduler
  64 is not specified,
  65 userland scheduler is inherited from parent process
  66 .Pq Nm .
  67 .Pp
  68 The following options are available:
  69 .Bl -tag -width indent
  70 .It Fl d
  71 Add debug output.
  72 .El
  73 .Pp
  74 .Nm
  75 is only usable for super user as other users cannot change
  76 userland scheduler or cpumask.
  77 .Pp
  78 System default userland scheduler can be changed in
  79 .Xr loader.conf 5 ,
  80 see
  81 .Xr loader 8 .
  82 .Sh EXAMPLES
  83 Run
  84 .Xr sh 1
  85 using only first 3
  86 .Tn CPUs .
  87 .Pp
  88 .Dl usched :7 sh
  89 .Pp
  90 Run
  91 .Xr sh 1
  92 using userland scheduler
  93 .Sq bsd4
  94 using only first 4
  95 .Tn CPUs .
  96 .Pp
  97 .Dl usched bsd4:0xf sh
  98 .Sh EXIT STATUS
  99 .Ex -std usched
 100 .Sh SEE ALSO
 101 .Xr usched_set 2 ,
 102 .Xr loader.conf 5 ,
 103 .Xr loader 8
 104 .Sh HISTORY
 105 The
 106 .Nm
 107 utility first appeared in
 108 .Dx 3.1 .
 109 .Sh AUTHORS
 110 .An Matthew Dillon Aq dillon@backplane.com
 111 and
 112 .An Thomas Nikolajsen Aq thomas.nikolajsen@mail.dk
 113 .Sh BUGS
 114 Using system default userland scheduler by specifying
 115 .Ar scheduler
 116 as
 117 .Sq default
 118 is not implemented.