- Devel - libvirt List Archives

[libvirt] 'make check' fails (qemuhotplugTest) with libvirt fakeroot build, starting with 3.1.0 release
by Predrag Ivanovic 06 Mar '17

06 Mar '17

Hello. I am not sure if this is a bug, but fakerot build of libvirt-3.1.0 reliably fails at 'make check' stage, always with the same error (qemuhotplugTest). 3.0.0 builds fine, 3.2.0 (git master dec6d9df5feeb768381dd1b010d8030b44ea1a9a) fails at the same spot. If I build as root, libvirt-3.1.0 'make check' passes without errors, and the build is successful. Is this the expected behaviour, bug in the fakeroot(1.21), or? Qemu is 2.8.0 test-suite.log -- ========================================= libvirt 3.1.0: tests/test-suite.log ========================================= # TOTAL: 114 # PASS: 113 # SKIP: 0 # XFAIL: 0 # FAIL: 1 # XPASS: 0 # ERROR: 0 .. contents:: :depth: 2 FAIL: qemuhotplugtest ===================== TEST: qemuhotplugtest ........................................ 40 ...!!!...!...!.. 56 FAIL FAIL qemuhotplugtest (exit status: 1) Pedja

3 6

[libvirt] [PATCH 0/4] Split out interface object into its own module
by John Ferlan 06 Mar '17

06 Mar '17

Feedback from the initial pass at RFC for making a common pool object was that it got really confusing trying to manage the multitude of changes. See patch 3 of the series: http://www.redhat.com/archives/libvir-list/2017-February/msg00519.html So while I figure out what it'll take to make a better object framework, I figure I could start splitting out things a bit to make future work a bit easier to understand. Also rather than trying to do them all in one massive series, I'm working through shorter series contained to each of the driver conf's - this one is for interface and if follows the same pattern as node device. John Ferlan (4): conf: Introduce virinterfaceobj conf: Adjust coding style for interface conf sources conf: Use consistent function name prefixes for virinterfaceobj conf: Alter coding style of interface function prototypes po/POTFILES.in | 1 + src/Makefile.am | 3 +- src/conf/interface_conf.c | 239 ++++++++------------------------ src/conf/interface_conf.h | 60 ++------ src/conf/virinterfaceobj.c | 217 +++++++++++++++++++++++++++++ src/conf/virinterfaceobj.h | 84 +++++++++++ src/interface/interface_backend_netcf.c | 1 + src/interface/interface_backend_udev.c | 1 + src/libvirt_private.syms | 19 +-- src/test/test_driver.c | 26 ++-- 10 files changed, 396 insertions(+), 255 deletions(-) create mode 100644 src/conf/virinterfaceobj.c create mode 100644 src/conf/virinterfaceobj.h -- 2.9.3

2 5

[libvirt] [PATH v9 00/12] Support cache tune in libvirt
by Eli Qiao 06 Mar '17

06 Mar '17

