lib/libc/sys/usched_set.2

   1 .\" Copyright (c) 2007 The DragonFly Project.  All rights reserved.
   2 .\"
   3 .\" This code is derived from software contributed to The DragonFly Project
   4 .\" by Matthew Dillon <dillon@backplane.com>
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\"
  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
  15 .\"    distribution.
  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.
  19 .\"
  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
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .Dd October 16, 2012
  34 .Dt USCHED_SET 2
  35 .Os
  36 .Sh NAME
  37 .Nm usched_set
  38 .Nd setting up a proc's usched
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/types.h
  43 .In sys/usched.h
  44 .Ft int
  45 .Fn usched_set "pid_t pid" "int cmd" "void *data" "int bytes"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn usched_set
  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.
  53 The
  54 .Fn usched_set
  55 function requires superuser privileges for all commands except
  56 .Dv USCHED_GET_CPU .
  57 .Pp
  58 The
  59 .Fa cmd
  60 argument specifies the action for
  61 .Fn usched_set
  62 to take:
  63 .Bl -tag -width ".Dv USCHED_SET_SCHEDULER"
  64 .It Dv USCHED_SET_SCHEDULER
  65 set the user scheduler where
  66 .Fa data
  67 is a
  68 .Vt char *
  69 that contains the name of the user scheduler.
  70 .It Dv USCHED_SET_CPU
  71 assign the LWP to the cpuid pointed to by
  72 .Fa data .
  73 .It Dv USCHED_GET_CPU
  74 copy the LWP's CPU ID to the cpuid pointed to by
  75 .Fa data .
  76 .It Dv USCHED_ADD_CPU
  77 add the cpuid specified by
  78 .Fa data
  79 to the list of available CPUs for the LWP.
  80 .It Dv USCHED_DEL_CPU
  81 remove the cpuid specified by
  82 .Fa data
  83 from the list of available CPUs for the LWP.
  84 .El
  85 .Sh RETURN VALUES
  86 .Rv -std
  87 .Sh ERRORS
  88 The function will fail if:
  89 .Bl -tag -width Er
  90 .It Bq Er EINVAL
  91 The user scheduler to set is not in the list of available user schedulers.
  92 The
  93 .Fa bytes
  94 argument is not the correct size
  95 .Vt ( int )
  96 for a cpuid.
  97 The specified cpuid is not set in
  98 .Va smp_active_mask .
  99 .Fa Cmd
 100 contains an unknown value.
 101 .It Bq Er EFBIG
 102 The specified cpuid is not a valid cpuid for the system.
 103 .It Bq Er EPERM
 104 Deleting the specified cpuid leaves the LWP without a CPU to run on.
 105 .El
 106 .Sh SEE ALSO
 107 .Xr usched 8
 108 .Sh HISTORY
 109 The
 110 .Fn usched_set
 111 function call was added in
 112 .Dx 1.9 .
 113 .Sh AUTHORS
 114 .An -nosplit
 115 The
 116 .Fn usched_set
 117 system call was written by
 118 .An Matt Dillon .
 119 This manual page was written by
 120 .An Joe Talbott .
 121 .Sh BUGS
 122 Only
 123 .Fa pid
 124 equals current LWP PID or 0 is implemented.
 125 The current LWP PID is used for
 126 .Fa pid
 127 when
 128 .Fa pid
 129 is 0.