summaryrefslogtreecommitdiff
path: root/static/freebsd/man9/BUS_GET_CPUS.9 3.html
blob: 26bb28ba4e6e992951256e56698be6878f57927e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<table class="head">
  <tr>
    <td class="head-ltitle">BUS_GET_CPUS(9)</td>
    <td class="head-vol">Kernel Developer's Manual</td>
    <td class="head-rtitle">BUS_GET_CPUS(9)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">BUS_GET_CPUS</code>,
    <code class="Nm">bus_get_cpus</code> &#x2014; <span class="Nd">request a set
    of device-specific CPUs</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
    &lt;<a class="In">sys/param.h</a>&gt;</code>
  <br/>
  <code class="In">#include &lt;<a class="In">sys/bus.h</a>&gt;</code>
  <br/>
  <code class="In">#include &lt;<a class="In">sys/cpuset.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">BUS_GET_CPUS</code>(<var class="Fa">device_t dev</var>,
    <var class="Fa">device_t child</var>, <var class="Fa">enum cpu_sets
    op</var>, <var class="Fa">size_t setsize</var>, <var class="Fa">cpuset_t
    *cpuset</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">bus_get_cpus</code>(<var class="Fa">device_t dev</var>,
    <var class="Fa">enum cpu_sets op</var>, <var class="Fa">size_t
    setsize</var>, <var class="Fa">cpuset_t *cpuset</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The
    <a class="permalink" href="#BUS_GET_CPUS"><code class="Fn" id="BUS_GET_CPUS">BUS_GET_CPUS</code></a>()
    method queries the parent bus device for a set of device-specific CPUs. The
    <var class="Fa">op</var> argument specifies which set of CPUs to retrieve.
    If successful, the requested set of CPUs are returned in
    <var class="Fa">cpuset</var>. The <var class="Fa">setsize</var> argument
    specifies the size in bytes of the set passed in
    <var class="Fa">cpuset</var>.</p>
<p class="Pp" id="BUS_GET_CPUS~2"><a class="permalink" href="#BUS_GET_CPUS~2"><code class="Fn">BUS_GET_CPUS</code></a>()
    supports querying different types of CPU sets via the <var class="Fa">op
    argument.</var> Not all set types are supported for every device. If a set
    type is not supported, <code class="Fn">BUS_GET_CPUS</code>() fails with
    <code class="Er">EINVAL</code>. These set types are supported:</p>
<dl class="Bl-tag">
  <dt id="LOCAL_CPUS"><a class="permalink" href="#LOCAL_CPUS"><code class="Dv">LOCAL_CPUS</code></a></dt>
  <dd>The set of CPUs that are local to the device. If a device is closer to a
      specific memory domain in a non-uniform memory architecture system (NUMA),
      this will return the set of CPUs in that memory domain.</dd>
  <dt id="INTR_CPUS"><a class="permalink" href="#INTR_CPUS"><code class="Dv">INTR_CPUS</code></a></dt>
  <dd>The preferred set of CPUs that this device should use for device
      interrupts. This set type must be supported by all bus drivers.</dd>
</dl>
<p class="Pp" id="bus_get_cpus">The
    <a class="permalink" href="#bus_get_cpus"><code class="Fn">bus_get_cpus</code></a>()
    function is a simple wrapper around
  <code class="Fn">BUS_GET_CPUS</code>().</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
  VALUES</a></h1>
<p class="Pp">Zero is returned on success, otherwise an appropriate error is
    returned.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">cpuset(2)</a>, <a class="Xr">BUS_BIND_INTR(9)</a>,
    <a class="Xr">device(9)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Fn">BUS_GET_CPUS</code>() method and
    <code class="Fn">bus_get_cpus</code>() function first appeared in
    <span class="Ux">FreeBSD 11.0</span>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">March 1, 2016</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>