Addressed comment from v9 -> v8 Marcelo: * New public API to query cache usage Eli: * Fix core dump while multiple tasks are added. Addressed comment from v8 -> v7 Martin: * Patch subject prefix. * Move some of cpu related information to virhostcpu.c. * Fix some memory leak in src/utils/resctrl.c Martin & Marcelo: * Don't remove directories which are not maintained by libvirt. Addressed comment from v7 -> v6 Marcelo: * Fix flock usage while VM initialization. Addressed comment from v6 -> v5 Marcelo: * Support other APPs to operate /sys/fs/resctrl at same time Libvirt will scan /sys/fs/resctrl again before doing cache allocation. patch 10 will address this. Addressed comment from v4 -> v5: Marcelo: * Several typos * Use flock instead of virFileLock Addressed comment from v3 -> v4: Daniel & Marcelo: * Added concurrence support Addressed comment from v2 -> v3: Daniel: * Fixed coding style, passed `make check` and `make syntax-check` * Variables renaming and move from header file to c file. * For locking/mutex support, no progress. There are some discussion from mailing list, but I can not find a better way to add locking support without performance impact. I'll explain the process and please help to advice what shoud we do. VM create: 1) Get the cache left value on each bank of the host. This should be shared amount all VMs. 2) Calculate the schemata on the bank based on all created resctrl domain's schemata 3) Calculate the default schemata by scaning all domain's schemata. 4) Flush default schemata to /sys/fs/resctrl/schemata VM destroy: 1) Remove the resctrl domain of that VM 2) Recalculate default schemata 3) Flush default schemata to /sys/fs/resctrl/schemata The key point is that all VMs shares /sys/fs/resctrl/schemata, and when a VM create a resctrl domain, the schemata of that VM depends on the default schemata and all other exsited schematas. So a global mutex is reqired. Before calculate a schemata or update default schemata, libvirt should gain this global mutex. I will try to think more about how to support this gracefully in next patch set. Marcelo: * Added vcpu support for cachetune, this will allow user to define which vcpu using which cache allocation bank. <cachetune id='0' host_id=0 size='3072' unit='KiB' vcpus='0,1'/> vcpus is a cpumap, the vcpu pids will be added to tasks file * Added cdp compatible, user can specify l3 cache even host enable cdp. See patch 8. On a cdp enabled host, specify l3code/l3data by <cachetune id='0' host_id='0' type='l3' size='3072' unit='KiB'/> This will create a schemata like: L3data:0=0xff00;... L3code:0=0xff00;... * Would you please help to test if the functions work. Martin: * Xml test case, I have no time to work on this yet, would you please show me an example, would like to amend it later. This series patches are for supportting CAT featues, which also called cache tune in libvirt. First to expose cache information which could be tuned in capabilites XML. Then add new domain xml element support to add cacahe bank which will apply on this libvirt domain. This series patches add a util file `resctrl.c/h`, an interface to talk with linux kernel's system fs. There are still one TODO left: 1. Expose a new public interface to set cachetune lively. Some discussion about this feature support can be found from: https://www.redhat.com/archives/libvir-list/2017-January/msg00644.html Eli Qiao (12): Resctrl: Add some utils functions Resctrl: expose cache information to capabilities Resctrl: Add new xml element to support cache tune Resctrl: Add private interfaces to operate cache bank Qemu: Set cache tune while booting a new domain. Resctrl: enable l3code/l3data Resctrl: Make sure l3data/l3code are pairs Resctrl: Compatible mode for cdp enabled Resctrl: concurrence support Resctrl: Scan resctrl before doing cache allocation Resctrl: Add Public API for nodecachestats Resctrl: Add nodecachestats daemon/remote.c | 67 +++ docs/schemas/domaincommon.rng | 46 ++ include/libvirt/libvirt-host.h | 32 ++ include/libvirt/virterror.h | 1 + po/POTFILES.in | 1 + src/Makefile.am | 1 + src/conf/capabilities.c | 56 +++ src/conf/capabilities.h | 23 + src/conf/domain_conf.c | 182 +++++++ src/conf/domain_conf.h | 19 + src/driver-hypervisor.h | 7 + src/libvirt-host.c | 41 ++ src/libvirt_private.syms | 12 + src/libvirt_public.syms | 1 + src/nodeinfo.c | 64 +++ src/nodeinfo.h | 1 + src/qemu/qemu_capabilities.c | 8 + src/qemu/qemu_driver.c | 18 + src/qemu/qemu_process.c | 54 ++ src/remote/remote_driver.c | 52 ++ src/remote/remote_protocol.x | 25 +- src/remote_protocol-structs | 16 + src/util/virerror.c | 1 + src/util/virhostcpu.c | 186 ++++++- src/util/virhostcpu.h | 6 + src/util/virresctrl.c | 1082 ++++++++++++++++++++++++++++++++++++++++ src/util/virresctrl.h | 96 ++++ tools/virsh-host.c | 49 ++ 28 files changed, 2129 insertions(+), 18 deletions(-) create mode 100644 src/util/virresctrl.c create mode 100644 src/util/virresctrl.h -- 1.9.1

