Skip to content

L
libvirt

openeuler / libvirt

通知 3
Star 0
Fork 0
L
libvirt

体验新版 GitCode，发现更多精彩内容 >>

切换分支/标签
查找文件 普通视图历史永久链接Permalink
formatdomaincaps.html.in 10.4 KB
Newer Older
M
Introduce domain_capabilities  
Michal Privoznik 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <body>
    <h1>Domain capabilities XML format</h1>

    <ul id="toc"></ul>

    <h2><a name="Overview">Overview</a></h2>

    <p>Sometimes, when a new domain is to be created it may come handy to know
    the capabilities of the hypervisor so the correct combination of devices and
    drivers is used. For example, when management application is considering the
    mode for a host device's passthrough there are several options depending not
    only on host, but on hypervisor in question too. If the hypervisor is qemu
    then it needs to be more recent to support VFIO, while legacy KVM is
    achievable just fine with older qemus.</p>
M
docs: Correct invalid hyperlinks  
Martin Kletzander 已提交
19 20 21 22 23 24 25 26 
    <p>The main difference between
      <a href="/html/libvirt-libvirt-host.html#virConnectGetCapabilities">
        <code>virConnectGetCapabilities</code>
      </a>
    and the emulator capabilities API is, the former one aims more on
    the host capabilities (e.g.  NUMA topology, security models in
    effect, etc.) while the latter one specializes on the hypervisor
    capabilities.</p>
M
Introduce domain_capabilities  
Michal Privoznik 已提交
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 

    <p>While the <a href="formatcaps.html">Driver Capabilities</a> provides the
    host capabilities (e.g NUMA topology, security models in effect, etc.), the
    Domain Capabilities provides the hypervisor specific capabilities for
    Management Applications to query and make decisions regarding what to
    utilize.</p>

    <p>The Domain Capabilities can provide information such as the correct
    combination of devices and drivers that are supported. Knowing which host
    and hypervisor specific options are available or supported would allow the
    management application to choose an appropriate mode for a pass-through
    host device as well as which adapter to utilize.</p>

    <h2><a name="elements">Element and attribute overview</a></h2>

    <p> A new query interface was added to the virConnect API's to retrieve the
    XML listing of the set of domain capabilities (<span class="since">Since
    1.2.7</span>):</p>

<pre>
M
formatdomaincaps: Correctly format API reference  
Michal Privoznik 已提交
47 
<a href="/html/libvirt-libvirt-domain.html#virConnectGetDomainCapabilities">virConnectGetDomainCapabilities</a>
M
Introduce domain_capabilities  
Michal Privoznik 已提交
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 89 90 91 92 93 94 95 96 97 98 
</pre>

    <p>The root element that emulator capability XML document starts with has
    name <code>domainCapabilities</code>. It contains at least four direct
    child elements:</p>

<pre>
&lt;domainCapabilities&gt;
  &lt;path&gt;/usr/bin/qemu-system-x86_64&lt;/path&gt;
  &lt;domain&gt;kvm&lt;/domain&gt;
  &lt;machine&gt;pc-i440fx-2.1&lt;/machine&gt;
  &lt;arch&gt;x86_64&lt;/arch&gt;
  ...
&lt;/domainCapabilities&gt;
</pre>
    <dl>
      <dt>path</dt>
      <dd>The full path to the emulator binary.</dd>

      <dt>domain</dt>
      <dd>Describes the <a href="formatdomain.html#elements">virtualization
          type</a> (or so called domain type).</dd>

      <dt>machine</dt>
      <dd>The domain's <a href="formatdomain.html#elementsOSBIOS">machine
          type</a>.</dd>

      <dt>arch</dt>
      <dd>The domain's <a href="formatdomain.html#elementsOSBIOS">
          architecture</a>.</dd>

    </dl>

    <h3><a name="elementsCPUAllocation">CPU Allocation</a></h3>

    <p>Before any devices capability occurs, there might be a info on domain
    wide capabilities, e.g. virtual CPUs:</p>

<pre>
&lt;domainCapabilities&gt;
  ...
  &lt;vcpu max='255'/&gt;
  ...
&lt;/domainCapabilities&gt;
</pre>

    <dl>
      <dt>vcpu</dt>
      <dd>The maximum number of supported virtual CPUs</dd>
    </dl>
M
domaincaps: Expose UEFI capability  
Michal Privoznik 已提交
99 100 101 102 103 104 105 106 107 108 109 110 
    <h3><a name="elementsOSBIOS">BIOS bootloader</a></h3>

    <p>Sometimes users might want to tweak some BIOS knobs or use
    UEFI. For cases like that, <a
    href="formatdomain.html#elementsOSBIOS"><code>os</code></a>
    element exposes what values can be passed to its children.</p>

