libvirt/src
Laine Stump 3b1c191fe7 conf: parse/format type='hostdev' network interfaces
This is the new interface type that sets up an SR-IOV PCI network
device to be assigned to the guest with PCI passthrough after
initializing some network device-specific things from the config
(e.g. MAC address, virtualport profile parameters). Here is an example
of the syntax:

  <interface type='hostdev' managed='yes'>
    <source>
      <address type='pci' domain='0' bus='0' slot='4' function='3'/>
    </source>
    <mac address='00:11:22:33:44:55'/>
    <address type='pci' domain='0' bus='0' slot='7' function='0'/>
  </interface>

This would assign the PCI card from bus 0 slot 4 function 3 on the
host, to bus 0 slot 7 function 0 on the guest, but would first set the
MAC address of the card to 00:11:22:33:44:55.

NB: The parser and formatter don't care if the PCI card being
specified is a standard single function network adapter, or a virtual
function (VF) of an SR-IOV capable network adapter, but the upcoming
code that implements the back end of this config will work *only* with
SR-IOV VFs. This is because modifying the mac address of a standard
network adapter prior to assigning it to a guest is pointless - part
of the device reset that occurs during that process will reset the MAC
address to the value programmed into the card's firmware.

Although it's not supported by any of libvirt's hypervisor drivers,
usb network hostdevs are also supported in the parser and formatter
for completeness and consistency. <source> syntax is identical to that
for plain <hostdev> devices, except that the <address> element should
have "type='usb'" added if bus/device are specified:

  <interface type='hostdev'>
    <source>
      <address type='usb' bus='0' device='4'/>
    </source>
    <mac address='00:11:22:33:44:55'/>
  </interface>

If the vendor/product form of usb specification is used, type='usb'
is implied:

  <interface type='hostdev'>
    <source>
      <vendor id='0x0012'/>
      <product id='0x24dd'/>
    </source>
    <mac address='00:11:22:33:44:55'/>
  </interface>

Again, the upcoming patch to fill in the backend of this functionality
will log an error and fail with "Unsupported Config" if you actually
try to assign a USB network adapter to a guest using <interface
type='hostdev'> - just use a standard <hostdev> entry in that case
(and also for single-port PCI adapters).
2012-03-05 23:24:28 -05:00
..
conf conf: parse/format type='hostdev' network interfaces 2012-03-05 23:24:28 -05:00
cpu cpu: Add new flag supported by qemu to the cpu definition 2012-03-05 09:54:26 +01:00
esx Fixed URI parsing 2012-02-24 16:49:21 -07:00
hyperv Fixed URI parsing 2012-02-24 16:49:21 -07:00
interface libvirt: do not mix internal flags into public API 2011-07-18 13:50:51 -06:00
libxl libxl: eliminate memory leak in libxmlDomainModifyDeviceFlags 2012-02-28 07:43:38 -05:00
locking virLockManagerNopInit: Rename flags to unused_flags 2011-09-27 11:11:14 +02:00
lxc lxc: Cleaner fix for compilation without SELinux 2012-02-29 14:55:32 +01:00
network util: combine bools in virNetDevTapCreateInBridgePort into flags 2012-03-02 16:04:06 -05:00
node_device npiv: Auto-generate WWN if it's not specified 2012-02-10 12:53:25 +08:00
nwfilter nwfilter: improved logging during driver initialization 2012-02-16 18:56:39 -05:00
openvz Fixed URI parsing 2012-02-24 16:49:21 -07:00
phyp Fix version numbers for isAlive and setKeepAlive driver APIs 2011-11-24 14:44:59 +01:00
qemu conf: parse/format type='hostdev' network interfaces 2012-03-05 23:24:28 -05:00
remote build: use correct type for pid and similar types 2012-03-02 06:57:43 -07:00
rpc rpc: Fix client crash on connection close 2012-03-05 11:30:02 +01:00
secret secret: add Ceph secret type 2011-10-28 11:34:17 -06:00
security build: use correct type for pid and similar types 2012-03-02 06:57:43 -07:00
storage Correct a check for capacity arg of storageVolumeResize() 2012-03-02 21:52:02 -07:00
test npiv: Auto-generate WWN if it's not specified 2012-02-10 12:53:25 +08:00
uml conf: parse/format type='hostdev' network interfaces 2012-03-05 23:24:28 -05:00
util Fix build after commit e3ba4025 2012-03-05 13:31:55 -07:00
vbox Fixed URI parsing 2012-02-24 16:49:21 -07:00
vmware build: use correct type for pid and similar types 2012-03-02 06:57:43 -07:00
vmx qemu: add virtio-scsi controller model 2012-02-28 14:27:03 +08:00
xen Fixed URI parsing 2012-02-24 16:49:21 -07:00
xenapi Fixed URI parsing 2012-02-24 16:49:21 -07:00
xenxs conf: parse/format type='hostdev' network interfaces 2012-03-05 23:24:28 -05:00
datatypes.c virStorageVol: avoid PATH_MAX-sized array 2011-06-22 17:13:58 -06:00
datatypes.h Fixed URI parsing 2012-02-24 16:49:21 -07:00
driver.c libvirt: do not mix internal flags into public API 2011-07-18 13:50:51 -06:00
driver.h build: use correct type for pid and similar types 2012-03-02 06:57:43 -07:00
dtrace2systemtap.pl Add a systemtap script for watching QEMU monitor interactions 2011-10-27 10:42:14 +01:00
fdstream.c fdstream: Add internal callback on stream close 2012-02-27 15:05:17 +01:00
fdstream.h fdstream: Add internal callback on stream close 2012-02-27 15:05:17 +01:00
gnutls_1_0_compat.h Fix detection of GnuTLS 1.x.y 2011-08-03 19:22:29 +02:00
internal.h Workaround python header file insanity 2012-02-24 16:43:27 +00:00
libvirt_daemon.syms Export conditional state driver symbols only when they are defined 2010-03-23 02:05:18 +01:00
libvirt_dbus.syms Fix build on Mingw32 wrt export of virNetServerGetDBusConn 2011-11-21 11:46:52 +00:00
libvirt_driver_modules.syms
libvirt_internal.h Introduce virConnectSetKeepAlive 2011-11-24 11:44:08 +01:00
libvirt_linux.syms
libvirt_network.syms network: provide internal API to return IP of a network 2011-07-25 13:48:55 +08:00
libvirt_nwfilter.syms Some NWFilter symbols are conditional and have to be exported conditional 2010-04-23 19:51:00 +02:00
libvirt_private.syms conf: parse/format type='hostdev' network interfaces 2012-03-05 23:24:28 -05:00
libvirt_public.syms Introduce virDomainPMWakeup API 2012-02-27 11:43:59 +01:00
libvirt_qemu.syms Define a QEMU specific API to attach to a running QEMU process 2011-07-12 15:39:03 +01:00
libvirt_sasl.syms build: fix mingw build without sasl 2011-10-11 16:30:25 -06:00
libvirt_vmx.syms esx: Move VMX handling code out of the driver directory 2010-12-21 22:40:17 +01:00
libvirt_xenxs.syms Fix build with --with-driver-modules enabled 2011-05-27 09:51:28 +02:00
libvirt-qemu.c build: use correct type for pid and similar types 2012-03-02 06:57:43 -07:00
libvirt.c blockResize: add flag for bytes 2012-03-05 10:06:52 -07:00
libvirt.conf Allow for URI aliases when connecting to libvirt 2011-10-19 09:14:34 +01:00
Makefile.am build: Fix build with dtrace + apparmor 2012-03-05 11:30:02 +01:00
nodeinfo.c avoid global variable shadowed 2012-03-01 20:09:23 -07:00
nodeinfo.h build: avoid ATTRIBUTE_UNUSED in headers 2011-07-14 07:51:30 -06:00
probes.d build: use correct type for pid and similar types 2012-03-02 06:57:43 -07:00
qemu_protocol-structs build: use correct type for pid and similar types 2012-03-02 06:57:43 -07:00
README hyperv: Add basic documentation 2011-08-26 17:52:55 +02:00
remote_protocol-structs Introduce virDomainPMWakeup API 2012-02-27 11:43:59 +01:00
virkeepaliveprotocol-structs build: Properly generate and check virkeepaliveprotocol-structs 2011-11-24 14:44:04 +01:00
virnetprotocol-structs Extend RPC protocol to allow FD passing 2011-10-28 10:27:15 +01:00

       libvirt library code README
       ===========================

