share/man/man9/BUS_GET_CPUS.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2016 John H. Baldwin <jhb@FreeBSD.org>
   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 .\" $FreeBSD$
  28 .\"
  29 .Dd March 1, 2016
  30 .Dt BUS_GET_CPUS 9
  31 .Os
  32 .Sh NAME
  33 .Nm BUS_GET_CPUS ,
  34 .Nm bus_get_cpus
  35 .Nd "request a set of device-specific CPUs"
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/bus.h
  39 .In sys/cpuset.h
  40 .Ft int
  41 .Fo BUS_GET_CPUS
  42 .Fa "device_t dev" "device_t child" "enum cpu_sets op" "size_t setsize"
  43 .Fa "cpuset_t *cpuset"
  44 .Fc
  45 .Ft int
  46 .Fo bus_get_cpus
  47 .Fa "device_t dev" "enum cpu_sets op" "size_t setsize" "cpuset_t *cpuset"
  48 .Fc
  49 .Sh DESCRIPTION
  50 The
  51 .Fn BUS_GET_CPUS
  52 method queries the parent bus device for a set of device-specific CPUs.
  53 The
  54 .Fa op
  55 argument specifies which set of CPUs to retrieve.
  56 If successful,
  57 the requested set of CPUs are returned in
  58 .Fa cpuset .
  59 The
  60 .Fa setsize
  61 argument specifies the size in bytes of the set passed in
  62 .Fa cpuset .
  63 .Pp
  64 .Fn BUS_GET_CPUS
  65 supports querying different types of CPU sets via the
  66 .Fa op argument.
  67 Not all set types are supported for every device.
  68 If a set type is not supported,
  69 .Fn BUS_GET_CPUS
  70 fails with
  71 .Er EINVAL .
  72 These set types are supported:
  73 .Bl -tag -width ".Dv LOCAL_CPUS"
  74 .It Dv LOCAL_CPUS
  75 The set of CPUs that are local to the device.
  76 If a device is closer to a specific memory domain in a non-uniform memory
  77 architecture system
  78 .Pq NUMA ,
  79 this will return the set of CPUs in that memory domain.
  80 .It Dv INTR_CPUS
  81 The preferred set of CPUs that this device should use for device interrupts.
  82 This set type must be supported by all bus drivers.
  83 .El
  84 .Pp
  85 The
  86 .Fn bus_get_cpus
  87 function is a simple wrapper around
  88 .Fn BUS_GET_CPUS .
  89 .Sh RETURN VALUES
  90 Zero is returned on success, otherwise an appropriate error is returned.
  91 .Sh SEE ALSO
  92 .Xr cpuset 2 ,
  93 .Xr BUS_BIND_INTR 9 ,
  94 .Xr device 9
  95 .Sh HISTORY
  96 The
  97 .Fn BUS_GET_CPUS
  98 method and
  99 .Fn bus_get_cpus
 100 function first appeared in
 101 .Fx 11.0 .