Skip to content

L
libvirt

openeuler / libvirt

通知 3
Star 0
Fork 0
L
libvirt
切换分支/标签
查找文件 普通视图历史永久链接Permalink
formatnode.html.in 19.4 KB
Newer Older
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
1 
<?xml version="1.0" encoding="UTF-8"?>
D
docs: switch to using HTML5 doctype declaration  
Daniel P. Berrange 已提交
2 
<!DOCTYPE html>
D
Fix multiple formatting problems in HTML docs  
Daniel P. Berrange 已提交
3 
<html xmlns="http://www.w3.org/1999/xhtml">
D
Split website out into one file per page. APply new layout and styling  
Daniel P. Berrange 已提交
4 5 
  <body>
    <h1>Node devices XML format</h1>
E
docs: document node device XML  
Eric Blake 已提交
6 7 8 

    <ul id="toc"></ul>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
9 
    <h2><a id="NodedevAttributes">Node Device XML</a></h2>
E
docs: document node device XML  
Eric Blake 已提交
10 11 12 13 14 15 

    <p>
      There are several libvirt functions, all with the
      prefix <code>virNodeDevice</code>, which deal with management of
      host devices that can be handed to guests via passthrough as
      &lt;hostdev&gt; elements
P
doc: Fix reference to #elementsUSB  
Philipp Hahn 已提交
16 
      in <a href="formatdomain.html#elementsHostDev">the domain XML</a>.
E
docs: document node device XML  
Eric Blake 已提交
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 
      These devices are represented as a hierarchy, where a device on
      a bus has a parent of the bus controller device; the root of the
      hierarchy is the node named "computer".
    </p>

    <p>
      When represented in XML, a node device uses the
      top-level <code>device</code> element, with the following
      elements present according to the type of device:
    </p>
    <dl>
      <dt><code>name</code></dt>
      <dd>The name for this device.  The name will be alphanumeric,
        with words separated by underscore.  For many devices, the
        name is just the bus type and address, as in
        "pci_0000_00_02_1" or "usb_1_5_3", but some devices are able
        to provide more specific names, such as
        "net_eth1_00_27_13_6a_fe_00".
      </dd>
      <dt><code>parent</code></dt>
      <dd>If this element is present, it names the parent device (that
        is, a controller to which this node belongs).
      </dd>
M
nodedev: add <devnode> paths  
Marc-André Lureau 已提交
40 41 42 43 44 45 
      <dt><code>devnode</code></dt>
      <dd>This node appears for each associated <code>/dev</code>
      special file. A mandatory attribute <code>type</code> specify
      the kind of file path, which may be either <code>dev</code> for
      the main name, or <code>link</code> for additional symlinks.
      </dd>
E
docs: document node device XML  
Eric Blake 已提交
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 
      <dt><code>capability</code></dt>
      <dd>This node appears for each capability that libvirt
        associates with a node.  A mandatory
        attribute <code>type</code> lists which category the device
        belongs to, and controls which further subelements will be
        present to describe the node:
        <dl>
          <dt><code>system</code></dt>
          <dd>Describes the overall host.  Sub-elements include:
            <dl>
              <dt><code>product</code></dt>
              <dd>If present, a simple text string giving the product
                name of the system.</dd>
              <dt><code>hardware</code></dt>
              <dd>Describes the hardware of the system, including
                sub-elements for <code>vendor</code>, <code>version</code>,
                <code>serial</code>, and <code>uuid</code>.</dd>
              <dt><code>firmware</code></dt>
              <dd>Describes the firmware of the system, including
                sub-elements for <code>vendor</code>, <code>version</code>,
                and <code>release_date</code>.</dd>
            </dl>
          </dd>
          <dt><code>pci</code></dt>
          <dd>Describes a device on the host's PCI bus.  Sub-elements
            include:
            <dl>
N
xml: nodedev: add class info for pci capability  
Nikolay Shirokovskiy 已提交
73 
              <dt><code>class</code></dt>
N
xml: nodedev: make pci capability class element optional  
Nikolay Shirokovskiy 已提交
74 
              <dd>Optional element for combined class, subclass and