3 16

[libvirt] [PATCH 0/3] Clean
by John Ferlan 06 Mar '17

06 Mar '17

More "fallout" from the RFC series to make a common pool object: http://www.redhat.com/archives/libvir-list/2017-February/msg00519.html were changes made along the way in the test_driver code to "commonalize" the various vir*ObjFindBy{Name|UUID} callers. This series will do the same for the existing code. Not even attempted was making test_driver to have updated coding style (maybe another day for that)! John Ferlan (3): test: Make common test*ObjFindByName helpers test: Make a common testNetworkObjFindByName test: Make common test*ObjFindByUUID helpers src/test/test_driver.c | 499 ++++++++++++++++--------------------------------- 1 file changed, 166 insertions(+), 333 deletions(-) -- 2.9.3

2 5

[libvirt] [RFC PATCH 00/12] Support multiple PHBs on pSeries guests
by Andrea Bolognani 06 Mar '17

06 Mar '17

Note: if you want to try this out, you'll need to make sure your QEMU binary includes this commit[1]; moreover, that commit is missing a way for libvirt to detect whether the new naming scheme is in place, so this will have to remain an RFC until the QEMU side has been sorted out. Patches 1-3 are just setting up the stage. Patch 4 starts actually introducing the feature, by relaxing some checks that can no longer be as strict. Patches 5-10 puts all the boring bits (XML parsing and formatting, QEMU capabilities) in place. Patch 11 enables the feature at last. Patch 12 introduces a single test, a bunch more will be added before posting this for real (not as RFC). [1] https://github.com/dgibson/qemu/commit/0a6a9ba2adc48a9a5ea7406d1a5fb3c36f00… Andrea Bolognani (12): qemu: Allow qemuBuildControllerDevStr() to return NULL qemu: Tweak index number checking conf: Move index number checking to drivers qemu: Relax pci-root index requirement for pSeries guests schema: Allow <target index='...'/> schema: Add 'spapr-pci-host-bridge' controller model conf: Parse and format <target index='...'/> conf: Add 'spapr-pci-host-bridge' controller model qemu: Automatically pick index and model for pci-root controllers qemu: Introduce QEMU_CAPS_DEVICE_SPAPR_PCI_HOST_BRIDGE qemu: Use multiple PHBs for pSeries guests tests: Add tests for pSeries guests with multiple PHBs docs/schemas/domaincommon.rng | 7 ++ src/bhyve/bhyve_domain.c | 15 +++ src/conf/domain_conf.c | 34 ++++-- src/conf/domain_conf.h | 2 + src/libxl/libxl_domain.c | 14 +++ src/lxc/lxc_domain.c | 14 +++ src/openvz/openvz_driver.c | 14 +++ src/qemu/qemu_capabilities.c | 2 + src/qemu/qemu_capabilities.h | 1 + src/qemu/qemu_command.c | 126 +++++++++++++++++---- src/qemu/qemu_command.h | 9 +- src/qemu/qemu_domain.c | 13 +++ src/qemu/qemu_domain_address.c | 47 +++++++- src/qemu/qemu_hotplug.c | 5 +- src/uml/uml_driver.c | 14 +++ src/vz/vz_driver.c | 14 +++ src/xen/xen_driver.c | 14 +++ .../qemuargv2xmldata/qemuargv2xml-pseries-disk.xml | 5 +- .../qemuargv2xml-pseries-nvram.xml | 5 +- tests/qemucapabilitiesdata/caps_2.6.0.ppc64le.xml | 1 + .../qemuxml2argv-pseries-phb-simple.args | 26 +++++ .../qemuxml2argv-pseries-phb-simple.xml | 20 ++++ tests/qemuxml2argvtest.c | 5 + .../qemuxml2xmlout-panic-pseries.xml | 5 +- .../qemuxml2xmlout-ppc64-usb-controller-legacy.xml | 5 +- .../qemuxml2xmlout-ppc64-usb-controller.xml | 5 +- .../qemuxml2xmlout-pseries-nvram.xml | 5 +- .../qemuxml2xmlout-pseries-panic-missing.xml | 5 +- .../qemuxml2xmlout-pseries-panic-no-address.xml | 5 +- ...g.xml => qemuxml2xmlout-pseries-phb-simple.xml} | 13 ++- tests/qemuxml2xmltest.c | 4 + 31 files changed, 407 insertions(+), 47 deletions(-) create mode 100644 tests/qemuxml2argvdata/qemuxml2argv-pseries-phb-simple.args create mode 100644 tests/qemuxml2argvdata/qemuxml2argv-pseries-phb-simple.xml copy tests/qemuxml2xmloutdata/{qemuxml2xmlout-pseries-panic-missing.xml => qemuxml2xmlout-pseries-phb-simple.xml} (69%) -- 2.7.4

