shaba/libvirt-python
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt-python.git synced 2025-07-15 20:59:34 +03:00
Code Issues Projects Releases Activity

build: make it easier to backport event ids

Browse Source 
In some cases, it is very easy for downstream distros to backport
enum values without requiring a .so bump.  Keying the conditional
code off of the upstream version where the enum value was added
is not ideal, because downstream then has to patch that the feature
is available in their build that still reports an earlier version
number.  For example, if RHEL 7 backports events from 1.2.11 into
a build based on 1.2.8, building the python bindings would warn:

libvirt-override.c: In function ‘libvirt_virConnectDomainEventRegisterAny’:
libvirt-override.c:6653:5: warning: enumeration value ‘VIR_DOMAIN_EVENT_ID_TUNABLE’ not handled in switch [-Wswitch]
     switch ((virDomainEventID) eventID) {
          ^
	  libvirt-override.c:6653:5: warning: enumeration value ‘VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE’ not handled in switch [-Wswitch]

The solution is simple - use feature-based probes instead of
version probes.  Since we already scrape the XML API document of
whatever libvirt build we are binding, and that XML already
documents any downstream enum additions, we can use those as the
features for gating conditional compilation.

* generator.py (enum): Track event id names.
(buildStubs): Output define wrappers for events.
* libvirt-override.c
(libvirt_virConnectDomainEventBalloonChangeCallback)
(libvirt_virConnectDomainEventPMSuspendDiskCallback)
(libvirt_virConnectDomainEventDeviceRemovedCallback)
(libvirt_virConnectDomainEventTunableCallback)
(libvirt_virConnectDomainEventAgentLifecycleCallback)
(libvirt_virConnectDomainEventRegisterAny): Use them.

Signed-off-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
Eric Blake
2015-01-14 19:57:42 -07:00
parent 1598bd7dd5
commit ab6eb69f8d
2 changed files with 33 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
generator.py
View File

@ -9,6 +9,7 @@ qemu_functions = {}
enums = {} # { enumType: { enumConstant: enumValue } }
lxc_enums = {} # { enumType: { enumConstant: enumValue } }
qemu_enums = {} # { enumType: { enumConstant: enumValue } }
event_ids = []
import os
import sys
@ -219,6 +220,9 @@ def lxc_function(name, desc, ret, args, file, module, cond):
def enum(type, name, value):
if type not in enums:
enums[type] = {}
if (name.startswith('VIR_DOMAIN_EVENT_ID_') or
name.startswith('VIR_NETWORK_EVENT_ID_')):
event_ids.append(name)
if value == 'VIR_TYPED_PARAM_INT':
value = 1
elif value == 'VIR_TYPED_PARAM_UINT':
@ -910,10 +914,10 @@ def buildStubs(module, api_xml):
wrapper_file = "build/%s.c" % module
include = open(header_file, "w")
include.write("/* Generated */\n\n")
include.write("/* Generated by generator.py */\n\n")
export = open(export_file, "w")
export.write("/* Generated */\n\n")
export.write("/* Generated by generator.py */\n\n")
wrapper = open(wrapper_file, "w")
wrapper.write("/* Generated by generator.py */\n\n")
@ -943,6 +947,10 @@ def buildStubs(module, api_xml):
# Write C pointer conversion functions.
for classname in primary_classes:
print_c_pointer(classname, wrapper, export, include)
# Write define wrappers around event id enums, so that the
# preprocessor can see which enums were available.
for event_id in event_ids:
include.write("#define %s %s\n" % (event_id, event_id))
include.close()
export.close()