N
xml: nodedev: add class info for pci capability  
Nikolay Shirokovskiy 已提交
75 76 
                programming interface codes as 6-digit hexadecimal number.
                <span class="since">Since 5.2.0</span></dd>
E
docs: document node device XML  
Eric Blake 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 
              <dt><code>domain</code></dt>
              <dd>Which domain the device belongs to.</dd>
              <dt><code>bus</code></dt>
              <dd>Which bus within the domain.</dd>
              <dt><code>slot</code></dt>
              <dd>Which slot within the bus.</dd>
              <dt><code>function</code></dt>
              <dd>Which function within the slot.</dd>
              <dt><code>product</code></dt>
              <dd>Product details from the device ROM, including an
                attribute <code>id</code> with the hexadecimal product
                id, and an optional text description of that id.</dd>
              <dt><code>vendor</code></dt>
              <dd>Vendor details from the device ROM, including an
                attribute <code>id</code> with the hexadecimal vendor
                id, and an optional text name of that vendor.</dd>
L
nodedev: add iommuGroup to node device object  
Laine Stump 已提交
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 
              <dt><code>iommuGroup</code></dt>
              <dd>
                This optional element describes the "IOMMU group" this
                device belongs to. If the element exists, it has a
                mandatory <code>number</code> attribute which tells
                the group number used for management of the group (all
                devices in group "n" will be found in
                "/sys/kernel/iommu_groups/n"). It will also have a
                list of <code>address</code> subelements, each
                containing the PCI address of a device in the same
                group. The toplevel device will itself be included in
                this list.
              </dd>
              <dt><code>capability</code></dt>
              <dd>
                This optional element can occur multiple times. If it
                exists, it has a mandatory <code>type</code> attribute
M
nodedev: Expose PCI header type  
Martin Kletzander 已提交
110 111 
                which will be set to:
                <dl>
J
docs: Fix names for PF and VF PCI device capabilities  
Jonathon Jongsma 已提交
112 
                  <dt><code>phys_function</code></dt>
M
nodedev: Expose PCI header type  
Martin Kletzander 已提交
113 114 115 116 117 118 119 
                  <dd>
                    That means there will be a single <code>address</code>
                    subelement which contains the PCI address of the SRIOV
                    Physical Function (PF) that is the parent of this device
                    (and this device is, by implication, an SRIOV Virtual
                    Function (VF)).
                  </dd>
J
docs: Fix names for PF and VF PCI device capabilities  
Jonathon Jongsma 已提交
120 
                  <dt><code>virt_functions</code></dt>