3 17

[libvirt] [PATCH] news: Fix typo
by Jiri Denemark 06 Mar '17

06 Mar '17

Signed-off-by: Jiri Denemark <jdenemar(a)redhat.com> --- Pushed as trivial. docs/news.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/news.xml b/docs/news.xml index 584c9afac..97393b3aa 100644 --- a/docs/news.xml +++ b/docs/news.xml @@ -21,7 +21,7 @@ </summary> <description> Previously, libvirt detected the host CPU model using CPUID - instruction, which cased libvirt to detect a lot of CPU features + instruction, which caused libvirt to detect a lot of CPU features that are not supported by QEMU/KVM. Asking QEMU makes sure we don't start it with unsupported features. </description> -- 2.12.0

1 0

[libvirt] [PATCH] qemu: Drop virQEMUCapsFreeStringList
by Jiri Denemark 06 Mar '17

06 Mar '17

The implementation matches virStringListFreeCount. The only difference between the two functions is the ordering of their parameters. Signed-off-by: Jiri Denemark <jdenemar(a)redhat.com> --- src/qemu/qemu_capabilities.c | 31 +++++++++---------------------- 1 file changed, 9 insertions(+), 22 deletions(-) diff --git a/src/qemu/qemu_capabilities.c b/src/qemu/qemu_capabilities.c index 5694d0ba4..359a0d87a 100644 --- a/src/qemu/qemu_capabilities.c +++ b/src/qemu/qemu_capabilities.c @@ -1881,19 +1881,6 @@ virQEMUCapsProcessProps(virQEMUCapsPtr qemuCaps, } -static void -virQEMUCapsFreeStringList(size_t len, - char **values) -{ - size_t i; - if (!values) - return; - for (i = 0; i < len; i++) - VIR_FREE(values[i]); - VIR_FREE(values); -} - - #define OBJECT_TYPE_PREFIX "name \"" static int @@ -1928,7 +1915,7 @@ virQEMUCapsParseDeviceStrObjectTypes(const char *str, cleanup: if (ret < 0) - virQEMUCapsFreeStringList(ntypelist, typelist); + virStringListFreeCount(typelist, ntypelist); return ret; } @@ -1981,7 +1968,7 @@ virQEMUCapsParseDeviceStrObjectProps(const char *str, cleanup: if (ret < 0) - virQEMUCapsFreeStringList(nproplist, proplist); + virStringListFreeCount(proplist, nproplist); return ret; } @@ -1999,7 +1986,7 @@ virQEMUCapsParseDeviceStr(virQEMUCapsPtr qemuCaps, const char *str) ARRAY_CARDINALITY(virQEMUCapsObjectTypes), virQEMUCapsObjectTypes, nvalues, values); - virQEMUCapsFreeStringList(nvalues, values); + virStringListFreeCount(values, nvalues); for (i = 0; i < ARRAY_CARDINALITY(virQEMUCapsObjectProps); i++) { const char *type = virQEMUCapsObjectProps[i].type; @@ -2011,7 +1998,7 @@ virQEMUCapsParseDeviceStr(virQEMUCapsPtr qemuCaps, const char *str) virQEMUCapsObjectProps[i].nprops, virQEMUCapsObjectProps[i].props, nvalues, values); - virQEMUCapsFreeStringList(nvalues, values); + virStringListFreeCount(values, nvalues); } /* Prefer -chardev spicevmc (detected earlier) over -device spicevmc */ @@ -2665,7 +2652,7 @@ virQEMUCapsProbeQMPCommands(virQEMUCapsPtr qemuCaps, ARRAY_CARDINALITY(virQEMUCapsCommands), virQEMUCapsCommands, ncommands, commands); - virQEMUCapsFreeStringList(ncommands, commands); + virStringListFreeCount(commands, ncommands); /* QMP add-fd was introduced in 1.2, but did not support * management control of set numbering, and did not have a @@ -2707,7 +2694,7 @@ virQEMUCapsProbeQMPEvents(virQEMUCapsPtr qemuCaps, ARRAY_CARDINALITY(virQEMUCapsEvents), virQEMUCapsEvents, nevents, events); - virQEMUCapsFreeStringList(nevents, events); + virStringListFreeCount(events, nevents); return 0; } @@ -2727,7 +2714,7 @@ virQEMUCapsProbeQMPObjects(virQEMUCapsPtr qemuCaps, ARRAY_CARDINALITY(virQEMUCapsObjectTypes), virQEMUCapsObjectTypes, nvalues, values); - virQEMUCapsFreeStringList(nvalues, values); + virStringListFreeCount(values, nvalues); for (i = 0; i < ARRAY_CARDINALITY(virQEMUCapsObjectProps); i++) { const char *type = virQEMUCapsObjectProps[i].type; @@ -2743,7 +2730,7 @@ virQEMUCapsProbeQMPObjects(virQEMUCapsPtr qemuCaps, ARRAY_CARDINALITY(virQEMUCapsPropObjects), virQEMUCapsPropObjects, type, nvalues, values); - virQEMUCapsFreeStringList(nvalues, values); + virStringListFreeCount(values, nvalues); } /* Prefer -chardev spicevmc (detected earlier) over -device spicevmc */ @@ -3043,7 +3030,7 @@ virQEMUCapsProbeQMPMigrationCapabilities(virQEMUCapsPtr qemuCaps, ARRAY_CARDINALITY(virQEMUCapsMigration), virQEMUCapsMigration, ncaps, caps); - virQEMUCapsFreeStringList(ncaps, caps); + virStringListFreeCount(caps, ncaps); return 0; } -- 2.12.0

