share/man/man9/BUS_GET_CPUS.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2016 John H. Baldwin <jhb@FreeBSD.org>
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd March 1, 2016
  29 .Dt BUS_GET_CPUS 9
  30 .Os
  31 .Sh NAME
  32 .Nm BUS_GET_CPUS ,
  33 .Nm bus_get_cpus
  34 .Nd "request a set of device-specific CPUs"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/bus.h
  38 .In sys/cpuset.h
  39 .Ft int
  40 .Fo BUS_GET_CPUS
  41 .Fa "device_t dev" "device_t child" "enum cpu_sets op" "size_t setsize"
  42 .Fa "cpuset_t *cpuset"
  43 .Fc
  44 .Ft int
  45 .Fo bus_get_cpus
  46 .Fa "device_t dev" "enum cpu_sets op" "size_t setsize" "cpuset_t *cpuset"
  47 .Fc
  48 .Sh DESCRIPTION
  49 The
  50 .Fn BUS_GET_CPUS
  51 method queries the parent bus device for a set of device-specific CPUs.
  52 The
  53 .Fa op
  54 argument specifies which set of CPUs to retrieve.
  55 If successful,
  56 the requested set of CPUs are returned in
  57 .Fa cpuset .
  58 The
  59 .Fa setsize
  60 argument specifies the size in bytes of the set passed in
  61 .Fa cpuset .
  62 .Pp
  63 .Fn BUS_GET_CPUS
  64 supports querying different types of CPU sets via the
  65 .Fa op argument.
  66 Not all set types are supported for every device.
  67 If a set type is not supported,
  68 .Fn BUS_GET_CPUS
  69 fails with
  70 .Er EINVAL .
  71 These set types are supported:
  72 .Bl -tag -width ".Dv LOCAL_CPUS"
  73 .It Dv LOCAL_CPUS
  74 The set of CPUs that are local to the device.
  75 If a device is closer to a specific memory domain in a non-uniform memory
  76 architecture system
  77 .Pq NUMA ,
  78 this will return the set of CPUs in that memory domain.
  79 .It Dv INTR_CPUS
  80 The preferred set of CPUs that this device should use for device interrupts.
  81 This set type must be supported by all bus drivers.
  82 .El
  83 .Pp
  84 The
  85 .Fn bus_get_cpus
  86 function is a simple wrapper around
  87 .Fn BUS_GET_CPUS .
  88 .Sh RETURN VALUES
  89 Zero is returned on success, otherwise an appropriate error is returned.
  90 .Sh SEE ALSO
  91 .Xr cpuset 2 ,
  92 .Xr BUS_BIND_INTR 9 ,
  93 .Xr device 9
  94 .Sh HISTORY
  95 The
  96 .Fn BUS_GET_CPUS
  97 method and
  98 .Fn bus_get_cpus
  99 function first appeared in
 100 .Fx 11.0 .