openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
libvirt/src
History
Eric Blake 31b5bad9ff event: make deregister return value match docs 
Ever since their introduction (commit 1509b80 in v0.5.0 for
virConnectDomainEventRegister, commit 4445723 in v0.8.0 for
virConnectDomainEventDeregisterAny), the event deregistration
functions have been documented as returning 0 on success;
likewise for older registration (only the newer RegisterAny
must return a non-zero callbackID).  And now that we are
adding virConnectNetworkEventDeregisterAny for v1.2.1, it
should have the same semantics.

Fortunately, all of the stateful drivers have been obeying
the docs and returning 0, thanks to the way the remote_driver
tracks things (in fact, the RPC wire protocol is unable to
send a return value for DomainEventRegisterAny, at least not
without adding a new RPC number).  Well, except for vbox,
which was always failing deregistration, due to failure to
set the return value to anything besides its initial -1.

But for local drivers, such as test:///default, we've been
returning non-zero numbers; worse, the non-zero numbers have
differed over time.  For example, in Fedora 12 (libvirt 0.8.2),
calling Register twice would return 0 and 1 [the callbackID
generated under the hood]; while in Fedora 20 (libvirt 1.1.3),
it returns 1 and 2 [the number of callbacks registered for
that event type].  Since we have changed the behavior over
time, and since it differs by local vs. remote, we can safely
argue that no one could have been reasonably relying on any
particular behavior, so we might as well obey the docs, as well
as prepare callers that might deal with older clients to not be
surprised if the docs are not strictly followed.

For consistency, this patch fixes the code for all drivers,
even though it only makes an impact for vbox and for local
drivers.  By fixing all drivers, future copy and paste from
a remote driver to a local driver is less likely to
reintroduce the bug.

Finally, update the testsuite to gain some coverage of the
issue for local drivers, including the first test of old-style
domain event registration via function pointer instead of
event id.

* src/libvirt.c (virConnectDomainEventRegister)
(virConnectDomainEventDeregister)
(virConnectDomainEventDeregisterAny): Clarify docs.
* src/libxl/libxl_driver.c (libxlConnectDomainEventRegister)
(libxlConnectDomainEventDeregister)
(libxlConnectDomainEventDeregisterAny): Match documentation.
* src/lxc/lxc_driver.c (lxcConnectDomainEventRegister)
(lxcConnectDomainEventDeregister)
(lxcConnectDomainEventDeregisterAny): Likewise.
* src/test/test_driver.c (testConnectDomainEventRegister)
(testConnectDomainEventDeregister)
(testConnectDomainEventDeregisterAny)
(testConnectNetworkEventDeregisterAny): Likewise.
* src/uml/uml_driver.c (umlConnectDomainEventRegister)
(umlConnectDomainEventDeregister)
(umlConnectDomainEventDeregisterAny): Likewise.
* src/vbox/vbox_tmpl.c (vboxConnectDomainEventRegister)
(vboxConnectDomainEventDeregister)
(vboxConnectDomainEventDeregisterAny): Likewise.
* src/xen/xen_driver.c (xenUnifiedConnectDomainEventRegister)
(xenUnifiedConnectDomainEventDeregister)
(xenUnifiedConnectDomainEventDeregisterAny): Likewise.
* src/network/bridge_driver.c
(networkConnectNetworkEventDeregisterAny): Likewise.
* tests/objecteventtest.c (testDomainCreateXMLOld): New test.
(mymain): Run it.
(testDomainCreateXML): Check return values.

Signed-off-by: Eric Blake <eblake@redhat.com>
 		2014-01-07 06:53:40 -07:00