<pre>
&lt;domainCapabilities&gt;
  ...
  &lt;os supported='yes'&gt;
    &lt;loader supported='yes'&gt;
M
domaincaps: Expose UEFI binary path, if it exists  
Michal Privoznik 已提交
111 
      &lt;value&gt;/usr/share/OVMF/OVMF_CODE.fd&lt;/value&gt;
M
domaincaps: Expose UEFI capability  
Michal Privoznik 已提交
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 
      &lt;enum name='type'&gt;
        &lt;value&gt;rom&lt;/value&gt;
        &lt;value&gt;pflash&lt;/value&gt;
      &lt;/enum&gt;
      &lt;enum name='readonly'&gt;
        &lt;value&gt;yes&lt;/value&gt;
        &lt;value&gt;no&lt;/value&gt;
      &lt;/enum&gt;
    &lt;/loader&gt;
  &lt;/os&gt;
  ...
&lt;domainCapabilities&gt;
</pre>

    <p>For the <code>loader</code> element, the following can occur:</p>

    <dl>
M
domaincaps: Expose UEFI binary path, if it exists  
Michal Privoznik 已提交
129 130 131 132 133 
      <dt>value</dt>
      <dd>List of known loader paths. Currently this is only used
      to advertise known locations of OVMF binaries for qemu. Binaries
      will only be listed if they actually exist on disk.</dd>
M
domaincaps: Expose UEFI capability  
Michal Privoznik 已提交
134 135 136 137 138 139 140 141 142 143 144 
      <dt>type</dt>
      <dd>Whether loader is a typical BIOS (<code>rom</code>) or
      an UEFI binary (<code>pflash</code>). This refers to
      <code>type</code> attribute of the &lt;loader/&gt;
      element.</dd>

      <dt>readonly</dt>
      <dd>Options for the <code>readonly</code> attribute of the
      &lt;loader/&gt; element.</dd>
    </dl>
M
Introduce domain_capabilities  
Michal Privoznik 已提交
145 146 147 
    <h3><a name="elementsDevices">Devices</a></h3>

    <p>
A
docs: Document the new XML elements  
Andrea Bolognani 已提交
148 
      Another set of XML elements describe the supported devices and their
M
Introduce domain_capabilities  
Michal Privoznik 已提交
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 
      capabilities. All devices occur as children of the main
      <code>devices</code> element.
    </p>

<pre>
&lt;domainCapabilities&gt;
  ...
  &lt;devices&gt;
    &lt;disk supported='yes'&gt;
      &lt;enum name='diskDevice'&gt;
        &lt;value&gt;disk&lt;/value&gt;
        &lt;value&gt;cdrom&lt;/value&gt;
        &lt;value&gt;floppy&lt;/value&gt;
        &lt;value&gt;lun&lt;/value&gt;
      &lt;/enum&gt;
      ...
    &lt;/disk&gt;
    &lt;hostdev supported='no'/&gt;
  &lt;/devices&gt;
&lt;/domainCapabilities&gt;
</pre>

    <p>Reported capabilities are expressed as an enumerated list of available
    options for each of the element or attribute.  For example, the
    &lt;disk/&gt; element has an attribute <code>device</code> which can
    support the values <code>disk</code>, <code>cdrom</code>,
    <code>floppy</code>, or <code>lun</code>.</p>

    <h4><a name="elementsDisks">Hard drives, floppy disks, CDROMs</a></h4>
    <p>Disk capabilities are exposed under <code>disk</code> element. For
    instance:</p>

<pre>
&lt;domainCapabilities&gt;
  ...
  &lt;devices&gt;
    &lt;disk supported='yes'&gt;
      &lt;enum name='diskDevice'&gt;
        &lt;value&gt;disk&lt;/value&gt;
        &lt;value&gt;cdrom&lt;/value&gt;
        &lt;value&gt;floppy&lt;/value&gt;
        &lt;value&gt;lun&lt;/value&gt;
      &lt;/enum&gt;
      &lt;enum name='bus'&gt;
        &lt;value&gt;ide&lt;/value&gt;
        &lt;value&gt;fdc&lt;/value&gt;
        &lt;value&gt;scsi&lt;/value&gt;
        &lt;value&gt;virtio&lt;/value&gt;
        &lt;value&gt;xen&lt;/value&gt;
        &lt;value&gt;usb&lt;/value&gt;
        &lt;value&gt;uml&lt;/value&gt;
        &lt;value&gt;sata&lt;/value&gt;
        &lt;value&gt;sd&lt;/value&gt;
      &lt;/enum&gt;
    &lt;/disk&gt;
    ...
  &lt;/devices&gt;