2 1

[libvirt] [PATCH] node: Replace variable named 'system' with 'syscap'
by John Ferlan 05 Mar '17

05 Mar '17

Changes in commit id 'dec6d9df' caused a compilation failure on a RHEL6 CI build environment. So just replace 'system' with 'syscap' as a name. cc1: warnings being treated as errors ../../src/conf/node_device_conf.c: In function 'virNodeDevCapSystemParseXML': ../../src/conf/node_device_conf.c:1415: error: declaration of 'system' shadows a global declaration [-Wshadow] Signed-off-by: John Ferlan <jferlan(a)redhat.com> --- Pushed as a build breaker src/conf/node_device_conf.c | 8 ++++---- src/node_device/node_device_udev.c | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/conf/node_device_conf.c b/src/conf/node_device_conf.c index d60f69d..3565aec 100644 --- a/src/conf/node_device_conf.c +++ b/src/conf/node_device_conf.c @@ -1412,10 +1412,10 @@ static int virNodeDevCapSystemParseXML(xmlXPathContextPtr ctxt, virNodeDeviceDefPtr def, xmlNodePtr node, - virNodeDevCapSystemPtr system) + virNodeDevCapSystemPtr syscap) { - virNodeDevCapSystemHardwarePtr hardware = &system->hardware; - virNodeDevCapSystemFirmwarePtr firmware = &system->firmware; + virNodeDevCapSystemHardwarePtr hardware = &syscap->hardware; + virNodeDevCapSystemFirmwarePtr firmware = &syscap->firmware; xmlNodePtr orignode; int ret = -1; char *tmp; @@ -1423,7 +1423,7 @@ virNodeDevCapSystemParseXML(xmlXPathContextPtr ctxt, orignode = ctxt->node; ctxt->node = node; - system->product_name = virXPathString("string(./product[1])", ctxt); + syscap->product_name = virXPathString("string(./product[1])", ctxt); hardware->vendor_name = virXPathString("string(./hardware/vendor[1])", ctxt); hardware->version = virXPathString("string(./hardware/version[1])", ctxt); diff --git a/src/node_device/node_device_udev.c b/src/node_device/node_device_udev.c index af44604..bcae444 100644 --- a/src/node_device/node_device_udev.c +++ b/src/node_device/node_device_udev.c @@ -1420,12 +1420,12 @@ static void udevEventHandleCallback(int watch ATTRIBUTE_UNUSED, /* DMI is intel-compatible specific */ #if defined(__x86_64__) || defined(__i386__) || defined(__amd64__) static void -udevGetDMIData(virNodeDevCapSystemPtr system) +udevGetDMIData(virNodeDevCapSystemPtr syscap) { struct udev *udev = NULL; struct udev_device *device = NULL; - virNodeDevCapSystemHardwarePtr hardware = &system->hardware; - virNodeDevCapSystemFirmwarePtr firmware = &system->firmware; + virNodeDevCapSystemHardwarePtr hardware = &syscap->hardware; + virNodeDevCapSystemFirmwarePtr firmware = &syscap->firmware; udev = udev_monitor_get_udev(DRV_STATE_UDEV_MONITOR(driver)); @@ -1441,7 +1441,7 @@ udevGetDMIData(virNodeDevCapSystemPtr system) } if (udevGetStringSysfsAttr(device, "product_name", - &system->product_name) < 0) + &syscap->product_name) < 0) goto cleanup; if (udevGetStringSysfsAttr(device, "sys_vendor", &hardware->vendor_name) < 0) -- 2.9.3

1 0

[libvirt] [PATCH v2] Document preferred naming conventions
by Daniel P. Berrange 04 Mar '17

04 Mar '17

This documents the preferred conventions for naming files, structs, enums, typedefs and functions. Signed-off-by: Daniel P. Berrange <berrange(a)redhat.com> --- Changed in v2: - Fix typo - Add macro docs - Clarify that $VERB is always last in function/macro names HACKING | 81 ++++++++++++++++++++++++++++++++++++++++++++ docs/hacking.html.in | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/hacking2.xsl | 4 +++ 3 files changed, 179 insertions(+) diff --git a/HACKING b/HACKING index fff003b..5077304 100644 --- a/HACKING +++ b/HACKING @@ -239,6 +239,87 @@ on the subject, on Richard Jones' guide to working with open source projects <http://people.redhat.com/rjones/how-to-supply-code-to-open-source-projects/>. +Naming conventions +================== +When reading libvirt code, a number of different naming conventions will be +evident due to various changes in thinking over the course of the project's +lifetime. The conventions documented below should be followed when creating +any entirely new files in libvirt. When working on existing files, while it is +desirable to apply these conventions, keeping a consistent style with existing +code in that particular file is generally more important. The overall guiding +rule is that every file, enum, struct, function, and typedef name must have a +'vir' or 'VIR' prefix. All local scope variable names are exempt, and global +variables are exempt, unless exported in a header file. + +*File names* + +File naming varies depending on the subdirectory. The preferred style is to +have a 'vir' prefix, followed by a name which matches the name of the +functions / objects inside the file. For example, a file containing an object +'virHashtable' is stored in files 'virhashtable.c' and 'virhashtable.h'. +Sometimes, methods which would otherwise be declared 'static' need to be +exported for use by a test suite. For this purpose a second header file should +be added with a suffix of 'priv'. e.g. 'virhashtablepriv.h'. Use of +underscores in file names is discouraged when using the 'vir' prefix style. +The 'vir' prefix naming applies to src/util, src/rpc and tests/ directories. +Most other directories do not follow this convention. + + + +*Enum type & field names* + +All enums should have a 'vir' prefix in their typedef name, and each following +word should have its first letter in uppercase. The enum name should match the +typedef name with a leading underscore. The enum member names should be in all +uppercase, and use an underscore to separate each word. The enum member name +prefix should match the enum typedef name. + + typedef enum _virSocketType virSocketType; + enum _virSocketType { + VIR_SOCKET_TYPE_IPV4, + VIR_SOCKET_TYPE_IPV6, + }; + + +*Struct type names* + +All structs should have a 'vir' prefix in their typedef name, and each +following word should have its first letter in uppercase. The struct name +should be the same as the typedef name with a leading underscore. A second +typedef should be given for a pointer to the struct with a 'Ptr' suffix. + + typedef struct _virHashTable virHashTable; + typedef virHashTable *virHashTablePtr; + struct _virHashTable { + ... + }; + + +*Function names* + +All functions should have a 'vir' prefix in their name, followed by one or +more words with first letter of each word capitalized. Underscores should not +be used in function names. If the function is operating on an object, then the +function name prefix should match the object typedef name. When naming +functions the verb should always be the last part of the name. For example, +given an object 'virHashTable', all functions should have a name +'virHashTable$VERB' e.g. 'virHashTableLookup'. If there is no object +associated with the function, then its name prefix should match the filename. +For example, given a filename of 'virfile.h', all functions should have a name +'virFile$VERB' e.g. 'virFileTouch'. + + + +*Macro names* + +All macros should have a "VIR" prefix in their name, followed by one or more +uppercase words separated by underscores. The macro argument names should be +in lowercase. As with functions, the verb should always be the last part of +the name. For example "VIR_FILE_CLOSE". + + + + Code indentation ================ Libvirt's C source code generally adheres to some basic code-formatting diff --git a/docs/hacking.html.in b/docs/hacking.html.in index b1bb149..1001f49 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -314,6 +314,100 @@ Richard Jones' guide to working with open source projects</a>. </p> + <h2><a name="naming">Naming conventions</a></h2> + + <p> + When reading libvirt code, a number of different naming conventions will + be evident due to various changes in thinking over the course of the + project's lifetime. The conventions documented below should be followed + when creating any entirely new files in libvirt. When working on existing + files, while it is desirable to apply these conventions, keeping a + consistent style with existing code in that particular file is generally + more important. The overall guiding rule is that every file, enum, struct, + function, and typedef name must have a 'vir' or 'VIR' prefix. All local + scope variable names are exempt, and global variables are exempt, unless + exported in a header file. + </p> + + <dl> + <dt>File names</dt> + <dd> + <p> + File naming varies depending on the subdirectory. The preferred + style is to have a 'vir' prefix, followed by a name which matches + the name of the functions / objects inside the file. For example, + a file containing an object 'virHashtable' is stored in files + 'virhashtable.c' and 'virhashtable.h'. Sometimes, methods which + would otherwise be declared 'static' need to be exported for use + by a test suite. For this purpose a second header file should be + added with a suffix of 'priv'. e.g. 'virhashtablepriv.h'. Use of + underscores in file names is discouraged when using the 'vir' + prefix style. The 'vir' prefix naming applies to src/util, + src/rpc and tests/ directories. Most other directories do not + follow this convention. + </p> + </dd> + <dt>Enum type & field names</dt> + <dd> + <p> + All enums should have a 'vir' prefix in their typedef name, + and each following word should have its first letter in + uppercase. The enum name should match the typedef name with + a leading underscore. The enum member names should be in all + uppercase, and use an underscore to separate each word. The + enum member name prefix should match the enum typedef name. + </p> + <pre> + typedef enum _virSocketType virSocketType; + enum _virSocketType { + VIR_SOCKET_TYPE_IPV4, + VIR_SOCKET_TYPE_IPV6, + };</pre> + </dd> + <dt>Struct type names</dt> + <dd> + <p> + All structs should have a 'vir' prefix in their typedef name, + and each following word should have its first letter in + uppercase. The struct name should be the same as the typedef + name with a leading underscore. A second typedef should be + given for a pointer to the struct with a 'Ptr' suffix. + </p> + <pre> + typedef struct _virHashTable virHashTable; + typedef virHashTable *virHashTablePtr; + struct _virHashTable { + ... + };</pre> + </dd> + <dt>Function names</dt> + <dd> + <p> + All functions should have a 'vir' prefix in their name, + followed by one or more words with first letter of each + word capitalized. Underscores should not be used in function + names. If the function is operating on an object, then the + function name prefix should match the object typedef name. + When naming functions the verb should always be the last + part of the name. For example, given an object 'virHashTable', + all functions should have a name 'virHashTable$VERB' + e.g. 'virHashTableLookup'. If there is no object associated + with the function, then its name prefix should match the + filename. For example, given a filename of 'virfile.h', all + functions should have a name 'virFile$VERB' e.g. 'virFileTouch'. + </p> + </dd> + <dt>Macro names</dt> + <dd> + <p> + All macros should have a "VIR" prefix in their name, followed + by one or more uppercase words separated by underscores. The + macro argument names should be in lowercase. As with functions, + the verb should always be the last part of the name. For example + "VIR_FILE_CLOSE". + </p> + </dd> + </dl> <h2><a name="indent">Code indentation</a></h2> <p> diff --git a/docs/hacking2.xsl b/docs/hacking2.xsl index 3595b7e..7e5ac82 100644 --- a/docs/hacking2.xsl +++ b/docs/hacking2.xsl @@ -114,6 +114,10 @@ from docs/hacking.html.in! <xsl:template match="html:li/html:ul/html:li">-- <xsl:apply-templates/><xsl:value-of select="$newline"/><xsl:value-of select="$newline"/> </xsl:template> +<xsl:template match="html:dl/html:dt">*<xsl:apply-templates/>*<xsl:value-of select="$newline"/><xsl:value-of select="$newline"/> +</xsl:template> +<xsl:template match="html:dl/html:dd"><xsl:apply-templates/><xsl:value-of select="$newline"/><xsl:value-of select="$newline"/> +</xsl:template>  -- 2.9.3

3 4

[libvirt] [PATCH RESEND] qdev: Make "hotplugged" property read-only
by Eduardo Habkost 04 Mar '17

04 Mar '17

The "hotplugged" property is user visible, but it was never meant to be set by the user. There are probably multiple ways to break or crash device code by overriding the property. For example, we recently fixed a crash in rtc_set_memory() related to the property (commit 26ef65beab852caf2b1ef4976e3473f2d525164d). There has been some discussion about making management software use "hotplugged=on" on migration, to indicate devices that were hotplugged in the migration source. There were other suggestions to address this, like including the "hotplugged" field in the migration stream instead of requiring it to be set propertly. Whatever solution we choose in the future, this patch disables setting "hotplugged" explicitly in the command-line by now, because the ability to set the property is unused, untested, and undocumented. Signed-off-by: Eduardo Habkost <ehabkost(a)redhat.com> --- hw/core/qdev.c | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/hw/core/qdev.c b/hw/core/qdev.c index 06ba02e2a3..800c9ca23f 100644 --- a/hw/core/qdev.c +++ b/hw/core/qdev.c @@ -1016,13 +1016,6 @@ static bool device_get_hotplugged(Object *obj, Error **err) return dev->hotplugged; } -static void device_set_hotplugged(Object *obj, bool value, Error **err) -{ - DeviceState *dev = DEVICE(obj); - - dev->hotplugged = value; -} - static void device_initfn(Object *obj) { DeviceState *dev = DEVICE(obj); @@ -1042,7 +1035,7 @@ static void device_initfn(Object *obj) object_property_add_bool(obj, "hotpluggable", device_get_hotpluggable, NULL, NULL); object_property_add_bool(obj, "hotplugged", - device_get_hotplugged, device_set_hotplugged, + device_get_hotplugged, NULL, &error_abort); class = object_get_class(OBJECT(dev)); -- 2.11.0.259.g40922b1

3 4