The directory provides the bulk of the libvirt codebase. Everything
except for the libvirtd daemon and client tools. The build uses a
large number of libtool convenience libraries - one for each child
directory, and then links them together for the final libvirt.so,
although some bits get linked directly to libvirtd daemon instead.

The files directly in this directory are supporting the public API
entry points & data structures.

There are two core shared modules to be aware of:

 * util/  - a collection of shared APIs that can be used by any
            code. This directory is always in the include path
            for all things built

 * conf/  - APIs for parsing / manipulating all the official XML
            files used by the public API. This directory is only
            in the include path for driver implementation modules

 * vmx/   - VMware VMX config handling (used by esx/ and vmware/)


Then there are the hypervisor implementations:

 * esx/          - VMware ESX and GSX support using vSphere API over SOAP
 * hyperv/       - Microsoft Hyper-V support using WinRM
 * lxc/          - Linux Native Containers
 * openvz/       - OpenVZ containers using cli tools
 * phyp/         - IBM Power Hypervisor using CLI tools over SSH
 * qemu/         - QEMU / KVM using qemu CLI/monitor
 * remote/       - Generic libvirt native RPC client
 * test/         - A "mock" driver for testing
 * uml/          - User Mode Linux
 * vbox/         - Virtual Box using native API
 * vmware/       - VMware Workstation and Player using the vmrun tool
 * xen/          - Xen using hypercalls, XenD SEXPR & XenStore
 * xenapi/       - Xen using libxenserver


Finally some secondary drivers that are shared for several HVs.
Currently these are used by LXC, OpenVZ, QEMU, UML and Xen drivers.
The ESX, Hyper-V, Power Hypervisor, Remote, Test & VirtualBox drivers all
implement the secondary drivers directly

 * cpu/          - CPU feature management
 * interface/    - Host network interface management
 * network/      - Virtual NAT networking
 * nwfilter/     - Network traffic filtering rules
 * node_device/  - Host device enumeration
 * secret/       - Secret management
 * security/     - Mandatory access control drivers
 * storage/      - Storage management drivers


Since both the hypervisor and secondary drivers can be built as
dlopen()able modules, it is *FORBIDDEN* to have build dependencies
between these directories. Drivers are only allowed to depend on
the public API, and the internal APIs in the util/ and conf/
directories