1 .\" Copyright (c) 2007 The DragonFly Project. All rights reserved.
3 .\" This code is derived from software contributed to The DragonFly Project
4 .\" by Matthew Dillon <dillon@backplane.com>
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in
14 .\" the documentation and/or other materials provided with the
16 .\" 3. Neither the name of The DragonFly Project nor the names of its
17 .\" contributors may be used to endorse or promote products derived
18 .\" from this software without specific, prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 .Nd setting up a proc's usched
45 .Fn usched_set "pid_t pid" "int cmd" "void *data" "int bytes"
49 function is used to perform several user scheduler tasks.
50 These tasks include: setting the user scheduler, assigning an LWP to a
51 specific CPU, adding a CPU to the available CPUs for an LWP,
52 and removing a CPU from the list of available CPUs for an LWP.
55 function requires superuser privileges for all commands except
58 .Dv USCHED_GET_CPUMASK .
62 argument specifies the action for
65 .Bl -tag -width ".Dv USCHED_SET_SCHEDULER"
66 .It Dv USCHED_SET_SCHEDULER
67 set the user scheduler where
71 that contains the name of the user scheduler.
73 assign the LWP to the cpuid pointed to by
76 copy the LWP's CPU ID to the cpuid pointed to by
78 .It Dv USCHED_GET_CPUMASK
79 copy the LWP's CPU mask to the cpumask_t type pointed to by
81 .It Dv USCHED_SET_CPUMASK
82 set the LWP's CPU mask to the cpumask_t type pointed to by
85 add the cpuid specified by
87 to the list of available CPUs for the LWP.
89 remove the cpuid specified by
91 from the list of available CPUs for the LWP.
96 The function will fail if:
99 The user scheduler to set is not in the list of available user schedulers.
102 argument is not the correct size
105 The specified cpuid is not set in
106 .Va smp_active_mask .
108 contains an unknown value.
110 The specified cpuid is not a valid cpuid for the system.
112 Deleting the specified cpuid leaves the LWP without a CPU to run on.
119 function call was added in
125 system call was written by
127 This manual page was written by
132 equals current LWP PID or 0 is implemented.
133 The current LWP PID is used for
138 One would normally only use 0 for