xref: /dflybsd-src/sbin/usched/usched.8 (revision 0d271772237c82a1f78d9cd6c5dcd98b3499c7a3)
193675141SSascha Wildner.\"
293675141SSascha Wildner.\" Copyright (c) 2012
393675141SSascha Wildner.\"	The DragonFly Project.  All rights reserved.
4f6d52dfbSThomas Nikolajsen.\" This code is derived from software contributed to The DragonFly Project
5f6d52dfbSThomas Nikolajsen.\" by Matthew Dillon <dillon@backplane.com> and Thomas Nikolajsen
6f6d52dfbSThomas Nikolajsen.\" <thomas.nikolajsen@mail.dk>
793675141SSascha Wildner.\"
893675141SSascha Wildner.\" Redistribution and use in source and binary forms, with or without
993675141SSascha Wildner.\" modification, are permitted provided that the following conditions
1093675141SSascha Wildner.\" are met:
1193675141SSascha Wildner.\"
1293675141SSascha Wildner.\" 1. Redistributions of source code must retain the above copyright
1393675141SSascha Wildner.\"    notice, this list of conditions and the following disclaimer.
1493675141SSascha Wildner.\" 2. Redistributions in binary form must reproduce the above copyright
1593675141SSascha Wildner.\"    notice, this list of conditions and the following disclaimer in
1693675141SSascha Wildner.\"    the documentation and/or other materials provided with the
1793675141SSascha Wildner.\"    distribution.
1893675141SSascha Wildner.\" 3. Neither the name of The DragonFly Project nor the names of its
1993675141SSascha Wildner.\"    contributors may be used to endorse or promote products derived
2093675141SSascha Wildner.\"    from this software without specific, prior written permission.
2193675141SSascha Wildner.\"
2293675141SSascha Wildner.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
2393675141SSascha Wildner.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
2493675141SSascha Wildner.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
2593675141SSascha Wildner.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
2693675141SSascha Wildner.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
2793675141SSascha Wildner.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
2893675141SSascha Wildner.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
2993675141SSascha Wildner.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
3093675141SSascha Wildner.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
3193675141SSascha Wildner.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
3293675141SSascha Wildner.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3393675141SSascha Wildner.\" SUCH DAMAGE.
3493675141SSascha Wildner.\"
35f6d52dfbSThomas Nikolajsen.Dd October 21, 2012
3693675141SSascha Wildner.Dt USCHED 8
3793675141SSascha Wildner.Os
3893675141SSascha Wildner.Sh NAME
3993675141SSascha Wildner.Nm usched
40f6d52dfbSThomas Nikolajsen.Nd run a program with a specified userland scheduler and cpumask
4193675141SSascha Wildner.Sh SYNOPSIS
4293675141SSascha Wildner.Nm
43f6d52dfbSThomas Nikolajsen.Op Fl d
44f6d52dfbSThomas Nikolajsen.Brq Ar scheduler Ns Oo Cm \&: Ns Ar cpumask Oc | Cm \&: Ns Ar cpumask
4593675141SSascha Wildner.Ar program
4693675141SSascha Wildner.Op Ar argument ...
4793675141SSascha Wildner.Sh DESCRIPTION
48f6d52dfbSThomas NikolajsenRun
4993675141SSascha Wildner.Ar program
5093675141SSascha Wildnerusing the specified userland
51f6d52dfbSThomas Nikolajsen.Ar scheduler
52f6d52dfbSThomas Nikolajsenon
53f6d52dfbSThomas Nikolajsen.Tn CPUs
54f6d52dfbSThomas Nikolajsengiven in
55f6d52dfbSThomas Nikolajsen.Ar cpumask .
563c79f8a4STomohiro KusumiIt assigns the
573c79f8a4STomohiro Kusumi.Ar program
583c79f8a4STomohiro Kusumito the
593c79f8a4STomohiro Kusumi.Tn CPU
603c79f8a4STomohiro Kusumiwith the smallest cpuid and adds the rest of the
613c79f8a4STomohiro Kusumi.Tn CPUs
623c79f8a4STomohiro Kusumito the list of available
633c79f8a4STomohiro Kusumi.Tn CPUs
643c79f8a4STomohiro Kusumifor the
653c79f8a4STomohiro Kusumi.Ar program .
66f6d52dfbSThomas NikolajsenThe userland
67f6d52dfbSThomas Nikolajsen.Ar scheduler
68f6d52dfbSThomas Nikolajsencan have value
69f6d52dfbSThomas Nikolajsen.Sq bsd4
70f6d52dfbSThomas Nikolajsenor
71f6d52dfbSThomas Nikolajsen.Sq dfly .
72f6d52dfbSThomas NikolajsenIf
73f6d52dfbSThomas Nikolajsen.Ar scheduler
74f6d52dfbSThomas Nikolajsenis not specified,
75f6d52dfbSThomas Nikolajsenuserland scheduler is inherited from parent process
76f6d52dfbSThomas Nikolajsen.Pq Nm .
77f6d52dfbSThomas Nikolajsen.Pp
78f6d52dfbSThomas NikolajsenThe following options are available:
79f6d52dfbSThomas Nikolajsen.Bl -tag -width indent
80f6d52dfbSThomas Nikolajsen.It Fl d
81f6d52dfbSThomas NikolajsenAdd debug output.
82f6d52dfbSThomas Nikolajsen.El
83f6d52dfbSThomas Nikolajsen.Pp
84f6d52dfbSThomas Nikolajsen.Nm
85f6d52dfbSThomas Nikolajsenis only usable for super user as other users cannot change
86f6d52dfbSThomas Nikolajsenuserland scheduler or cpumask.
87f6d52dfbSThomas Nikolajsen.Pp
88f6d52dfbSThomas NikolajsenSystem default userland scheduler can be changed in
89f6d52dfbSThomas Nikolajsen.Xr loader.conf 5 ,
90f6d52dfbSThomas Nikolajsensee
91f6d52dfbSThomas Nikolajsen.Xr loader 8 .
921f214455SFranco Fichtner.Sh EXIT STATUS
931f214455SFranco Fichtner.Ex -std usched
94f6d52dfbSThomas Nikolajsen.Sh EXAMPLES
95f6d52dfbSThomas NikolajsenRun
96f6d52dfbSThomas Nikolajsen.Xr sh 1
97f6d52dfbSThomas Nikolajsenusing only first 3
98f6d52dfbSThomas Nikolajsen.Tn CPUs .
99f6d52dfbSThomas Nikolajsen.Pp
100f6d52dfbSThomas Nikolajsen.Dl usched :7 sh
101f6d52dfbSThomas Nikolajsen.Pp
102f6d52dfbSThomas NikolajsenRun
103f6d52dfbSThomas Nikolajsen.Xr sh 1
104f6d52dfbSThomas Nikolajsenusing userland scheduler
105f6d52dfbSThomas Nikolajsen.Sq bsd4
106f6d52dfbSThomas Nikolajsenusing only first 4
107f6d52dfbSThomas Nikolajsen.Tn CPUs .
108f6d52dfbSThomas Nikolajsen.Pp
109f6d52dfbSThomas Nikolajsen.Dl usched bsd4:0xf sh
11093675141SSascha Wildner.Sh SEE ALSO
111f6d52dfbSThomas Nikolajsen.Xr usched_set 2 ,
112f6d52dfbSThomas Nikolajsen.Xr loader.conf 5 ,
113f6d52dfbSThomas Nikolajsen.Xr loader 8
11493675141SSascha Wildner.Sh HISTORY
11593675141SSascha WildnerThe
11693675141SSascha Wildner.Nm
11793675141SSascha Wildnerutility first appeared in
11893675141SSascha Wildner.Dx 3.1 .
119f6d52dfbSThomas Nikolajsen.Sh AUTHORS
1201cb631f7SFranco Fichtner.An Matthew Dillon Aq Mt dillon@backplane.com
1211cb631f7SFranco Fichtner.An Thomas Nikolajsen Aq Mt thomas.nikolajsen@mail.dk
122f6d52dfbSThomas Nikolajsen.Sh BUGS
123f6d52dfbSThomas NikolajsenUsing system default userland scheduler by specifying
124f6d52dfbSThomas Nikolajsen.Ar scheduler
125f6d52dfbSThomas Nikolajsenas
126f6d52dfbSThomas Nikolajsen.Sq default
127f6d52dfbSThomas Nikolajsenis not implemented.
128*0d271772STomohiro Kusumi.Pp
129*0d271772STomohiro Kusumi.Ar cpumask
130*0d271772STomohiro Kusumionly supports up to 64 CPUs due to implementation of usched.
131