lib/libc/sys/sa_setconcurrency.2

   1 .\"     $NetBSD: sa_setconcurrency.2,v 1.4 2005/09/05 21:57:35 yamt Exp $
   2 .\"
   3 .\" Copyright (c)2004 YAMAMOTO Takashi,
   4 .\" All rights reserved.
   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 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" ------------------------------------------------------------
  28 .Dd September 6, 2005
  29 .Dt SA_CONCURRENCY 2
  30 .Os
  31 .Sh NAME
  32 .Nm sa_setconcurrency
  33 .Nd increase the number of virtual processors
  34 .\" ------------------------------------------------------------
  35 .Sh LIBRARY
  36 .Lb libc
  37 .\" ------------------------------------------------------------
  38 .Sh SYNOPSIS
  39 .In sa.h
  40 .Ft int
  41 .Fn sa_setconcurrency \
  42     "int concurrency"
  43 .\" ------------------------------------------------------------
  44 .Sh DESCRIPTION
  45 .Fn sa_setconcurrency
  46 is used to increase the number of scheduler activation virtual processors
  47 used by the process.
  48 .Fn sa_setconcurrency
  49 increases the number of virtual processors, i.e., execution concurrency,
  50 up to
  51 .Fa concurrency .
  52 However,
  53 .Fn sa_setconcurrency
  54 won't try to allocate more virtual processors than there are physical
  55 processors on the system.
  56 .Pp
  57 Scheduler activation should be enabled by
  58 .Fn sa_enable
  59 beforehand.
  60 .\" ------------------------------------------------------------
  61 .Sh RETURN VALUES
  62 On success,
  63 .Fn sa_setconcurrency
  64 returns the number of newly added virtual processors.
  65 Otherwise, a value of \-1 is returned and
  66 .Va errno
  67 is set to indicate the error.
  68 .\" ------------------------------------------------------------
  69 .Sh SEE ALSO
  70 .Xr pthread 3