..
access Avoid Coverity DEADCODE warning 2013-10-24 06:40:18 -04:00
conf event: use newer array management macros 2014-01-06 08:01:10 -07:00
cpu cpu: x86: Add internal CPUID features support and KVM feature bits 2013-11-08 09:44:42 +01:00
esx src: Align make output 2013-12-04 09:41:33 +01:00
hyperv src: Align make output 2013-12-04 09:41:33 +01:00
interface interface: Take interface status into account when starting and destroying 2013-12-24 17:20:00 +01:00
libxl event: make deregister return value match docs 2014-01-07 06:53:40 -07:00
locking maint: improve VIR_ERR_OPERATION_DENIED usage 2014-01-06 08:29:29 -07:00
lxc event: make deregister return value match docs 2014-01-07 06:53:40 -07:00
network event: make deregister return value match docs 2014-01-07 06:53:40 -07:00
node_device maint: fix comma style issues: remaining code 2013-11-20 09:14:55 -07:00
nwfilter Remove stray semicolon after pragma macros 2013-12-19 16:02:38 +00:00
openvz maint: fix comma style issues: remaining drivers 2013-11-20 09:14:55 -07:00
parallels Renamed virDomainEventState to virObjectEventState 2013-12-10 11:35:34 +00:00
phyp Convert 'int i' to 'size_t i' in src/phyp/ files 2013-07-10 17:55:15 +01:00
qemu qemuProcessStop: Don't overwrite any errors 2014-01-07 14:50:40 +01:00
remote event: don't overwrite registration error message 2014-01-02 05:54:53 -07:00
rpc virnetserverclient: Fix conditional change HAVE_SASL to WITH_SASL 2013-12-04 06:27:20 -05:00
secret Convert 'int i' to 'size_t i' in src/secret/ files 2013-07-10 17:40:14 +01:00
security maint: improve VIR_ERR_NO_SUPPORT usage 2014-01-04 12:15:08 -07:00
storage storage: Use VIR_DELETE_ELEMENT instead of open coding 2014-01-06 16:05:31 +01:00
test event: make deregister return value match docs 2014-01-07 06:53:40 -07:00
uml event: make deregister return value match docs 2014-01-07 06:53:40 -07:00
util maint: improve VIR_ERR_OPERATION_DENIED usage 2014-01-06 08:29:29 -07:00
vbox event: make deregister return value match docs 2014-01-07 06:53:40 -07:00
vmware vmware: os x support is broken 2014-01-03 11:13:43 -07:00
vmx Support transient attribute on vmware disks 2013-12-17 14:24:49 -07:00
xen event: make deregister return value match docs 2014-01-07 06:53:40 -07:00
xenapi maint: fix comma style issues: xen 2013-11-20 09:14:54 -07:00
xenxs maint: fix comma style issues: xen 2013-11-20 09:14:54 -07:00
Makefile.am Added Network events API and virNetworkEventLifecycle. 2013-12-11 13:10:41 +00:00
README hyperv: Add basic documentation 2011-08-26 17:52:55 +02:00
check-aclperms.pl Fix naming of permission for detecting storage pools 2013-09-12 17:20:07 +01:00
check-aclrules.pl maint: ship .pl scripts as executables 2013-11-19 14:32:59 -07:00
check-driverimpls.pl Skip virNWFilterTechDriver when validating API naming 2013-05-09 17:09:59 +01:00
check-drivername.pl Extend previous check to validate driver struct field names 2013-04-24 10:59:53 +01:00
check-symfile.pl maint: use LGPL correctly 2013-05-20 14:03:48 -06:00
check-symsorting.pl maint: use LGPL correctly 2013-05-20 14:03:48 -06:00
datatypes.c maint: improve VIR_ERR_INVALID_CONN usage 2014-01-06 21:41:02 -07:00
datatypes.h maint: improve VIR_ERR_INVALID_CONN usage 2014-01-06 21:41:02 -07:00
driver.c Remove all direct use of getenv 2013-10-21 14:03:52 +01:00
driver.h maint: Fix messy include of libvirt_internal.h 2014-01-07 10:03:14 +01:00
dtrace2systemtap.pl maint: fix up copyright notice inconsistencies 2012-09-20 16:30:55 -06:00
fdstream.c Always open files in binary mode in virFDStreamOpenFileInternal 2013-09-24 14:27:41 +02:00
fdstream.h Allow the iohelper path to be customized by test programs 2013-05-10 19:57:18 +01:00
gnutls_1_0_compat.h maint: don't use config.h in .h files 2013-06-05 05:53:25 -06:00
internal.h maint: Fix messy include of libvirt_internal.h 2014-01-07 10:03:14 +01:00
libvirt-lxc.c maint: improve VIR_ERR_INVALID_CONN usage 2014-01-06 21:41:02 -07:00
libvirt-qemu.c maint: improve VIR_ERR_INVALID_CONN usage 2014-01-06 21:41:02 -07:00
libvirt.c event: make deregister return value match docs 2014-01-07 06:53:40 -07:00
libvirt.conf Allow overriding default URI in config file 2012-03-15 11:20:17 +00:00
libvirt_atomic.syms maint: check all symfiles for sorting 2013-02-22 16:48:12 -07:00
libvirt_daemon.syms maint: make it easier to sort syms files 2013-01-25 08:33:09 -07:00
libvirt_driver_modules.syms maint: one missed syms file 2013-01-26 09:59:12 -07:00
libvirt_esx.syms maint: enforce private symbol section sorting 2013-02-20 08:27:03 -07:00
libvirt_gnutls.syms Add APIs to get at more client security data 2013-03-19 13:11:46 +00:00
libvirt_internal.h New internal migration APIs with extensible parameters 2013-06-25 01:13:16 +02:00
libvirt_libssh2.syms maint: enforce private symbol section sorting 2013-02-20 08:27:03 -07:00
libvirt_linux.syms maint: enforce private symbol section sorting 2013-02-20 08:27:03 -07:00
libvirt_lxc.syms Apply security label when entering LXC namespaces 2013-03-13 15:16:37 +00:00
libvirt_openvz.syms maint: enforce private symbol section sorting 2013-02-20 08:27:03 -07:00
libvirt_private.syms event: fix doc typos, and doc more public methods 2014-01-03 10:45:54 -07:00
libvirt_probes.d Re-add DTrace probes on 'dispose' functions 2013-03-14 12:42:21 +00:00
libvirt_public.syms Added Network events API and virNetworkEventLifecycle. 2013-12-11 13:10:41 +00:00
libvirt_qemu.syms qemu-agent: available in 0.10.0 2012-08-23 13:05:52 -06:00
libvirt_qemu_probes.d build: fix binary location in stap files --with-driver-modules 2012-08-10 23:11:26 -04:00
libvirt_remote.syms build: fix build --without-remote 2013-10-04 17:01:47 -06:00
libvirt_sasl.syms Add APIs to get at more client security data 2013-03-19 13:11:46 +00:00
libvirt_vmware.syms VMware: Make version parsing testable and add tests 2013-09-20 08:23:31 -05:00
libvirt_vmx.syms VMX: Create virVMXFormatDisk() from HD and CD-ROM 2013-09-01 23:11:50 -05:00
libvirt_xenxs.syms maint: enforce private symbol section sorting 2013-02-20 08:27:03 -07:00
lock_protocol-structs tests: check remaining .x files 2013-09-09 12:04:03 -06:00
lxc_monitor_protocol-structs tests: check remaining .x files 2013-09-09 12:04:03 -06:00
lxc_protocol-structs build: add new file, for lxc_protocol checking 2013-01-15 12:01:22 -07:00
nodeinfo.c BSD: implement nodeGetMemoryStats 2014-01-07 06:26:33 -07:00
nodeinfo.h Separate internal node device APIs from public API 2013-05-08 10:47:47 +01:00
qemu_protocol-structs Make naming of remote procedures match API names exactly 2013-04-24 10:33:10 +01:00
remote_protocol-structs Add network events to the remote driver 2013-12-11 13:26:25 +00: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

README 

       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