M
nodedev: Expose PCI header type  
Martin Kletzander 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 
                  <dd>
                    In this case this device is an SRIOV PF, and the capability
                    element will have a list of <code>address</code>
                    subelements, one for each VF on this PF. If the host system
                    supports reporting it (via the "sriov_maxvfs" file in the
                    device's sysfs directory) the capability element will also
                    have an attribute named <code>maxCount</code> which is the
                    maximum number of SRIOV VFs supported by this device, which
                    could be higher than the number of VFs that are curently
                    active <span class="since">since 1.3.0</span>; in this case,
                    even if there are currently no active VFs the
                    virtual_functions capabililty will still be shown.
                  </dd>
                  <dt><code>pci-bridge</code> or <code>cardbus-bridge</code></dt>
                  <dd>
                    This shows merely that the lower 7 bits of PCI header type
                    have either value of 1 or 2 respectively.  Usually this
                    means such device cannot be used for PCI passthrough.
                    <span class="since">Since 1.3.3</span>
                  </dd>
                </dl>
L
nodedev: add iommuGroup to node device object  
Laine Stump 已提交
142 
              </dd>
M
nodedev: Export NUMA node locality for PCI devices  
Michal Privoznik 已提交
143 144 145 146 147 148 149 
              <dt><code>numa</code></dt>
              <dd>
                This optional element contains information on the PCI device
                with respect to NUMA. For example, the optional
                <code>node</code> attribute tells which NUMA node is the PCI
                device associated with.
              </dd>
M
nodedev: Introduce <pci-express/> to PCI devices  
Michal Privoznik 已提交
150 151 152 153 154 
              <dt><code>pci-express</code></dt>
              <dd>
              This optional element contains information on PCI Express part of
              the device. For example, it can contain a child element
              <code>link</code> which addresses the PCI Express device's link.
J
maint: remove incorrect apostrophes from 'its'  
Ján Tomko 已提交
155 
              While a device has its own capabilities
M
nodedev: Introduce <pci-express/> to PCI devices  
Michal Privoznik 已提交
156 157 158 159 160 161 162 163 164 
              (<code>validity='cap'</code>), the actual run time capabilities
              are negotiated on the device initialization
              (<code>validity='sta'</code>). The <code>link</code> element then
              contains three attributes: <code>port</code> which says in which
              port is the device plugged in, <code>speed</code> (in
              GigaTransfers per second) and <code>width</code> for the number
              of lanes used. Since the port can't be negotiated, it's not
              exposed in <code>./pci-express/link/[@validity='sta']</code>.
              </dd>
E
docs: document node device XML  
Eric Blake 已提交
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 
            </dl>
          </dd>
          <dt><code>usb_device</code></dt>
          <dd>Describes a device on the host's USB bus, based on its
            location within the bus.  Sub-elements include:
            <dl>
              <dt><code>bus</code></dt>
              <dd>Which bus the device belongs to.</dd>
              <dt><code>device</code></dt>
              <dd>Which device within the bus.</dd>
              <dt><code>product</code></dt>
              <dd>Product details from the device ROM, including an
                attribute <code>id</code> with the hexadecimal product
                id, and an optional text description of that id.</dd>
              <dt><code>vendor</code></dt>
              <dd>Vendor details from the device ROM, including an
                attribute <code>id</code> with the hexadecimal vendor
                id, and an optional text name of that vendor.</dd>
            </dl>
          </dd>
          <dt><code>usb</code></dt>
          <dd>Describes a USB device, based on its advertised driver
            interface.  Sub-elements include:
            <dl>
              <dt><code>number</code></dt>
              <dd>The device number.</dd>
X
docs: fix usb node device sub-element names  
Xuesong Zhang 已提交
191 
              <dt><code>class</code></dt>
E
docs: document node device XML  
Eric Blake 已提交
192 
              <dd>The device class.</dd>
X
docs: fix usb node device sub-element names  
Xuesong Zhang 已提交
193 
              <dt><code>subclass</code></dt>
E
docs: document node device XML  
Eric Blake 已提交
194 
              <dd>The device subclass.</dd>
X
docs: fix usb node device sub-element names  
Xuesong Zhang 已提交
195 
              <dt><code>protocol</code></dt>
E
docs: document node device XML  
Eric Blake 已提交
196 197 198 199 200 201 202 203 204 205 206 207 208 
              <dd>The device protocol.</dd>
              <dt><code>description</code></dt>
              <dd>If present, a description of the device.</dd>
            </dl>
          </dd>
          <dt><code>net</code></dt>
          <dd>Describes a device capable for use as a network
            interface.  Sub-elements include:
            <dl>
              <dt><code>interface</code></dt>
              <dd>The interface name tied to this device.</dd>
              <dt><code>address</code></dt>
              <dd>If present, the MAC address of the device.</dd>
M
node_device: Expose link state & speed  
Michal Privoznik 已提交
209 210 211 212 213 214 215 
              <dt><code>link</code></dt>
              <dd>Optional to reflect the status of the link. It has
                two optional attributes: <code>speed</code> in Mbits per
                second and <code>state</code> to tell the state of the
                link. So far, the whole element is just for output,
                not setting.
              </dd>
J
SRIOV NIC offload feature discovery  
James Chapman 已提交
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 
              <dt><code>feature</code></dt>
              <dd>If present, the hw offloads supported by this network
                interface. Possible features are:
                <dl>
                    <dt><code>rx</code></dt><dd>rx-checksumming</dd>
                    <dt><code>tx</code></dt><dd>tx-checksumming</dd>
                    <dt><code>sg</code></dt><dd>scatter-gather</dd>
                    <dt><code>tso</code></dt><dd>tcp-segmentation-offload</dd>
                    <dt><code>ufo</code></dt><dd>udp-fragmentation-offload</dd>
                    <dt><code>gso</code></dt><dd>generic-segmentation-offload</dd>
                    <dt><code>gro</code></dt><dd>generic-receive-offload</dd>
                    <dt><code>lro</code></dt><dd>large-receive-offload</dd>
                    <dt><code>rxvlan</code></dt><dd>rx-vlan-offload</dd>
                    <dt><code>txvlan</code></dt><dd>tx-vlan-offload</dd>
                    <dt><code>ntuple</code></dt><dd>ntuple-filters</dd>
                    <dt><code>rxhash</code></dt><dd>receive-hashing</dd>
M
nodedev: add RDMA and tx-udp_tnl-segmentation NIC capabilities  
Moshe Levi 已提交
232 233 
                    <dt><code>rdma</code></dt><dd>remote-direct-memory-access</dd>
                    <dt><code>txudptnl</code></dt><dd>tx-udp-tunnel-segmentation</dd>
E
nodedev: add switchdev to NIC capabilities  
Edan David 已提交
234 
                    <dt><code>switchdev</code></dt><dd>kernel-forward-plane-offload</dd>
J
SRIOV NIC offload feature discovery  
James Chapman 已提交
235 236 
                </dl>
              </dd>
E
docs: document node device XML  
Eric Blake 已提交
237 238 239 240 
              <dt><code>capability</code></dt>
              <dd>A network protocol exposed by the device, where the
                attribute <code>type</code> can be "80203" for IEEE
                802.3, or "80211" for various flavors of IEEE 802.11.
O
npiv: Expose fabric_name outside  
Osier Yang 已提交
241 
              </dd>
E
docs: document node device XML  
Eric Blake 已提交
242 243 244 245 246 247 248 
            </dl>
          </dd>
          <dt><code>scsi_host</code></dt>
          <dd>Describes a SCSI host device.  Sub-elements include:
            <dl>
              <dt><code>host</code></dt>
              <dd>The SCSI host number.</dd>
J
Add unique_id to nodedev output  
John Ferlan 已提交
249 250 251 252 253 254 255 256 257 258 259 
              <dt><code>unique_id</code></dt>
              <dd>On input, this optionally provides the value from the
                'unique_id' file found in the scsi_host's directory. To
                view the values of all 'unique_id' files, use <code>find -H
                /sys/class/scsi_host/host{0..9}/unique_id |
                xargs grep '[0-9]'</code>. On output, if the unique_id
                file exists, the value from the file will be displayed.
                This can be used in order to help uniquely identify the
                scsi_host adapter in a <a href="formatstorage.html">
                Storage Pool</a>. <span class="since">Since 1.2.7</span>
              </dd>
O
npiv: Expose fabric_name outside  
Osier Yang 已提交
260 261 
              <dt><code>capability</code></dt>
              <dd>Current capabilities include "vports_ops" (indicates
O
nodedev: Dump max vports and vports in use for HBA's XML  
Osier Yang 已提交
262 263 264 265 266 267 
                vport operations are supported) and "fc_host". "vport_ops"
                could contain two optional sub-elements: <code>vports</code>,
                and <code>max_vports</code>. <code>vports</code> shows the
                number of vport in use. <code>max_vports</code> shows the
                maximum vports the HBA supports. "fc_host" implies following
                sub-elements: <code>wwnn</code>, <code>wwpn</code>, and
B
nodedev: Fabric name must not be required for fc_host capability  
Boris Fiuczynski 已提交
268 
                optionally <code>fabric_wwn</code>.
O
npiv: Expose fabric_name outside  
Osier Yang 已提交
269 
              </dd>
E
docs: document node device XML  
Eric Blake 已提交
270 271 272 
            </dl>
          </dd>
          <dt><code>scsi</code></dt>
Y
Fix some typos in messages, docs and comments.  
Yuri Chornoivan 已提交
273 
          <dd>Describes a SCSI device.  Sub-elements include:
E
docs: document node device XML  
Eric Blake 已提交
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 
            <dl>
              <dt><code>host</code></dt>
              <dd>The SCSI host containing the device.</dd>
              <dt><code>bus</code></dt>
              <dd>The bus within the host.</dd>
              <dt><code>target</code></dt>
              <dd>The target within the bus.</dd>
              <dt><code>lun</code></dt>
              <dd>The lun within the target.</dd>
              <dt><code>type</code></dt>
              <dd>The type of SCSI device.</dd>
            </dl>
          </dd>
          <dt><code>storage</code></dt>
          <dd>Describes a device usable for storage.  Sub-elements
            include:
            <dl>
              <dt><code>block</code></dt>
              <dd>A block device file name that accesses the storage
                present on the device.</dd>
              <dt><code>bus</code></dt>
              <dd>If present, the name of the bus the device is found
                on.</dd>
              <dt><code>drive_type</code></dt>
              <dd>The type of the drive, such as "disk" or
                "cdrom".</dd>
              <dt><code>model</code></dt>
              <dd>Any model information available from the
                device.</dd>
              <dt><code>vendor</code></dt>
              <dd>Any vendor information available from the
                device.</dd>
              <dt><code>serial</code></dt>
              <dd>Any serial number information available from the
                device.</dd>
              <dt><code>size</code></dt>
              <dd>For fixed-size storage, the amount of storage
                available.</dd>
              <dt><code>capability</code></dt>
              <dd>If present, an additional capability is listed via
Y
Fix some typos in messages, docs and comments.  
Yuri Chornoivan 已提交
314 
                the attribute <code>type</code>.  Current capabilities
E
docs: document node device XML  
Eric Blake 已提交
315 316 317 318 319 320 321 
                include "hotpluggable" and "removable", with the
                latter implying the following
                sub-elements: <code>media_available</code> (0 or
                1), <code>media_size</code>,
                and <code>media_label</code>.</dd>
            </dl>
          </dd>
M
nodedev: add drm capability  
Marc-André Lureau 已提交
322 323 324 325 326 327 328 329 330 331 
          <dt><code>drm</code></dt>
          <dd>Describes a Direct Rendering Manager (DRM) device.
          Sub-elements include:
            <dl>
              <dt><code>type</code></dt>
              <dd>The type of DRM device. Could be
              <code>primary</code>, <code>control</code> or
              <code>render</code>.</dd>
            </dl>
          </dd>
B
virsh: nodedev: ability to filter CCW capabilities  
Bjoern Walk 已提交
332 333 334 335 336 337 338 339 340 341 342 343 
          <dt><code>ccw</code></dt>
          <dd>Describes a Command Channel Word (CCW) device commonly found on
          the S390 architecture. Sub-elements include:
            <dl>
              <dt><code>cssid</code></dt>
              <dd>The channel subsystem identifier.</dd>
              <dt><code>ssid</code></dt>
              <dd>The subchannel-set identifier.</dd>
              <dt><code>devno</code></dt>
              <dd>The device number.</dd>
            </dl>
          </dd>
E
docs: document node device XML  
Eric Blake 已提交
344 345 346 347 
        </dl>
      </dd>
    </dl>
D
docs: switch to using 'id' attribute instead of 'name' for links  
Daniel P. Berrange 已提交
348 
    <h2><a id="nodeExample">Examples</a></h2>
E
docs: document node device XML  
Eric Blake 已提交
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 

    <p>The following are some example node device XML outputs:</p>
    <pre>
&lt;device&gt;
  &lt;name&gt;computer&lt;/name&gt;
  &lt;capability type='system'&gt;
    &lt;product&gt;2241B36&lt;/product&gt;
    &lt;hardware&gt;
      &lt;vendor&gt;LENOVO&lt;/vendor&gt;
      &lt;version&gt;ThinkPad T500&lt;/version&gt;
      &lt;serial&gt;R89055N&lt;/serial&gt;
      &lt;uuid&gt;c9488981-5049-11cb-9c1c-993d0230b4cd&lt;/uuid&gt;
    &lt;/hardware&gt;
    &lt;firmware&gt;
      &lt;vendor&gt;LENOVO&lt;/vendor&gt;
      &lt;version&gt;6FET82WW (3.12 )&lt;/version&gt;
      &lt;release_date&gt;11/26/2009&lt;/release_date&gt;
    &lt;/firmware&gt;
  &lt;/capability&gt;
&lt;/device&gt;

&lt;device&gt;
  &lt;name&gt;net_eth1_00_27_13_6a_fe_00&lt;/name&gt;
  &lt;parent&gt;pci_0000_00_19_0&lt;/parent&gt;
  &lt;capability type='net'&gt;
    &lt;interface&gt;eth1&lt;/interface&gt;
    &lt;address&gt;00:27:13:6a:fe:00&lt;/address&gt;
    &lt;capability type='80203'/&gt;
  &lt;/capability&gt;
L
nodedev: add iommuGroup to node device object  
Laine Stump 已提交
378 379 380 381 382 383 384 385 386 387 
&lt;/device&gt;

&lt;device&gt;
  &lt;name&gt;pci_0000_02_00_0&lt;/name&gt;
  &lt;path&gt;/sys/devices/pci0000:00/0000:00:04.0/0000:02:00.0&lt;/path&gt;
  &lt;parent&gt;pci_0000_00_04_0&lt;/parent&gt;
  &lt;driver&gt;
    &lt;name&gt;igb&lt;/name&gt;
  &lt;/driver&gt;
  &lt;capability type='pci'&gt;
N
xml: nodedev: add class info for pci capability  
Nikolay Shirokovskiy 已提交
388 
    &lt;class&gt;0x020000&lt;/class&gt;
L
nodedev: add iommuGroup to node device object  
Laine Stump 已提交
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 
    &lt;domain&gt;0&lt;/domain&gt;
    &lt;bus&gt;2&lt;/bus&gt;
    &lt;slot&gt;0&lt;/slot&gt;
    &lt;function&gt;0&lt;/function&gt;
    &lt;product id='0x10c9'&gt;82576 Gigabit Network Connection&lt;/product&gt;
    &lt;vendor id='0x8086'&gt;Intel Corporation&lt;/vendor&gt;
    &lt;capability type='virt_functions'&gt;
      &lt;address domain='0x0000' bus='0x02' slot='0x10' function='0x0'/&gt;
      &lt;address domain='0x0000' bus='0x02' slot='0x10' function='0x2'/&gt;
      &lt;address domain='0x0000' bus='0x02' slot='0x10' function='0x4'/&gt;
      &lt;address domain='0x0000' bus='0x02' slot='0x10' function='0x6'/&gt;
      &lt;address domain='0x0000' bus='0x02' slot='0x11' function='0x0'/&gt;
      &lt;address domain='0x0000' bus='0x02' slot='0x11' function='0x2'/&gt;
      &lt;address domain='0x0000' bus='0x02' slot='0x11' function='0x4'/&gt;
    &lt;/capability&gt;
    &lt;iommuGroup number='12'&gt;
      &lt;address domain='0x0000' bus='0x02' slot='0x00' function='0x0'/&gt;
      &lt;address domain='0x0000' bus='0x02' slot='0x00' function='0x1'/&gt;
    &lt;/iommuGroup&gt;
M
nodedev: Introduce <pci-express/> to PCI devices  
Michal Privoznik 已提交
408 409 410 411 
    &lt;pci-express&gt;
      &lt;link validity='cap' port='1' speed='2.5' width='1'/&gt;
      &lt;link validity='sta' speed='2.5' width='1'/&gt;
    &lt;/pci-express&gt;
L
nodedev: add iommuGroup to node device object  
Laine Stump 已提交
412 413 414 
  &lt;/capability&gt;
&lt;/device&gt;
    </pre>
E
docs: document node device XML  
Eric Blake 已提交
415
D
Split website out into one file per page. APply new layout and styling  
Daniel P. Berrange 已提交
416 417 
  </body>
</html>