&lt;/domainCapabilities&gt;
</pre>

    <dl>
      <dt>diskDevice</dt>
      <dd>Options for the <code>device</code> attribute of the &lt;disk/&gt;
      element.</dd>

      <dt>bus</dt>
      <dd>Options for the <code>bus</code> attribute of the &lt;target/&gt;
      element for a &lt;disk/&gt;.</dd>
    </dl>

    <h4><a name="elementsHostDev">Host device assignment</a></h4>
    <p>Some host devices can be passed through to a guest (e.g. USB, PCI and
    SCSI). Well, only if the following is enabled:</p>

<pre>
&lt;domainCapabilities&gt;
  ...
  &lt;devices&gt;
    &lt;hostdev supported='yes'&gt;
      &lt;enum name='mode'&gt;
        &lt;value&gt;subsystem&lt;/value&gt;
        &lt;value&gt;capabilities&lt;/value&gt;
      &lt;/enum&gt;
      &lt;enum name='startupPolicy'&gt;
        &lt;value&gt;default&lt;/value&gt;
        &lt;value&gt;mandatory&lt;/value&gt;
        &lt;value&gt;requisite&lt;/value&gt;
        &lt;value&gt;optional&lt;/value&gt;
      &lt;/enum&gt;
      &lt;enum name='subsysType'&gt;
        &lt;value&gt;usb&lt;/value&gt;
        &lt;value&gt;pci&lt;/value&gt;
        &lt;value&gt;scsi&lt;/value&gt;
      &lt;/enum&gt;
      &lt;enum name='capsType'&gt;
        &lt;value&gt;storage&lt;/value&gt;
        &lt;value&gt;misc&lt;/value&gt;
        &lt;value&gt;net&lt;/value&gt;
      &lt;/enum&gt;
      &lt;enum name='pciBackend'&gt;
        &lt;value&gt;default&lt;/value&gt;
        &lt;value&gt;kvm&lt;/value&gt;
        &lt;value&gt;vfio&lt;/value&gt;
        &lt;value&gt;xen&lt;/value&gt;
      &lt;/enum&gt;
    &lt;/hostdev&gt;
  &lt;/devices&gt;
&lt;/domainCapabilities&gt;
</pre>

    <dl>
      <dt>mode</dt>
      <dd>Options for the <code>mode</code> attribute of the &lt;hostdev/&gt;
      element.</dd>

      <dt>startupPolicy</dt>
      <dd>Options for the <code>startupPolicy</code> attribute of the
      &lt;hostdev/&gt; element.</dd>

      <dt>subsysType</dt>
      <dd>Options for the <code>type</code> attribute of the &lt;hostdev/&gt;
      element in case of <code>mode="subsystem"</code>.</dd>

      <dt>capsType</dt>
      <dd>Options for the <code>type</code> attribute of the &lt;hostdev/&gt;
      element in case of <code>mode="capabilities"</code>.</dd>

      <dt>pciBackend</dt>
      <dd>Options for the <code>name</code> attribute of the &lt;driver/&gt;
      element.</dd>
    </dl>
A
docs: Document the new XML elements  
Andrea Bolognani 已提交
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 314 315 316 317 318 319 320 

    <h3><a name="elementsFeatures">Features</a></h3>

    <p>One more set of XML elements describe the supported features and
    their capabilities. All features occur as children of the main
    <code>features</code> element.</p>

<pre>
&lt;domainCapabilities&gt;
  ...
  &lt;features&gt;
    &lt;gic supported='yes'&gt;
      &lt;enum name='version'&gt;
        &lt;value&gt;2&lt;/value&gt;
        &lt;value&gt;3&lt;/value&gt;
      &lt;/enum&gt;
    &lt;/gic&gt;
  &lt;/features&gt;
&lt;/domainCapabilities&gt;
</pre>

    <p>Reported capabilities are expressed as an enumerated list of
    possible values for each of the elements or attributes. For example, the
    <code>gic</code> element has an attribute <code>version</code> which can
    support the values <code>2</code> or <code>3</code>.</p>

    <p>For information about the purpose of each feature, see the
    <a href="formatdomain.html#elementsFeatures">relevant section</a> in
    the domain XML documentation.
    </p>

    <h4><a name="elementsGIC">GIC capabilities</a></h4>

    <p>GIC capabilities are exposed under the <code>gic</code> element.</p>

    <dl>
      <dt>version</dt>
      <dd>Options for the <code>version</code> attribute of the
      <code>gic</code> element.</dd>
    </dl>
M
Introduce domain_capabilities  
Michal Privoznik 已提交
321 322 
  </body>
</html>